Set up Github Actions

.github/workflows/e2e-dispatch.yml

@@ -0,0 +1,78 @@
+# Copyright 2024 The Ground Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+name: End to End Test Dispatchers
+
+on:
+    workflow_dispatch:
+
+jobs:
+    createTest:
+        name: Create a new survey
+        runs-on: ubuntu-latest
+        steps:
+            - name: Check out code
+              uses: actions/checkout@v1
+
+            - name: Set up Node.js
+              uses: actions/setup-node@v2
+              with:
+                node-version: "18"
+
+            - name: Install dependencies
+              run: npm run build:local
+
+            - name: Run create e2e tests
+              run: npm run test:e2e:create
+
+            - name: Store data/local
+              uses: actions/upload-artifact@v4
+              with:
+                name: data-test
+                path: data/test
+                retention-days: 1
+                overwrite: true
+
+    submitTest:
+      needs: createTest
+      name: Submit to survey
+      runs-on: ubuntu-latest
+      steps:
+        - name: Run submission action
+          run: |
+            gh workflow run --repo google/ground-android e2e-dispatch.yml
+
+    verifyTest:
+        needs: submitTest
+        name: Verify survey submissions
+        runs-on: ubuntu-latest
+        steps:
+            - name: Check out code
+              uses: actions/checkout@v1
+
+            - name: Set up Node.js
+              uses: actions/setup-node@v2
+              with:
+                node-version: "18"
+
+            - name: Install dependencies
+              run: npm run build:local
+
+            - name: Copy Firebase emulator data
+              uses: actions/download-artifact@v4
+              with:
+                name: data-test
+                path: data/test
+
+            - name: Run create e2e tests
+              run: npm run test:e2e:verify

.github/workflows/test-e2e.yml

@@ -0,0 +1,28 @@
+# Copyright 2024 The Ground Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+name: End to End Test
+
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+    e2eTest:
+        runs-on: ubuntu-latest
+        timeout-minutes: 5
+        if: github.event.issue.pull_request && contains(github.event.comment.body, '/e2eTest')
+        steps:
+          - name: Run End To End Tests
+            run: |
+              gh workflow run e2e-dispatch.yml

.github/workflows/test-pr.yml

@@ -44,7 +44,7 @@ jobs:
         run: ./precheck.sh
 
       - name: Install dependencies
-        run: npm install
+        run: npm install --legacy-peer-deps
 
       - name: Run Jasmine tests
         run: npm run test-with-coverage
@@ -71,4 +71,4 @@ jobs:
           node-version: "16"
 
       - name: Run Jasmine tests
-        run: npm run test
+        run: npm run test

e2e-tests/.gitignore

@@ -0,0 +1,9 @@
+# Compiled JavaScript files
+lib/**/*.js
+lib/**/*.js.map
+
+# TypeScript v1 declaration files
+typings/
+
+# Node.js dependency directory
+node_modules/

e2e-tests/ground-helpers.ts

@@ -0,0 +1,37 @@
+/**
+ * Copyright 2019 The Ground Authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the 'License');
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an 'AS IS' BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export enum LoiType {
+  DROP_PIN = 'pin',
+  DRAW_AREA = 'draw',
+}
+
+export enum TaskType {
+  TEXT = 'text',
+  SELECT_ONE = 'select one',
+  SELECT_MULTIPLE = 'select multiple',
+  NUMBER = 'number',
+  DATE = 'date',
+  TIME = 'time',
+  PHOTO = 'photo',
+  CAPTURE_LOCATION = 'capture location',
+}
+
+export enum Role {
+  DATA_COLLECTOR = 'data collector',
+  SURVEY_ORGANIZER = 'survey organizer',
+  VIEWER = 'viewer',
+}

e2e-tests/spec/create_survey.spec.ts

@@ -0,0 +1,52 @@
+/**
+ * Copyright 2024 The Ground Authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the 'License');
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an 'AS IS' BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import 'jasmine';
+
+import {WebDriverHelper} from '../webdriver-helpers.js';
+import {TestConfig} from '../test_config.js';
+
+// Increase default timeout.
+jasmine.DEFAULT_TIMEOUT_INTERVAL = TestConfig.TEST_TIME_OUT;
+
+describe('ground-platform', () => {
+  let helper: WebDriverHelper;
+
+  beforeAll(async () => {
+    helper = new WebDriverHelper();
+    await helper.start(TestConfig.WEB_URL);
+    await helper.waitUntilPageReady();
+  });
+
+  afterAll(() => {
+    return helper.quit();
+  });
+
+  it('adds a new survey', async () => {
+    await helper.addNewSurvey();
+    await helper.setSurveyMetadata(
+      TestConfig.SURVEY_TITLE,
+      TestConfig.SURVEY_DESCRIPTION,
+      TestConfig.JOB_NAME,
+      TestConfig.ADHOC
+    );
+    await helper.addAllTasks(
+      TestConfig.ADHOC ? TestConfig.LOI_TASK_TYPE : null
+    );
+    await helper.shareSurvey(TestConfig.USER);
+    await helper.verifySurveyCreated();
+  });
+});

e2e-tests/spec/verify_submissions.spec.ts

@@ -0,0 +1,46 @@
+/**
+ * Copyright 2024 The Ground Authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the 'License');
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an 'AS IS' BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import 'jasmine';
+
+import {WebDriverHelper} from '../webdriver-helpers.js';
+import {TestConfig} from '../test_config.js';
+
+// Increase default timeout.
+jasmine.DEFAULT_TIMEOUT_INTERVAL = TestConfig.TEST_TIME_OUT;
+
+describe('ground-platform', () => {
+  let helper: WebDriverHelper;
+
+  beforeAll(async () => {
+    helper = new WebDriverHelper();
+    await helper.start(TestConfig.WEB_URL);
+    await helper.waitUntilPageReady();
+  });
+
+  afterAll(() => {
+    return helper.quit();
+  });
+
+  it('selects test survey', async () => {
+    await helper.selectTestSurvey();
+  });
+
+  it('displays submissions', async () => {
+    await helper.waitForSurveySubmissions();
+    await helper.verifySurveySubmissions();
+  });
+});

e2e-tests/test_config.ts

@@ -0,0 +1,34 @@
+/**
+ * Copyright 2019 The Ground Authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the 'License');
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an 'AS IS' BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {LoiType} from './ground-helpers';
+
+export class TestConfig {
+  static WEB_URL = 'http://localhost:5000';
+  static TEST_TIME_OUT = 5 * 60 * 1000; // 5m
+  static SHORT_TIME_OUT = 1000; // 1s
+  static LONG_TIME_OUT = TestConfig.SHORT_TIME_OUT * 5; // 5s
+  static SURVEY_TITLE = 'A test title';
+  static SURVEY_DESCRIPTION = 'A test description';
+  static JOB_NAME = 'A job name';
+  static ADHOC = true;
+  static LOI_TASK_TYPE = LoiType.DROP_PIN;
+  static MULTIPLE_CHOICE_COUNT = 3;
+  static MULTIPLE_CHOICE_ADD_OTHER = true;
+  static USER = '[email protected]';
+  static EXPECTED_SUBMISSION_COUNT = 2;
+  static WAIT_FOR_SUBMISSION_TRIES = 30;
+}