GitHub user cestella opened a pull request:

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

    METRON-1490: Better error message when user specifies an enrichment type 
that doesn't exist

    ## Contributor Comments
    If a user specifies an enrichment adapter name that doesn't exist (e.g. 
`hbaseEnrichment` vs `hbaseThreatIntel`), then we NPE rather than express the 
issue in the logs.
    
    To test this, try to create an enrichment with an incorrect name.  For 
instance, an enrichment like so:
    ```
    {
        "enrichment": {
                "fieldMap": {},
                "fieldToTypeMap": {},
                "config": {}
        },
        "threatIntel": {
                "fieldMap": {
                        "hbaseEnrichment": ["ip_src_addr", "ip_dst_addr"]
                },
                "fieldToTypeMap": {
                        "ip_src_addr": ["malicious_ip"],
                        "ip_dst_addr": ["malicious_ip"]
                },
                "config": {},
                "triageConfig": {
                        "riskLevelRules": [],
                        "aggregator": "MAX",
                        "aggregationConfig": {}
                }
        },
        "configuration": {}
    }
    ```
    Because there is no enrichment adapter named `hbaseEnrichment` available 
for threat intel (the correct name is `hbaseThreatIntel`), an error should be 
noted in the logs and there should be a sensible message, such as: 
`java.lang.IllegalStateException: Unable to find an adapter for 
hbaseEnrichment, possible adapters are: stellar,hbaseThreatIntel` rather than a 
NPE.
    
    ## 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?
    - [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 metron folder via:
      ```
      mvn -q clean integration-test install && 
dev-utilities/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?
    
    
    #### 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 METRON-1490

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

    https://github.com/apache/metron/pull/963.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 #963
    
----
commit a0914b2db15ec94f98d2c82173c187bfc101bc04
Author: cstella <cestella@...>
Date:   2018-03-14T21:02:12Z

    METRON-1490: Better error message when user specifies an enrichment type 
that doesn't exist

----


---

Reply via email to