feat: SRE-1388 - Migration from CircleCI to GH Actions

.github/workflows/test-behat.yml

@@ -0,0 +1,91 @@
+name: Test Behat CI
+
+on:
+  pull_request:
+  workflow_dispatch:
+  # Nightly at 00:00 UTC (CircleCI: "0 0 * * *")
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  test-behat:
+    # Skip scheduled runs unless the workflow file is on a branch named 'release'
+    if: github.event_name != 'schedule' || github.ref_name == 'release'
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        shell: bash
+
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: ~/vendor
+          key: test-lint-dependencies-{{ checksum "composer.json" }}
+          restore-keys: test-lint-dependencies-{{ checksum "composer.json" }}
+
+      - name: Install dependencies
+        run: composer install -n --prefer-dist
+
+      - name: Run PHP Lint
+        run: composer phpcs
+
+      - name: Generate WP admin password
+        run: echo "$(openssl rand -hex 8)" > /tmp/WORDPRESS_ADMIN_PASSWORD
+
+      - name: Export environment (CircleCI -> GHA equivalents)
+        run: |
+          echo "TERMINUS_ENV=ci-${GITHUB_RUN_NUMBER}" >> "$GITHUB_ENV"
+          echo "TERMINUS_SITE=pantheon-hud" >> "$GITHUB_ENV"
+          echo "SITE_ENV=pantheon-hud.ci-${GITHUB_RUN_NUMBER}" >> "$GITHUB_ENV"
+          echo "WORDPRESS_ADMIN_USERNAME=pantheon" >> "$GITHUB_ENV"
+          echo "WORDPRESS_ADMIN_EMAIL=no-reply@getpantheon.com" >> "$GITHUB_ENV"
+          echo "WORDPRESS_ADMIN_PASSWORD=$(cat /tmp/WORDPRESS_ADMIN_PASSWORD)" >> "$GITHUB_ENV"
+
+      # Configures SSH to automatically accept new host keys.
+      - name: Force SSH to ignore host keys
+        run: echo "GIT_SSH_COMMAND=ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null" >> $GITHUB_ENV
+
+      - name: Install SSH key
+        uses: webfactory/ssh-agent@v0.7.0
+        with:
+          ssh-private-key: ${{ secrets.SITE_OWNER_SSH_PRIVATE_KEY }}
+
+      - name: Configure Composer GitHub OAuth (optional)
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          if [ -z "${GITHUB_TOKEN}" ]; then
+            echo "GITHUB_TOKEN missing; assuming unauthenticated build"; exit 0
+          fi
+          { composer config -g github-oauth.github.com "${GITHUB_TOKEN}"; } &>/dev/null
+
+      - name: Install Terminus
+        uses: pantheon-systems/terminus-github-actions@v1
+        with:
+          pantheon-machine-token: ${{ secrets.TERMINUS_TOKEN }}
+
+      - name: Validate fixture version
+        uses: jazzsequence/action-validate-plugin-version@v1
+        with:
+          branch: ${{ github.head_ref }}
+          dry-run: 'true'
+
+      - name: Behat prepare
+        run: ./bin/behat-prepare.sh
+
+      - name: Behat tests (strict)
+        run: ./bin/behat-test.sh --strict
+
+      - name: Behat cleanup (always)
+        if: always()
+        run: ./bin/behat-cleanup.sh

.gitignore

@@ -1,4 +1,6 @@
 .DS_Store
+.idea
+.codacy
 binding.*
 node_modules/
 vendor/

README.md

@@ -1,11 +1,11 @@
 # Pantheon HUD #
