You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@metron.apache.org by ottobackwards <gi...@git.apache.org> on 2017/07/07 18:59:07 UTC
[GitHub] metron pull request #638: METRON-933 New stellar function for regex group ca...
GitHub user ottobackwards opened a pull request:
https://github.com/apache/metron/pull/638
METRON-933 New stellar function for regex group capture
New Stellar function for capturing a group from a Regex Pattern.
I created a new RegExFunctions in Stellar for this, and moved the existing RegEx Match function there.
I also created the corresponding test class, and added a test for the existing RegEx Match function as well, since there didn't seem to be one.
To support these functions I created a thread local cache for compiled Pattern objects.
Testing -> Build, run tests
Start stellar shell and execute the functions.
### For all changes:
- [x ] Is there a JIRA ticket associated with this PR? If not one needs to be created at [Metron Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel).
- [x ] Does your PR title start with METRON-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
- [x ] Has your PR been rebased against the latest commit within the target branch (typically master)?
### For code changes:
- [ x] Have you included steps to reproduce the behavior or problem that is being changed or addressed?
- [ x] Have you included steps or a guide to how the change may be verified and tested manually?
- [x ] Have you ensured that the full suite of tests and checks have been executed in the root incubating-metron folder via:
```
mvn -q clean integration-test install && build_utils/verify_licenses.sh
```
- [x ] Have you written or updated unit tests and or integration tests to verify your changes?
- [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] Have you verified the basic functionality of the build by building and running locally with Vagrant full-dev environment or the equivalent?
### For documentation related changes:
- [x ] Have you ensured that format looks appropriate for the output in which it is rendered by building and verifying the site-book? If not then run the following commands and the verify changes via `site-book/target/site/index.html`:
```
cd site-book
mvn site
```
#### Note:
Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.
It is also recommended that [travis-ci](https://travis-ci.org) is set up for your personal repository such that your branches are built there before submitting a pull request.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/ottobackwards/metron stellar_regex_capture
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/638.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #638
----
commit 3d7a79d2afaeb521113f1d77ba6211a0a52e8401
Author: Otto Fowler <ot...@gmail.com>
Date: 2017-07-07T18:52:04Z
New stellar function for regex group capture
Create a test for existing regex match function
Move both to RegExFunctions
Create a cache for compiled patterns (thread local)
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron pull request #638: METRON-933 New stellar function for regex group ca...
Posted by ottobackwards <gi...@git.apache.org>.
Github user ottobackwards commented on a diff in the pull request:
https://github.com/apache/metron/pull/638#discussion_r126778032
--- Diff: metron-stellar/stellar-common/src/test/java/org/apache/metron/stellar/dsl/functions/RegExFunctionsTest.java ---
@@ -0,0 +1,70 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.metron.stellar.dsl.functions;
+
+import org.apache.metron.stellar.dsl.ParseException;
+import org.junit.Assert;
+import org.junit.Test;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import static org.apache.metron.stellar.common.utils.StellarProcessorUtils.runPredicate;
+
+public class RegExFunctionsTest {
+
+ // test RegExMatch
+ @Test
+ public void testRegExMatch() throws Exception {
+ final Map<String, String> variableMap = new HashMap<String, String>() {{
+ put("numbers", "12345");
+ put("numberPattern", "\\d(\\d)(\\d).*");
--- End diff --
In java I need to \\ to escape
http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron issue #638: METRON-933 New stellar function for regex group capture
Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:
https://github.com/apache/metron/pull/638
I love it. The pattern cache is great! +1 by inspection
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron issue #638: METRON-933 New stellar function for regex group capture
Posted by JonZeolla <gi...@git.apache.org>.
Github user JonZeolla commented on the issue:
https://github.com/apache/metron/pull/638
+1 via inspection
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron pull request #638: METRON-933 New stellar function for regex group ca...
Posted by JonZeolla <gi...@git.apache.org>.
Github user JonZeolla commented on a diff in the pull request:
https://github.com/apache/metron/pull/638#discussion_r126778701
--- Diff: metron-stellar/stellar-common/src/test/java/org/apache/metron/stellar/dsl/functions/RegExFunctionsTest.java ---
@@ -0,0 +1,70 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.metron.stellar.dsl.functions;
+
+import org.apache.metron.stellar.dsl.ParseException;
+import org.junit.Assert;
+import org.junit.Test;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import static org.apache.metron.stellar.common.utils.StellarProcessorUtils.runPredicate;
+
+public class RegExFunctionsTest {
+
+ // test RegExMatch
+ @Test
+ public void testRegExMatch() throws Exception {
+ final Map<String, String> variableMap = new HashMap<String, String>() {{
+ put("numbers", "12345");
+ put("numberPattern", "\\d(\\d)(\\d).*");
--- End diff --
Ahh, right sorry. So no need to do this when specifying within Stellar, just in the tests - sounds good.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron pull request #638: METRON-933 New stellar function for regex group ca...
Posted by ottobackwards <gi...@git.apache.org>.
Github user ottobackwards commented on a diff in the pull request:
https://github.com/apache/metron/pull/638#discussion_r126778367
--- Diff: metron-stellar/stellar-common/src/main/java/org/apache/metron/stellar/dsl/functions/RegExFunctions.java ---
@@ -0,0 +1,103 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.metron.stellar.dsl.functions;
+
+import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import org.apache.metron.stellar.common.utils.ConversionUtils;
+import org.apache.metron.stellar.common.utils.PatternCache;
+import org.apache.metron.stellar.dsl.BaseStellarFunction;
+import org.apache.metron.stellar.dsl.Stellar;
+
+public class RegExFunctions {
+
+ @Stellar(name = "REGEXP_MATCH",
+ description = "Determines whether a regex matches a string",
+ params = {
+ "string - The string to test",
+ "pattern - The proposed regex pattern"
+ },
+ returns = "True if the regex pattern matches the string and false if otherwise.")
+ public static class RegexpMatch extends BaseStellarFunction {
+
+ @Override
+ public Object apply(List<Object> list) {
+ if (list.size() < 2) {
+ throw new IllegalStateException(
+ "REGEXP_MATCH expects two args: [string, pattern] where pattern is a regexp pattern");
+ }
+ String patternString = (String) list.get(1);
+ String str = (String) list.get(0);
+ if (str == null || patternString == null) {
+ return false;
+ }
+ return PatternCache.INSTANCE.getPattern(patternString).matcher(str).matches();
+ }
+ }
+
+ @Stellar(name = "REGEXP_GROUP_VAL",
+ description = "Returns the value of a group in a regex against a string",
+ params = {
+ "string - The string to test",
+ "pattern - The proposed regex pattern",
+ "group - integer that selects what group to select, starting at 1"
+ },
+ returns = "The value of the group, or null if not matched or no group at index")
+ public static class RegexpGroupValue extends BaseStellarFunction {
+
+ @Override
+ public Object apply(List<Object> list) {
+ if (list.size() < 3) {
--- End diff --
Addressed, good catch
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron pull request #638: METRON-933 New stellar function for regex group ca...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/metron/pull/638
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron pull request #638: METRON-933 New stellar function for regex group ca...
Posted by JonZeolla <gi...@git.apache.org>.
Github user JonZeolla commented on a diff in the pull request:
https://github.com/apache/metron/pull/638#discussion_r126739325
--- Diff: metron-stellar/stellar-common/src/main/java/org/apache/metron/stellar/dsl/functions/RegExFunctions.java ---
@@ -0,0 +1,103 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.metron.stellar.dsl.functions;
+
+import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import org.apache.metron.stellar.common.utils.ConversionUtils;
+import org.apache.metron.stellar.common.utils.PatternCache;
+import org.apache.metron.stellar.dsl.BaseStellarFunction;
+import org.apache.metron.stellar.dsl.Stellar;
+
+public class RegExFunctions {
+
+ @Stellar(name = "REGEXP_MATCH",
+ description = "Determines whether a regex matches a string",
+ params = {
+ "string - The string to test",
+ "pattern - The proposed regex pattern"
+ },
+ returns = "True if the regex pattern matches the string and false if otherwise.")
+ public static class RegexpMatch extends BaseStellarFunction {
+
+ @Override
+ public Object apply(List<Object> list) {
+ if (list.size() < 2) {
+ throw new IllegalStateException(
+ "REGEXP_MATCH expects two args: [string, pattern] where pattern is a regexp pattern");
+ }
+ String patternString = (String) list.get(1);
+ String str = (String) list.get(0);
+ if (str == null || patternString == null) {
+ return false;
+ }
+ return PatternCache.INSTANCE.getPattern(patternString).matcher(str).matches();
+ }
+ }
+
+ @Stellar(name = "REGEXP_GROUP_VAL",
+ description = "Returns the value of a group in a regex against a string",
+ params = {
+ "string - The string to test",
+ "pattern - The proposed regex pattern",
+ "group - integer that selects what group to select, starting at 1"
+ },
+ returns = "The value of the group, or null if not matched or no group at index")
+ public static class RegexpGroupValue extends BaseStellarFunction {
+
+ @Override
+ public Object apply(List<Object> list) {
+ if (list.size() < 3) {
--- End diff --
Why isn't this `!=`, since any arguments after the 3rd are ignored?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron pull request #638: METRON-933 New stellar function for regex group ca...
Posted by JonZeolla <gi...@git.apache.org>.
Github user JonZeolla commented on a diff in the pull request:
https://github.com/apache/metron/pull/638#discussion_r126755801
--- Diff: metron-stellar/stellar-common/src/test/java/org/apache/metron/stellar/dsl/functions/RegExFunctionsTest.java ---
@@ -0,0 +1,70 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.metron.stellar.dsl.functions;
+
+import org.apache.metron.stellar.dsl.ParseException;
+import org.junit.Assert;
+import org.junit.Test;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import static org.apache.metron.stellar.common.utils.StellarProcessorUtils.runPredicate;
+
+public class RegExFunctionsTest {
+
+ // test RegExMatch
+ @Test
+ public void testRegExMatch() throws Exception {
+ final Map<String, String> variableMap = new HashMap<String, String>() {{
+ put("numbers", "12345");
+ put("numberPattern", "\\d(\\d)(\\d).*");
--- End diff --
I did a bit of digging and couldn't find where the obvious documentation for this format (`\\d` instead of `\d`). Perhaps I missed it in other docs? I was primarily searching [here](https://github.com/apache/metron/tree/master/metron-stellar/stellar-common).
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---