End-to-end tests

[ugurdogrusoz]

Let's investigate how we can implement some end-to-end tests for Newt.

[ugurdogrusoz]

@canbax Let's please start implementing these end-to-end tests as you have time.

[canbax]

Currently, there are 23 tests. 3 of them are skipped. 2 of them are because of the inability of the newt. For one I couldn't find a solution.

1. "TC4: File -> Import -> CellDesigner": doesn't work in the newt itself
2. "TC4: Query -> Pathway Commons -> Neighborhood...": doesn't work because it takes longer than 30 seconds and gives an error.
3. "TC1: Add process with convenient edges": Simply I couldn't manage to do drag and drop on the canvas. This might be achieved by emitting cytoscape.js events or somehow emitting the events from cypress.io. I tried to use cypress-drag-drop but still couldn't do it.

I added the script to the crontab file. So after every regular build, the tests should be executed. The results of the tests can be observed from http://ivis.cs.bilkent.edu.tr/e2e-test-results.txt

[ugurdogrusoz]

1. Let's use one we know imports fine, use this:
   M-Phase.xml.txt

2. Let's use a less common Macromolecule to decrease query time: BAMBI

Can we please

• rename test result file to "Newt-e2e-test-results.txt"?
• document all these in Servers and Deployment doc. refer to the test document from here as well. also list any SBGN, SBML, CD, etc. files used in testing.

[canbax]

Currently, after every regular build, end-to-end tests should be executed. I added a small section on "i-Vis Servers and Deployment" document about end-to-end tests.

The results of the tests and the date-time that the tests are executed can be seen from http://ivis.cs.bilkent.edu.tr/Newt-e2e-test-results.txt
We are skipping one test because I couldn't find a way to do a drag-n-drop on cytoscape.js canvas.

[ugurdogrusoz]

@hasanbalci Please review, including documentation of the process.

[hasanbalci]

It seems good. @canbax I just want to be sure, for the test of other third-party services, whether we check a new tab is opened with the given URL successfully or not for TC1 and whether we check the properties in Properties from ChEBI field one by one for TC2. In the result document, they are mentioned only as selecting macromolecule/simple chemical, so I want to be sure.

[canbax]

Here we are not really clicking and opening a new tab. This is mainly because cypress does not support multiple tabs. We are just checking the onclick property of the button. You can see that in

newt/cypress/integration/3rdPartyServices.spec.js

Lines 29 to 30 in 248fba9

	cy.contains('button.btn.btn-default', 'ChAT').should('be.visible').invoke('attr', 'onclick')
	.should('eq', "window.open('https://www.genecards.org/cgi-bin/carddisp.pl?gene=ChAT', '_blank')")

If opening a new tab is important, we might try to find a way.

We are checking the 3 ChEBI fields one by one for TC2. You can see that

newt/cypress/integration/3rdPartyServices.spec.js

Lines 41 to 43 in 248fba9

	cy.get('tr.chemical-info.chebi-name').children('td').contains('ADP').should('be.visible');
	cy.get('tr.chemical-info.chemical-description.node-details-summary').children('td').contains("A purine ribonucleoside 5'-diphosphate having adenine as the nucleobase").should('be.visible');
	cy.get('tr.chemical-info.chebi-id').children('td').contains("16761").should('be.visible');

[hasanbalci]

Actually what is important here is not opening a new tab, but to know that the URL is valid (not returns 404 error etc.) so that we can understand this website is still useful for us to get service. Is there any way to achieve this?

[hasanbalci]

Thanks @canbax! Finally, let's add an email notifier to notify us when any of the test cases fails. These emails can be send to newteditor@gmail.com.

[hasanbalci]

And one more thing: These tests are currently working in the unstable branch. When we merge unstable to master, test related code will also be transferred into the master branch. @canbax We'll not run tests on the master branch, but if there is something in the test codes that may affect the master branch and so will require any change we need to apply before/after merge, can you list them in the Servers and Deployment doc. as well?

[canbax]

In the Ubuntu machine, to add a new environment variable I did modify the file "/etc/environment" with nano using the command sudo nano /etc/environment

I added an environment variable like newtforminerva_pwd="..."

I did this to hide the password.

[ugurdogrusoz]

Let's use the dashboard in Cypress for test results.

[canbax]

We are storing the cypress dashboard project id as an environment variable. We are using an environment named "test0" for storing the id. Environments can be seen from https://github.com/iVis-at-Bilkent/newt/settings/environments.