You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@metron.apache.org by cestella <gi...@git.apache.org> on 2017/12/21 23:30:23 UTC
[GitHub] metron pull request #880: METRON-1379: Add an OBJECT_GET stellar function
GitHub user cestella opened a pull request:
https://github.com/apache/metron/pull/880
METRON-1379: Add an OBJECT_GET stellar function
## Contributor Comments
With the creation of METRON-1378 we have the ability to create serialized summaries of data. We need to interact with these summaries from within Stellar. This enables use-cases like creating a bloom filter of malicious domains and interacting with that bloom filter from within all the places where stellar is available.
This PR depends on #879 to create summarized objects for testing. Test plan pending.
## Pull Request Checklist
Thank you for submitting a contribution to Apache Metron.
Please refer to our [Development Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235) for the complete guide to follow for contributions.
Please refer also to our [Build Verification Guidelines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview) for complete smoke testing guides.
In order to streamline the review of the contribution we ask you follow these guidelines and ask you to double check the following:
### 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?
- [ ] 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 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?
- [x] 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)?
- [x] 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/cestella/incubator-metron object_get
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/880.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 #880
----
commit 5328931504bdd069e827ba55cc6015ce9b3031f8
Author: cstella <ce...@...>
Date: 2017-12-21T23:23:32Z
METRON-1379: Add an OBJECT_GET stellar function
----
---
[GitHub] metron pull request #880: METRON-1379: Add an OBJECT_GET stellar function
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/metron/pull/880
---
[GitHub] metron pull request #880: METRON-1379: Add an OBJECT_GET stellar function
Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on a diff in the pull request:
https://github.com/apache/metron/pull/880#discussion_r160242210
--- Diff: metron-platform/metron-enrichment/src/test/java/org/apache/metron/enrichment/stellar/ObjectGetTest.java ---
@@ -0,0 +1,91 @@
+/**
+ * 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.enrichment.stellar;
+
+import com.google.common.collect.ImmutableMap;
+import org.apache.commons.io.IOUtils;
+import org.apache.hadoop.conf.Configuration;
+import org.apache.hadoop.fs.FileSystem;
+import org.apache.hadoop.fs.Path;
+import org.apache.metron.common.utils.SerDeUtils;
+import org.apache.metron.stellar.common.utils.StellarProcessorUtils;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+import java.io.BufferedOutputStream;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+
+public class ObjectGetTest {
+ FileSystem fs;
+ List<String> data;
+
+ @Before
+ public void setup() throws IOException {
+ fs = FileSystem.get(new Configuration());
+ data = new ArrayList<>();
+ {
+ data.add("apache");
+ data.add("metron");
+ data.add("is");
+ data.add("great");
+ }
+
+ }
+
+ @Test
+ public void test() throws Exception {
+ String filename = "target/ogt/test.ser";
+ Assert.assertTrue(ObjectGet.cache == null || !ObjectGet.cache.asMap().containsKey(filename));
+ assertDataIsReadCorrectly(filename);
+ }
+
+ public void assertDataIsReadCorrectly(String filename) throws IOException {
+ try(BufferedOutputStream bos = new BufferedOutputStream(fs.create(new Path(filename), true))) {
+ IOUtils.write(SerDeUtils.toBytes(data), bos);
+ bos.flush();
--- End diff --
That is not necessarily correct (in general) as Closeable does not enforce flush prior to close (in fact, it doesn't even know about flush()). That being said, strictly speaking, it is not required in this case as it is called for `BufferedOutputStream`. I have just gotten into the habit of being explicit in calling flush since it's bitten me in the butt so many times in the past. I'm going to take it out in this case as it's not strictly required.
---
[GitHub] metron pull request #880: METRON-1379: Add an OBJECT_GET stellar function
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on a diff in the pull request:
https://github.com/apache/metron/pull/880#discussion_r160210633
--- Diff: metron-platform/metron-enrichment/src/test/java/org/apache/metron/enrichment/stellar/ObjectGetTest.java ---
@@ -0,0 +1,91 @@
+/**
+ * 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.enrichment.stellar;
+
+import com.google.common.collect.ImmutableMap;
+import org.apache.commons.io.IOUtils;
+import org.apache.hadoop.conf.Configuration;
+import org.apache.hadoop.fs.FileSystem;
+import org.apache.hadoop.fs.Path;
+import org.apache.metron.common.utils.SerDeUtils;
+import org.apache.metron.stellar.common.utils.StellarProcessorUtils;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+import java.io.BufferedOutputStream;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+
+public class ObjectGetTest {
+ FileSystem fs;
+ List<String> data;
+
+ @Before
+ public void setup() throws IOException {
+ fs = FileSystem.get(new Configuration());
+ data = new ArrayList<>();
+ {
+ data.add("apache");
+ data.add("metron");
+ data.add("is");
+ data.add("great");
+ }
+
+ }
+
+ @Test
+ public void test() throws Exception {
+ String filename = "target/ogt/test.ser";
+ Assert.assertTrue(ObjectGet.cache == null || !ObjectGet.cache.asMap().containsKey(filename));
+ assertDataIsReadCorrectly(filename);
+ }
+
+ public void assertDataIsReadCorrectly(String filename) throws IOException {
+ try(BufferedOutputStream bos = new BufferedOutputStream(fs.create(new Path(filename), true))) {
+ IOUtils.write(SerDeUtils.toBytes(data), bos);
+ bos.flush();
--- End diff --
`flush()` isn't necessary is it? Doesn't `close()` automatically call flush, and shouldn't try-with-resources take care of that?
Correct me if I'm wrong there, I may be misremembering how this stuff ties together.
---
[GitHub] metron issue #880: METRON-1379: Add an OBJECT_GET stellar function
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on the issue:
https://github.com/apache/metron/pull/880
I ran this up in the combined PR, and it worked really well. As noted on that ticket, further changes are necessary in the instructions (to handle ES5), but for this ticket looking in ES for the results was sufficient.
+1, thanks for the contribution!
---