GitHub user tiborm opened a pull request:
https://github.com/apache/metron/pull/1226
METRON-1803: Integrate Cypress with Travis
## Contributor Comments
[DISCUSS] thread on the dev mailing list:
https://lists.apache.org/thread.html/b6a0272c7809c05e8b7aff20171720e8ec76f8a0e9481169c37a4a4a@%3Cdev.metron.apache.org%3E
JIRA Ticket: https://issues.apache.org/jira/browse/METRON-1803
This PR adds Cypress.io to our project. It makes us able to run E2E tests,
UI integration tests. Also higher level UI tests with mocked services.
As part of this PR I added tests to cover the following functionalities of
PCAP UI panel:
- checking running jobs on navigating to PCAP tab
- submitting PCAP job request
- requesting job status
- process status in percentage
- getting PCAP JSON
- rendering PCAP table
- showing PCAP details
- navigating across pages
- downloading PDML
- cancelli PCAP query job
- showing filter validation messages
- showing date validation messages
Please consider while reviewing that these tests are not meant to cover all
the details of the functionalities above. The aim here is to extend the test
coverage build up by a large number of Unit Tests with higher level UI tests.
### New folders
Cypress files sit in cypress folder. Some of them might look like an empty
placeholder but cypress actively uses all files in this PR.
#### Integration folder
That contains the actual Cypress tests. The folder name comes from the
Cypress naming convention, however, no real integration tests implemented here
yet (at least no other than the integration of UI components to a whole
application). We could change the name of the folder anytime we like to, but
only one folder applicable.
#### Fixture folder
The tests are running on mocked data. This makes us able to integrate them
with Travis without the need to having PCAP related services available from our
CI.
Each file in the Fixture folder represents a response to a particular
request. This makes it fairly easy to create and maintain.
### How to run tests on your local machine
To run Cypress tests locally please do the following:
1. pull this branch to your workspace
2. move to metron-interface/metron-alerts folder
3. run: npm ci
4. run: scripts/start-server-for-e2e.sh
5. run: node_modules/cypress/bin/cypress run
or run: node_modules/cypress/bin/cypress open
if you like to use the dashboard.
### Travis integration
As part of this PR I modified the package.json in metron-alert to make
Cypress running in Travis. If you like to see the integration working please
check to logs of build step #3.
Failing Cypress tests brakes the build.
Example of build broken by failing Cypress test:
https://travis-ci.com/tiborm/metron/builds/86869264
## 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?
### 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/tiborm/metron METRON-1803
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/1226.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 #1226
----
----
---
