Add e2e_testing env

Author: AdrienClairembault

.github/actions/docker-compose-app-e2e.yml

@@ -0,0 +1,18 @@
+services:
+  app:
+    container_name: "glpi-test-app-e2e"
+    image: "ghcr.io/glpi-project/${PHP_IMAGE:-githubactions-php-apache:8.3}"
+    environment:
+      CODE_COVERAGE: "${CODE_COVERAGE:-false}"
+      CI: true # Will be used to alter some configuration when running on github vs locally.
+      PLAYWRIGHT_BROWSERS_PATH: /opt/pw-browsers # Custom browser path to prevent some rights issues.
+      GLPI_BASE_URL: http://localhost:80 # Default URL for GLPI. Used for e2e tests.
+      PHP: php
+      GLPI_ENVIRONMENT_TYPE: e2e_testing
+    volumes:
+      - type: "bind"
+        source: "${APPLICATION_ROOT}"
+        target: "/var/www/glpi"
+      - type: "bind"
+        source: "${APP_CONTAINER_HOME}"
+        target: "/home/www-data"

.github/actions/docker-compose-app.yml

@@ -4,9 +4,6 @@ services:
     image: "ghcr.io/glpi-project/${PHP_IMAGE:-githubactions-php-apache:8.3}"
     environment:
       CODE_COVERAGE: "${CODE_COVERAGE:-false}"
-      CI: true # Will be used to alter some configuration when running on github vs locally.
-      PLAYWRIGHT_BROWSERS_PATH: /opt/pw-browsers # Custom browser path to prevent some rights issues.
-      GLPI_BASE_URL: http://localhost:80 # Default URL for GLPI. Used for e2e tests.
     volumes:
       - type: "bind"
         source: "${APPLICATION_ROOT}"

.github/workflows/ci.yml

@@ -283,7 +283,7 @@ jobs:
     runs-on: "ubuntu-latest"
     timeout-minutes: 60
     env:
-      COMPOSE_FILE: ".github/actions/docker-compose-app.yml:.github/actions/docker-compose-services.yml"
+      COMPOSE_FILE: ".github/actions/docker-compose-app-e2e.yml:.github/actions/docker-compose-services.yml"
       APPLICATION_ROOT: "${{ github.workspace }}"
       DB_IMAGE: "githubactions-mariadb:10.11"
       PHP_IMAGE: "githubactions-php-apache:8.3"

.gitignore

@@ -58,3 +58,5 @@ ctrf/
 /playwright/.cache/
 /tests/playwright/.env.local
 !/tests/playwright/.env
+/tests/playwright/glpi_config/*
+/tests/playwright/glpi_files/*

Makefile

@@ -23,7 +23,7 @@ help: ## Show this help message
 	@grep -E '(^[a-zA-Z_-]+:.*?##.*$$)|(^##)' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-25s\033[0m %s\n", $$1, $$2}' | sed -e 's/\[32m##/[33m/'
 .PHONY: help
 
-install: init-override build up vendor db-install test-db-install ## Install the project
+install: init-override build up vendor db-install test-db-install e2e-db-install ## Install the project
 .PHONY: install
 
 ## —— Docker ———————————————————————————————————————————————————————————————————
@@ -119,8 +119,31 @@ test-db-update: ## Update testing's database
 		-n \
 		--allow-unstable \
 		--force \
-		--skip-db-checks
-.PHONY: db-update
+		--skip-db-checks \
+		--env=testing
+.PHONY: test-db-update
+
+e2e-db-install: ## Install e2e testing's database
+	@$(CONSOLE) database:install \
+		-r -f \
+		--db-host=db \
+		--db-port=3306 \
+		--db-name=glpi_e2e \
+		--db-user=root \
+		--db-password=glpi \
+		--no-interaction \
+		--no-telemetry \
+		--env=e2e_testing
+.PHONY: e2e-db-install
+
+e2e-db-update: ## Update e2e testing's database
+	@$(CONSOLE) database:update \
+		-n \
+		--allow-unstable \
+		--force \
+		--skip-db-checks  \
+		--env=e2e_testing
+.PHONY: e2e-db-update
 
 ## —— Dependencies —————————————————————————————————————————————————————————————
 composer: ## Run a composer command, example: make composer c='require mypackage/package'

docker-compose.yaml

@@ -11,6 +11,7 @@ services:
       - "custom_php_ini:/usr/local/etc/php/custom_conf.d/:rw"
     ports:
       - "8080:80"
+      - "8090:8090"
       - "9637:9637"
     depends_on:
       - db

install/empty_data.php

@@ -75,9 +75,9 @@ public function getEmptyData(): array
         $tables = [];
 
         // API need to be enabled to ease e2e testing
-        $add_e2e_data = Environment::get()->shouldAddExtraE2EDataDuringInstallation();
-        $enable_api = $add_e2e_data ? "1" : "0";
-        $enable_api_login_credentials = $add_e2e_data ? "1" : "0";
+        $add_cypress_data = Environment::get()->shouldAddExtraCypressDataDuringInstallation();
+        $enable_api = $add_cypress_data ? "1" : "0";
+        $enable_api_login_credentials = $add_cypress_data ? "1" : "0";
 
         $tables['glpi_apiclients'] = [
             [
@@ -9422,7 +9422,7 @@ public function getEmptyData(): array
         ];
 
         // Test environment data
-        if ($add_e2e_data) {
+        if ($add_cypress_data) {
             $root_entity = array_filter($tables['glpi_entities'], static fn($e) => $e['id'] === 0);
             $root_entity = current($root_entity);
 

playwright.config.ts

@@ -3,6 +3,7 @@ import { config } from 'dotenv' ;
 import { Config } from './tests/playwright/utils/Config';
 
 // Load .env file so it is available everywhere.
+config({path: './tests/playwright/.env'});
 config({path: './tests/playwright/.env.local'});
 
 /**

src/Glpi/Application/Environment.php

@@ -58,6 +58,13 @@ enum Environment: string
      */
     case TESTING = 'testing';
 
