graphdb-workbench-tests 3.3.1 → 3.3.2-RC2

package/fixtures/guides/main-menu/main-menu-guide.json

@@ -0,0 +1,98 @@
+[
+    {
+        "guideName": {
+            "en": "Main menu guide test"
+        },
+        "steps": [
+            {
+                "guideBlockName": "click-main-menu",
+                "options": {
+                    "menu": "import",
+                    "mainAction": "import-file",
+                    "showIntro": true
+                }
+            },
+            {
+                "guideBlockName": "click-main-menu",
+                "options": {
+                    "menu": "repositories",
+                    "mainAction": "create-repository",
+                    "showIntro": true
+                }
+            },
+            {
+                "guideBlockName": "click-main-menu",
+                "options": {
+                    "menu": "class-hierarchy",
+                    "mainAction": "class-hierarchy",
+                    "showIntro": true
+                }
+            },
+            {
+                "guideBlockName": "click-main-menu",
+                "options": {
+                    "menu": "class-relationships",
+                    "mainAction": "class-relationships",
+                    "showIntro": true
+                }
+            },
+            {
+                "guideBlockName": "click-main-menu",
+                "options": {
+                    "menu": "visual-graph",
+                    "mainAction": "visual-graph",
+                    "showIntro": true
+                }
+            },
+            {
+                "guideBlockName": "click-main-menu",
+                "options": {
+                    "menu": "similarity",
+                    "mainAction": "create-similarity-index",
+                    "showIntro": true
+                }
+            },
+            {
+                "guideBlockName": "click-main-menu",
+                "options": {
+                    "menu": "sparql",
+                    "mainAction": "execute-sparql-query",
+                    "showIntro": true
+                }
+            },
+            {
+                "guideBlockName": "click-main-menu",
+                "options": {
+                    "menu": "ttyg",
+                    "mainAction": "create-ttyg-agent",
+                    "showIntro": true
+                }
+            },
+            {
+                "guideBlockName": "click-main-menu",
+                "options": {
+                    "menu": "autocomplete",
+                    "mainAction": "enable-autocomplete",
+                    "showIntro": true
+                }
+            },
+            {
+                "guideBlockName": "click-main-menu",
+                "options": {
+                    "menu": "connectors",
+                    "title": "Connectors"
+                }
+            },
+            {
+                "guideBlockName": "click-main-menu",
+                "options": {
+                    "menu": "rdf-rank",
+                    "title": "RDF Rank"
+                }
+            },
+            {
+                "guideBlockName": "guide-end"
+            }
+        ]
+    }
+]

package/fixtures/guides/ttyg/edit-ttyg-agent/edit-ttyg-agent-guide.json

@@ -0,0 +1,22 @@
+[
+    {
+        "guideName": {
+            "en": "edit-ttyg-test-guide"
+        },
+        "steps": [
+            {
+                "guideBlockName": "edit-ttyg-agent",
+                "options": {
+                    "methods": [
+                        {
+                            "guideBlockName": "sparql-search-method",
+                            "options": {
+                                "ontologyGraph": "http://example.com"
+                            }
+                        }
+                    ]
+                }
+            }
+        ]
+    }
+]

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "graphdb-workbench-tests",
-  "version": "3.3.1",
+  "version": "3.3.2-RC2",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "graphdb-workbench-tests",
-      "version": "3.3.1",
+      "version": "3.3.2-RC2",
       "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.3.1",
