UHF-11523: Test for emergency site static version generation

[wktohesi]

UHF-11523

What was done

• Adds a Playwright test for emergency site static version generation.
  • The logic is to make sure a new news item appears on the static version.

How to install

Set up emergency site instance

• Make sure your emergency site instance is up and running latest version of dev-branch
  • git checkout dev && git pull origin dev
  • make fresh
• Switch to feature branch
  • git fetch && git checkout UHF-11523
• Update the Helfi Platform config
  • composer require drupal/helfi_platform_config:dev-UHF-11523
• Run code updates
  • composer install
  • make drush-deploy drush-locale-update drush-cr
• Simulate changes in drupal-helfi-platform
  • Add the following to your local.settings.php:

$test_account = [
  "username" => "drupal_e2e_user",
  "password" => "drupal_e2e_password",
  "roles" => [
    "admin",
  ],
];
$config['helfi_api_base.api_accounts']['accounts'][] = $test_account;
$config['helfi_platform_config.e2e_test_users']['users'][] = array_intersect_key($test_account, [
  "username" => TRUE,
]);

• Then run drush helfi:post-deploy

Set up e2e testing local environment

• Get the feature branch
  • git fetch && git checkout UHF-11523
• Install the testing tools
  • nvm use && npm i
• Update .env (see .env.example) and make sure you have these new variables (also make sure username and password for DRUPAL_E2E_USER match the ones in local.settings.php in your emergency site instance):

EMERGENCY_SITE_BASE_URL="https://emergency-site.docker.so"
EMERGENCY_SITE_STATIC_URL="https://poikkeustilanne.stage.hel.ninja"
APP_DEBUG=TRUE
DRUPAL_E2E_USER='{"username": "drupal_e2e_user", "password": "drupal_e2e_password"}'

How to test

• Run the test npx playwright test --project=emergency-site
  • Test should run successfully until it starts waiting for the static version update. There's no static site generation available for local environment, so the test keeps polling for the static site staging, and will never pass unless we add an item there manually (there's an optional step for this below)
  • You should see debug output like
    Drupal news item URL: https://emergency-site.docker.so/en/news/test-news-062bopbm7xwu1768831869236
Static news item URL: https://poikkeustilanne.stage.hel.ninja/en/news/test-news-062bopbm7xwu1768831869236.html
  • Go to https://emergency-site.docker.so/en; you should see a test news item with a title that matches the url alias of the above debug output
• OPTIONAL: Add a similar news item to emergency site staging to allow the test to pass
  • Go to https://emergency-site.stage.hel.ninja/en
  • Log in to drupal by following the instructions in https://helsinkisolutionoffice.atlassian.net/wiki/spaces/HEL/pages/9825353830/Poikkeustilannesivusto#Poikkeustilannesivuston-lokit and then instead of running the podman command for logs output, run podman exec drupal drush uli to get a login link.
  • Add a new news item with a title that matches the debug output path alias, so "Test news " + the random string. Make it public and save.
  • Then clear all the caches through admin UI (staging does not yet clear the frontpage caches on new news items)
  • Check the static html generation pipeline at https://dev.azure.com/City-of-Helsinki/emergency-site/_build?definitionId=3357 ; a new pipeline run should've been triggered from adding the news item. If not, trigger it manually from https://emergency-site.stage.hel.ninja/en/admin/config/services/static-trigger
  • Wait until static html generation has reached the step "Purging cache". This step can take up to 45 minutes to pass, but the static html version of the news item should already be live. Check the previously started test run on your local; it should now have been passed.
• Check that the code follows our standards

Links to related PRs

• UHF-11523: Drupal user for e2e tests drupal-helfi-platform#371
• UHF-11523: TFA handling for e2e test users drupal-helfi-platform-config#1187
• UHF-11523: Adding cahce tags for crisis news paragraph drupal-emergency-site#230

[khalima]

Excellent! 🚀