GitHub user merrimanr opened a pull request:
https://github.com/apache/metron/pull/662
Metron 1056
## Contributor Comments
This PR adds 2 additional search REST endpoints. The first takes a list of
indices as input and returns field to type mappings for each index. The second
also takes a list of indices as input but only returns field to type mappings
for the intersection of the common fields across the indices. These endpoints
are needed by the alerts UI and will also be necessary for correctly formatting
faceted search results.
This can been tested in full dev. After spinning up full dev, go the the
SearchController section of the Swagger UI. There the endpoints can be tested
against sample data in Elasticsearch. Passing in "["bro","snort"] to
"/api/v1/search/column/metadata" should return type mappings for both indices.
Passing in the same list to "/api/v1/search/column/metadata/common" should only
return type mappings for fields that are in both indices.
Reviewers will notice that tests were not added to the unit tests in
ElasticsearchDaoTest. As the original author of that class I found it awkward
mocking the various Elasticsearch client classes and it took a non-trivial
amount of time to figure out. I started adding to the test for this PR and ran
into similar issues. I feel like this test will be difficult to maintain,
especially since several different people will be contributing to this class,
and I don't feel it gives us a good return on investment. We have 100% test
coverage in the integration tests which are much easier to maintain and
understand. Maybe there is an easier way to test Elasticsearch client classes
but I vote we remove this and instead rely on the integration tests since they
provide complete coverage and are easy to work with.
## 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:
- [ ] 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).
- [ ] 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:
- [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 && 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/merrimanr/incubator-metron METRON-1056
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/662.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 #662
----
commit 9ab30cd5ea2103d6f756639126faa7d7ab352e1e
Author: merrimanr <[email protected]>
Date: 2017-07-21T16:05:35Z
initial commit
commit 7e2daafc1e0256a0fc1706b496acf1fd64c728dc
Author: merrimanr <[email protected]>
Date: 2017-07-21T21:12:53Z
Added documentation to the README
commit 02c147266027f02ab025206a22f205cd19dec0a2
Author: merrimanr <[email protected]>
Date: 2017-07-21T21:16:55Z
small formatting fixes
----
---
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 [email protected] or file a JIRA ticket
with INFRA.
---
