Prepare testing with profiles

.github/workflows/testing.js.yml

@@ -25,6 +25,13 @@ on:
 
 jobs:
   testing:
+    strategy:
+      # Each job needs its own backend. Running backends in parallel requires using differnt ports.
+      matrix:
+        selection: [
+          'default',
+          'xml-storage'
+        ]
     name: Unit tests
     runs-on: ubuntu-latest
 
@@ -86,8 +93,8 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-cypress-
 
-      - name: Set Cypress environment variables
-        run: cp cypress.env.json.cicd cypress.env.json
+      - name: Choose tests to run - choice is ${{ matrix.selection }}
+        run: sed "s|SELECTION|\"selection\":\"${{ matrix.selection }}\",|g" cypress.env.json.cicd.template > cypress.env.json
         working-directory: ladybug-frontend
 
       - name: Run linter
@@ -117,6 +124,9 @@ jobs:
         run: echo "maven.skip.javadoc=true" >> frank-runner/specials/ladybug/build.properties
       - name: Set property to skip checking licenses
         run: echo "maven.skip.copyright=true" >> frank-runner/specials/ladybug/build.properties
+      - name: Choose Spring profile storage.xml if matrix.selection is 'xml-storage'
+        run: echo "spring.profiles.active=storage.xml" >> frank-runner/specials/ladybug/build.properties
+        if: ${{ matrix.selection == 'xml-storage' }}
       - name: Set port where ladybug-test-webapp is served
         run: echo "tomcat.connector.port=8090" > frank-runner/build.properties
       - name: Prevent Java exception about binding port 443 (for https)
@@ -205,52 +215,57 @@ jobs:
       - name: Show files
         run: tree -d -L 5 .
         if: always()
-
+      - name: Store cypress.env.json
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: cypress.env.json ${{ matrix.selection }}
+          path: ladybug-frontend/cypress.env.json
       - name: Store log of Frank!Runner downloads
         uses: actions/upload-artifact@v4
         if: always()
         with:
-          name: installFrankRunnerEnv.log
+          name: installFrankRunnerEnv.log ${{ matrix.selection }}
           path: frank-runner/installFrankRunnerEnv.log
       - name: Store log of starting the server with the Frank!Runner
         uses: actions/upload-artifact@v4
         if: always()
         with:
-          name: serverStartLog.log
+          name: serverStartLog.log ${{ matrix.selection }}
           path: frank-runner/specials/ladybug/serverStartLog.log
       - name: Store build.properties
         uses: actions/upload-artifact@v4
         if: always()
         with:
-          name: specials_build.properties
+          name: specials_build.properties ${{ matrix.selection }}
           path: frank-runner/specials/ladybug/build.properties
       - name: Store Apache Tomcat log
         uses: actions/upload-artifact@v4
         if: always()
         with:
