Page MenuHomePhabricator
Create Task
Maniphest T351707

Implement Cypress Test Runner
Open, LowPublic
Actions

Description

We are embarking on the migration journey to Codex for our FileImporter Extension and want to enhance our testing infrastructure by incorporating the Cypress test runner. Cypress is known for its robust end-to-end and component testing capabilities, therefore this is a great opportunity to explore the capabilities of Cypress for Vue tests.

Tasks

  • Set up Cypress to work seamlessly with the FileImporter Extension within the Codex environment.
  • Investigate Cypress's features for e2e & component testing and identify areas where it can enhance our testing suite.
  • Document the setup process and any insights gained during the exploration and integration phases for future reference.

Notes:

  • use node version 18 (nvm use v18.0.0)
  • run npm install (not npm install cypress)
  • chromium worked for all of us (others got redirect loop)
  • run headless tests: docker run -it --add-host dev.wiki.local.wmftest.net:host-gateway -v $PWD:/e2e -w /e2e cypress/included:latest

https://gerrit.wikimedia.org/r/c/mediawiki/extensions/FileImporter/+/976231

Details

SubjectRepoBranchLines +/-
Experimental cypress testmediawiki/extensions/FileImportermaster+1 K -183
Customize query in gerrit

Related Objects

Event Timeline

MareikeHeuerWMDE created this task.Nov 21 2023, 11:10 AM
MareikeHeuerWMDE moved this task from Backlog to Doing on the WMDE-TechWish-Maintenance-2023 board.
MareikeHeuerWMDE claimed this task.Nov 21 2023, 2:23 PM
MareikeHeuerWMDE updated Other Assignee, added: awight.
lilients_WMDE updated the task description. (Show Details)Nov 21 2023, 3:53 PM
Tobi_WMDE_SW added a project: WMDE-TechWish-Sprint-2023-11-22.Nov 22 2023, 9:23 AM
Tobi_WMDE_SW moved this task from Sprint Backlog to Doing on the WMDE-TechWish-Sprint-2023-11-22 board.Nov 22 2023, 9:27 AM
thiemowmde moved this task from Incoming to In progress on the WMDE-TechWish-Maintenance board.Nov 22 2023, 9:28 AM
awight subscribed.Nov 22 2023, 12:48 PM

I found a bit of prior work:

It looks like our CI images are already equipped with all the libraries Cypress might need, so the remaining work is to set up a patch to validate this possibility.

Michael subscribed.Nov 22 2023, 2:02 PM
MareikeHeuerWMDE moved this task from Doing to Tech Review on the WMDE-TechWish-Sprint-2023-11-22 board.Nov 23 2023, 9:17 AM
MareikeHeuerWMDE updated the task description. (Show Details)Nov 23 2023, 10:31 AM
gerritbot added a comment.Nov 23 2023, 10:51 AM

Change 976231 had a related patch set uploaded (by Mareike Heuer; author: Awight):

[mediawiki/extensions/FileImporter@master] Experimental cypress test

https://gerrit.wikimedia.org/r/976231

gerritbot added a project: Patch-For-Review.Nov 23 2023, 10:51 AM
MareikeHeuerWMDE moved this task from Doing to Review on the WMDE-TechWish-Maintenance-2023 board.Nov 23 2023, 1:15 PM
WMDE-Fisch added a project: WMDE-TechWish-Sprint-2023-12-06.Dec 6 2023, 12:09 PM
WMDE-Fisch moved this task from Sprint Backlog to Tech Review on the WMDE-TechWish-Sprint-2023-12-06 board.
awight added a comment.Dec 12 2023, 3:19 PM

Some small work we can do to finish this up:

  • Write documentation and share team knowledge so that all devs can run cypress locally.
  • Implement one useful test case. Overhead of cypress is very low (currently 1 second of execution time) so it's not a problem to leave in place if we have even a small excuse.
awight triaged this task as Low priority.Dec 12 2023, 3:19 PM
MareikeHeuerWMDE moved this task from Tech Review to Doing on the WMDE-TechWish-Sprint-2023-12-06 board.Dec 12 2023, 3:20 PM
awight mentioned this in T353436: Port Cite web test suite to Cypress.Dec 14 2023, 11:55 AM
gerritbot added a comment.Dec 14 2023, 4:26 PM

Change 976231 abandoned by Awight:

[mediawiki/extensions/FileImporter@master] Experimental cypress test

Reason:

We've decided not to merge to this repo until there's a better use case for writing new web tests, but the Cypress glue will be copied over to Cite where we're more actively working, in task T353436.

https://gerrit.wikimedia.org/r/976231

awight removed MareikeHeuerWMDE as the assignee of this task.Dec 14 2023, 4:28 PM
awight moved this task from Tech Review to Done on the WMDE-TechWish-Sprint-2023-11-22 board.
awight updated Other Assignee, removed: awight.

Investigation was successful, although we won't merge the proof-of-concept code here for now. Setting up Cypress locally gave us a bit of trouble, but we were able to run on bare metal, in docker-dev, and most importantly in CI.

awight moved this task from Done to Tech Review on the WMDE-TechWish-Sprint-2023-11-22 board.Dec 14 2023, 4:29 PM
awight moved this task from Doing to Done on the WMDE-TechWish-Sprint-2023-12-06 board.
Maintenance_bot removed a project: Patch-For-Review.Dec 14 2023, 4:30 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL