cht-conf 3.23.0 → 4.1.0

package/.sonarcloud.properties

@@ -0,0 +1,11 @@
+sonar.sources=.
+# Can have multiple comma-separated entries
+sonar.exclusions=test/**/*
+
+sonar.tests=.
+# Can have multiple comma-separated entries
+sonar.test.inclusions=test/**/*
+
+sonar.issue.ignore.block=e1
+sonar.issue.ignore.block.e1.beginBlockRegexp=NOSONAR_BEGIN
+sonar.issue.ignore.block.e1.endBlockRegexp=NOSONAR_END

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+# [4.1.0](https://github.com/medic/cht-conf/compare/v4.0.0...v4.1.0) (2024-07-15)
+
+
+### Features
+
+* **#425:** E2E test actions ([#620](https://github.com/medic/cht-conf/issues/620)) ([ba54d49](https://github.com/medic/cht-conf/commit/ba54d49730b73c6d77b219a45b8ba3d98b909227)), closes [#425](https://github.com/medic/cht-conf/issues/425) [#425](https://github.com/medic/cht-conf/issues/425)
+
+# [4.0.0](https://github.com/medic/cht-conf/compare/v3.23.0...v4.0.0) (2024-07-01)
+
+
+### Performance Improvements
+
+* **#600:** drop support for Node versions < 18 ([#619](https://github.com/medic/cht-conf/issues/619)) ([496d074](https://github.com/medic/cht-conf/commit/496d0742890f1347557caecc1241bdd590c774c0)), closes [#600](https://github.com/medic/cht-conf/issues/600)
+
+
+### BREAKING CHANGES
+
+* **#600:** Dropping support for NodeJS versions < 18
+
 # [3.23.0](https://github.com/medic/cht-conf/compare/v3.22.0...v3.23.0) (2024-06-20)
 
 

package/README.md

@@ -5,8 +5,8 @@ CHT Conf is a command-line interface tool to manage and configure your apps buil
 
 # Requirements
 
-* nodejs 8 or later
-* python 2.7
+* nodejs 18 or later
+* python 3
 * or Docker
 
 # Installation
@@ -303,8 +303,16 @@ To develop a new action or improve an existing one, check the ["Actions" doc](sr
 
 ## Testing
 
+### Unit tests
+
 Execute `npm test` to run static analysis checks and the test suite. Requires Docker to run integration tests against a CouchDB instance. 
 
+### End-to-end tests
+
+Run `npm run test-e2e` to run the end-to-end test suite against an actual CHT instance locally. These tests rely on [CHT Docker Helper](https://docs.communityhealthtoolkit.org/hosting/4.x/app-developer/#cht-docker-helper-for-4x) to spin up and tear down an instance locally.
+
+The code interfacing with CHT Docker Helper lives in [`test/e2e/cht-docker-utils.js`](./test/e2e/cht-docker-utils.js). You should rely on the API exposed by this file to orchestrate CHT instances for testing purposes. It is preferable to keep the number of CHT instances orchestrated in E2E tests low as it takes a non-negligible amount of time to spin up an instance and can quickly lead to timeouts.
+
 ## Executing your local branch
 
 1. Clone the project locally
@@ -349,7 +357,7 @@ Builds brought to you courtesy of GitHub actions.
 
 # Copyright
 
-Copyright 2013-2023 Medic Mobile, Inc. <hello@medic.org>
+Copyright 2013-2024 Medic Mobile, Inc. <hello@medic.org>
 
 # License
 

package/package.json

@@ -1,17 +1,18 @@
 {
   "name": "cht-conf",
-  "version": "3.23.0",
+  "version": "4.1.0",
   "description": "Configure CHT deployments",
   "main": "./src/lib/main.js",
   "engines": {
-    "node": ">=8.10.0"
+    "node": ">=18.0.0"
   },
   "scripts": {
     "clean": "rm -rf ./build/",
     "eslint": "eslint 'src/**/*.js' test/*.js 'test/**/*.js'",
     "docker-start-couchdb": "npm run docker-stop-couchdb && docker run -d -p 6984:5984 --rm --name cht-conf-couchdb couchdb:2.3.1 && sh test/scripts/wait_for_response_code.sh 6984 200 CouchDB",
     "docker-stop-couchdb": "docker stop cht-conf-couchdb || true",
-    "test": "npm run eslint && npm run docker-start-couchdb && npm run clean && mkdir -p build/test && cp -r test/data build/test/data && cd build/test && nyc --reporter=html mocha --forbid-only \"../../test/**/*.spec.js\" && cd ../.. && npm run docker-stop-couchdb",
+    "test": "npm run eslint && npm run docker-start-couchdb && npm run clean && mkdir -p build/test && cp -r test/data build/test/data && cd build/test && nyc --reporter=html mocha --forbid-only \"../../test/**/*.spec.js\" --exclude \"../../test/e2e/**/*.spec.js\" && cd ../.. && npm run docker-stop-couchdb",
+    "test-e2e": "mocha --config test/e2e/.mocharc.js",
     "semantic-release": "semantic-release"
   },
   "bin": {