You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@metron.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2018/10/05 09:32:00 UTC
[jira] [Commented] (METRON-1803) Integrate Cypress with Travis
[ https://issues.apache.org/jira/browse/METRON-1803?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16639544#comment-16639544 ]
ASF GitHub Bot commented on METRON-1803:
----------------------------------------
GitHub user tiborm opened a pull request:
https://github.com/apache/metron/pull/1225
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 also 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
#### 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 modified the package.json script block in metron-alert to make Cypress tests running in Travis. If you like to see the integration working please check to logs of build step #3 (mvn test --projects metron-interface/metron-config,metron-interface/metron-alerts)
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:
- [ ] 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:
- [ ] 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 && dev-utilities/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](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] 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](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-cypress-to-travis
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/1225.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 #1225
----
commit 5ab23187d77efd51917c17aeddb00ad7af9daeec
Author: tiborm <ti...@...>
Date: 2018-09-26T12:15:44Z
METRON-1797 adding cypress and initial tests
commit 1cf5cc3eb6e7bee9c35ce11264f49769211882c8
Author: tiborm <ti...@...>
Date: 2018-10-01T11:52:17Z
METRON-1797 status check and loading tests
commit 7af47201907a9550a88a585542c793b7cfa5810c
Author: tiborm <ti...@...>
Date: 2018-10-01T15:12:34Z
METRON-1797 adding tests for cancelling, getting pcap data and validating inputs
commit d1fc7ad5a4861affdc281c795dec414a6c0c5f8f
Author: tiborm <ti...@...>
Date: 2018-10-02T08:07:38Z
METRON-1797 removing onlies, testing pcap details
commit 01dcaf99431e5aec45f6a8cc841496d32d013da1
Author: tiborm <ti...@...>
Date: 2018-10-02T08:51:19Z
METRON-1797 asserting details view visible
commit ff8548c04bbfb1151b9d16831d113e3fec6017bb
Author: tiborm <ti...@...>
Date: 2018-10-02T09:20:32Z
METRON-1797 testing download and paging
commit 9bfb0f627340c5da12c2261993df189316f07f88
Author: tiborm <ti...@...>
Date: 2018-10-03T11:17:20Z
METRON-1803 turning off video
commit 6bd3fafcba539f3c2d94470967b60f04ad3d8e03
Author: tiborm <ti...@...>
Date: 2018-10-03T11:18:01Z
METRON-1803 adding npm-run-all as a dev dependency and adding cypress:ci script
commit 77569ce433ab6182293acde95e26b6ff76c66c8e
Author: tiborm <ti...@...>
Date: 2018-10-03T11:22:23Z
METRON-1803 adding cypress:ci to testCI
commit 97395175a74d501726b21c9826f55e1d6e77c1de
Author: tiborm <ti...@...>
Date: 2018-10-03T12:27:05Z
METRON-1803 adding license header
commit ea9ba66ad2ecf291097e8dd5405e16bf29e0349a
Author: tiborm <ti...@...>
Date: 2018-10-03T12:27:05Z
METRON-1803 adding license header
commit 636c00897c7728c77c5cc37c89afb616a46ee2e5
Author: tiborm <ti...@...>
Date: 2018-10-03T13:23:09Z
Merge branch 'METRON-1797-pcap-ui-tests' into METRON-1803-cypress-to-travis
commit ecddedd00747b85f98391b9b5015f5deb19f0066
Author: tiborm <ti...@...>
Date: 2018-10-03T14:55:47Z
METRON-1797 adding more missing license header
commit f23f5b0774dada47ec2c57164af1c800e4edf416
Author: tiborm <ti...@...>
Date: 2018-10-03T14:56:32Z
Merge branch 'METRON-1797-pcap-ui-tests' into METRON-1803-cypress-to-travis
commit 87d3018b79b7867e41a12b6956c2b52a80ebffc4
Author: tiborm <ti...@...>
Date: 2018-10-04T11:48:40Z
METRON-1803 breaking the tests to see whether it's breaks the build
commit b6fa7ea2e75bfb8e10f4491577b691038adbfb8e
Author: tiborm <ti...@...>
Date: 2018-10-04T12:45:19Z
Revert "METRON-1803 breaking the tests to see whether it's breaks the build"
This reverts commit 87d3018b79b7867e41a12b6956c2b52a80ebffc4.
commit 8875d475d408ccf02602bdcfd0c1c619f78711e9
Author: tiborm <ti...@...>
Date: 2018-10-03T14:55:47Z
METRON-1797 adding more missing license header
commit a5ff0c7b8b68e8825693a2d35cdd6d3c6afa5616
Author: Tibor Meller <ti...@...>
Date: 2018-10-05T08:45:47Z
Merge branch 'METRON-1797-pcap-ui-tests' into METRON-1803-cypress-to-travis
----
> Integrate Cypress with Travis
> -----------------------------
>
> Key: METRON-1803
> URL: https://issues.apache.org/jira/browse/METRON-1803
> Project: Metron
> Issue Type: Improvement
> Reporter: Tibor Meller
> Assignee: Tibor Meller
> Priority: Major
>
> [DISCUSS] thread on the dev mailing list:
> [https://lists.apache.org/thread.html/b6a0272c7809c05e8b7aff20171720e8ec76f8a0e9481169c37a4a4a@%3Cdev.metron.apache.org%3E]
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)