chore: add e2e test for fetching forms from Google Drive (#796)

Author: jkuester

.github/workflows/build.yml

@@ -35,6 +35,11 @@ jobs:
   e2e:
     name: E2E tests
     runs-on: ubuntu-22.04
+    env:
+      GOOGLE_CLIENT_ID: ${{ secrets.GOOGLE_CLIENT_ID }}
+      GOOGLE_CLIENT_SECRET: ${{ secrets.GOOGLE_CLIENT_SECRET }}
+      GOOGLE_REDIRECT_URI: "http://localhost"
+      GOOGLE_TOKEN_SCOPE: 'https://www.googleapis.com/auth/drive.readonly'
 
     steps:
     - uses: actions/checkout@v4
@@ -48,5 +53,20 @@ jobs:
     - name: Hard code local-ip IP in /etc/hosts per https://github.com/medic/medic-infrastructure/issues/571#issuecomment-2209120441
       run: |
         echo "15.188.129.97 local-ip.medicmobile.org" | sudo tee -a /etc/hosts
+    - id: auth
+      uses: google-github-actions/auth@7c6bc770dae815cd3e89ee6cdf493a5fab2cc093
+      with:
+        service_account: ${{ env.GOOGLE_SERVICE_ACCT }}
+        credentials_json: ${{ secrets.GOOGLE_CREDENTIALS }}
+        token_format: access_token
+        access_token_scopes: ${{ env.GOOGLE_TOKEN_SCOPE }}
+    - name: Write access_token to .gdrive.session.json
+      run: |
+        echo '{
+          "access_token": "${{ steps.auth.outputs.access_token }}",
+          "scope": "${{ env.GOOGLE_TOKEN_SCOPE }}",
+          "token_type": "Bearer",
+          "expiry_date": "9999999999999"
+        }' > .gdrive.session.json
     - name: Run E2E tests
       run: npm run test-e2e

test/e2e/.mocharc.js

@@ -4,7 +4,7 @@ module.exports = {
   ...rootConfig,
   captureFile: 'test/e2e/results.txt',
   checkLeaks: true,
-  exclude: [],
+  exclude: process.env.CI ? [] : ['test/e2e/fetch-forms-from-google-drive.spec.js'], // Do not run Google tests locally by default
   file: 'test/e2e/hooks.js',
   spec: 'test/e2e/**/*.spec.js',
   timeout: 120_000, // spinning up a CHT instance takes a little long

test/e2e/fetch-forms-from-google-drive.spec.js

@@ -0,0 +1,53 @@
+const { expect } = require('chai');
+const fs = require('node:fs');
+const {
+  cleanupProject,
+  initProject,
+  runChtConf,
+  getProjectDirectory
+} = require('./cht-conf-utils');
+const path = require('path');
+
+const FORMS = {
+  'app/death_report.xlsx': '1azFHCMTMehxuSg_LWOgsJZxrJo0yhseLp9FK4gTT38M',
+  'contact/person-create.xlsx': '1VhOPphx4IXyZiGbcevVZwvsvap8WPKHmUjOp8NuWJW8'
+};
+
+/**
+ * Running this test locally requires OAuth desktop client credentials for a Google Cloud Project.
+ * https://docs.communityhealthtoolkit.org/apps/guides/forms/google-drive/
+ * Once you have created the OAuth client, configure the following environment variables in your current shell:
+ * `CI=true`, `GOOGLE_REDIRECT_URI=http://localhost`, and `GOOGLE_CLIENT_ID=<client_id from OAuth client>`,
+ * `GOOGLE_CLIENT_SECRET=<>`. Next, generate a `.gdrive.session.json` file with a valid access token by manually
+ * running `cht fetch-forms-from-google-drive`. Copy the `.gdrive.session.json` file to the root of the cht-conf repo.
+ * Then you should be able to successfully run `npm test-e2e`.
+ *
+ * On CI, this test runs with a configured Service Account by preemptively getting an access token and setting it in
+ * the `.gdrive.session.json` file. Unfortunately, this means these tests cannot cover the login portion of the
+ * functionality, but it does to cover the actual fetching and file writing logic.
+ */
+describe('fetch-forms-from-google-drive', () => {
+  before(initProject);
+  after(cleanupProject);
+
+  it('downloads configured forms from Google Drive', async () => {
+    const projectDir = getProjectDirectory();
+    await fs.promises.writeFile(
+      path.join(projectDir, 'forms-on-google-drive.json'),
+      JSON.stringify(FORMS, null, 2),
+    );
+
+    const sessionJsonSrcPath = path.resolve(__dirname, '../../.gdrive.session.json');
+    const sessionJsonDestPath = path.resolve(projectDir, '.gdrive.session.json');
+    await fs.promises.copyFile(sessionJsonSrcPath, sessionJsonDestPath);
+
+    await runChtConf('fetch-forms-from-google-drive');
+
+    const formFilePaths = Object
+      .keys(FORMS)
+      .map(formPath => path.join(projectDir, 'forms', formPath));
+    formFilePaths.forEach(formPath => {
+      expect(fs.existsSync(formPath)).to.be.true;
+    });
+  });
+});