CD-511 Demo content and Github Actions

.github/workflows/lighthouse-budget.json

@@ -1,6 +1,24 @@
 [
   {
-    "path": "/*",
+    "path": "/",
+    "timings": [
+      {
+        "metric": "largest-contentful-paint",
+        "budget": 4000
+      },
+      {
+        "metric": "max-potential-fid",
+        "budget": 300
+      },
+      {
+        "metric": "interactive",
+        "budget": 5000
+      },
+      {
+        "metric": "cumulative-layout-shift",
+        "budget": 0.25
+      }
+    ],
     "resourceSizes": [
       {
         "resourceType": "document",
@@ -12,12 +30,33 @@
       },
       {
         "resourceType": "stylesheet",
-        "budget": 20
+        "budget": 30
       },
       {
         "resourceType": "total",
         "budget": 700
       }
     ]
+  },
+  {
+    "path": "/demo",
+    "timings": [
+      {
+        "metric": "largest-contentful-paint",
+        "budget": 5000
+      },
+      {
+        "metric": "max-potential-fid",
+        "budget": 400
+      },
+      {
+        "metric": "interactive",
+        "budget": 6000
+      },
+      {
+        "metric": "cumulative-layout-shift",
+        "budget": 0.35
+      }
+    ]
   }
 ]

.github/workflows/lighthouserc.js

