Fix CI (bumping minimum versions of Ruby and govuk_publishing_components) #381
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In some tests we're using string matching/regex to make assertions about rendered HTML. Those assertions can be overly sensitive to, say, the order that an HTML element's attributes are listed in. This is particularly an issue where Govspeak invokes GovukPublishingComponents, since we no longer pin the version of that dependency and different versions can produce different HTML. Parsing the HTML string and making assertions against an object representation is likely to be more reliable. --- For this method, I've copied an approach taken in one of the assertions provided by the existing GovspeakTestHelper. GovspeakTestHelper is designed in such a way that our tests that make use of it need to be written in quite a rigid format. It has been suggested once in a while that we revisit the design of this gem's tests and test helpers generally. For now, this new method is standalone and flexible enough to just insert into our more vanilla tests.
This isn't an exhaustive update, I'm only changing the ones that're making the CI build fail right now. A change in the order of an HTML element's attributes has caused the build to start failing. The regex pattern expects the class name to immediately follow the tag name, but that's no longer true -- due to a change in our (unpinned) govuk_publishing_components dependency. This new assertion works with older and newer versions of the components gem.
We're looking into compatibility issues with a recent release of the govuk_publishing_components gem. Unfortunately, since the components gem dropped support for Ruby <3.2 in its own 41.1.0 release (August 2024), we need to use a newer version of Ruby to be able to actually reproduce the problem. While updating the .ruby-version (to 3.2.2, same as govuk_publishing_components), it seems sensible to update the minimum supported Ruby version to match it.
I've based this new minimum requirement on the oldest versions listed in the GOV.UK dependency management spreadsheet[1] for projects that're also using Govspeak. It also needed to be >38.4.1 because of backwards-incompatible changes we've since made to our tests[2] [1]: https://docs.google.com/spreadsheets/d/137KZhjctJ8qTKYPnq2QNVkyoIC6ok7KA2G1vErNC6Oo/edit?gid=1160366178#gid=1160366178 [2]: be27793
Bumping the minimum required versions of Ruby and govuk_publishing_components. This should be uneventful, but it seems worthy of a major version to me.
mike3985
changed the title
brucebolt
approved these changes
Jan 27, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://trello.com/c/o6eA7900/1558-make-govspeak-tests-work-again