feat(e2e): Smoke tests task & initial entrypoint COMPASS-8531 (#6571)

* initial smoketest task & entrypoint

* limit to just ubuntu and just the compass distribution for now

* correct package

* fine. no shebang

* xor the IS_* platform options

* verify once

* add error callback

Author: lerouxb

.evergreen/buildvariants-and-tasks.in.yml

@@ -60,6 +60,40 @@ const PACKAGE_BUILD_VARIANTS = [
   }
 ];
 
+const SMOKETEST_BUILD_VARIANTS = [
+  {
+    name: 'smoketest-ubuntu',
+    display_name: 'Smoketest Ubuntu',
+    run_on: 'ubuntu2004-large',
+    depends_on: 'package-ubuntu',
+  },
+  
+//  {
+//    name: 'smoketest-windows',
+//    display_name: 'Smoketest Windows',
+//    run_on: 'windows-vsCurrent-large',
+//    depends_on: 'package-windows',
+//  },
+//  {
+//    name: 'smoketest-rhel',
+//    display_name: 'Smoketest RHEL',
+//    run_on: 'rhel80-large',
+//    depends_on: 'package-rhel',
+//  },
+//  {
+//    name: 'smoketest-macos-x64',
+//    display_name: 'Smoketest MacOS Intel',
+//    run_on: 'macos-14',
+//    depends_on: 'package-macos-x64',
+//  },
+//  {
+//    name: 'smoketest-macos-arm',
+//    display_name: 'Smoketest MacOS Arm64',
+//    run_on: 'macos-14-arm64',
+//    depends_on: 'package-macos-arm',
+//  }
+];
+
 const TEST_PACKAGED_APP_BUILD_VARIANTS = [
   {
     name: 'test-packaged-app-ubuntu',
@@ -180,6 +214,19 @@ buildvariants:
     <% } %>
 <% } %>
 
+<% for (const buildVariant of SMOKETEST_BUILD_VARIANTS) { %>
+<% for (const distribution of ['compass']) { %>
+  - name: <%= buildVariant.name %>-<%= distribution %>
+    display_name: <%= buildVariant.display_name %> (<%= distribution %>)
+    run_on: <%= buildVariant.run_on %>
+    depends_on:
+      - name: package-<%= distribution %>
+        variant: <%= buildVariant.depends_on %>
+    tasks:
+    - name: smoketest-<%= distribution %>
+<% } %>
+<% } %>
+
   - name: test-eol-servers
     display_name: Test EoL Servers
     run_on: ubuntu1804-large
@@ -424,6 +471,22 @@ tasks:
       - func: save-all-artifacts
         vars:
           compass_distribution: <%= distribution %>
+  <% } %>
+
+<% for (const distribution of ['compass']) { %>
+  - name: smoketest-<%= distribution %>
+    tags: ['required-for-publish', 'run-on-pr']
+    commands:
+      - func: prepare
+      - func: install
+      - func: bootstrap
+        vars:
+          scope: 'compass-e2e-tests'
+      - func: smoketest-packaged-app
+        vars:
+          mongodb_version: latest-enterprise
+          compass_distribution: <%= distribution %>
+          debug: 'compass-e2e-tests*,electron*,hadron*,mongo*'
 <% } %>
 
 <% for (const serverVersion of SERVER_VERSIONS) { %>

.evergreen/buildvariants-and-tasks.yml

@@ -76,6 +76,14 @@ buildvariants:
       - name: package-compass
       - name: package-compass-isolated
       - name: package-compass-readonly
+  - name: smoketest-ubuntu-compass
+    display_name: Smoketest Ubuntu (compass)
+    run_on: ubuntu2004-large
+    depends_on:
+      - name: package-compass
+        variant: package-ubuntu
+    tasks:
+      - name: smoketest-compass
   - name: test-eol-servers
     display_name: Test EoL Servers
     run_on: ubuntu1804-large
@@ -472,6 +480,21 @@ tasks:
       - func: save-all-artifacts
         vars:
           compass_distribution: compass-readonly
+  - name: smoketest-compass
+    tags:
+      - required-for-publish
+      - run-on-pr
+    commands:
+      - func: prepare
+      - func: install
+      - func: bootstrap
+        vars:
+          scope: compass-e2e-tests
+      - func: smoketest-packaged-app
+        vars:
+          mongodb_version: latest-enterprise
+          compass_distribution: compass
+          debug: compass-e2e-tests*,electron*,hadron*,mongo*
   - name: test-server-40x-community-1
     tags:
       - required-for-publish

.evergreen/functions.yml

@@ -651,6 +651,31 @@ functions:
 
           npm run --unsafe-perm --workspace compass-e2e-tests test-packaged-ci
 
+  smoketest-packaged-app:
+    - command: shell.exec
+      # Fail the task if it's idle for 10 mins
+      timeout_secs: 600
+      params:
+        working_dir: src
+        shell: bash
+        env:
+          <<: *compass-env
+          DEBUG: ${debug|}
+          MONGODB_VERSION: ${mongodb_version|}
+          MONGODB_RUNNER_VERSION: ${mongodb_version|}
+          HADRON_DISTRIBUTION: ${compass_distribution}
+        script: |
+          set -e
+          # Load environment variables
+          eval $(.evergreen/print-compass-env.sh)
+
+          if [[ "$IS_OSX" == "true" ]]; then
+            echo "Disabling clipboard usage in e2e tests (TODO: https://jira.mongodb.org/browse/BUILD-14780)"
+            export COMPASS_E2E_DISABLE_CLIPBOARD_USAGE="true"
+          fi
+
+          npm run --workspace compass-e2e-tests smoketest
+
   test-web-sandbox:
     - command: shell.exec
       # Fail the task if it's idle for 10 mins

.evergreen/preinstall.sh

@@ -12,6 +12,11 @@ echo "NPM_VERSION: $NPM_VERSION"
 echo "APPDATA: $APPDATA"
 echo "PATH: $PATH"
 
+# these are super useful if you want to run the smoke tests locally
+echo "DEV_VERSION_IDENTIFIER: $DEV_VERSION_IDENTIFIER"
+echo "EVERGREEN_BUCKET_NAME: $EVERGREEN_BUCKET_NAME"
+echo "EVERGREEN_BUCKET_KEY_PREFIX: $EVERGREEN_BUCKET_KEY_PREFIX"
+
 echo "IS_OSX: $IS_OSX"
 echo "IS_LINUX: $IS_LINUX"
 echo "IS_WINDOWS: $IS_WINDOWS"

packages/compass-e2e-tests/.gitignore

@@ -2,3 +2,4 @@
 .log
 fixtures/*.csv
 fixtures/*.json
+hadron-build-info.json

packages/compass-e2e-tests/package.json

@@ -28,7 +28,8 @@
     "test-web": "env DEBUG=hadron*,mongo*,compass*,xvfb-maybe* npm run test web",
     "test-web-noserver": "env DEBUG=hadron*,mongo*,compass*,xvfb-maybe* npm run test web -- --disable-start-stop --bail",
     "coverage-merge": "nyc merge .log/coverage .nyc_output/coverage.json",
-    "coverage-report": "npm run coverage-merge && nyc report"
+    "coverage-report": "npm run coverage-merge && nyc report",
+    "smoketest": "ts-node smoke-test.ts"
   },
   "devDependencies": {
     "@electron/rebuild": "^3.7.1",