cht-conf 4.0.0 → 4.1.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [4.1.1](https://github.com/medic/cht-conf/compare/v4.1.0...v4.1.1) (2024-08-21)
+
+
+### Bug Fixes
+
+* **#632:** replace cht-conf with cht in readme.md ([fc5b7f3](https://github.com/medic/cht-conf/commit/fc5b7f3ee5e1b8ae381b3182efbeedd4b6631418)), closes [#632](https://github.com/medic/cht-conf/issues/632)
+
+# [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)
 
 

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:16-slim
+FROM node:20-slim
 
 RUN apt update \
     && apt install --no-install-recommends -y \
@@ -9,6 +9,7 @@ RUN apt update \
       openssh-client \
       python3-pip \
       python3-setuptools \
+      python3-venv \
       python3-wheel \
       xsltproc \
     # Remove chromium to save space. We only installed it to get the transitive dependencies that are needed
@@ -16,6 +17,10 @@ RUN apt update \
     && apt remove -y chromium \
     && rm -rf /var/lib/apt/lists/*
 
+ENV VIRTUAL_ENV=/opt/venv
+RUN python3 -m venv "$VIRTUAL_ENV"
+ENV PATH="$VIRTUAL_ENV/bin:$PATH"
+
 RUN python3 -m pip install git+https://github.com/medic/pyxform.git@medic-conf-1.17#egg=pyxform-medic
 
 RUN npm install -g cht-conf

package/README.md

@@ -42,7 +42,7 @@ Install [Docker](https://www.docker.com/). If you are using Windows, you also ne
 
 ##### VS Code Development Container
 
-If you want to develop CHT apps with VS Code, you can use the Docker image as a Development Container. This will allow you to use the `cht-conf` utility and its associated tech stack from within VS Code (without needing to install dependencies like NodeJS on your host system).
+If you want to develop CHT apps with VS Code, you can use the Docker image as a Development Container. This will allow you to use the `cht` utility and its associated tech stack from within VS Code (without needing to install dependencies like NodeJS on your host system).
 
 See the [CHT Documentation](https://docs.communityhealthtoolkit.org/apps/tutorials/local-setup/#developing-with-vs-code-dev-container) for more information on building CHT apps with VS Code Development Containers.
 
@@ -58,7 +58,7 @@ docker run -it --rm -v "$PWD":/workdir medicmobile/cht-app-ide initialise-projec
 
 #### Note on connecting to a local CHT instance
 
-When using `cht-conf` within a Docker container to connect to a CHT instance that is running on your local machine (e.g. a development instance), you cannot use the `--local` flag or `localhost` in your `--url` parameter (since these will be interpreted as "local to the container"). 
+When using `cht` within a Docker container to connect to a CHT instance that is running on your local machine (e.g. a development instance), you cannot use the `--local` flag or `localhost` in your `--url` parameter (since these will be interpreted as "local to the container"). 
 
 It is recommended to run a local CHT instance using the [CHT Docker Helper script](https://docs.communityhealthtoolkit.org/apps/guides/hosting/4.x/app-developer/). You can connect to the resulting `...my.local-ip.co` URL from the Docker container (or the VS Code terminal). (Just make sure the port your CHT instance is hosted on is not blocked by your firewall). 
 
@@ -66,7 +66,7 @@ It is recommended to run a local CHT instance using the [CHT Docker Helper scrip
 
 To enable tab completion in bash, add the following to your `.bashrc`/`.bash_profile`:
 
-	eval "$(cht-conf --shell-completion=bash)"
+	eval "$(cht --shell-completion=bash)"
 
 ## Upgrading
 
@@ -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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cht-conf",
-  "version": "4.0.0",
+  "version": "4.1.1",
   "description": "Configure CHT deployments",
   "main": "./src/lib/main.js",
   "engines": {
@@ -11,7 +11,8 @@
     "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": {
@@ -35,46 +36,46 @@
   },
   "homepage": "https://github.com/medic/cht-conf#readme",
   "dependencies": {
-    "@medic/translation-checker": "^1.0.1",
-    "@parcel/watcher": "^2.0.5",
+    "@medic/translation-checker": "^1.1.0",
+    "@parcel/watcher": "^2.1.0",
     "@xmldom/xmldom": "^0.8.10",
     "async-retry": "^1.3.3",
     "canonical-json": "0.0.4",
-    "csv-parse": "^4.16.0",
+    "csv-parse": "^5.5.6",
     "dom-compare": "^0.6.0",
-    "eslint": "^6.8.0",
-    "eslint-loader": "^3.0.4",
-    "googleapis": "^84.0.0",
-    "iso-639-1": "^3.1.0",
-    "joi": "^17.11.0",
-    "json-diff": "^0.5.4",
+    "eslint": "^8.57.0",
+    "eslint-webpack-plugin": "^2.7.0",
+    "googleapis": "^140.0.1",
+    "iso-639-1": "^3.1.2",
+    "joi": "^17.13.3",
+    "json-diff": "^1.0.6",
     "json-stringify-safe": "^5.0.1",
     "json2csv": "^4.5.4",
     "mime-types": "^2.1.35",
     "minimist": "^1.2.8",
-    "mkdirp": "^1.0.4",
-    "open": "^7.4.2",
+    "mkdirp": "^3.0.1",
+    "open": "^8.4.2",
     "pluralize": "^8.0.0",
     "pouchdb-adapter-http": "^7.2.2",
     "pouchdb-core": "^7.2.2",
     "pouchdb-mapreduce": "^7.2.2",
-    "pouchdb-session-authentication": "^1.3.0",
+    "pouchdb-session-authentication": "^1.4.0",
     "properties": "^1.2.1",
     "queue-promise": "^2.2.1",
     "readline-sync": "^1.4.10",
     "redact-basic-auth": "^1.0.1",
     "request": "^2.88.2",
     "request-promise-native": "^1.0.9",
-    "semver": "^6.1.1",
-    "svgo": "^1.3.2",
-    "terser-webpack-plugin": "^1.4.3",
-    "uuid": "^8.3.2",
-    "webpack": "^4.46.0",
+    "semver": "^7.6.3",
+    "svgo": "^3.3.2",
+    "terser-webpack-plugin": "^5.3.10",
+    "uuid": "^10.0.0",
+    "webpack": "^5.93.0",
     "xpath": "0.0.33"
   },
   "devDependencies": {
-    "@commitlint/cli": "^13.2.0",
-    "@commitlint/config-conventional": "^13.2.0",
+    "@commitlint/cli": "^19.3.0",
+    "@commitlint/config-conventional": "^19.2.2",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "body-parser": "^1.20.2",
@@ -83,16 +84,16 @@
     "chai-exclude": "^2.1.0",
     "chai-shallow-deep-equal": "^1.4.6",
     "chai-xml": "^0.4.1",
-    "eslint-plugin-node": "^11.1.0",
-    "express": "^4.18.2",
+    "eslint-plugin-n": "^17.9.0",
+    "express": "^4.19.2",
     "express-pouchdb": "^4.2.0",
-    "fs-extra": "8.1.0",
-    "husky": "^7.0.2",
-    "mocha": "^6.2.3",
-    "nyc": "^15.1.0",
+    "fs-extra": "11.2.0",
+    "husky": "^9.1.1",
+    "mocha": "^10.7.0",
+    "nyc": "^17.0.0",
     "pouchdb-adapter-memory": "^7.2.2",
-    "rewire": "^5.0.0",
-    "semantic-release": "^18.0.0",
-    "sinon": "^8.1.1"
+    "rewire": "^7.0.0",
+    "semantic-release": "^22.0.0",
+    "sinon": "^18.0.0"
   }
 }

package/src/contact-summary/.eslintrc

@@ -1,11 +1,11 @@
 {
   "env": {
-    "es6": true,
+    "es2022": true,
     "node": true
   },
   "root": true,
   "parserOptions": {
-    "ecmaVersion": 5
+    "ecmaVersion": 2022
   },
   "extends": "eslint:recommended",
   "rules": {

package/src/fn/compress-images.js

@@ -1,4 +1,4 @@
-/*eslint node/no-missing-require: "off"*/
+/*eslint n/no-missing-require: "off"*/
 const compressPng = require('../lib/compress-png').execute;
 const compressSvg = require('../lib/compress-svg').execute;
 

package/src/fn/compress-svgs.js

@@ -2,8 +2,7 @@ const environment = require('../lib/environment');
 const fs = require('../lib/sync-fs');
 const { info, trace, warn } = require('../lib/log');
 
-const SVGO = require('svgo');
-const svgo = new SVGO();
+const svgo = require('svgo');
 
 module.exports = {
   requiresInstance: false,

package/src/fn/create-users.js

@@ -1,4 +1,4 @@
-const csvParse = require('csv-parse/lib/sync');
+const { parse: csvParse } = require('csv-parse/sync');
 const userPrompt = require('../../src/lib/user-prompt');
 
 const api = require('../lib/api');
@@ -90,4 +90,4 @@ const execute = async () => {
 module.exports = {
   requiresInstance: true,
   execute
-};
+};

package/src/fn/initialise-project-layout.js

@@ -20,10 +20,10 @@ const LAYOUT = {
   '.eslintrc': `{
   "env": {
     "node": true,
-    "es6": true
+    "es2022": true,
   },
   "parserOptions": {
-    "ecmaVersion": 6
+    "ecmaVersion": 2022
   }
 }`,
   forms: {

package/src/lib/compilation/package-lib.js

@@ -2,6 +2,7 @@ const fs = require('fs');
 const os = require('os');
 const path = require('path');
 const TerserPlugin = require('terser-webpack-plugin');
+const ESLintPlugin = require('eslint-webpack-plugin');
 const webpack = require('webpack');
 
 const fsUtils = require('../sync-fs');
@@ -17,7 +18,7 @@ module.exports = (pathToProject, entry, baseEslintPath, options = {}) => {
   const outputDirectoryPath = os.tmpdir();
   const outputFilename = `./${libName}.js`;
 
-  const compiler = webpack([{
+  const compiler = webpack({
     mode: 'production',
     entry,
     output: {
@@ -25,7 +26,7 @@ module.exports = (pathToProject, entry, baseEslintPath, options = {}) => {
       filename: outputFilename,
       libraryTarget: options.libraryTarget ? 'umd' : undefined,
       globalObject: options.libraryTarget,
-      hashFunction: 'sha512' // remove when we upgrade to webpack 5
+      hashFunction: 'xxhash64'
     },
     optimization: {
       minimize: !!options.minifyScripts,
@@ -54,29 +55,21 @@ module.exports = (pathToProject, entry, baseEslintPath, options = {}) => {
         'node_modules',
       ],
     },
-    module: {
-      rules: [
-        {
-          enforce: 'pre',
-          test: /\.js$/,
-          loader: require.resolve('eslint-loader'),
-          exclude: /node_modules/,
-          options: {
-            baseConfig: baseEslintConfig,
-            useEslintrc: true,
-            ignore: !options.skipEslintIgnore,
-
-            // pack the library regardless of the eslint result
-            failOnError: false,
-            failOnWarning: false,
-          },
-        },
-      ],
-    },
     plugins: [
-      new webpack.IgnorePlugin(/^\.\/locale$/, /moment$/), // Ignore all optional deps of moment.js
-    ]
-  }]);
+      new ESLintPlugin({
+        context: pathToProject,
+        extensions: 'js',
+        exclude: 'node_modules',
+        baseConfig: baseEslintConfig,
+        useEslintrc: true,
+        ignore: !options.skipEslintIgnore,
+        // pack the library regardless of the eslint result
+        failOnError: false,
+        failOnWarning: false,
+      }),
+      new webpack.IgnorePlugin({ resourceRegExp: /^\.\/locale$/, contextRegExp: /moment$/ }), // Ignore all optional deps of moment.js
+    ],
+  });
 
   return new Promise((resolve, reject) => {
     compiler.run((err, stats) => {
@@ -92,17 +85,21 @@ module.exports = (pathToProject, entry, baseEslintPath, options = {}) => {
       info(stats.toString());
 
       if (stats.hasErrors()) {
-        const hasErrorsNotRelatedToLinting = stats.toJson().errors.some(err => !err.includes('node_modules/eslint-loader'));
-        const shouldHalt = options.haltOnLintMessage || hasErrorsNotRelatedToLinting;
+        return reject(Error(`Webpack errors when building ${libName}`));
+      }
+
+      if (stats.hasWarnings()) {
+        const hasWarningsRelatedToLinting = stats.toJson().warnings.some(warning => warning.message.includes('warnings potentially fixable'));
+        const shouldHalt = options.haltOnWebpackWarning ||
+          options.haltOnLintMessage && hasWarningsRelatedToLinting;
+
         if (shouldHalt) {
-          return reject(Error(`Webpack errors when building ${libName}`));
-        } else {
-          warn('Ignoring linting errors');
+          return reject(Error(`Webpack warnings when building ${libName}`));
         }
-      }
 
-      if (stats.hasWarnings() && options.haltOnWebpackWarning) {
-        return reject(Error(`Webpack warnings when building ${libName}`));
+        if (hasWarningsRelatedToLinting) {
+          warn('Ignoring linting errors');
+        }
       }
 
       const outputPath = path.join(outputDirectoryPath, outputFilename);

package/src/lib/sync-fs.js

@@ -1,4 +1,4 @@
-const csvParse = require('csv-parse/lib/sync');
+const { parse: csvParse } = require('csv-parse/sync');
 const fs = require('fs');
 const mkdirp = require('mkdirp').sync;
 const os = require('os');

package/src/nools/.eslintrc

@@ -1,11 +1,11 @@
 {
   "env": {
-    "es6": true,
+    "es2022": true,
     "node": true
   },
   "root": true,
   "parserOptions": {
-    "ecmaVersion": 5
+    "ecmaVersion": 2022
   },
   "extends": "eslint:recommended",
   "rules": {