graphdb-workbench-tests 3.5.0-TR8 → 3.5.0-TR9

package/e2e-legacy/home/solr-banner/solr-banner.spec.js

@@ -0,0 +1,137 @@
+import HomeSteps from '../../../steps/home-steps.js';
+import {DeprecationSteps} from '../../../steps/deprecation-steps.js';
+import {LoginSteps} from '../../../steps/login-steps.js';
+import {GuidesStubs} from '../../../stubs/guides/guides-stubs.js';
+import {GuideSteps} from '../../../steps/guides/guide-steps.js';
+import {GuideDialogSteps} from '../../../steps/guides/guide-dialog-steps.js';
+
+describe('Solr deprecation banner', () => {
+    context('Security disabled', () => {
+        it('should keep the Solr deprecation banner hidden after the anonymous user dismisses it', () => {
+            // GIVEN: I have opened the application with security disabled.
+            HomeSteps.visit();
+
+            // THEN: I expect the Solr deprecation banner to be visible.
+            DeprecationSteps.getDeprecationBanner()
+                .should('be.visible')
+                .should('contain.text', 'The Solr connector is deprecated and will be removed in GraphDB 12');
+
+            // WHEN: I dismiss the Solr deprecation banner.
+            DeprecationSteps.closeBanner();
+            // THEN: I expect the Solr deprecation banner to be hidden.
+            DeprecationSteps.getDeprecationBanner().should('not.exist');
+
+            // WHEN: I reload the application.
+            HomeSteps.visit();
+            // THEN: I expect the Solr deprecation banner to remain hidden.
+            DeprecationSteps.getDeprecationBanner().should('not.exist');
+        });
+    });
+
+    context('Security enabled', () => {
+        const PASSWORD = 'root';
+        const USER_USERNAME = 'username';
+
+        beforeEach(() => {
+            cy.createUser({
+                username: USER_USERNAME,
+                password: PASSWORD
+            });
+
+            cy.switchOnSecurity()
+                .then(() => cy.loginAsAdmin())
+                .then(() => cy.switchOnFreeAccess(true));
+        });
+
+        afterEach(() => {
+            cy.loginAsAdmin()
+                .then(() => {
+                    cy.deleteUser(USER_USERNAME, true);
+                    cy.switchOffFreeAccess(true);
+                    cy.switchOffSecurity(true);
+                });
+        });
+
+        it('should persist separate Solr banner states for anonymous and logged-in users', () => {
+            // GIVEN: Security and free access are enabled, and no user is logged in.
+            HomeSteps.visit();
+
+            // THEN: I expect the Solr deprecation banner to be visible for the anonymous user.
+            DeprecationSteps.getDeprecationBanner()
+                .should('be.visible')
+                .should('contain.text', 'The Solr connector is deprecated and will be removed in GraphDB 12');
+
+            // WHEN: The anonymous user dismisses the banner.
+            DeprecationSteps.closeBanner();
+            // THEN: I expect the banner to be hidden for the anonymous user.
+            DeprecationSteps.getDeprecationBanner().should('not.exist');
+
+            // WHEN: I log in as a user who has not dismissed the banner.
+            cy.loginAs(USER_USERNAME, PASSWORD);
+            HomeSteps.visit();
+
+            // THEN: I expect the banner to be visible for the logged-in user.
+            DeprecationSteps.getDeprecationBanner()
+                .should('be.visible')
+                .should('contain.text', 'The Solr connector is deprecated and will be removed in GraphDB 12');
+
+            // WHEN: The logged-in user dismisses the banner.
+            DeprecationSteps.closeBanner();
+            // THEN: I expect the banner to be hidden for the logged-in user.
+            DeprecationSteps.getDeprecationBanner().should('not.exist');
+
+            // WHEN: The user logs out.
+            LoginSteps.logout();
+            // THEN: I expect the banner to remain hidden because the anonymous user has already dismissed it.
+            DeprecationSteps.getDeprecationBanner().should('not.exist');
+
+            // WHEN: I log in as the administrator, who has not dismissed the banner.
+            cy.loginAs('admin', 'root');
+            HomeSteps.visit();
+            // THEN: I expect the banner to be visible for the administrator.
+            DeprecationSteps.getDeprecationBanner()
+                .should('be.visible')
+                .should('contain.text', 'The Solr connector is deprecated and will be removed in GraphDB 12');
+
+            // WHEN: The administrator logs out.
+            LoginSteps.logout();
+            // THEN: I expect the banner to remain hidden because the anonymous user has already dismissed it.
+            DeprecationSteps.getDeprecationBanner().should('not.exist');
+
+            // WHEN: I log in again as the user who previously dismissed the banner.
+            cy.loginAs(USER_USERNAME, PASSWORD);
+            HomeSteps.visit();
+            // THEN: I expect the banner to remain hidden for the logged-in user.
+            DeprecationSteps.getDeprecationBanner().should('not.exist');
+        });
+    });
+
+    context('User guides', () => {
+        it('should hide the Solr deprecation banner while a guide is running', () => {
+            // GIVEN: The guides are loaded and ready to be started.
+            GuidesStubs.stubMainMenuGuide();
+            GuideSteps.visit();
+            GuideSteps.verifyGuidesListExists();
+            cy.wait('@getGuides');
+
+            // WHEN: I am on an application page, and the Solr deprecation banner has not been dismissed by the current user.
+            // THEN: I expect the Solr deprecation banner to be visible because it has not been dismissed by the current user.
+            DeprecationSteps.getDeprecationBanner()
+                .should('be.visible')
+                .should('contain.text', 'The Solr connector is deprecated and will be removed in GraphDB 12');
+
+            // WHEN: I start a guide.
+            GuideSteps.runFirstGuide();
+            // THEN: I expect the Solr deprecation banner to be hidden while the guide is running.
+            DeprecationSteps.getDeprecationBanner().should('not.exist');
+
+            // WHEN: I cancel the guide.
+            GuideDialogSteps.clickOnCancelButton();
+            GuideDialogSteps.clickConfirmCancelDialogExitButton();
+            // THEN: I expect the Solr deprecation banner to be visible again.
+            DeprecationSteps.getDeprecationBanner()
+                .should('be.visible')
+                .should('contain.text', 'The Solr connector is deprecated and will be removed in GraphDB 12');
+        });
+    });
+});