+    /**
+     * E2E Testing environment.
+     * Separate from testing as it commit data to the database which may interfere
+     * with regular tests that expect a static database.
+     */
+    case E2E_TESTING = 'e2e_testing';
+
     /**
      * Development environment.
      * Suitable for developer machines and development servers.
@@ -151,6 +158,16 @@ public function getConstantsOverride(string $root_dir): array
                     $root_dir . '/tests/fixtures/plugins',
                 ],
             ],
+            self::E2E_TESTING => [
+                'GLPI_CONFIG_DIR'          => $root_dir . '/tests/playwright/glpi_config',
+                'GLPI_VAR_DIR'             => $root_dir . '/tests/playwright/glpi_files',
+                'GLPI_LOG_LVL'             => LogLevel::DEBUG,
+                'GLPI_STRICT_ENV'          => true,
+                'GLPI_PLUGINS_DIRECTORIES' => [
+                    $root_dir . '/tests/fixtures/plugins',
+                ],
+
+            ],
             self::DEVELOPMENT => [
                 'GLPI_LOG_LVL'                       => LogLevel::DEBUG,
                 'GLPI_STRICT_ENV'                    => true,
@@ -169,7 +186,11 @@ public function shouldExpectResourcesToChange(string $root_dir = GLPI_ROOT): boo
         // Only production/staging environment are considered as environments
         // where resources are not supposed to change.
         // In others environments, we must match for changes.
-        if ($this === self::TESTING || $this === self::DEVELOPMENT) {
+        if (
+            $this === self::TESTING
+            || $this === self::DEVELOPMENT
+            || $this === self::E2E_TESTING
+        ) {
             return true;
         }
 
@@ -212,7 +233,7 @@ public function shouldEnableExtraDevAndDebugTools(): bool
         };
     }
 
-    public function shouldAddExtraE2EDataDuringInstallation(): bool
+    public function shouldAddExtraCypressDataDuringInstallation(): bool
     {
         // Note: this will be removed when we switch to playwright.
         return match ($this) {

tests/playwright/.env

@@ -1,11 +1,11 @@
 # Copy this file as .env.local and set your own values if needed.
 
 # GLPI base URL
-GLPI_BASE_URL="http://localhost:80"
+GLPI_BASE_URL="http://localhost:8090" # Should be an url leading to a GLPI server running in the "e2e_testing" environment
 
 # PHP executable
-PHP="php"
-# PHP="docker compose exec app php" # Use this instead if you use docker
+PHP="docker compose exec app php"
+# PHP="php" # If you don't use the official docker image, you may use this instead docker
 
 # Disable web report being automatically opened on failure
 # PW_TEST_HTML_REPORT_OPEN='never'