Feat cy port by duncdrum · Pull Request #570 · HistoryAtState/hsg-shell

duncdrum · 2026-01-28T16:40:27Z

This ports the test from the original 24 wdio specs (npm test) to cypress.

none of the old tests or their dependencies have been removed yet, as requested.

It also adds actually executing the tests on CI using the joewiz/hsg-project container.

note: the e2e test run is not yet taken into account for automated releases, that still works as before.

OP#290

line-o

I went through each commit separately as the changesets where so large.
I see that this allows to follow the development of the tests and the tests we end up with are easy to understand and grouped by the pages they are testing.
I would want to discuss if we need to keep the intermediate steps in the git history or if it would be cleaner and also easier to understand in the future to squash the changes into one ore two.
Especially the fact that a lot of files, commands and settings are first created just to be later removed again is why I think the project would benefit from a cleaned up history.

If we want to

keep the connection from a test case to the previous test case
I would be in favour of a comment in the test file that refs the original web driver test file
keep the history of the approach taken
I would prefer that to be summarised in text form or that we keep this branch and not delete it.

Happy to hear your thoughts on all this. Just to be clear, I think that the tests will make a change for the better as they are much cleaner in both setup and grouping. So I am looking forward to making this switch.

line-o · 2026-02-23T18:27:51Z

cypress.config.cjs

+    viewportWidth: 1280,
+    viewportHeight: 720,
+    trashAssetsBeforeRuns: true,
+    includeShadowDom: true,


I would be surprised to see shadowDom used in hsg-shell

Is this setting on by default or because you anticipate we are going to need shadowDom later?

while i expect shadow dom as part of rewrites, it also ensures that the config between hsg-shell and other jinks profile things stays consistent. The flag adds no performance penalties if no shadow dom is present.

line-o · 2026-02-23T18:28:30Z

cypress.config.cjs

+    includeShadowDom: true,
+    retries: 1,
+    supportFile: 'tests/cypress/support/e2e.js', 
+    specPattern: 'tests/cypress/e2e/**/*.cy.{js,jsx,ts,tsx}',


At the moment we do only have js files, correct?

package.json

line-o · 2026-02-27T09:42:42Z

cypress.config.cjs

@@ -0,0 +1,29 @@
+const { defineConfig } = require('cypress');


I would prefer the configuration to be an ES module

I would rather change that once cypress and its docs make the switch, otherwise it just creates additional friction for interacting with the tests.

tests/cypress/e2e/conferences/prod_conferences_titles.cy.js

line-o · 2026-02-27T10:08:05Z

tests/cypress/e2e/search/prod_search_filter_results.cy.js

-  '&sort-by=relevance',
-  '&sort-by=date-asc'
+  {
+    label: '&sort-by=relevance',


I do see the value of using the qs object directly as test input. If the label is and will always be just the serialised quer string I wonder if it could not be serialised within the test function instead.
That way label and qs object cannot deviate from one another in the future.

line-o · 2026-02-27T10:09:58Z

tests/cypress/e2e/search/prod_search_new-indexes.cy.js

-      const countNum = count.replace(/,/, '')
-      console.log('count=', countNum)
-      expect(countNum).to.equal('4512', 'Current result did not match expected result')
+    cy.visit('search', {


I wonder if the approach taken in prod_ser_filter_results - to create tests programmatically can be used in prod_search_new-indexes as well

line-o · 2026-02-27T10:12:45Z

tests/cypress/e2e/ui-components/breadcrumb.cy.js

-    cy.getCssProperty('.hsg-breadcrumb__list-item:nth-last-child(2) .hsg-breadcrumb__link:before', '-webkit-mask').then((c) => {
-      //console.log('c=', c);
-      expect(c).to.equal('url(../images/arrow_back.svg) no-repeat center/contain;')
+    cy.get('.hsg-breadcrumb__list-item:nth-last-child(2) .hsg-breadcrumb__link').then(($el) => {


Note to self: I hope we can find a more future proof way of ensuring the correct display on smaller screens.

line-o · 2026-02-27T10:21:06Z

README.md

 ### Check currently installed versions

-1. node: `node -v` => Should output `v18.18.2`
+1. node: `node -v` => Should satisfy `package.json` engines (e.g. `>=18.0.0`; the asdf example uses 18.18.2).


What is the asdf example that is referred to here?

seection 1.1 from this readme

line-o · 2026-02-27T10:23:12Z

README.md

-```bash
-npm run cy:run:jenkins
-```
+Specs live under `tests/cypress/e2e/` by feature; many areas use subfolders (e.g. conferences by year, countries/archives, departmenthistory/buildings) so each spec can run in parallel:


Is it necessary to put test suites that should run in parallel in subfolders?

it makes for nicer reporting, but is not strictly necessary. I propose to rethink that once we actually expand the tests.

@see

- Add Cypress e2e suite with one spec per page and beforeEach(visit) - Add normalizeHeadlineText custom command; use cy.contains for simple headlines - Group specs in subfolders (e.g. conferences by year, countries/archives) - Add @see comments referencing original tests/specs/**/prod_*.spec.js (wdio) - Add .github/workflows/cypress.yml to run Cypress in Firefox against eXist - Update README and add tests/cypress/COVERAGE_COMPARISON.md - Align search new-indexes assertions (China, Tokyo) with 12eb024 (at least N results)

- Increase body-max-line-length from 200 to 250 - Add footer-max-line-length rule set to 150

duncdrum · 2026-03-03T15:32:25Z

@line-o added inline refs and squashed into a single commit. I also incorporated the changes from 12eb024 into this PR and rebased.

the commitlint errors weren't from my commits, so I upped the acceptable line length.

duncdrum requested a review from windauer January 28, 2026 16:47

duncdrum added enhancement github_actions Pull requests that update GitHub Actions code labels Jan 28, 2026

duncdrum marked this pull request as ready for review January 28, 2026 16:49

duncdrum requested review from line-o and removed request for windauer February 16, 2026 12:28

line-o reviewed Feb 27, 2026

View reviewed changes

duncdrum force-pushed the feat-cy-port branch from 2ebd6fc to 661528f Compare March 3, 2026 15:19

duncdrum force-pushed the feat-cy-port branch from 661528f to 16708dc Compare March 3, 2026 15:20

chore(commitlint): update line length rules for commit messages

be6cf66

- Increase body-max-line-length from 200 to 250 - Add footer-max-line-length rule set to 150

		@@ -0,0 +1,29 @@
		const { defineConfig } = require('cypress');

Conversation

duncdrum commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

line-o left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

duncdrum commented Mar 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

duncdrum commented Jan 28, 2026 •

edited

Loading