graphdb-workbench-tests 3.4.0-TR4 → 3.4.0-TR5

package/support/{index.js → e2e.js}

@@ -23,16 +23,23 @@ import 'cypress-real-events';
 import 'cypress-file-upload';
 import {LicenseStubs} from "../stubs/license-stubs";
 import {SecurityStubs} from "../stubs/security-stubs";
+// https://github.com/bahmutov/cypress-code-coverage
+import '@bahmutov/cypress-code-coverage/support';
 
 // Configures an environment variable with the key used for common actions (cmd on mac, ctrl on other OS).
 // This variable must be used in all actions that type e.g. ctrl-a to select text.
 Cypress.env('modifierKey', Cypress.platform === 'darwin' ? '{cmd}' : '{ctrl}');
 
-require('cypress-failed-log');
-require('cypress-terminal-report/src/installLogsCollector')();
+import 'cypress-failed-log';
+import * as ctr from 'cypress-terminal-report/src/installLogsCollector';
+const installLogsCollector = ('default' in ctr) ? ctr.default : ctr;
+installLogsCollector();
 
 // We don't want any tests to hit real Google
 beforeEach(() => {
+    // Ensure no pre-set repository leaks between specs
+    cy.unsetRepository();
+
     LicenseStubs.stubGoogleCalls();
     // This env variable is set globally in the cypress.config.js and
     // can be changed from within the spec files if needed like this
@@ -44,6 +51,5 @@ beforeEach(() => {
         // for some reason.
         // It'll be good to investigate it a bit sometime.
         SecurityStubs.stubGetAdminUser();
-        // SecurityStubs.stubUpdateUserData('admin');
     }
 });

package/support/repository-commands.js

@@ -3,7 +3,7 @@ import repoTemplate from '../fixtures/repo-template.json';
 export const REPOSITORIES_URL = '/rest/repositories';
 const AUTOCOMPLETE_URL = '/rest/autocomplete/';
 
-const PRESET_REPO = 'ls.repository-id';
+const PRESET_REPO = 'ontotext.gdb.repository.selectedRepository';
 
 Cypress.Commands.add('createRepository', (options = {}) => {
     cy.request({
@@ -15,10 +15,13 @@ Cypress.Commands.add('createRepository', (options = {}) => {
         }
     }).then((response) => {
         cy.waitUntil(() => response && response.status === 201); // 201 Created
+        cy.log('Created repository with ID:', options.id);
     });
 });
 
 Cypress.Commands.add('deleteRepository', (id, secured = false) => {
+    // unset the repository before delete to avoid missing repo errors
+    unsetRepository();
     // Note: Going through /rest/repositories because it would not fail if the repo is missing
     const url = REPOSITORIES_URL + '/' + id;
 
@@ -39,14 +42,29 @@ Cypress.Commands.add('deleteRepository', (id, secured = false) => {
             headers,
         // Prevent Cypress from failing the test on non-2xx status codes
             failOnStatusCode: false
-        });
+        }).then((response) => {
+        cy.waitUntil(() => response);
+    });
 });
 
 Cypress.Commands.add('presetRepository', (id) => {
-    cy.setLocalStorage('ls.repository-id', id);
+    cy.setLocalStorage(PRESET_REPO, JSON.stringify({id: id, location: ''}));
+    cy.waitUntil(() =>
+        cy.getLocalStorage(PRESET_REPO)
+            .then((preset) => {
+                const presetRepo = JSON.parse(preset);
+                return presetRepo && presetRepo.id === id
+            }));
+    cy.log('Pre-set repository:', id);
+});
+
+Cypress.Commands.add('unsetRepository', () => {
+    cy.removeLocalStorage(PRESET_REPO);
     cy.waitUntil(() =>
         cy.getLocalStorage(PRESET_REPO)
-            .then((preset) => preset && preset === id));
+            .then((preset) => {
+                return !preset;
+            }));
 });
 
 /**
@@ -78,6 +96,8 @@ Cypress.Commands.add('getNamespaces', (id) => {
     });
 });
 
+Cypress.Commands.add('unsetRepository', () => unsetRepository())
+
 const toggleAutocomplete = (repositoryId, enable) => {
     cy.request({
         method: 'POST',
@@ -101,3 +121,8 @@ const waitAutocomplete = function (repositoryId) {
             }
         }).then((response) => response.status === 200 && (response.body === 'READY' || response.body === 'NONE')));
 };
+
+const unsetRepository = () => {
+    cy.removeLocalStorage(PRESET_REPO);
+    cy.log('Unset repository');
+}

package/support/settings-commands.js

@@ -1,4 +1,12 @@
-Cypress.Commands.add('setDefaultUserData', (cookieConsent = true) => {
+/**
+ * Sets the default user settings for the admin user, including cookie consent.
+ * @param {CookieConsent} cookieConsent - The value to set for cookie consent.
+ * - policyAccepted: boolean indicating whether the cookie policy has been accepted.
+ * - statistic: boolean indicating consent for statistical cookies.
+ * - thirdParty: boolean indicating consent for third-party cookies.
+ * - updatedAt: epoch timestamp of last update in seconds.
+ */
+Cypress.Commands.add('setDefaultUserData', (cookieConsent) => {
     const defaultUserSettings = {
         'COOKIE_CONSENT': cookieConsent,
         'DEFAULT_SAMEAS': true,
@@ -18,3 +26,27 @@ Cypress.Commands.add('setDefaultUserData', (cookieConsent = true) => {
         cy.waitUntil(() => response && response.status === 200); // 201 Created
     });
 });
+
+/**
+ * Sets the cookie consent in user settings for the admin user.
+ * @param {CookieConsent} cookieConsent - The value to set for cookie consent.
+ * - policyAccepted: boolean indicating whether the cookie policy has been accepted.
+ * - statistic: boolean indicating consent for statistical cookies.
+ * - thirdParty: boolean indicating consent for third-party cookies.
+ * - updatedAt: epoch timestamp of last update in seconds.
+ */
+Cypress.Commands.add('setCookieConsent', (cookieConsent ) => {
+    const defaultUserSettings = {
+        'COOKIE_CONSENT': cookieConsent
+    };
+    cy.request({
+        method: 'PATCH',
+        url: `rest/security/users/${encodeURIComponent('admin')}`,
+        body: {
+            "appSettings": defaultUserSettings,
+            'password': 'root'
+        }
+    }).then((response) => {
+        cy.waitUntil(() => response && response.status === 200); // 201 Created
+    });
+});

package/support/url-commands.js

@@ -0,0 +1,13 @@
+/**
+ * Custom Cypress command to retrieve the value of a query parameter from the current page URL.
+ *
+ * @param {string} key - The name of the query parameter to retrieve.
+ * @returns {Cypress.Chainable<string | null>} A chainable that resolves to the value of the query parameter,
+ * or null if the parameter is not present.
+ */
+Cypress.Commands.add('getQueryParam', (key) => {
+    return cy.location('search').then((search) => {
+        const params = new URLSearchParams(search);
+        return params.get(key);
+    });
+});

package/support/user-commands.js

@@ -1,7 +1,15 @@
-Cypress.Commands.add('createUser', (options = {}) => {
+Cypress.Commands.add('createUser', (options = {}, secured = false) => {
+    let headers = {'Content-Type': 'application/json'};
+    if (secured) {
+        const authHeader = Cypress.env('adminToken');
+        headers = {...headers,
+            'Authorization': authHeader
+        }
+    }
     cy.request({
         method: 'POST',
         url: `/rest/security/users/${options.username}`,
+        headers,
         body: {
             "password": options.password || "root",
             "appSettings": {
@@ -12,9 +20,6 @@ Cypress.Commands.add('createUser', (options = {}) => {
                 "DEFAULT_VIS_GRAPH_SCHEMA": true
             },
             "grantedAuthorities": options.grantedAuthorities || ["ROLE_USER", "WRITE_REPO_*", "READ_REPO_*"]
-        },
-        headers: {
-            'Content-Type': 'application/json'
         }
     }).then((response) => {
         cy.waitUntil(() => response && response.status === 201); // 201 Created

package/utils/html-util.js

@@ -2,8 +2,9 @@ export class HtmlUtil {
 
     /**
      * Verifies that an element's content is truncated with an ellipsis by checking that
-     * the scroll width of the element is greater than its offset width.
-     * This is used to assert that the element's text is overflowing and is being clipped with ellipsis.
+     * either the scroll width or the scroll height of the element is greater than its offset dimensions.
+     * This is used to assert that the element's text is overflowing (either horizontally or vertically)
+     * and is being clipped with ellipsis.
      *
      * @param {Cypress.Chainable<JQuery<HTMLElement>>} element - The Cypress chainable element to check.
      * @throws {AssertionError} If the element's content is not truncated with ellipsis.
@@ -14,8 +15,27 @@ export class HtmlUtil {
      */
     static verifyEllipsis(element) {
         element.should(($el) => {
-            const el = $el[0];
-            expect(el.scrollWidth).to.be.greaterThan(el.offsetWidth);
+            expect(HtmlUtil.isOverflowing($el), 'Element should have an ellipsis (overflowing content)').to.be.true;
         });
     }
+
+    /**
+     * Verifies that an element's content is NOT truncated.
+     * Checks that the scroll dimensions are equal to the offset dimensions,
+     * indicating the content fits completely within the visible area.
+     *
+     * @param {Cypress.Chainable<JQuery<HTMLElement>>} element - The Cypress chainable element to check.
+     */
+    static verifyNoEllipsis(element) {
+        element.should(($el) => {
+            expect(HtmlUtil.isOverflowing($el), 'Element content should fit fully (no ellipsis)').to.be.false;
+        });
+    }
+
+    static isOverflowing($el) {
+        const el = $el[0];
+        const isHorizontalOverflow = el.scrollWidth > el.offsetWidth;
+        const isVerticalOverflow = el.scrollHeight > el.offsetHeight;
+        return isHorizontalOverflow || isVerticalOverflow;
+    }
 }

package/Dockerfile

@@ -1,11 +0,0 @@
-FROM cypress/base:20.11.0
-
-COPY . /workbench/tests-cypress/
-
-WORKDIR /workbench/tests-cypress/
-
-ENV NO_COLOR=1
-
-RUN npm ci
-
-CMD ["npm", "test"]