Cht-conf-test-harness 4.0 is now available

cht-conf-test-harness 4.0 is now available!

Summary of Changes

This release is all about supporting the latest version of cht-core and making cht-conf-test-harness more realistic. cht-core has made changes which improve the long-term maintenance of cht-conf-test-harness.

  • Test changes required: none
  • Interface changes: none

These are great changes which will bring value to cht-conf-test-harness users but unfortuenately, we were unable to maintain backward compatibility with cht-core 4.0 to 4.5. You can continue to run test automation for these cht-core versions by using cht-conf-test-harness@3. We will continue to support cht-conf-test-harness@3 until the majority of our users have moved over.

Technical Details

cht-core 4.6 refactors the core’s logic for rendering and interacting with forms into a reusable component. cht-conf-test-harness now reuses this cht-core component in your test automation. This makes automated tests more realist, and will make it easier for cht-conf-test-harness to support new versions of cht-core in the future.

What version of cht-conf-test-harness should you use?

That depends on what version of cht-core you’re running in production.

cht-conf-test-harness CHT Core Framework Supported cht-core versions
2.x 3.9.x+ 3.9, 3.10, 3.11, 3.12, 3.13, 3.14
3.x 4.0.x to 4.5.x 4.0 to 4.5
4.x 4.6.x+ 4.6

How do I upgrade?

When the time is right for your project to upgrade to cht-core 4.6 or above, you can verify your application’s behavior by running tests against the updated core version.

  1. Run npm install --save cht-conf-test-harness@latest
  2. Edit harness.defaults.json to set "coreVersion": "4.6" or whatever version you are running in production.
  3. Execute your tests

As always, we aplogise for any inconvenience caused by CHT breaking changes. Despite the breaking nature of this change the upgrade process here be no more challenging than a typical npm upgrade.

Huge shoutout to @jkuester who made this happen both within the cht-core and on the harness side.