package/e2e-legacy/ttyg/chat-list.spec.js

@@ -230,7 +230,7 @@ describe('TTYG chat list', () => {
         HomeSteps.visit();
         cy.wait('@get-chat');
         // and came back to the ttyg page
-        TTYGViewSteps.visit();
+        TTYGViewSteps.visit(false);
 
         // Then I expect to last used chat be selected.
         TTYGViewSteps.getChatFromGroup(0, 2).should('have.class', 'selected');

package/e2e-legacy/ttyg/create-chat.spec.js

@@ -61,7 +61,7 @@ describe('TTYG create chat', () => {
         // and returns to the TTYG page
         TTYGStubs.stubChatsListGet("/ttyg/chats/create/get-chats-after-create.json");
         TTYGStubs.stubAgentGet();
-        TTYGViewSteps.visit();
+        TTYGViewSteps.visit(false);
         cy.wait('@get-chat-list');
         // Then I expect newly created chat be selected.
         TTYGViewSteps.getChatFromGroup(0, 0).should('contain', 'New chat of Han Solo is a character');

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "graphdb-workbench-tests",
-  "version": "3.5.0-TR8",
+  "version": "3.5.0-TR9",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "graphdb-workbench-tests",
-      "version": "3.5.0-TR8",
+      "version": "3.5.0-TR9",
       "license": "Apache-2.0",
       "devDependencies": {
         "@bahmutov/cypress-code-coverage": "^2.7.2",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphdb-workbench-tests",
-  "version": "3.5.0-TR8",
+  "version": "3.5.0-TR9",
   "description": "Cypress tests for GraphDB workbench",
   "type": "module",
   "scripts": {

package/steps/deprecation-steps.js

@@ -0,0 +1,13 @@
+export class DeprecationSteps {
+  static getDeprecationBanner() {
+    return cy.get('onto-deprecation-banner');
+  }
+
+  static getCloseButton() {
+    return DeprecationSteps.getDeprecationBanner().find('.close-button');
+  }
+
+  static closeBanner() {
+    DeprecationSteps.getCloseButton().click();
+  }
+}

package/steps/ttyg/ttyg-view-steps.js

@@ -2,9 +2,20 @@ import {BaseSteps} from "../base-steps";
 import {DeprecationSteps} from '../deprecation-banner/deprecation-banner-steps.js';
 
 export class TTYGViewSteps extends BaseSteps {
-    static visit() {
+    /**
+     * Visits the TTYG page and closes the Solr deprecation banner by default.
+     *
+     * @param {boolean} closeSolrBanner Whether to close the banner. Set to `false`
+     * when revisiting the page after the banner has already been closed.
+     */
+    static visit(closeSolrBanner = true) {
         cy.visit('/ttyg');
-        DeprecationSteps.closeBanner();
+        // Temporary workaround until the Solr deprecation banner is removed.
+        // The banner changes the page layout, causing tests to fail randomly.
+        // This quick fix prevents GraphDB build failures and should be deleted together with the banner.
+        if (closeSolrBanner) {
+            DeprecationSteps.closeBanner();
+        }
     }
 
     static getTtygView() {

package/support/security-command.js

@@ -29,6 +29,30 @@ Cypress.Commands.add('loginAsAdmin', () => {
     });
 });
 
+Cypress.Commands.add('loginAs', (username, password) => {
+    return cy.request({
+        method: 'POST',
+        url: '/rest/login',
+        body: {
+            username,
+            password,
+        },
+        headers: {
+            'Content-Type': 'application/json',
+        },
+        failOnStatusCode: true,
+    }).then((response) => {
+        const authHeader = response.headers['authorization'];
+        const token = Array.isArray(authHeader)
+            ? authHeader[0]
+            : authHeader;
+        cy.window().then((win) => {
+            win.localStorage.setItem('ontotext.gdb.auth.jwt', token);
+            win.localStorage.setItem('ontotext.gdb.auth.authenticated', 'true');
+        });
+    });
+});
+
 Cypress.Commands.add('switchOffSecurity', (secured = false) => {
     let headers = {'Content-Type': 'application/json'};
     if (secured) {
@@ -64,3 +88,22 @@ Cypress.Commands.add('switchOffFreeAccess', (secured = false) => {
         failOnStatusCode: true,
     });
 });
+
+Cypress.Commands.add('switchOnFreeAccess', (secured = false) => {
+    let headers = {'Content-Type': 'application/json'};
+    if (secured) {
+        const authHeader = Cypress.env('adminToken');
+        headers = {...headers,
+            'Authorization': authHeader
+        }
+    }
+    return cy.request({
+        method: 'POST',
+        url: '/rest/security/free-access',
+        body: {
+            'enabled': true
+        },
+        headers,
+        failOnStatusCode: false,
+    });
+});