METRON-1247: REST search and findOne endpoints return unexpected or incorrect results for guids

[justinleet]

Contributor Comments

Updates documentation to have users surround GUIDs in double quotes in the search API.

Updates ElasticsearchDao to have findOne to use theIdsQuery, rather than a match query. This works because our guid is our id now, and this won't be subject to the analyzer.

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?

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

• 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 
  

• 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?

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

[justinleet]

To test this spin up full dev and go to the Swagger API.

An unquoted search can result in multiple results that only partially match. These matches may be across sensors.

For all the below queries, it'll be necessary to do your own querying to get appropriate GUIDs. These are just what my machine generated on full-dev.

Example query.

{
  "indices": ["websphere", "snort", "asa", "bro", "yaf"],
  "query": "guid:a2d7ba04-d335-4948-8bc8-c889e7c531c9",
  "from": 0,
  "size": 500
}

e.g.

{
...
      "id": "cabb2468-d827-4948-8137-71694ad85944",
...
      "id": "58f975ae-0bd0-4948-91d7-fd433b29cd49",
...
      "id": "a2d7ba04-d335-4948-8bc8-c889e7c531c9",
...

Now make the query against findOne and ensure it produces the correct record:

{
  "guid": "a2d7ba04-d335-4948-8bc8-c889e7c531c9",
  "sensorType": "bro"
}

Now try again with one of the partial matches and ensure it also produces the correct record.:

{
  "guid": "cabb2468-d827-4948-8137-71694ad85944",
  "sensorType": "bro"
}

Feel free to try this with more of the partial matches. All should return the correct record now, rather than mismatching.

[cestella]

+1 by inspection, good job!