Tests - Migrate to expectParametersToContain for permalink and viewpo…

…rt, and sme cleaning
3liz · Feb 4, 2025 · dbe225b · dbe225b
1 parent 916552a
commit dbe225b
Show file tree

Hide file tree

Showing 5 changed files with 96 additions and 62 deletions.
diff --git a/tests/README.md b/tests/README.md
@@ -262,6 +262,10 @@ You can then :
 
 You can also install the handy [Playwright extension](https://marketplace.visualstudio.com/items?itemName=ms-playwright.playwright) on VSCode.
 
+#### Writing tests
+
+A tests doing only a **read-only** on Lizmap must be tagged as `@readonly`, otherwise, it must be tagged `@write`.
+
 ### Artifacts
 
 When GitHub Action is failing, all screenshots and downloaded files are uploaded in an ZIP.

diff --git a/tests/end2end/playwright/permalink.spec.js b/tests/end2end/playwright/permalink.spec.js
@@ -1,6 +1,6 @@
 // @ts-check
 import { test, expect } from '@playwright/test';
-import { gotoMap, reloadMap } from './globals';
+import {expectParametersToContain, gotoMap, reloadMap} from './globals';
 
 test.describe('Permalink', () => {
 
@@ -721,18 +721,20 @@ test.describe('BBox parameter', () => {
         const getMapPromise = page.waitForRequest(/GetMap/);
         await page.getByLabel('sousquartiers').check();
         const getMapRequest = await getMapPromise;
-        const getMapUrl = getMapRequest.url();
-        expect(getMapUrl).toContain('SERVICE=WMS');
-        expect(getMapUrl).toContain('VERSION=1.3.0');
-        expect(getMapUrl).toContain('REQUEST=GetMap');
-        expect(getMapUrl).toContain('FORMAT=image%2Fpng');
-        expect(getMapUrl).toContain('TRANSPARENT=TRUE');
-        expect(getMapUrl).toContain('LAYERS=sousquartiers');
-        expect(getMapUrl).toContain('CRS=EPSG%3A2154');
-        expect(getMapUrl).toContain('STYLES=d%C3%A9faut');
-        expect(getMapUrl).toContain('WIDTH=958');
-        expect(getMapUrl).toContain('HEIGHT=633');
-        expect(getMapUrl).toMatch(/BBOX=762375.04\d+%2C6277986.97\d+%2C775048.61\d+%2C6286361.05\d+/);
+        const expectedParameters = {
+            'SERVICE': 'WMS',
+            'VERSION': '1.3.0',
+            'REQUEST': 'GetMap',
+            'FORMAT': /image\/png/, // "image/png; mode=8bit"
+            'TRANSPARENT': /\b(\w*^true$\w*)\b/gmi,
+            'LAYERS': 'sousquartiers',
+            'CRS': 'EPSG:2154',
+            'STYLES': 'défaut',
+            'WIDTH': '958',
+            'HEIGHT': '633',
+            'BBOX': /762375.04\d+,6277986.97\d+,775048.61\d+,6286361.05\d+/,
+        }
+        await expectParametersToContain('GetMap', getMapRequest.url(), expectedParameters);
 
         // Check Permalink tool
         const new_share_value = await page.locator('#input-share-permalink').inputValue();
@@ -768,18 +770,20 @@ test.describe('BBox parameter', () => {
         const getMapPromise = page.waitForRequest(/GetMap/);
         await page.getByLabel('sousquartiers').check();
         const getMapRequest = await getMapPromise;
-        const getMapUrl = getMapRequest.url();
-        expect(getMapUrl).toContain('SERVICE=WMS');
-        expect(getMapUrl).toContain('VERSION=1.3.0');
-        expect(getMapUrl).toContain('REQUEST=GetMap');
-        expect(getMapUrl).toContain('FORMAT=image%2Fpng');
-        expect(getMapUrl).toContain('TRANSPARENT=TRUE');
-        expect(getMapUrl).toContain('LAYERS=sousquartiers');
-        expect(getMapUrl).toContain('CRS=EPSG%3A2154');
-        expect(getMapUrl).toContain('STYLES=d%C3%A9faut');
-        expect(getMapUrl).toContain('WIDTH=958');
-        expect(getMapUrl).toContain('HEIGHT=633');
-        expect(getMapUrl).toMatch(/BBOX=762375.04\d+%2C6277986.97\d+%2C775048.61\d+%2C6286361.05\d+/);
+        const expectedParameters = {
+            'SERVICE': 'WMS',
+            'VERSION': '1.3.0',
+            'REQUEST': 'GetMap',
+            'FORMAT': /image\/png/, // "image/png; mode=8bit"
+            'TRANSPARENT': /\b(\w*^true$\w*)\b/gmi,
+            'LAYERS': 'sousquartiers',
+            'CRS': 'EPSG:2154',
+            'STYLES': 'défaut',
+            'WIDTH': '958',
+            'HEIGHT': '633',
+            'BBOX': /762375.04\d+,6277986.97\d+,775048.61\d+,6286361.05\d+/,
+        }
+        await expectParametersToContain('GetMap', getMapRequest.url(), expectedParameters);
 
         // Check Permalink tool
         const new_share_value = await page.locator('#input-share-permalink').inputValue();

diff --git a/tests/end2end/playwright/project_load_warning.spec.js b/tests/end2end/playwright/project_load_warning.spec.js
@@ -2,7 +2,11 @@
 import { test, expect } from '@playwright/test';
 import { ProjectPage } from './pages/project';
 
-test.describe('Project warnings in CFG as admin', () => {
+test.describe('Project warnings in CFG as admin',
+    {
+        tag: ['@readonly'],
+    }, () => {
+
     test.use({ storageState: 'playwright/.auth/admin.json' });
 
     test('Visit map with a warning', async ({ page }) => {
@@ -13,7 +17,10 @@ test.describe('Project warnings in CFG as admin', () => {
 
 });
 
-test.describe('Project warnings in CFG as anonymous', () => {
+test.describe('Project warnings in CFG as anonymous',
+    {
+        tag: ['@readonly'],
+    }, () => {
 
     test('Visit map without a warning', async ({ page }) => {
         const project = new ProjectPage(page, 'project_cfg_warnings');

diff --git a/tests/end2end/playwright/qgis-request.spec.js b/tests/end2end/playwright/qgis-request.spec.js
@@ -8,8 +8,11 @@ test.describe('QGIS Requests', () => {
         await gotoMap(url, page)
 
         const single = await page.evaluate(async () => {
-            return await fetch("/index.php/lizmap/service?repository=testsrepository&project=layer_legends&SERVICE=WMS&VERSION=1.3.0&REQUEST=GetLegendGraphic&LAYER=layer_legend_single_symbol&STYLE=&EXCEPTIONS=application/vnd.ogc.se_inimage&FORMAT=application/json&TRANSPARENT=TRUE&DPI=96")
-                .then(r => r.ok ? r.json() : Promise.reject(r))
+            return await fetch(
+                "/index.php/lizmap/service?repository=testsrepository&project=layer_legends&" +
+                "SERVICE=WMS&VERSION=1.3.0&REQUEST=GetLegendGraphic&LAYER=layer_legend_single_symbol&STYLE=&" +
+                "EXCEPTIONS=application/vnd.ogc.se_inimage&FORMAT=application/json&TRANSPARENT=TRUE&DPI=96"
+            ).then(r => r.ok ? r.json() : Promise.reject(r))
         })
         // check root
         expect(single.nodes).toHaveLength(1)
@@ -23,8 +26,11 @@ test.describe('QGIS Requests', () => {
         expect(singleNode.symbols).toBeUndefined()
 
         const categorized = await page.evaluate(async () => {
-            return await fetch("/index.php/lizmap/service?repository=testsrepository&project=layer_legends&SERVICE=WMS&VERSION=1.3.0&REQUEST=GetLegendGraphic&LAYER=layer_legend_categorized&STYLE=&EXCEPTIONS=application/vnd.ogc.se_inimage&FORMAT=application/json&TRANSPARENT=TRUE&DPI=96")
-                .then(r => r.ok ? r.json() : Promise.reject(r))
+            return await fetch(
+                "/index.php/lizmap/service?repository=testsrepository&project=layer_legends&" +
+                "SERVICE=WMS&VERSION=1.3.0&REQUEST=GetLegendGraphic&LAYER=layer_legend_categorized&STYLE=&" +
+                "EXCEPTIONS=application/vnd.ogc.se_inimage&FORMAT=application/json&TRANSPARENT=TRUE&DPI=96"
+            ).then(r => r.ok ? r.json() : Promise.reject(r))
         })
         // check root
         expect(categorized.nodes).toHaveLength(1)
@@ -39,8 +45,11 @@ test.describe('QGIS Requests', () => {
         expect(categorizedNode.symbols).toHaveLength(2)
 
         const group = await page.evaluate(async () => {
-            return await fetch("/index.php/lizmap/service?repository=testsrepository&project=layer_legends&SERVICE=WMS&VERSION=1.3.0&REQUEST=GetLegendGraphic&LAYER=legend_option_test&STYLE=&EXCEPTIONS=application/vnd.ogc.se_inimage&FORMAT=application/json&TRANSPARENT=TRUE&DPI=96")
-                .then(r => r.ok ? r.json() : Promise.reject(r))
+            return await fetch(
+                "/index.php/lizmap/service?repository=testsrepository&project=layer_legends&" +
+                "SERVICE=WMS&VERSION=1.3.0&REQUEST=GetLegendGraphic&LAYER=legend_option_test&STYLE=" +
+                "&EXCEPTIONS=application/vnd.ogc.se_inimage&FORMAT=application/json&TRANSPARENT=TRUE&DPI=96"
+            ).then(r => r.ok ? r.json() : Promise.reject(r))
         })
         // check root
         expect(group.nodes).toHaveLength(1)
@@ -58,8 +67,12 @@ test.describe('QGIS Requests', () => {
         const combined = await page.evaluate(async () => {
             // To get layer_legend_single_symbol first, layer_legend_categorized second and legend_option_test third
             // LAYER parameter has to be the inverse: legend_option_test,layer_legend_categorized,layer_legend_single_symbol
-            return await fetch("/index.php/lizmap/service?repository=testsrepository&project=layer_legends&SERVICE=WMS&VERSION=1.3.0&REQUEST=GetLegendGraphic&LAYER=legend_option_test,layer_legend_categorized,layer_legend_single_symbol&STYLE=&EXCEPTIONS=application/vnd.ogc.se_inimage&FORMAT=application/json&TRANSPARENT=TRUE&DPI=96")
-                .then(r => r.ok ? r.json() : Promise.reject(r))
+            return await fetch(
+                "/index.php/lizmap/service?repository=testsrepository&project=layer_legends&" +
+                "SERVICE=WMS&VERSION=1.3.0&REQUEST=GetLegendGraphic&" +
+                "LAYER=legend_option_test,layer_legend_categorized,layer_legend_single_symbol&STYLE=&" +
+                "EXCEPTIONS=application/vnd.ogc.se_inimage&FORMAT=application/json&TRANSPARENT=TRUE&DPI=96"
+            ).then(r => r.ok ? r.json() : Promise.reject(r))
         })
         // check root
         expect(combined.nodes).toHaveLength(3)

diff --git a/tests/end2end/playwright/viewport.spec.js b/tests/end2end/playwright/viewport.spec.js
@@ -1,6 +1,6 @@
 // @ts-check
 import { test, expect } from '@playwright/test';
-import { gotoMap } from './globals';
+import {expectParametersToContain, gotoMap} from './globals';
 
 test.describe('Viewport devicePixelRatio 1', () => {
     test('Greater than WMS max size', async ({ page }) => {
@@ -206,19 +206,22 @@ test.describe('Viewport standard', () => {
         await page.getByRole('button', { name: 'Zoom in' }).click();
         // Check GetMap request
         let getMapRequest = await getMapPromise;
-        let getMapUrl = getMapRequest.url();
-        expect(getMapUrl).toContain('SERVICE=WMS');
-        expect(getMapUrl).toContain('VERSION=1.3.0');
-        expect(getMapUrl).toContain('REQUEST=GetMap');
-        expect(getMapUrl).toContain('FORMAT=image%2Fpng');
-        expect(getMapUrl).toContain('TRANSPARENT=TRUE');
-        expect(getMapUrl).toContain('LAYERS=world');
-        expect(getMapUrl).toContain('CRS=EPSG%3A3857');
-        expect(getMapUrl).toContain('STYLES=d%C3%A9faut');
-        expect(getMapUrl).toContain('DPI=96');
-        expect(getMapUrl).toContain('WIDTH=958');
-        expect(getMapUrl).toContain('HEIGHT=633');
-        expect(getMapUrl).toMatch(/BBOX=-9373014.15\d+%2C-6193233.77\d+%2C9373014.15\d+%2C6193233.77\d+/);
+        let  expectedParameters = {
+            'SERVICE': 'WMS',
+            'VERSION': '1.3.0',
+            'REQUEST': 'GetMap',
+            'FORMAT': 'image/png',
+            'TRANSPARENT': /\b(\w*^true$\w*)\b/gmi,
+            'LAYERS': 'world',
+            'CRS': 'EPSG:3857',
+            'STYLES': 'défaut',
+            'DPI': '96',
+            'WIDTH': '958',
+            'HEIGHT': '633',
+            'BBOX': /-9373014.15\d+,-6193233.77\d+,9373014.15\d+,6193233.77\d+/,
+        }
+        await expectParametersToContain('GetMap', getMapRequest.url(), expectedParameters);
+
         // Check zoom
         expect(await page.evaluate(() => lizMap.mainLizmap.map.getView().getZoom())).toBe(1);
 
@@ -233,19 +236,22 @@ test.describe('Viewport standard', () => {
         await page.setViewportSize({ width: viewport?.height, height: viewport?.width });
         // Check GetMap request
         getMapRequest = await getMapPromise;
-        getMapUrl = getMapRequest.url();
-        expect(getMapUrl).toContain('SERVICE=WMS');
-        expect(getMapUrl).toContain('VERSION=1.3.0');
-        expect(getMapUrl).toContain('REQUEST=GetMap');
-        expect(getMapUrl).toContain('FORMAT=image%2Fpng');
-        expect(getMapUrl).toContain('TRANSPARENT=TRUE');
-        expect(getMapUrl).toContain('LAYERS=world');
-        expect(getMapUrl).toContain('CRS=EPSG%3A3857');
-        expect(getMapUrl).toContain('STYLES=d%C3%A9faut');
-        expect(getMapUrl).toContain('DPI=96');
-        expect(getMapUrl).toContain('WIDTH=716');
-        expect(getMapUrl).toContain('HEIGHT=909');
-        expect(getMapUrl).toMatch(/BBOX=-7005300.76\d+%2C-8893601.11\d+%2C7005300.76\d+%2C8893601.11\d+/);
+        expectedParameters = {
+            'SERVICE': 'WMS',
+            'VERSION': '1.3.0',
+            'REQUEST': 'GetMap',
+            'FORMAT': 'image/png',
+            'TRANSPARENT': /\b(\w*^true$\w*)\b/gmi,
+            'LAYERS': 'world',
+            'CRS': 'EPSG:3857',
+            'STYLES': 'défaut',
+            'DPI': '96',
+            'WIDTH': '716',
+            'HEIGHT': '909',
+            'BBOX': /-7005300.76\d+,-8893601.11\d+,7005300.76\d+,8893601.11\d+/,
+        }
+        await expectParametersToContain('GetMap', getMapRequest.url(), expectedParameters);
+
         // Check zoom
         expect(await page.evaluate(() => lizMap.mainLizmap.map.getView().getZoom())).toBe(1);