graphdb-workbench-tests 3.4.0-dynamic-guides-test → 3.4.0-migrated-guide-services

package/steps/cookie-policy/cookie-consent-banner-steps.js

@@ -0,0 +1,21 @@
+export class CookieConsentBannerSteps {
+    static getCookieConsentBanner() {
+        return cy.get('.cookie-consent-banner');
+    }
+
+    static getCookieConsentButton() {
+        return this.getCookieConsentBanner().find('button');
+    }
+
+    static giveCookieConsent() {
+        return this.getCookieConsentButton().click();
+    }
+
+    static getCookiePolicyLink() {
+        return cy.get('.cookie-consent-content a');
+    }
+
+    static clickCookiePolicyLink() {
+        return this.getCookiePolicyLink().click();
+    }
+}

package/steps/cookie-policy/cookie-policy-modal.steps.js

@@ -0,0 +1,56 @@
+import {SharedModalDialogSteps} from '../shared-modal-dialog-steps';
+
+export class CookiePolicyModalSteps extends SharedModalDialogSteps {
+    static getDialogComponent(cssClass = '.cookie-policy-modal') {
+        return super.getDialogComponent(cssClass);
+    }
+
+    static getStatisticCookiesToggle() {
+        return this.getBody().find('.statistic-cookies-toggle .toggle-switch');
+    }
+
+    static getStatisticCookiesCheckbox() {
+        return this.getStatisticCookiesToggle().find('input');
+    }
+
+    static toggleStatisticCookies() {
+        this.getStatisticCookiesToggle().click();
+        // Wait here is intentional because there is a debounce before the checkbox state is updated
+        // eslint-disable-next-line cypress/no-unnecessary-waiting
+        cy.wait(500);
+    }
+
+    static getThirdPartyCookiesToggle() {
+        return this.getBody().find('.third-party-cookies-toggle .toggle-switch');
+    }
+
+    static getThirdPartyCookiesCheckbox() {
+        return this.getThirdPartyCookiesToggle().find('input');
+    }
+
+    static toggleThirdPartyCookies() {
+        this.getThirdPartyCookiesToggle().click();
+        // Wait here is intentional because there is a debounce before the checkbox state is updated
+        // eslint-disable-next-line cypress/no-unnecessary-waiting
+        cy.wait(500);
+    }
+
+    static closeDialog() {
+        this.getFooter().find('.close-btn').click();
+    }
+
+    /**
+     * Validates the cookie policy dialog by checking the visibility of the dialog and the state of the checkboxes for
+     * analytic and third party cookies.
+     * @param {boolean} expectedStatisticChecked
+     * @param {boolean} expectedThirdPartyChecked
+     */
+    static validateCookiePolicyDialog(expectedStatisticChecked, expectedThirdPartyChecked) {
+        // I should see the cookie policy
+        CookiePolicyModalSteps.getDialogComponent().should('be.visible');
+        CookiePolicyModalSteps.getBody().should('be.visible');
+        // And I expect to see that analytic and third party cookies are allowed
+        CookiePolicyModalSteps.getStatisticCookiesCheckbox().should(expectedStatisticChecked ? 'be.checked' : 'not.be.checked');
+        CookiePolicyModalSteps.getThirdPartyCookiesCheckbox().should(expectedThirdPartyChecked ? 'be.checked' : 'not.be.checked');
+    }
+}

package/steps/guides/guide-dialog-steps.js