+  "version": "3.3.2-RC2",
   "description": "Cypress tests for GraphDB workbench",
   "type": "module",
   "scripts": {

package/steps/base-steps.js

@@ -22,4 +22,8 @@ export class BaseSteps {
   static getUrl() {
     return cy.url();
   }
+
+  static validateUrl(url) {
+    this.getUrl().should('include', url);
+  }
 }

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/error-page-steps.js

@@ -0,0 +1,9 @@
+export class ErrorPageSteps {
+    static visit404() {
+        cy.visit('/404');
+    }
+
+    static get404Page() {
+        return cy.get('app-not-found-page');
+    }
+}

package/steps/graphql/playground-editor-steps.js

@@ -0,0 +1,46 @@
+export class PlaygroundEditorSteps {
+
+    static getResponse() {
+        return cy.get('.graphiql-response');
+    }
+
+    static getResponseCodeMirror() {
+        return PlaygroundEditorSteps.getResponse().find('.CodeMirror');
+    }
+
+    static getGraphiqlEditors() {
+        return cy.get('.graphiql-editors');
+    }
+
+    static getGraphiqlEditorsCodeMirror() {
+        return PlaygroundEditorSteps.getGraphiqlEditors().find('.CodeMirror');
+    }
+
+    static getGraphiqlEditorTools() {
+        return cy.get('.graphiql-editor-tools');
+    }
+
+    static getGraphiqlEditorTool() {
+        return cy.get('.graphiql-editor-tool');
+    }
+
+    static getVariablesBtn() {
+        return PlaygroundEditorSteps.getGraphiqlEditorTools().find('button[data-name="variables"]');
+    }
+
+    static openVariables() {
+        PlaygroundEditorSteps.getVariablesBtn().click();
+    }
+
+    static getHeadersBtn() {
+        return PlaygroundEditorSteps.getGraphiqlEditorTools().find('button[data-name="headers"]');
+    }
+
+    static openHeaders() {
+        PlaygroundEditorSteps.getHeadersBtn().click();
+    }
+
+    static getActiveGraphiqlEditorToolCodeMirror() {
+        return PlaygroundEditorSteps.getGraphiqlEditorTool().find('.graphiql-editor:not(.hidden) .CodeMirror');
+    }
+}

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/import/import-resource-message-dialog.js

@@ -14,7 +14,7 @@ export class ImportResourceMessageDialog extends ModalDialogSteps {
     }
 
     static getMessage() {
-        return this.getDialogBody().find('.message');
+        return this.getDialogBody();
     }
 
     static getCopyToClipboard() {

package/steps/login-steps.js

@@ -18,6 +18,10 @@ export class LoginSteps {
         cy.visit(`/login?r=${returnURLEncoded}`);
     }
 
+    static getLoginPage() {
+        return cy.get('app-login');
+    }
+
     static navigateToLoginPage() {
         cy.get('onto-user-login').click();
     }
@@ -29,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

@@ -95,6 +95,10 @@ export class MainMenuSteps {
 
     static clickOnVisualGraph() {
         this.clickOnExplore();
+        this.clickOnSubmenuVisualGraph();
+    }
+
+    static clickOnSubmenuVisualGraph() {
         this.getSubMenuButton('sub-menu-visual-graph').click();
     }
 
@@ -190,11 +194,19 @@ export class MainMenuSteps {
 
     static clickOnRDFRank() {
         this.clickOnMenuSetup();
+        this.clickOnSubmenuRDFRank();
+    }
+
+    static clickOnSubmenuRDFRank() {
         this.getSubMenuButton('sub-menu-rdf-rank').click();
     }
 
     static clickOnConnectors() {
         this.clickOnMenuSetup();
+        this.clickOnSubmenuConnectors();
+    }
+
+    static clickOnSubmenuConnectors() {
         this.getSubMenuButton('sub-menu-connectors').click();
     }
 

package/steps/repository-steps.js

@@ -76,7 +76,7 @@ export class RepositorySteps extends BaseSteps {
     }
 
     static getRepositoryConnectionOffBtn(id) {
-        return RepositorySteps.getRepositoryFromList(id).find('.ri-link-unlink');
+        return RepositorySteps.getRepositoryFromList(id).find('.icon-connection-off');
     }
 
     static activateRepository(id) {
@@ -84,7 +84,7 @@ export class RepositorySteps extends BaseSteps {
     }
 
     static getRepositoryConnectionOnBtn(id) {
-        return RepositorySteps.getRepositoryFromList(id).find('.ri-link');
+        return RepositorySteps.getRepositoryFromList(id).find('.icon-connection-on');
     }
 
     static clickRepositoryIcon(repositoryId, selector) {

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/setup/user-and-access-steps.js

@@ -13,6 +13,10 @@ export class UserAndAccessSteps {
         });
     }
 
+    static getUsersCatalogContainer() {
+        return cy.get('#wb-users');
+    }
+
     static getUrl() {
         return cy.url();
     }
@@ -105,6 +109,10 @@ export class UserAndAccessSteps {
             .closest('tr').as('user');
     }
 
+    static getUserCustomRoles(userRow) {
+        return cy.get(userRow).getByTestId('custom-roles').getByTestId('custom-role');
+    }
+
     static getUsernameField() {
         return cy.get('#wb-user-username');
     }
@@ -359,15 +367,15 @@ export class UserAndAccessSteps {
     }
 
     static clickFreeWriteAccessRepo(repoName) {
-        const repoRow = cy.get('.repo-fields').contains(repoName).parent('.row');
-        repoRow.scrollIntoView();
-        repoRow.find('.write').realClick();
+        cy.get('.repo-fields').contains(repoName).parent('.row').as('row');
+        cy.get('@row').scrollIntoView();
+        cy.get('@row').find('.write').realClick();
     }
 
     static clickFreeGraphqlAccessRepo(repoName) {
-        const repoRow = cy.get('.repo-fields').contains(repoName).parent('.row');
-        repoRow.scrollIntoView();
-        repoRow.find('.graphql').realClick();
+        cy.get('.repo-fields').contains(repoName).parent('.row').as('row');
+        cy.get('@row').scrollIntoView();
+        cy.get('@row').find('.graphql').realClick();
     }
 
 }

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

@@ -133,7 +133,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() {

package/stubs/guides/guides-stubs.js

@@ -15,6 +15,10 @@ export class GuidesStubs {
         GuidesStubs.stubWithFixture('../fixtures/guides/ttyg/conversation/ttyg-conversation-guide.json');
     }
 
+    static stubTTYGEditAgentGuide() {
+        GuidesStubs.stubWithFixture('../fixtures/guides/ttyg/edit-ttyg-agent/edit-ttyg-agent-guide.json');
+    }
+
     static stubClassHierarchyGuide() {
         GuidesStubs.stubWithFixture('../fixtures/guides/class-hierarchy/class-hierarchy-guide.json');
     }
@@ -39,6 +43,10 @@ export class GuidesStubs {
         GuidesStubs.stubWithFixture('../fixtures/guides/download-guide-resource/download-guide-resource-guide.json');
     }
 
+    static stubMainMenuGuide() {
+        GuidesStubs.stubWithFixture('../fixtures/guides/main-menu/main-menu-guide.json');
+    }
+
     static stubDownloadResource(resourcePath, resourceFile) {
         cy.intercept('GET', `/rest/guides/download/${resourcePath}/${resourceFile}`, {
             fixture: `guides/download-resource.ttl`,

package/stubs/security-stubs.js

@@ -10,12 +10,20 @@ export class SecurityStubs {
         }).as('security-get-admin');
     }
 
+    static spyOnUserCreate() {
+        cy.intercept('POST', 'rest/security/users/*').as('create-user');
+    }
+
     static stubInferAndSameAsDefaults() {
         cy.intercept('rest/security/all', (req) => {
             req.reply(SecurityStubs.getResponseSecurityEnabled());
         }).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/ttyg/ttyg-stubs.js

@@ -106,12 +106,10 @@ export class TTYGStubs extends Stubs {
         }).as('get-agent');
     }
 
-    static stubAgentListGetError() {
+    static stubAgentListGetError(error = 'Internal Server Error') {
         cy.intercept('GET', '/rest/chat/agents', {
             statusCode: 500,
-            response: {
-                error: 'Internal Server Error'
-            }
+            body: error
         }).as('get-agent-list-error');
     }
 

package/support/e2e-security.js

@@ -0,0 +1,9 @@
+import './e2e';
+
+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.
+    cy.switchOffSecurity(true);
+    cy.switchOffFreeAccess(true);
+});

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
     };