-**Contributors:** [getpantheon](https://profiles.wordpress.org/getpantheon/), [danielbachhuber](https://profiles.wordpress.org/danielbachhuber/), [jspellman](https://profiles.wordpress.org/jspellman/), [jazzs3quence](https://profiles.wordpress.org/jazzs3quence), [pwtyler](https://profiles.wordpress.org/pwtyler)  
-**Tags:** Pantheon, hosting, environment-indicator  
-**Requires at least:** 4.9  
-**Tested up to:** 6.8.1  
-**Requires PHP:** 7.4  
-**Stable tag:** 0.4.5-dev  
-**License:** GPLv2 or later  
+**Contributors:** [getpantheon](https://profiles.wordpress.org/getpantheon/), [danielbachhuber](https://profiles.wordpress.org/danielbachhuber/), [jspellman](https://profiles.wordpress.org/jspellman/), [jazzs3quence](https://profiles.wordpress.org/jazzs3quence), [pwtyler](https://profiles.wordpress.org/pwtyler)
+**Tags:** Pantheon, hosting, environment-indicator
+**Requires at least:** 4.9
+**Tested up to:** 6.8.3
+**Requires PHP:** 7.4
+**Stable tag:** 0.4.5-dev
+**License:** GPLv2 or later
 **License URI:** http://www.gnu.org/licenses/gpl-2.0.html
 
 A heads-up display into your Pantheon environment.

bin/behat-prepare.sh

@@ -8,22 +8,28 @@
 
 terminus whoami > /dev/null
 if [ $? -ne 0 ]; then
-	echo "Terminus unauthenticated; assuming unauthenticated build"
-	exit 0
+  echo "Terminus unauthenticated; assuming unauthenticated build"
+  exit 0
 fi
 
 if [ -z "$TERMINUS_SITE" ] || [ -z "$TERMINUS_ENV" ]; then
-	echo "TERMINUS_SITE and TERMINUS_ENV environment variables must be set"
-	exit 1
+  echo "TERMINUS_SITE and TERMINUS_ENV environment variables must be set"
+  exit 1
 fi
 
 if [ -z "$WORDPRESS_ADMIN_USERNAME" ] || [ -z "$WORDPRESS_ADMIN_PASSWORD" ]; then
-	echo "WORDPRESS_ADMIN_USERNAME and WORDPRESS_ADMIN_PASSWORD environment variables must be set"
-	exit 1
+  echo "WORDPRESS_ADMIN_USERNAME and WORDPRESS_ADMIN_PASSWORD environment variables must be set"
+  exit 1
 fi
 
 set -ex
 
+###
+# Install Composer dependencies, including Behat. This makes the
+# ./vendor/bin/behat executable available for the test runner.
+###
+composer install --no-progress --prefer-dist
+
 ###
 # Check for and apply any outstanding upstream updates.
 # This never happens manually, so we might as well do it in automation before we run tests.
@@ -78,15 +84,25 @@ git commit -m "Include Pantheon HUD and its configuration files"
 git push
 
 # Sometimes Pantheon takes a little time to refresh the filesystem
-terminus build:workflow:wait $TERMINUS_SITE.$TERMINUS_ENV
+terminus workflow:wait $TERMINUS_SITE.$TERMINUS_ENV
 
 ###
 # Set up WordPress, theme, and plugins for the test run
 ###
-# Silence output so as not to show the password.
-{
-  terminus wp $SITE_ENV -- core install --title=$TERMINUS_ENV-$TERMINUS_SITE --url=$PANTHEON_SITE_URL --admin_user=$WORDPRESS_ADMIN_USERNAME --admin_email=pantheon-hud@getpantheon.com --admin_password=$WORDPRESS_ADMIN_PASSWORD
-} &> /dev/null
+
+# Retry WP core install as the environment may take a moment to be ready.
+max_attempts=5
+attempt_num=1
+until terminus wp $SITE_ENV -- core install --title=$TERMINUS_ENV-$TERMINUS_SITE --url=$PANTHEON_SITE_URL --admin_user=$WORDPRESS_ADMIN_USERNAME --admin_email=pantheon-hud@getpantheon.com --admin_password=$WORDPRESS_ADMIN_PASSWORD; do
+  if [ $attempt_num -eq $max_attempts ]; then
+    echo "WP core install failed after $max_attempts attempts."
+    exit 1
+  fi
+  echo "WP core install failed. Retrying in 15 seconds... (Attempt $attempt_num of $max_attempts)"
+  sleep 15
+  attempt_num=$((attempt_num+1))
+done
+
 terminus wp $SITE_ENV -- cache flush
 terminus wp $SITE_ENV -- plugin activate pantheon-hud
 terminus wp $SITE_ENV -- theme activate twentytwentythree

readme.txt

@@ -2,7 +2,7 @@
 Contributors: getpantheon, danielbachhuber, jazzs3quence, jspellman, pwtyler
 Tags: Pantheon, hosting, environment-indicator
 Requires at least: 4.9
-Tested up to: 6.8.1
+Tested up to: 6.8.3
 Requires PHP: 7.4
 Stable tag: 0.4.5-dev
 License: GPLv2 or later
@@ -12,7 +12,7 @@ A heads-up display into your Pantheon environment.
 
 == Description ==
 
-This plugin provides situational awareness of the Pantheon plaform from within your WordPress dashboard. It's helpful to be reminded what environment you're in, as well as providing quick links to get back to Pantheon's dashboard, or to interface with your WordPress installation via the command line.
+This plugin provides situational awareness of the Pantheon platform from within your WordPress dashboard. It's helpful to be reminded what environment you're in, as well as providing quick links to get back to Pantheon's dashboard, or to interface with your WordPress installation via the command line.
 
 Pantheon HUD is in early stages of development. We want your feedback! [Create a Github issue](https://github.com/pantheon-systems/pantheon-hud/issues) with questions, feature requests, or bug reports.