@@ -1,4 +1,6 @@
-export class GuideDialogSteps {
+import {BaseSteps} from "../base-steps.js";
+
+export class GuideDialogSteps extends BaseSteps {
 
     static getModalDialog() {
         return cy.get('.shepherd-content:visible');
@@ -8,6 +10,50 @@ export class GuideDialogSteps {
         return GuideDialogSteps.getModalDialog().find('.shepherd-header');
     }
 
+    static getCancelButton() {
+        return this.getHeader().find('.shepherd-cancel-icon');
+    }
+
+    static clickOnCancelButton() {
+        return this.getCancelButton().click();
+    }
+
+    static getConfirmCancelDialog() {
+        return this.getByTestId('confirm-cancel-dialog');
+    }
+
+    static getConfirmCancelDialogCloseButton() {
+        return this.getByTestId('close-dialog-btn');
+    }
+
+    static clickOnConfirmCancelDialogCloseButton() {
+        return this.getConfirmCancelDialogCloseButton().click();
+    }
+
+    static getConfirmCancelDialogCancelButton() {
+        return this.getByTestId('cancel-btn');
+    }
+
+    static clickConfirmCancelDialogCancelButton() {
+        return this.getConfirmCancelDialogCancelButton().click();
+    }
+
+    static getConfirmCancelDialogDontShowAgainButton() {
+        return this.getByTestId('dont-show-again-btn');
+    }
+
+    static clickConfirmCancelDialogDontShowAgainButton() {
+        return this.getConfirmCancelDialogDontShowAgainButton().click();
+    }
+
+    static getConfirmCancelDialogExitButton() {
+        return this.getByTestId('exit-btn');
+    }
+
+    static clickConfirmCancelDialogExitButton() {
+        return this.getConfirmCancelDialogExitButton().click();
+    }
+
     static getContent() {
         return GuideDialogSteps.getModalDialog().find('.shepherd-text');
     }
@@ -28,8 +74,12 @@ export class GuideDialogSteps {
         return GuideDialogSteps.getFooter().find('.shepherd-button').contains('Close');
     }
 
+    static getSkipButton() {
+        return GuideDialogSteps.getFooter().find('.shepherd-button').contains('Skip');
+    }
+
     static clickOnNextButton(forceVisible = false) {
-        GuideDialogSteps.getNextButton().scrollIntoView().click({force: forceVisible});
+        return GuideDialogSteps.getNextButton().scrollIntoView().click({force: forceVisible});
     }
 
     static clickOnPreviousButton(forceVisible = false) {
@@ -40,6 +90,10 @@ export class GuideDialogSteps {
         GuideDialogSteps.getCloseButton().scrollIntoView().click();
     }
 
+    static clickOnSkipButton() {
+        GuideDialogSteps.getSkipButton().scrollIntoView().click();
+    }
+
     static getContentLink() {
         return GuideDialogSteps.getContent().find('a');
     }

package/steps/header-steps.js

@@ -6,4 +6,17 @@ export class HeaderSteps {
     static openHomePage() {
         HeaderSteps.getHeader().find('.home-page').click();
     }
+
+    static logout() {
+        this.getHeader().find('onto-user-menu').click();
+        cy.get('.onto-user-menu-dropdown')
+            .contains('Logout')
+            .first()
+            // Force the click because Cypress sometimes determines that the item has 0x0 dimensions
+            .click({force: true});
+    }
+
+    static login() {
+        this.getHeader().find('.onto-user-login').click();
+    }
 }

package/steps/home-steps.js

@@ -313,26 +313,6 @@ class HomeSteps extends BaseSteps {
         return cy.get('#license-label-home');
     }
 
-    static getCookieConsentPopup() {
-        return cy.get('.cookie-consent-modal');
-    }
-
-    static getAgreeButton() {
-        return HomeSteps.getCookieConsentPopup().find('button');
-    }
-
-    static clickAgreeButton() {
-        return HomeSteps.getAgreeButton().click();
-    }
-
-    static getCookiePolicyLink() {
-        return cy.get('.cookie-consent-content a');
-    }
-
-    static clickCookiePolicyLink() {
-        return HomeSteps.getCookiePolicyLink().click();
-    }
-
     static getCookiePolicyModal() {
         return cy.get('.cookie-policy-modal');
     }

package/steps/login-steps.js

@@ -33,6 +33,7 @@ export class LoginSteps {
         cy.getByTestId('submit-btn').click();
     }
 
+    // TODO: Use the HeaderSteps.logout()
     static logout() {
         cy.get('onto-user-menu').click();
         cy.get('.onto-user-menu-dropdown')

package/steps/main-menu-steps.js

@@ -16,6 +16,7 @@ export class MainMenuSteps {
         return MainMenuSteps.getMenuButton('Import');
     }
 
+    // TODO: temporary using more complex implementation until we have two SPARQL menu elements in the navbar
     static getMenuSparql() {
         return MainMenuSteps.getMenuButton('SPARQL');
     }

package/steps/setup/settings-steps.js

@@ -107,7 +107,7 @@ export class SettingsSteps {
     }
 
     static clickCookiePolicyLink() {
-        return SettingsSteps.getCookiePolicyButton().click();
+        return this.getCookiePolicyButton().click();
     }
 
     static getCookiePolicyModal() {

package/steps/shared-modal-dialog-steps.js

@@ -0,0 +1,45 @@
+/**
+ * Basic steps for interacting with the onto-dialog component. This class is designed to be extended by more specific
+ * dialog steps classes.
+ */
+export class SharedModalDialogSteps {
+    /**
+     * Returns the onto-dialog element.
+     * This is the generic method to get the dialog element.
+     */
+    static getDialog() {
+        return cy.get('onto-dialog');
+    }
+
+    /**
+     * Returns a child component of the dialog based on the provided CSS class. The onto-dialog component is designed to
+     * be flexible and can contain be composed of various child components included in different slots: header, body,
+     * and footer.
+     * The purpose of this method is to allow selection of specific dialog in case there are multiple dialogs in the page.
+     * @param cssClass - The CSS class of the child component to retrieve. Defaults to '.dialog', which will return the
+     * dialog itself.
+     */
+    static getDialogComponent(cssClass = '.dialog') {
+        return cy.get(cssClass);
+    }
+
+    static getHeader() {
+        return this.getDialog().find('.dialog-header');
+    }
+
+    static getBody() {
+        return this.getDialog().find('.dialog-body');
+    }
+
+    static getFooter() {
+        return this.getDialog().find('.dialog-footer');
+    }
+
+    static getCloseButton() {
+        return this.getHeader().find('.close');
+    }
+
+    static close() {
+        this.getCloseButton().click();
+    }
+}

package/steps/visual-graph-steps.js

@@ -87,6 +87,30 @@ export class VisualGraphSteps extends BaseSteps {
         return cy.get('.autocomplete-toast a');
     }
 
+    static getRdfResourceSearchInput() {
+        return cy.getByTestId('rdf-resource-input');
+    }
+
+    static searchForRdfResource(resource) {
+        this.getRdfResourceSearchInput().type(resource, {force: true});
+    }
+
+    static shareVisualGraphWithOtherUsers() {
+        this.getShareGraphButton().click();
+    }
+
+    static getShareGraphButton() {
+        return cy.getByTestId('share-graph-config');
+    }
+
+    static selectConfig(configName) {
+        this.getConfigByName(configName).click();
+    }
+
+    static getConfigByName(name) {
+        return cy.getByTestId(`graph-config-${name}`);
+    }
+
     static getGraphVisualizationNodes() {
         return this.getGraphVisualizationPane().find('.node-wrapper');
     }
@@ -133,7 +157,7 @@ export class VisualGraphSteps extends BaseSteps {
     }
 
     static getNodeLabel(nodeId) {
-        return this.getNode(nodeId).find('.node-label-body');
+        return this.getNode(nodeId).find('.node-label-body div');
     }
 
     static getPredicates() {
@@ -153,7 +177,7 @@ export class VisualGraphSteps extends BaseSteps {
     }
 
     static dblclickOnNode(nodeId) {
-        this.getCircleOfNodeByNodeId(nodeId).dblclick();
+        this.getCircleOfNodeByNodeId(nodeId).trigger('dblclick');
     }
 
     static getLineBetweenNodesById(narrowId) {
@@ -176,6 +200,16 @@ export class VisualGraphSteps extends BaseSteps {
         this.getSidePanelCloseButton().click();
     }
 
+    // Note the index is 1-based
+    static openConfigTab(tabIndex) {
+        return this.getConfigTab(tabIndex).click();
+    }
+
+    // Note the index is 1-based
+    static getConfigTab(tabIndex) {
+        return cy.getByTestId(`graph-config-tab-${tabIndex}`);
+    }
+
     // Visual graph settings form field access
 
     static openPredicatesTab() {
@@ -263,12 +297,32 @@ export class VisualGraphSteps extends BaseSteps {
         return cy.get('.create-graph-config').should('be.visible');
     }
 
+    static createCustomGraph() {
+        this.getCreateCustomGraphLink().click();
+    }
+
     static getGraphConfigName() {
         return cy.get('.graph-config-name').should('be.visible');
     }
 
     static typeGraphConfigName(name) {
-        this.getGraphConfigName().type(name);
+        this.getGraphConfigName().type(name, {force: true});
+    }
+
+    static typeGraphConfigDescription(description) {
+        return this.getGraphConfigDescription().type(description, {force: true});
+    }
+
+    static getGraphConfigDescription() {
+        return cy.get('.graph-config-description').should('be.visible');
+    }
+
+    static typeGraphConfigHint(hint) {
+        return this.getGraphConfigHint().type(hint, {force: true});
+    }
+
+    static getGraphConfigHint() {
+        return cy.get('.graph-config-example').should('be.visible');
     }
 
     static getSaveConfigButton() {

package/stubs/guides/guides-stubs.js

@@ -85,6 +85,14 @@ export class GuidesStubs {
         GuidesStubs.stubWithFixture('../fixtures/guides/visual-graph/visual-graph-guide.json');
     }
 
+    static stubVisualGraphConfigGuide() {
+        GuidesStubs.stubWithFixture('../fixtures/guides/visual-graph/visual-graph-config-guide.json');
+    }
+
+    static stubNavigationGuide() {
+        GuidesStubs.stubWithFixture('../fixtures/guides/navigation/navigation-guide.json');
+    }
+
     static stubWithFixture(fixturePath) {
         cy.intercept('/rest/guides', {fixture: fixturePath}).as('getGuides');
     }

package/stubs/repositories/repositories-stubs.js

@@ -1,6 +1,7 @@
 import {Stubs} from '../stubs';
 import {REPOSITORIES_URL} from '../../support/repository-commands';
 import {GlobalOperationsStatusesStub} from '../global-operations-statuses-stub.js';
+import repoTemplate from "../../fixtures/repo-template.json";
 
 export class RepositoriesStubs extends Stubs {
     static stubRepositories(withDelay = 0, fixture = '/repositories/get-repositories.json') {
@@ -225,4 +226,25 @@ export class RepositoriesStubs extends Stubs {
         RepositoriesStubs.stubAutocomplete();
         GlobalOperationsStatusesStub.stubNoOperationsResponse('starwars');
     }
+
+    static stubRepositoryModel(repositoryId, options = {}) {
+        const body = Cypress._.defaultsDeep(
+            { id: repositoryId, ...options },
+            repoTemplate
+        );
+        cy.intercept('GET', `/rest/repositories/${repositoryId}`, {
+            statusCode: 200,
+            body
+        }).as('repository-model');
+    }
+
+    static stubFtsSearchDisabled(repositoryId) {
+        RepositoriesStubs.stubRepositoryModel(repositoryId, {
+            params: {
+                enableFtsIndex: {
+                    value: 'false'
+                }
+            }
+        });
+    }
 }

package/stubs/security-stubs.js

@@ -20,6 +20,10 @@ export class SecurityStubs {
         }).as('security-all');
     }
 
+    static spyOnUserUpdate(userName) {
+        cy.intercept('PATCH', `rest/security/users/${userName}`).as('updateUser');
+    }
+
     static stubUpdateUserData(userName) {
         cy.intercept('PATCH', `/rest/security/users/${userName}`, {
             statusCode: 200,

package/stubs/sparql-stubs.js

@@ -0,0 +1,10 @@
+import {Stubs} from './stubs.js';
+
+export class SparqlStubs extends Stubs {
+    static spyAddKnownPrefixes() {
+        cy.intercept('/rest/sparql/add-known-prefixes', {
+            method: 'POST',
+            body: 'PREFIX voc: <https://swapi.co/vocabulary/> SELECT ?name ?height WHERE { ?character voc:height ?height; rdfs:label ?name. FILTER(?name = "Luke Skywalker" || ?name = "Leia Organa") }'
+        }).as('addKnownPrefixes')
+    }
+}

package/support/e2e-security.js

@@ -1,6 +1,6 @@
 import './e2e';
 
-afterEach(() => {
+beforeEach(() => {
     cy.loginAsAdmin();
     // Switch off security after each test to ensure that tests are independent and don't affect each other.
     // For example, if security is enabled in one test, it can cause other tests that don't expect security to fail.

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,
@@ -19,7 +27,15 @@ Cypress.Commands.add('setDefaultUserData', (cookieConsent = true) => {
     });
 });
 
-Cypress.Commands.add('setCookieConsent', (cookieConsent) => {
+/**
+ * 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
     };

package/e2e-legacy/home/cookie-policy.spec.js

@@ -1,108 +0,0 @@
-import HomeSteps from '../../steps/home-steps';
-import {SecurityStubs} from '../../stubs/security-stubs';
-import {SettingsSteps} from '../../steps/setup/settings-steps';
-import {LicenseStubs} from '../../stubs/license-stubs';
-
-Cypress.env('set_default_user_data', false);
-
-describe('Cookie policy', () => {
-    beforeEach(() => {
-        cy.setCookieConsent(undefined);
-        cy.viewport(1280, 1000);
-        LicenseStubs.stubFreeLicense();
-    });
-
-    afterEach(() => cy.setCookieConsent(true));
-
-    context('should show', () => {
-        it('Should show consent popup to user', () => {
-            HomeSteps.visitInProdMode();
-            HomeSteps.getCookieConsentPopup().should('exist').and('be.visible');
-            // When I click on the link
-            HomeSteps.clickCookiePolicyLink();
-            // Then I see the cookie policy
-            HomeSteps.getCookiePolicyModal().should('exist').and('be.visible');
-        });
-
-        it('Should show cookie policy to user in user settings', () => {
-            SettingsSteps.visitInProdMode();
-            SettingsSteps.getCookiePolicyButton().should('exist').and('be.visible');
-
-            // When I click on the link
-            SettingsSteps.clickCookiePolicyLink();
-            // Then I see the cookie policy
-            SettingsSteps.getCookiePolicyModal().should('exist').and('be.visible');
-        });
-
-        it('Should save consent in user settings', () => {
-            HomeSteps.visitInProdMode();
-            SecurityStubs.stubUpdateUserData('admin');
-
-            // When I click Agree button
-            HomeSteps.clickAgreeButton();
-
-            // I expect to save cookie consent in user settings
-            cy.wait('@updateUser').then((xhr) => {
-                expect(xhr.request.body.appSettings).to.include({
-                    DEFAULT_INFERENCE: true,
-                    DEFAULT_VIS_GRAPH_SCHEMA: true,
-                    DEFAULT_SAMEAS: true,
-                    IGNORE_SHARED_QUERIES: false,
-                    EXECUTE_COUNT: true
-                });
-
-                // Assert COOKIE_CONSENT properties, excluding updatedAt
-                expect(xhr.request.body.appSettings.COOKIE_CONSENT).to.include({
-                    policyAccepted: true
-                });
-
-                // Assert that updatedAt is present, is a number, and is a reasonable timestamp
-                const updatedAt = xhr.request.body.appSettings.COOKIE_CONSENT.updatedAt;
-                expect(updatedAt).to.exist;
-                expect(updatedAt).to.be.a('number');
-
-                // Check that updatedAt is within 1 hour of the current time
-                const oneHourInMilliseconds = 60 * 60 * 1000;
-                const now = Date.now();
-                expect(updatedAt).to.be.within(now - oneHourInMilliseconds, now + oneHourInMilliseconds);
-            });
-        });
-
-        it('Should set cookies for tracking when accepted', () => {
-            cy.intercept('PATCH', `/rest/security/users/admin`).as('updateUser');
-            HomeSteps.visitInProdMode();
-
-            // When I click Agree button
-            HomeSteps.clickAgreeButton();
-
-            // I expect to save cookie consent in user settings
-            // There are two requests one from the new shared component and one in the legacy
-            cy.wait('@updateUser');
-            cy.wait('@updateUser');
-
-            // Check if the GA tracking script is set correctly in the head
-            cy.document()
-                .get('head script')
-                .should("have.attr", "src")
-                .should('include', 'https://www.googletagmanager.com/gtm.js?id=GTM-WBP6C6Z4');
-
-            // Check if the installation ID cookie is set correctly
-            cy.getCookie('_wb').then((cookie) => {
-                expect(cookie).to.exist;
-                expect(cookie.value).to.match(/^WB1\.[a-zA-Z0-9\-]+\.\d+$/); // Check the cookie structure: WB1.<installationId>.<timestamp>
-            });
-        })
-    })
-
-    context('should not show', () => {
-        it('Should NOT show consent popup to user when tracking is not applicable', () => {
-            HomeSteps.visitInDevMode();
-            HomeSteps.getCookieConsentPopup().should('not.exist');
-        });
-
-        it('Should NOT show cookie policy to user when tracking is not applicable', () => {
-            SettingsSteps.visitInDevMode();
-            SettingsSteps.getCookiePolicyButton().should('not.exist');
-        });
-    });
-});