You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@metron.apache.org by zezutom <gi...@git.apache.org> on 2017/09/03 12:47:12 UTC

[GitHub] metron pull request #732: METRON-632: Added validation of "shew.enrichmentTy...

GitHub user zezutom opened a pull request:

    https://github.com/apache/metron/pull/732

    METRON-632: Added validation of "shew.enrichmentType" and "shew.keyCo…

    …lumns"
    
    ## Contributor Comments
    [Please place any comments here.  A description of the problem/enhancement, how to reproduce the issue, your testing methodology, etc.]
    
    
    ## 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:
    - [ ] 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?
    - [ ] 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:
    - [ ] 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/zezutom/metron METRON-632

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/metron/pull/732.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 #732
    
----
commit 979186f2bf4d3792e320199f96d87b3d1b39c6be
Author: zezutom <ze...@gmail.com>
Date:   2017-09-03T12:06:18Z

    METRON-632: Added validation of "shew.enrichmentType" and "shew.keyColumns"

----


---
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 #732: METRON-632: Added validation of "shew.enrichmentType" and...

Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:

    https://github.com/apache/metron/pull/732
  
    Awesome, +1 by inspection  Thanks for the contribution!


---

[GitHub] metron pull request #732: METRON-632: Added validation of "shew.enrichmentTy...

Posted by zezutom <gi...@git.apache.org>.
Github user zezutom commented on a diff in the pull request:

    https://github.com/apache/metron/pull/732#discussion_r137960020
  
    --- Diff: metron-platform/metron-enrichment/src/main/java/org/apache/metron/enrichment/writer/SimpleHbaseEnrichmentWriter.java ---
    @@ -134,6 +136,39 @@ public void configure(String sensorName, WriterConfiguration configuration) {
         LOG.debug("Sensor: '{}': {Provider: '{}', Converter: '{}'}", sensorName, getClassName(provider), getClassName(converter));
       }
     
    +
    +  private void validateEnrichmentType(String sensorName, WriterConfiguration configuration) {
    +    Map<String, Object> sensorConfig = configuration.getSensorConfig(sensorName);
    +    Object enrichmentTypeObj = Configurations.ENRICHMENT_TYPE.get(sensorConfig);
    +    if (enrichmentTypeObj == null) {
    +      throw new IllegalArgumentException(String.format("%s must be provided", Configurations.ENRICHMENT_TYPE.getKey()));
    +    }
    +
    +    if (!(enrichmentTypeObj instanceof String)) {
    +      throw new IllegalArgumentException(String.format("%s must be a string", Configurations.ENRICHMENT_TYPE.getKey()));
    +    }
    +
    +    String enrichmentType = enrichmentTypeObj.toString();
    +    if (enrichmentType.trim().isEmpty()) {
    +      throw new IllegalArgumentException(String.format("%s must not be an empty string",
    +              Configurations.ENRICHMENT_TYPE.getKey()));
    +    }
    +  }
    +
    +  private void validateKeyColumns(String sensorName, WriterConfiguration configuration) {
    +    Map<String, Object> sensorConfig = configuration.getSensorConfig(sensorName);
    +    Object keyColumnsObj = Configurations.KEY_COLUMNS.get(sensorConfig);
    +
    +    try {
    +      List<String> keyColumns = getColumns(keyColumnsObj, true);
    +      if (keyColumns == null || keyColumns.isEmpty()) {
    +        throw new IllegalArgumentException(String.format("%s must be provided", Configurations.KEY_COLUMNS.getKey()));
    +      }
    +    } catch (RuntimeException ex) {
    +      throw new IllegalArgumentException(ex.getMessage());
    --- End diff --
    
    Hi @cestella , thanks for the review. The second arg is now added, and yes I did check  hbase streaming worked in the full-dev cluster.


---

[GitHub] metron issue #732: METRON-632: Added validation of "shew.enrichmentType" and...

Posted by zezutom <gi...@git.apache.org>.
Github user zezutom commented on the issue:

    https://github.com/apache/metron/pull/732
  
    @cestella Could I possibly get this approved? Cheers


---

[GitHub] metron pull request #732: METRON-632: Added validation of "shew.enrichmentTy...

Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on a diff in the pull request:

    https://github.com/apache/metron/pull/732#discussion_r137895036
  
    --- Diff: metron-platform/metron-enrichment/src/main/java/org/apache/metron/enrichment/writer/SimpleHbaseEnrichmentWriter.java ---
    @@ -134,6 +136,39 @@ public void configure(String sensorName, WriterConfiguration configuration) {
         LOG.debug("Sensor: '{}': {Provider: '{}', Converter: '{}'}", sensorName, getClassName(provider), getClassName(converter));
       }
     
    +
    +  private void validateEnrichmentType(String sensorName, WriterConfiguration configuration) {
    +    Map<String, Object> sensorConfig = configuration.getSensorConfig(sensorName);
    +    Object enrichmentTypeObj = Configurations.ENRICHMENT_TYPE.get(sensorConfig);
    +    if (enrichmentTypeObj == null) {
    +      throw new IllegalArgumentException(String.format("%s must be provided", Configurations.ENRICHMENT_TYPE.getKey()));
    +    }
    +
    +    if (!(enrichmentTypeObj instanceof String)) {
    +      throw new IllegalArgumentException(String.format("%s must be a string", Configurations.ENRICHMENT_TYPE.getKey()));
    +    }
    +
    +    String enrichmentType = enrichmentTypeObj.toString();
    +    if (enrichmentType.trim().isEmpty()) {
    +      throw new IllegalArgumentException(String.format("%s must not be an empty string",
    +              Configurations.ENRICHMENT_TYPE.getKey()));
    +    }
    +  }
    +
    +  private void validateKeyColumns(String sensorName, WriterConfiguration configuration) {
    +    Map<String, Object> sensorConfig = configuration.getSensorConfig(sensorName);
    +    Object keyColumnsObj = Configurations.KEY_COLUMNS.get(sensorConfig);
    +
    +    try {
    +      List<String> keyColumns = getColumns(keyColumnsObj, true);
    +      if (keyColumns == null || keyColumns.isEmpty()) {
    +        throw new IllegalArgumentException(String.format("%s must be provided", Configurations.KEY_COLUMNS.getKey()));
    +      }
    +    } catch (RuntimeException ex) {
    +      throw new IllegalArgumentException(ex.getMessage());
    --- End diff --
    
    can we pass in `ex` as the second arg?


---

[GitHub] metron pull request #732: METRON-632: Added validation of "shew.enrichmentTy...

Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:

    https://github.com/apache/metron/pull/732


---

[GitHub] metron issue #732: METRON-632: Added validation of "shew.enrichmentType" and...

Posted by zezutom <gi...@git.apache.org>.
Github user zezutom commented on the issue:

    https://github.com/apache/metron/pull/732
  
    Thank you!


---