feat(#425): E2E test actions

.github/workflows/build.yml

@@ -30,3 +30,19 @@ jobs:
           coverage
           .nyc_output
       if: ${{ failure() }}
+
+  e2e:
+    name: E2E tests
+    runs-on: ubuntu-22.04
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: 18.x
+    - name: Install dependencies
+      run: |
+        pip install git+https://github.com/medic/[email protected]#egg=pyxform-medic
+        npm ci
+    - name: Run E2E tests
+      run: npm run test-e2e

.gitignore

@@ -10,3 +10,4 @@ coverage
 .nyc_output
 .DS_Store
 test/.DS_Store
+test/e2e/.cht-docker-helper

package.json

@@ -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": "npm run eslint && mocha --config test/e2e/.mocharc.js",
     "semantic-release": "semantic-release"
   },
   "bin": {

test/e2e/.mocharc.js

@@ -0,0 +1,14 @@
+module.exports = {
+  allowUncaught: false,
+  color: true,
+  checkLeaks: true,
+  fullTrace: true,
+  asyncOnly: false,
+  spec: ['test/e2e/**/*.spec.js'],
+  timeout: 60_000, // API takes a little long to start up
+  reporter: 'spec',
+  file: ['test/e2e/hooks.js'],
+  captureFile: 'test/e2e/results.txt',
+  exit: true,
+  recursive: true,
+};

test/e2e/cht-conf-utils.js

@@ -0,0 +1,57 @@
+const path = require('path');
+const { exec } = require('child_process');
+const fs = require('fs');
+const fse = require('fs-extra');
+
+const log = require('../../src/lib/log');
+const { getProjectUrl } = require('./cht-docker-utils');
+
+const getProjectDirectory = (projectName) => path.resolve(__dirname, `../../build/${projectName}`);
+
+const runChtConf = (projectName, command) => new Promise((resolve, reject) => {
+  getProjectUrl(projectName).then(url => {
+    const projectDirectory = getProjectDirectory(projectName);
+    const cliPath = path.join(__dirname, '../../src/bin/index.js');
+    exec(`node ${cliPath} --url=${url} ${command}`, { cwd: projectDirectory }, (error, stdout, stderr) => {
+      if (!error) {
+        return resolve(stdout);
+      }
+
+      log.error(stderr);
+      reject(new Error(stdout.toString('utf8')));
+    });
+  });
+});
+
+const cleanupProject = (projectName) => {
+  const projectDirectory = getProjectDirectory(projectName);
+  fse.removeSync(projectDirectory);
+};
+
+const initProject = async (projectName) => {
+  const projectDirectory = getProjectDirectory(projectName);
+  if (fs.existsSync(projectDirectory)) {
+    fse.removeSync(projectDirectory);
+  }
+
+  fse.mkdirpSync(projectDirectory);
+  fs.writeFileSync(
+    path.join(projectDirectory, 'package.json'),
+    JSON.stringify({
+      name: 'e2e-edit-app-settings',
+      version: '1.0.0',
+      dependencies: {
+        'cht-conf': 'file:../..',
+      },
+    }, null, 4),
+  );
+
+  await runChtConf(projectName, 'initialise-project-layout');
+};
+
+module.exports = {
+  cleanupProject,
+  getProjectDirectory,
+  initProject,
+  runChtConf,
+};

test/e2e/cht-docker-utils.js

@@ -0,0 +1,134 @@
+const path = require('path');
+const fs = require('fs');
+const https = require('https');
+const { spawn } = require('child_process');
+const request = require('request-promise-native');
+
+const log = require('../../src/lib/log');
+
+const DEFAULT_PROJECT_NAME = 'cht_conf_e2e_tests';
+const dockerHelperDirectory = path.resolve(__dirname, '.cht-docker-helper');
+const dockerHelperScript = path.resolve(dockerHelperDirectory, './cht-docker-compose.sh');
+
+const downloadDockerHelperScript = () => new Promise((resolve, reject) => {
+  const file = fs.createWriteStream(dockerHelperScript, { mode: 0o755 });
+  https
+    // TODO: switch back to using `master` branch of cht-core once DNS issue is resolved - https://github.com/medic/medic-infrastructure/issues/571#issuecomment-2209120441
+    .get('https://raw.githubusercontent.com/medic/cht-core/dnm-docker-helper-experiments/scripts/docker-helper-4.x/cht-docker-compose.sh', (response) => {
+      response.pipe(file);
+      file.on('finish', () => file.close(resolve));
+      file.on('error', () => file.close(reject));
+    })
+    .on('error', () => {
+      fs.unlinkSync(file.path);
+      file.close(() => reject('Failed to download CHT Docker Helper script "cht-docker-compose.sh"'));
+    });
+});
+
+const ensureScriptExists = async () => {
+  if (!fs.existsSync(dockerHelperDirectory)) {
+    await fs.promises.mkdir(dockerHelperDirectory);
+  }
+
+  if (!fs.existsSync(dockerHelperScript)) {
+    await downloadDockerHelperScript();
+  }
+};
+
+const sleep = (ms) => new Promise(resolve => setTimeout(resolve, ms));
+
+const getProjectConfig = async (projectName) => {
+  try {
+    const configFile = await fs.promises.readFile(path.resolve(dockerHelperDirectory, `${projectName}.env`), 'utf8');
+    return Object.fromEntries(
+      configFile.toString()
+        .split('\n')
+        .map(line => line.split('='))
+        .filter(entry => entry.length === 2),
+    );
+  } catch (error) {
+    log.error(error);
+    return {
+      COUCHDB_USER: 'medic',
+      COUCHDB_PASSWORD: 'password',
+      NGINX_HTTPS_PORT: '10443',
+    };
+  }
+};
+
+const getProjectUrl = async (projectName = DEFAULT_PROJECT_NAME) => {
+  const config = await getProjectConfig(projectName);
+  const { COUCHDB_USER, COUCHDB_PASSWORD, NGINX_HTTPS_PORT } = config;
+  return `https://${COUCHDB_USER}:${COUCHDB_PASSWORD}@127-0-0-1.local-ip.medicmobile.org:${NGINX_HTTPS_PORT}`;
+};
+
+const isProjectReady = async (projectName, attempt = 1) => {
+  log.info(`Checking if CHT is ready, attempt ${attempt}.`);
+  const url = await getProjectUrl(projectName);
+  await request({ uri: `${url}/api/v2/monitoring`, json: true })
+    .catch(async (error) => {
+      if (error.error.code === 'DEPTH_ZERO_SELF_SIGNED_CERT') {
+        await sleep(1000);
+        return isProjectReady(projectName, attempt + 1);
+      }
+
+      if ([502, 503].includes(error.statusCode)) {
+        await sleep(1000);
+        return isProjectReady(projectName, attempt + 1);
+      }
+
+      throw error;
+    });
+};
+
+const startProject = (projectName) => new Promise((resolve, reject) => {
+  const configFile = path.resolve(dockerHelperDirectory, `${projectName}.env`);
+  if (fs.existsSync(configFile)) {
+    // project config already exists, reuse it
+    const childProcess = spawn(dockerHelperScript, [`${projectName}.env`, 'up'], { cwd: dockerHelperDirectory });
+    childProcess.on('error', reject);
+    childProcess.on('close', resolve);
+  } else {
+    // initialize a new project, config will be saved to `${projectName}.env`
+    const childProcess = spawn(dockerHelperScript, { stdio: 'pipe', cwd: dockerHelperDirectory });
+    childProcess.on('error', reject);
+    childProcess.on('close', async () => {
+      await isProjectReady(projectName);
+      resolve();
+    });
+
+    childProcess.stdin.write('y\n');
+    childProcess.stdin.write('y\n');
+    childProcess.stdin.write(`${projectName}\n`);
+  }
+});
+
+const destroyProject = (projectName) => new Promise((resolve, reject) => {
+  const childProcess = spawn(dockerHelperScript, [`${projectName}.env`, 'destroy'], {
+    stdio: 'inherit',
+    cwd: dockerHelperDirectory
+  });
+  childProcess.on('error', reject);
+  childProcess.on('close', resolve);
+});
+
+const spinUpCht = async (projectName = DEFAULT_PROJECT_NAME) => {
+  await ensureScriptExists();
+  await startProject(projectName);
+};
+
+const tearDownCht = async (projectName = DEFAULT_PROJECT_NAME) => {
+  if (!fs.existsSync(path.resolve(dockerHelperDirectory, `${projectName}.env`))) {
+    return;
+  }
+
+  await ensureScriptExists();
+  await destroyProject(projectName);
+};
+
+module.exports = {
+  DEFAULT_PROJECT_NAME,
+  getProjectUrl,
+  spinUpCht,
+  tearDownCht,
+};

test/e2e/edit-app-settings.spec.js

@@ -0,0 +1,69 @@
+const fs = require('fs');
+const path = require('path');
+const { expect } = require('chai');
+const request = require('request-promise-native');
+
+const { getProjectUrl } = require('./cht-docker-utils');
+const {
+  DEFAULT_PROJECT_NAME,
+  cleanupProject,
+  getProjectDirectory,
+  initProject,
+  runChtConf,
+} = require('./cht-conf-utils');
+
+describe('edit-app-settings', () => {
+  const projectName = DEFAULT_PROJECT_NAME;
+  const projectDirectory = getProjectDirectory(projectName);
+
+  before(async () => {
+    await initProject(projectName);
+  });
+
+  after(async () => {
+    await cleanupProject(projectName);
+  });
+
+  it('disables a language, recompile, and push app settings', async () => {
+    const url = await getProjectUrl(projectName);
+    const initialSettings = await request.get({ url: `${url}/api/v1/settings`, json: true });
+
+    // TODO: remove next line when we upgrade eslint and its `parserOptions.ecmaVersion` setting to parse syntax supported by node 18+
+    // eslint-disable-next-line no-undef
+    const baseSettings = structuredClone(initialSettings);
+    baseSettings.languages = baseSettings.languages.map(language => {
+      if (language.locale === 'en') {
+        language.enabled = false;
+      }
+
+      return language;
+    });
+    baseSettings.locale = 'fr';
+    baseSettings.locale_outgoing = 'fr';
+    await fs.promises.writeFile(
+      path.join(projectDirectory, 'app_settings/base_settings.json'),
+      JSON.stringify(baseSettings, null, 2),
+    );
+
+    await runChtConf(projectName, 'compile-app-settings');
+    const compiledSettings = JSON.parse(
+      await fs.promises.readFile(path.join(projectDirectory, 'app_settings.json'), 'utf8')
+    );
+    expect(compiledSettings.languages.find(language => language.locale === 'en')).to.deep.equal({
+      locale: 'en',
+      enabled: false,
+    });
+    expect(compiledSettings.locale).to.equal('fr');
+    expect(compiledSettings.locale_outgoing).to.equal('fr');
+
+    await runChtConf(projectName, 'upload-app-settings');
+    const newSettings = await request.get({ url: `${url}/api/v1/settings`, json: true });
+    expect(newSettings.languages.find(language => language.locale === 'en')).to.deep.equal({
+      locale: 'en',
+      enabled: false,
+    });
+    expect(newSettings.locale).to.equal('fr');
+    expect(newSettings.locale_outgoing).to.equal('fr');
+
+  });
+});

test/e2e/hooks.js

@@ -0,0 +1,11 @@
+const { spinUpCht, tearDownCht } = require('./cht-docker-utils');
+
+before(async () => {
+  // cleanup eventual leftovers before starting
+  await tearDownCht();
+  await spinUpCht();
+});
+
+after(async () => {
+  await tearDownCht();
+});

test/e2e/session-token.spec.js → test/integration/session-token.spec.js

@@ -56,7 +56,7 @@ const runCliCommand = (command) => {
   });
 };
 
-describe('e2e/session-token', function() {
+describe('integration/session-token', function() {
   this.timeout(15000);
 
   let sessionToken;
@@ -149,4 +149,4 @@ describe('e2e/session-token', function() {
       // Bad Request: Malformed AuthSession cookie
       .that.contains('INFO Error: Received error code 400');
   });
-});
+});