-          name: logs
+          name: logs ${{ matrix.selection }}
           path: frank-runner/build/*/logs/*
       - name: Store Cypress screenshots
         uses: actions/upload-artifact@v4
         if: always()
         with:
-          name: screenshots
+          name: screenshots ${{ matrix.selection }}
           path: ladybug-frontend/cypress/screenshots/
       - name: Store Cypress videos
         uses: actions/upload-artifact@v4
         if: always()
         with:
-          name: videos
+          name: videos ${{ matrix.selection }}
           path: ladybug-frontend/cypress/videos/
       - name: Store Cypress screenshots for Firefox
         uses: actions/upload-artifact@v4
         if: always()
         with:
-          name: Firefix screenshots
+          name: Firefix screenshots ${{ matrix.selection }}
           path: ladybug-frontend/cypress/firefox/screenshots/
       - name: Store Cypress videos for Firefox
         uses: actions/upload-artifact@v4
         if: always()
         with:
-          name: Firefox videos
+          name: Firefox videos ${{ matrix.selection }}
           path: ladybug-frontend/cypress/firefox/videos/

cypress.config.ts

@@ -2,10 +2,6 @@ import { defineConfig } from 'cypress';
 
 export default defineConfig({
   trashAssetsBeforeRuns: false,
-  env: {
-    backendServer: 'http://localhost:80',
-    FILESEP: '\\',
-  },
   e2e: {
     baseUrl: 'http://localhost:4200',
     excludeSpecPattern: ['**/cypress/e2e/1-getting-started/**', '**/cypress/e2e/2-advanced-examples/**'],

cypress.env.json

@@ -0,0 +1,5 @@
+{
+    "backendServer": "http://localhost:80",
+    "FILESEP": "\\",
+    "selection":"default"
+}

cypress.env.json.cicd → cypress.env.json.cicd.template

@@ -1,4 +1,5 @@
 {
+    SELECTION
     "backendServer": "http://localhost:8090",
     "FILESEP": "/"
 }

cypress/e2e/1 about-xml-storage.cy.ts

@@ -0,0 +1,25 @@
+// This test should be run as the first. Other tests
+// have to delete all reports from the test tab and
+// would remove pre-existing reports.
+//
+// Furthermore, we need an empty test tab in case
+// there are no predefined reports.
+//
+describe('Compare with and without profile xml.storage', () => {
+  beforeEach(() => {
+    cy.initializeApp();
+    cy.navigateToTestTabAndInterceptApiCall();
+  })
+
+  if(Cypress.env('selection') === "xml-storage") {
+    it('Report present in src/test/testtool should be shown', () => {
+      cy.getTestTableRows().contains('Pre existing report').should('have.length', 1)
+    })
+  } else {
+    it('Report present in src/test/testtool should not be shown', () => {
+      // We cannot search for 'Pre existing report' within the
+      // test rows when there are not table rows at all.
+      cy.getTestTableRows().should('not.exist')
+    })
+  }
+})

cypress/e2e/checks.cy.ts

@@ -0,0 +1,4 @@
+describe('Checks of the test environment', () => {
+  it('Environment \'selection\' is: ' + Cypress.env('selection'), () => {
+  })
+})

cypress/e2e/copying.cy.ts

@@ -1,4 +1,11 @@
+import { showSkipped } from "cypress/support/commands";
+
 describe('Tests about copying', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
+
   before(() => {
     cy.resetApp();
   });

cypress/e2e/debug/aboutOpenedReports.cy.ts

@@ -1,4 +1,11 @@
+import { showSkipped } from "cypress/support/commands";
+
 describe('About opened reports', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
+
   before(() => cy.resetApp());
 
   beforeEach(() => {

cypress/e2e/debug/clickingInTableOpensReport.cy.ts

@@ -1,4 +1,11 @@
+import { showSkipped } from "cypress/support/commands";
+
 describe('Clicking a report', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
+
   before(() => {
     cy.resetApp();
   });

cypress/e2e/debug/custom-editor.cy.ts

@@ -1,4 +1,11 @@
+import { showSkipped } from "cypress/support/commands";
+
 describe('Tests for custom editor in debug tab', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
+
   before(() => cy.resetApp());
 
   beforeEach(() => {

cypress/e2e/debug/deleteReports.cy.ts

@@ -1,4 +1,11 @@
+import { showSkipped } from "cypress/support/commands";
+
 describe('About deleting reports', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
+
   beforeEach(() => {
     cy.resetApp()
   });

cypress/e2e/debug/fileupload.cy.ts

@@ -1,4 +1,11 @@
+import { showSkipped } from "cypress/support/commands";
+
 describe('Debug file upload', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
+
   before(() => cy.resetApp());
 
   beforeEach(() => {

cypress/e2e/debug/filterTable.cy.ts

@@ -1,4 +1,11 @@
+import { showSkipped } from "cypress/support/commands";
+
 describe('Tests for table filter', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
+
   before(() => cy.resetApp());
 
   beforeEach(() => {

cypress/e2e/debug/labels.cy.ts

@@ -1,4 +1,11 @@
+import { showSkipped } from "cypress/support/commands";
+
 describe('Test labels', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
+
   before(() => cy.resetApp());
 
   afterEach(() => {

cypress/e2e/debug/refresh.cy.ts

@@ -1,4 +1,11 @@
+import { showSkipped } from "cypress/support/commands";
+
 describe('Refresh', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
+
   before(() => {
     cy.resetApp();
   });

cypress/e2e/debug/reportGenerator.cy.ts

@@ -1,4 +1,11 @@
+import { showSkipped } from "cypress/support/commands";
+
 describe('Report generator', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
+
   before(() => cy.resetApp());
 
   beforeEach(() => {

cypress/e2e/debug/runningReports.cy.ts

@@ -1,4 +1,11 @@
+import { showSkipped } from "cypress/support/commands";
+
 describe('Test running reports', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
+
   before(() => cy.resetApp());
 
   afterEach(() => cy.resetApp());
@@ -10,6 +17,11 @@ describe('Test running reports', () => {
 });
 
 describe('With running reports', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
+
   before(() => {
     cy.resetApp();
     cy.createRunningReport();
@@ -42,6 +54,11 @@ describe('With running reports', () => {
 });
 
 describe('Test Reports in progress warning', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
+
   beforeEach(() => {
     cy.createRunningReport();
     cy.request(Cypress.env('backendServer') + '/index.jsp?setReportInProgressThreshold=1').then((resp) => {

cypress/e2e/debug/settings-component.cy.ts

@@ -1,4 +1,11 @@
+import { showSkipped } from "cypress/support/commands";
+
 describe('Tests for settings component', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
+
   before(() => cy.resetApp());
 
   beforeEach(() => {

cypress/e2e/debug/show-warnings-and-errors.cy.ts

@@ -1,4 +1,11 @@
+import { showSkipped } from "cypress/support/commands";
+
 describe('Tests for showing errors and warnings', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
+
   it('should show errors that occur for the storage of the current view', () => {
     cy.initializeApp();
     const apiCallAlias: string = 'warningsAndErrors';

cypress/e2e/debug/table.cy.ts

@@ -1,4 +1,11 @@
+import { showSkipped } from "cypress/support/commands";
+
 describe('Tests for Debug tab table', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
+
   before(() => cy.resetApp());
 
   beforeEach(() => {

cypress/e2e/debug/toast.cy.ts

@@ -1,4 +1,11 @@
+import { showSkipped } from "cypress/support/commands";
+
 describe('Test toast window', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
+
   before(() => cy.resetApp());
 
   beforeEach(() => cy.initializeApp());

cypress/e2e/debug/transformation.cy.ts

@@ -1,4 +1,11 @@
+import { showSkipped } from "cypress/support/commands";
+
 describe('Tests for report transformation', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
+
   before(() => cy.resetApp());
 
   afterEach(() => cy.resetApp());

cypress/e2e/keep_state.cy.ts

@@ -1,4 +1,10 @@
+import { showSkipped } from "cypress/support/commands";
+
 describe('Tests for keeping state in tabs when switching tabs', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
 
   beforeEach(() => {
     cy.createReport();

cypress/e2e/test/testtab.cy.ts

@@ -1,4 +1,11 @@
+import { showSkipped } from "cypress/support/commands";
+
 describe('Test the Test tab', () => {
+  if(Cypress.env('selection') !== "default") {
+    showSkipped()
+    return
+  }
+
   before(() => {
     cy.resetApp();
   });