@@ -1,7 +1,6 @@
 module.exports = {
   ci: {
     collect: {
-      url: ['http://127.0.0.1:8080/demo'],
       startServerCommand: 'docker compose -f tests/docker-compose.yml exec -T drupal drush rs 127.0.0.1:8080'
     },
     assert: {

.github/workflows/run-tests.yml

@@ -1,16 +1,11 @@
 name: Run tests
-
-on: [pull_request]
+on:
+  pull_request:
+    types: [labeled, opened, synchronize]
 
 jobs:
   tests:
     runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      checks: write
-      pull-requests: write
-      actions: read
-      statuses: write
 
     steps:
       - name: Checkout Code
@@ -64,8 +59,7 @@ jobs:
         uses: cafuego/command-output@main
         with:
           run: |
-            # Uncomment this if we have custom modules.
-            # test ! -d ./html/modules/custom || find -L ./html/modules/custom -iregex '.*\.\(php\|module\|inc\|install\)$' -print0 | xargs -0 -n 1 -P 4 php -l
+            test ! -d ./html/modules/custom || find -L ./html/modules/custom -iregex '.*\.\(php\|module\|inc\|install\)$' -print0 | xargs -0 -n 1 -P 4 php -l
             test ! -d ./html/themes/custom || find -L ./html/themes/custom -iregex '.*\.\(php\|theme\)$' -print0 | xargs -0 -n 1 -P 4 php -l
         env:
           fail-fast: true
@@ -111,12 +105,19 @@ jobs:
         env:
           fail-fast: true
 
+      - name: Install Subtheme
+        id: subtheme
+        uses: cafuego/command-output@main
+        with:
+          run: |
+            docker compose -f tests/docker-compose.yml exec -w /srv/www -T drupal /usr/bin/composer run sub-theme
+
       - name: PHPCS
         id: phpcs
         uses: cafuego/command-output@main
         with:
           run: |
-            docker compose -f tests/docker-compose.yml exec -u appuser -w /srv/www -T drupal phpcs -p --report=full --standard=phpcs.xml ./html/themes/custom
+            docker compose -f tests/docker-compose.yml exec -u appuser -w /srv/www -T drupal phpcs -p --report=full --standard=phpcs.xml ./html/modules/custom ./html/themes/custom
         env:
           fail-fast: true
 
@@ -125,12 +126,107 @@ jobs:
         uses: cafuego/command-output@main
         with:
           run: |
-            # This isn't very useful as we're not actually running tests.
-            docker compose -f tests/docker-compose.yml exec -T drupal drush -y si --existing-config
+            docker compose -f tests/docker-compose.yml exec -T drupal drush -y si --existing-config minimal install_configure_form.enable_update_status_emails=NULL
+        env:
+          fail-fast: true
+
+      - name: Run tests
+        id: tests
+        uses: cafuego/command-output@main
+        with:
+          run: |
             docker compose -f tests/docker-compose.yml exec -T drupal drush -y en dblog
+            docker compose -f tests/docker-compose.yml exec -T drupal chmod -R 777 /srv/www/html/sites/default/files /srv/www/html/sites/default/private
+            docker compose -f tests/docker-compose.yml exec -T drupal mkdir -p /srv/www/html/build/logs
+            docker compose -f tests/docker-compose.yml exec -T drupal chmod -R 777 /srv/www/html/build/logs
+            docker-compose -f tests/docker-compose.yml exec -T drupal mkdir -p /srv/www/html/build/logs /srv/www/html/sites/default/files/browser_output
+            docker-compose -f tests/docker-compose.yml exec -T drupal chmod -R 777 /srv/www/html/build/logs /srv/www/html/sites/default/files/browser_output
+            docker compose -f tests/docker-compose.yml exec -T -w /srv/www -e XDEBUG_MODE=coverage -e BROWSERTEST_OUTPUT_DIRECTORY=/srv/www/html/sites/default/files/browser_output -e DTT_BASE_URL=http://127.0.0.1 drupal ./vendor/bin/phpunit --coverage-clover /srv/www/html/build/logs/clover.xml --debug
         env:
           fail-fast: true
 
+      - name: Copy Coveralls
+        id: copy_coveralls
+        if: success()
+        run: docker cp "$(docker compose -f tests/docker-compose.yml ps -q drupal)":/srv/www/html/build/logs/clover.xml . || echo "skip=true" >> "$GITHUB_OUTPUT"
+
+      - name: Monitor coverage
+        id: coveralls
+        if: ${{ steps.copy_coveralls.outputs.skip != 'true' }}
+        uses: slavcodev/coverage-monitor-action@v1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          coverage_path: "clover.xml"
+          threshold_alert: 0
+          threshold_warning: 50
+          threshold_metric: "lines"
+          comment_footer: false
+
+      - name: Install demo content
+        # Install Demo content if the PR has the label "e2e" or "performance"
+        if: contains(github.event.pull_request.labels.*.name, 'e2e') || contains(github.event.pull_request.labels.*.name, 'performance')
+        id: content
+        uses: cafuego/command-output@main
+        with:
+          run: |
+            docker-compose -f tests/docker-compose.yml exec -T drupal drush -y en unocha_demo_content
+            curl -v http://127.0.0.1:8080/demo
+        env:
+          fail-fast: true
+
+      - name: Set up node
+        # Run Jest e2e tests if the PR has the label "e2e"
+        if: contains(github.event.pull_request.labels.*.name, 'e2e')
+        uses: actions/setup-node@v4
+        with:
+          node-version: '^18.16.1'
+
+      - name: Install node dependencies
+        # Run Jest e2e tests if the PR has the label "e2e"
+        if: contains(github.event.pull_request.labels.*.name, 'e2e')
+        run: |
+          docker compose -f tests/docker-compose.yml exec -w /srv/www drupal sh
+          cd html/themes/custom/common_design_subtheme
+          npm install
+
+      - name: Run e2e tests
+        # Run Jest e2e tests if the PR has the label "e2e"
+        if: contains(github.event.pull_request.labels.*.name, 'e2e')
+        run: |
+          docker compose -f tests/docker-compose.yml exec -w /srv/www drupal sh
+          cd html/themes/custom/common_design_subtheme
+          npm run ci -- -t '^(?!.*Subtheme).*$'
+        env:
+          fail-fast: true
+
+      # - name: Debug Server
+      #   uses: cafuego/command-output@main
+      #   with:
+      #     run: |
+      #       docker ps -a
+
+      - name: Audit URLs using Lighthouse
+      # Run Lighthouse if the PR has the label "performance"
+        if: contains(github.event.pull_request.labels.*.name, 'performance')
+        uses: treosh/lighthouse-ci-action@10.1.0
+        with:
+          urls: |
+            http://127.0.0.1:8080/
+            http://127.0.0.1:8080/demo
+          runs: 3
+          budgetPath: .github/workflows/lighthouse-budget.json # test performance budgets
+          configPath: .github/workflows/lighthouserc.js
+          uploadArtifacts: true # save results as an action artifacts
+          temporaryPublicStorage: true # upload lighthouse report to the temporary storage
+
+      - name: DB Logs
+        id: dblog
+        if: failure()
+        uses: cafuego/command-output@main
+        with:
+          run: |
+            docker compose -f tests/docker-compose.yml exec -T drupal drush watchdog:show
+
       - name: Find Comment
         uses: peter-evans/find-comment@v2
         if: ${{ !env.ACT }}

README.md

@@ -1,6 +1,6 @@
-# Common Design Demo | [![Build Status](https://travis-ci.com/UN-OCHA/common-design-site.svg?branch=master)](https://travis-ci.com/UN-OCHA/common-design-site)
+# Common Design Demo
 
-This is the Common Design Drupal 8 site. The code for this project is managed with composer.
+This is the Common Design Drupal 10 site. The code for this project is managed with composer.
 
 To install security updates for Drupal, run `composer update drupal/core drupal/core-dev --with-dependencies`.
 
@@ -29,9 +29,11 @@ and stage_file_proxy.
 
 ### Remote
 
-Automatic testing is run via Travis CI. Code syntax, style and quality are inspected.
+Automatic testing is run via GitHub Actions.
+Code syntax, style and quality are inspected by default, based on [drupal-starterkit run-tests.yml](https://github.com/UN-OCHA/drupal-starterkit/blob/develop/.github/workflows/run-tests.yml)
 
-With a small alteration, these tests could run via GitHub Actions.
+To run Lighthouse tests, add the label "performance" to the PR.
+To run end-to-end test with Jest, add the label "e2e" to the PR.
 
 ### Locally
 
@@ -79,3 +81,31 @@ fin composer outdated drupal/*
 fin composer update drupal/* --with-dependencies
 fin drush updb -y && fin drush cr
 ```
+
+### Set up with local stack
+See [/local/README](https://github.com/UN-OCHA/common-design-site/tree/develop/local)
+
+##  Performance or e2e tests with Github Actions
+Optional test steps - see `run-tests.yml`
+
+Custom Github labels need to be applied to the PR for the above test steps to run: `performance` or `e2e` depending.
+
+### Install demo content
+
+Enables unocha_demo_content module and imports nodes, menu items etc from json, set the frontpage
+
+### Set up node
+
+Github action to install node
+
+### Install node dependencies
+
+In sub theme, install packages including Jest for e2e
+
+### Run e2e tests
+
+Runs Jest e2e tests in sub theme using as ci at http://127.0.0.1:8080
+
+### Audit URLs using Lighthouse
+
+Runs multiple times on 2 URLS (http://127.0.0.1:8080 and http://127.0.0.1:8080/demo) against a performance budget and provides temporary links to Lighthouse reports.

assets/docker-build-image.yml

@@ -0,0 +1,31 @@
+name: Build docker image
+
+on:
+  push:
+    branches:
+      - develop
+      - 'feature/**'
+      - main
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Build
+      id: build-action
+      uses: UN-OCHA/actions/drupal-docker-build@main
+      with:
+        aws_access_key_id: ${{ secrets.ECR_AWS_ACCESS_KEY_ID }}
+        aws_secret_access_key: ${{ secrets.ECR_AWS_ACCESS_KEY_ID }}
+        docker_registry_url: public.ecr.aws
+        docker_registry_path: /unocha/
+        docker_image: starterkit-site
+        docker_username: ${{ secrets.ECR_AWS_ACCESS_KEY_ID }}
+        docker_password: ${{ secrets.ECR_AWS_SECRET_ACCESS_KEY }}
+        ecr_github_token: ${{ secrets.ECR_GITHUB_TOKEN }}
+        ecr_jenkins_token: ${{ secrets.JENKINS_ECR_TOKEN }}
+        slack_bot_token: ${{ secrets.SLACK_BOT_TOKEN }}
+        slack_channel_name: ${{ secrets.SLACK_CHANNEL }}

assets/robots.txt.append

@@ -0,0 +1 @@
+# Sitemap