Skip to content
This repository has been archived by the owner on May 12, 2021. It is now read-only.

METRON-1011 Enforce submission of 4 params Stellar ENRICHMENT functions #628

Closed
wants to merge 3 commits into from

Conversation

jasper-k
Copy link
Contributor

@jasper-k jasper-k commented Jul 3, 2017

Contributor Comments

This is a PR to METRON-1011.
Currently the Stellar functions ENRICHMENT_EXISTS and ENRICHMENT_GET only check for params 'enrichment_type' and 'indicator' to be submitted by the user. In reality all 4 params are mandatory as ArrayIndexOutOfBoundsExceptions are thrown at anything less than 4.

Pull Request Checklist

Thank you for submitting a contribution to Apache Metron.
Please refer to our Development Guidelines for the complete guide to follow for contributions.
Please refer also to our Build Verification Guidelines 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:

  • Is there a JIRA ticket associated with this PR? If not one needs to be created at Metron Jira.
  • 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.
  • 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?

Steps to reproduce (old behaviour):
first do a valid Stellar enrichment_get:
ENRICHMENT_GET(null,null,null,null)

now issue:
ENRICHMENT_GET(null)

You'll get "java.lang.IllegalStateException: Requires at least an enrichment type and indicator" which makes one believe only 2 parameters are mandatory

But in fact all 4 parameters are mandatory, as anything less then 4 will get you:
ENRICHMENT_GET(null,null,null)
[!] Index: 3, Size: 3
java.lang.IndexOutOfBoundsException: Index: 3, Size: 3

  • Have you included steps or a guide to how the change may be verified and tested manually?

New behaviour:
Anything but exactly 4 parameters will get you:
java.lang.IllegalStateException: All parameters are mandatory, submit 'enrichment type', 'indicator', 'nosql_table' and 'column_family'

A much clearer problem statement..

  • 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 
    
  • Have you written or updated unit tests and or integration tests to verify your changes?

    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 is set up for your personal repository such that your branches are built there before submitting a pull request.

@ottobackwards
Copy link
Contributor

Hi Jasper, thanks for the submission. Can you please fill out the PR template above? The contributor comment section ( This is a PR to XXXX because YYYY by doing ZZZZZ, test this by doing 1,2,3,4,5 ) is important for reviewers.

@ottobackwards
Copy link
Contributor

+1 by inspection pending filling out the PR template. Thanks for the contribution Jasper!

@jasper-k
Copy link
Contributor Author

jasper-k commented Jul 4, 2017

@ottobackwards regarding the merge conflict, something I need to do?

@ottobackwards
Copy link
Contributor

Yes. Another PR was merged into master, and this PR refactored Stellar greatly. This has introduced conflict with your changes ( they made change and you made changes etc ).

You need to resolve the conflicts and push the result to your github branch

@asfgit asfgit closed this in 14bcc03 Aug 1, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
2 participants