graphdb-workbench-tests 2.8.0-Test → 2.8.1-RC1

package/stubs/license-stubs.js

@@ -0,0 +1,112 @@
+export class LicenseStubs {
+
+    static spyGetLicense() {
+        cy.intercept('GET', '/rest/graphdb-settings/license').as('get-license');
+    }
+
+    static stubFreeLicense() {
+        cy.intercept('GET', '/rest/graphdb-settings/license', {
+            statusCode: 200,
+            body: LicenseStubs.freeLicense()
+        }).as('freeLicense');
+    }
+
+    static stubEnterpriseLicense() {
+        cy.intercept('GET', '/rest/graphdb-settings/license', {
+            statusCode: 200,
+            body: LicenseStubs.enterpriseLicense()
+        }).as('enterpriseLicense');
+    }
+
+    static stubEvaluationLicense() {
+        cy.intercept('GET', '/rest/graphdb-settings/license', {
+            statusCode: 200,
+            body: LicenseStubs.evaluationLicense()
+        }).as('evaluationLicense');
+    }
+
+
+    static freeLicense() {
+        return {
+            "message": "OK",
+            "valid": true,
+            "version": "10.7",
+            "expiryDate": null,
+            "licensee": "Freeware",
+            "product": "GRAPHDB_LITE",
+            "maxCpuCores": 1,
+            "typeOfUse": "THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
+            "latestPublicationDate": null,
+            "licenseCapabilities": [
+                "Lucene connector"
+            ],
+            "productType": "free",
+            "installationId": "1234-abcd-5678"
+        };
+    }
+
+    static enterpriseLicense() {
+        return {
+            message: "OK",
+            valid: true,
+            version: null,
+            expiryDate: 8640000000000000,
+            licensee: "ONTOTEXT_INTERNAL",
+            product: "GRAPHDB_ENTERPRISE",
+            maxCpuCores: null,
+            typeOfUse: "Non-commercial research only",
+            latestPublicationDate: null,
+            licenseCapabilities: [
+                "OpenSearch connector",
+                "Lucene connector",
+                "Kafka connector",
+                "Solr connector",
+                "Cluster",
+                "Elasticsearch connector"
+            ],
+            productType: "enterprise",
+            installationId: "1234-abcd-5678"
+
+        };
+    }
+
+    static evaluationLicense() {
+        return {
+            message: "OK",
+            valid: true,
+            version: null,
+            expiryDate: 8640000000000000,
+            licensee: "ONTOTEXT_INTERNAL",
+            product: "GRAPHDB_ENTERPRISE",
+            maxCpuCores: null,
+            typeOfUse: "this is an evaluation license",
+            latestPublicationDate: null,
+            licenseCapabilities: [
+                "OpenSearch connector",
+                "Lucene connector",
+                "Kafka connector",
+                "Solr connector",
+                "Cluster",
+                "Elasticsearch connector"
+            ],
+            productType: "enterprise",
+            installationId: "1234-abcd-5678"
+        };
+    }
+
+    static stubGoogleCalls() {
+        cy.intercept('GET', 'https://www.googletagmanager.com/**', {
+            statusCode: 503
+        });
+        cy.intercept('POST', 'https://region1.google-analytics.com/**', {
+            statusCode: 500
+        });
+    }
+
+    static stubLicenseHardcoded(hardcoded = false) {
+        cy.intercept('GET', '/rest/graphdb-settings/license/hardcoded', {
+            statusCode: 200,
+            body: hardcoded + ''
+        }).as('license-hardcoded');
+    }
+}

package/stubs/namespace-stubs.js

@@ -7,4 +7,9 @@ export class NamespaceStubs {
     static stubNameSpaceResponse(repositoryId, fixture, withDelay = 0) {
         cy.intercept(`/repositories/${repositoryId}/namespaces`, {fixture, delay: withDelay}).as(`${repositoryId}-stub-namespaces`);
     }
+
+    static stubErrorOnNamespaceUpdate(repositoryId) {
+        cy.intercept('PUT', `/repositories/${repositoryId}/namespaces/*`,
+            {statusCode: 500, body: 'Internal Server Error'}).as(`stub-namespace-update-error`);
+    }
 }

package/stubs/repositories/repositories-stubs.js

@@ -4,11 +4,19 @@ import {RepositoriesStub} from "../repositories-stub";
 
 export class RepositoriesStubs extends Stubs {
     static stubRepositories(withDelay = 0, fixture = '/repositories/get-repositories.json') {
-        RepositoriesStubs.stubQueryResponse('/rest/repositories/all', fixture, 'get-all-repositories', withDelay);
+        RepositoriesStubs.stubGetQueryResponse('/rest/repositories/all', fixture, 'get-all-repositories', withDelay);
     }
 
     static stubLocations(withDelay = 0) {
-        RepositoriesStubs.stubQueryResponse('/rest/locations?filterClusterLocations=true', '/repositories/get-locations.json', 'backup-and-restore-response', withDelay);
+        RepositoriesStubs.stubQueryResponse('/rest/locations', '/repositories/get-locations.json', 'get-locations', withDelay);
+    }
+
+    static spyCreateLocation() {
+        cy.intercept('POST', '/rest/locations').as('createLocation');
+    }
+
+    static spyDeleteLocation() {
+        cy.intercept('DELETE', '/rest/locations?**').as('deleteLocation');
     }
 
     static stubEditOntopResponse(repositoryId) {
@@ -107,12 +115,7 @@ export class RepositoriesStubs extends Stubs {
             body: {}
         }).as('restartRepository');
 
-        cy.intercept(`/rest/autocomplete/enabled`, {
-            statusCode: 200,
-            body: {}
-        });
-
-        RepositoriesStub.stubNameSpaces(repositoryId, [{
+        RepositoriesStub.stubBaseEndpoints(repositoryId, [{
             "type": "literal",
             "value": "http://jena.apache.org/ARQ/function/aggregate#"
         }]);

package/stubs/repositories-stub.js

@@ -1,3 +1,5 @@
+import {GlobalOperationsStatusesStub} from "./global-operations-statuses-stub";
+
 export class RepositoriesStub {
 
     static stubOntopRepository(repositoryId) {
@@ -55,4 +57,17 @@ export class RepositoriesStub {
             body: namespacesResponse
         });
     }
+
+    static stubAutocomplete() {
+        cy.intercept(`/rest/autocomplete/enabled`, {
+            statusCode: 200,
+            body: {}
+        });
+    }
+
+    static stubBaseEndpoints(repositoryId, namespaces) {
+        RepositoriesStub.stubNameSpaces(repositoryId, namespaces);
+        RepositoriesStub.stubAutocomplete();
+        GlobalOperationsStatusesStub.stubNoOperationsResponse('starwars');
+    }
 }

package/stubs/security-stubs.js

@@ -12,6 +12,35 @@ export class SecurityStubs {
         }).as('security-all');
     }
 
+    static stubUpdateUserData(userName) {
+        cy.intercept('PATCH', `/rest/security/users/${userName}`, {
+            statusCode: 200,
+            body: {}
+        }).as('updateUser');
+    }
+
+    static stubGetAdminUser() {
+        cy.intercept('GET', 'rest/security/users/admin', {
+            fixture: '/security/get-admin-user.json',
+            statusCode: 200
+        }).as('getAdminUser');
+    }
+
+    /**
+     * Disables the globally configured interceptor for the GET request to get the admin user.
+     * This is useful when you want to test the real response from the server.
+     *
+     * This should be called in each test where you want to test the real response.
+     */
+    static resetGetAdminUserStub() {
+        cy.intercept('GET', 'rest/security/users/admin', (req) => {
+                req.reply((res) => {
+                    res.send({});
+                });
+            }
+        ).as('getAdminUser');
+    }
+
     static getAdminResponse(infer, sameAs) {
         return {
             "username": "admin",

package/stubs/setup/plugins-stubs.js

@@ -0,0 +1,5 @@
+export class PluginsStubs {
+    static spyPluginsGet(repositoryId) {
+        cy.intercept('GET', `/repositories/${repositoryId}?query=**`).as('get-plugins');
+    }
+}

package/stubs/similarity-index-stubs.js

@@ -4,4 +4,29 @@ export class SimilarityIndexStubs extends Stubs {
     static stubGetSimilarityIndexes(fixture = '/similarity/get-similarity-indexes.json', delay = 0) {
         this.stubQueryResponse('/rest/similarity', fixture, 'get-similarity-indexes', delay);
     }
+
+
+    /**
+     * Stubs Similarity indexes for three repositories:
+     * <ol>
+     *     <li> "starwars" - it has two similarity indexes "similarity_index_starwars_one" and "similarity_index_starwars_two"
+     *     <li> "biomarkers" - it has one similarity index "similarity_index_biomarkers_one"
+     *     <li> "ttyg-repo-1725518186812" - it has no any similarity indexes.
+     * </ol>
+     * @param {number} delay
+     */
+    static stubTTYGSimilarityIndexes(delay = 0) {
+        cy.fixture('/similarity/get-ttyg-similarity-connectors.json').then((body) => {
+            cy.intercept('/rest/similarity', (req) => {
+                const repositoryId = req.headers['x-graphdb-repository'];
+                const connectors = body[repositoryId];
+                // Respond with the modified body
+                req.reply({
+                    statusCode: 200,
+                    body: JSON.stringify(connectors),
+                    delay: delay
+                });
+            }).as('get-ttyg-similarity-indexes');
+        });
+    }
 }

package/stubs/stubs.js

@@ -2,4 +2,8 @@ export class Stubs {
     static stubQueryResponse(url, fixture, alias, withDelay = 0) {
         cy.intercept(url, {fixture, delay: withDelay}).as(alias);
     }
+
+    static stubGetQueryResponse(url, fixture, alias, withDelay = 0) {
+        cy.intercept('GET', url, {fixture, delay: withDelay}).as(alias);
+    }
 }

package/stubs/ttyg/ttyg-stubs.js

@@ -2,8 +2,7 @@ import {Stubs} from "../stubs";
 
 export class TTYGStubs extends Stubs {
     static stubChatsListGet(fixture = '/ttyg/chats/get-chat-list.json', delay = 0) {
-        cy.intercept('/rest/chat/conversations', {
-            method: 'GET',
+        cy.intercept('GET', '/rest/chat/conversations', {
             fixture: fixture,
             statusCode: 200,
             delay: delay
@@ -11,8 +10,7 @@ export class TTYGStubs extends Stubs {
     }
 
     static stubChatListGetError() {
-        cy.intercept('/rest/chat/conversations', {
-            method: 'GET',
+        cy.intercept('GET', '/rest/chat/conversations', {
             statusCode: 500,
             response: {
                 error: 'Internal Server Error'
@@ -21,86 +19,95 @@ export class TTYGStubs extends Stubs {
     }
 
     static stubChatsListGetNoResults() {
-        cy.intercept('/rest/chat/conversations', {
-            method: 'GET',
+        cy.intercept('GET', '/rest/chat/conversations', {
             fixture: '/ttyg/chats/get-chat-list-0.json',
             statusCode: 200
         }).as('get-chat-list');
     }
 
-    static stubChatCreate() {
-
-    }
-
     /**
      * Loads the specified <code>fixture</code> and updates the chatId in the fixture with the actual ID passed in the endpoint call.
      *
-     * @param {string} fixture - Path to the JSON file containing the chat conversation.
      * @param {number} delay - Optional delay in milliseconds before responding with the fixture.
      */
-    static stubChatGet(fixture = '/ttyg/chats/get-chat-1.json', delay = 0) {
-        cy.fixture(fixture).then((body) => {
-            const bodyString = JSON.stringify(body);
-            cy.intercept('/rest/chat/conversations/*', (req) => {
+    static stubChatGet(delay = 0) {
+        cy.fixture('/ttyg/chats/get-chat.json').then((body) => {
+            cy.intercept({
+                method: 'GET',
+                url: '/rest/chat/conversations/*'
+            }, (req) => {
                 const chatId = req.url.split('/').pop();
-                    // Respond with the modified body
-                    req.reply({
-                        statusCode: 200,
-                        body: bodyString.replace(/{chatId}/g, chatId),
-                        delay: delay
-                    });
+                const chat = body[chatId];
+                // Respond with the modified body
+                req.reply({
+                    statusCode: 200,
+                    body: JSON.stringify(chat),
+                    delay: delay
+                });
             }).as('get-chat');
         });
     }
 
+    static stubChatGet404Error() {
+        cy.intercept('GET', '/rest/chat/conversations/*', {
+            statusCode: 404,
+            response: {
+                error: 'Not Found'
+            }
+        }).as('get-chat');
+    }
+
     static stubChatUpdate() {
-        cy.intercept('/rest/chat/conversations/*', {
-            method: 'PUT',
+        cy.intercept('PUT', '/rest/chat/conversations/*', {
             fixture: '/ttyg/chats/renamed-chat.json',
             statusCode: 200
         }).as('update-chat');
     }
 
     static stubChatDelete() {
-        cy.intercept('/rest/chat/conversations/*', {
-            method: 'DELETE',
+        cy.intercept('DELETE', '/rest/chat/conversations/*', {
             fixture: '/ttyg/chats/deleted-chat.json',
             statusCode: 200
         }).as('delete-chat');
     }
 
     static stubChatExport() {
-        cy.intercept('/rest/chat/conversations/export/*', {
-            method: 'GET',
+        cy.intercept('GET', '/rest/chat/conversations/export/*', {
             fixture: '/ttyg/chats/export-chat.json',
             statusCode: 200
         }).as('export-chat');
     }
 
-    static stubAgentListGet(fixture = '/ttyg/agent/get-agent-list.json', delay = 0, invocation = 0) {
-        cy.intercept('/rest/chat/agents', {
-            method: 'GET',
+    static stubAgentListGet(fixture = '/ttyg/agent/get-agent-list.json', delay = 0) {
+        cy.intercept('GET', '/rest/chat/agents', {
             fixture: fixture,
             statusCode: 200,
             delay: delay
-        }).as('get-agent-list-' + invocation);
+        }).as('get-agent-list');
+    }
+
+    static stubAgentGet(fixture = '/ttyg/agent/get-agent.json', delay = 0) {
+        cy.intercept('GET', '/rest/chat/agents/*', {
+            fixture: fixture,
+            statusCode: 200,
+            delay: delay
+        }).as('get-agent');
     }
 
     static stubAgentListGetError() {
-        cy.intercept('/rest/chat/agents', {
-            method: 'GET',
+        cy.intercept('GET', '/rest/chat/agents', {
             statusCode: 500,
             response: {
                 error: 'Internal Server Error'
             }
-        }).as('get-agent-list');
+        }).as('get-agent-list-error');
     }
 
-    static stubAgentCreate() {
-        cy.intercept('/rest/chat/agents', {
-            method: 'POST',
+    static stubAgentCreate(delay = 0) {
+        cy.intercept('POST', '/rest/chat/agents', {
             fixture: '/ttyg/agent/create-agent.json',
-            statusCode: 200
+            statusCode: 200,
+            delay: delay
         }).as('create-agent');
     }
 
@@ -118,10 +125,42 @@ export class TTYGStubs extends Stubs {
     }
 
     static stubAgentDelete(delay = 0) {
-        cy.intercept('/rest/chat/agents/**', {
-            method: 'DELETE',
+        cy.intercept('DELETE', '/rest/chat/agents/**', {
             statusCode: 200,
             delay: delay
         }).as('delete-agent');
     }
+
+    static stubAgentDefaultsGet() {
+        cy.intercept('GET', '/rest/chat/agents/default', {
+            fixture: '/ttyg/agent/get-agent-defaults.json',
+            statusCode: 200
+        }).as('get-agent-defaults');
+    }
+
+    static stubAnswerQuestion(fixture = '/ttyg/chats/ask-question.json') {
+        cy.intercept('POST', '/rest/chat/conversations', {
+            fixture,
+            statusCode: 200
+        }).as('get-agent-defaults');
+    }
+
+    static stubCrateNewChat(fixture = 'ttyg/chats/create/create-chat-response.json') {
+        cy.fixture(fixture).then((fixtureData) => {
+            const today = Math.floor(Date.now() / 1000) + '';
+            const body = JSON.stringify(fixtureData).replace(/"creationDate"/g, today);
+            cy.intercept('POST', '/rest/chat/conversations', {
+                statusCode: 200,
+                body: JSON.parse(body)
+            }).as('create-chat');
+        });
+
+    }
+
+    static stubExplainResponse(fixture = '/ttyg/chats/explain-response-1.json') {
+        cy.intercept('POST', 'rest/chat/conversations/explain', {
+            fixture,
+            statusCode: 200
+        }).as('explain-response');
+    }
 }

package/support/commands.js

@@ -4,6 +4,8 @@ import './sparql-commands';
 import './import-commands';
 import './settings-commands';
 import './visual-graph-commands';
+import './user-commands';
+import './security-command';
 import 'cypress-wait-until';
 
 /**

package/support/index.js

@@ -21,6 +21,8 @@ import './commands';
 
 import 'cypress-real-events';
 import 'cypress-file-upload';
+import {LicenseStubs} from "../stubs/license-stubs";
+import {SecurityStubs} from "../stubs/security-stubs";
 
 // 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.
@@ -29,3 +31,19 @@ Cypress.env('modifierKey', Cypress.platform === 'darwin' ? '{cmd}' : '{ctrl}');
 require('cypress-failed-log');
 require('cypress-terminal-report/src/installLogsCollector')();
 
+// We don't want any tests to hit real Google
+beforeEach(() => {
+    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
+    // Cypress.env('set_default_user_data', false);
+    if (Cypress.env('set_default_user_data')) {
+        // cy.setDefaultUserData();
+        // Stub the request for updating user data instead of making request
+        // to modify it because for some reason this request gets a 401 response
+        // for some reason.
+        // It'll be good to investigate it a bit sometime.
+        SecurityStubs.stubGetAdminUser();
+        // SecurityStubs.stubUpdateUserData('admin');
+    }
+});

package/support/security-command.js

@@ -0,0 +1,25 @@
+Cypress.Commands.add('switchOnSecurity', () => {
+    cy.request({
+        method: 'POST',
+        url: `/rest/security`,
+        body: 'true',
+        headers: {
+            'Content-Type': 'application/json'
+        },
+        // Prevent Cypress from failing the test on non-2xx status codes
+        failOnStatusCode: false
+    });
+});
+
+Cypress.Commands.add('switchOffSecurity', () => {
+    cy.request({
+        method: 'POST',
+        url: `/rest/security`,
+        body: 'false',
+        headers: {
+            'Content-Type': 'application/json'
+        },
+        // Prevent Cypress from failing the test on non-2xx status codes
+        failOnStatusCode: true
+    });
+});

package/support/settings-commands.js

@@ -1,5 +1,6 @@
-Cypress.Commands.add('setDefaultUserData', () => {
+Cypress.Commands.add('setDefaultUserData', (cookieConsent = true) => {
     const defaultUserSettings = {
+        'COOKIE_CONSENT': cookieConsent,
         'DEFAULT_SAMEAS': true,
         'DEFAULT_INFERENCE': true,
         'EXECUTE_COUNT': true,
@@ -10,10 +11,8 @@ Cypress.Commands.add('setDefaultUserData', () => {
         method: 'PATCH',
         url: `rest/security/users/${encodeURIComponent('admin')}`,
         body: {
-            data: {
-                "appSettings": defaultUserSettings,
-                'password': 'root'
-            }
+            "appSettings": defaultUserSettings,
+            'password': 'root'
         }
     }).then((response) => {
         cy.waitUntil(() => response && response.status === 200); // 201 Created

package/support/user-commands.js

@@ -0,0 +1,31 @@
+Cypress.Commands.add('createUser', (options = {}) => {
+    cy.request({
+        method: 'POST',
+        url: `/rest/security/users/${options.username}`,
+        body: {
+            "password": options.password || "root",
+            "appSettings": {
+                "DEFAULT_SAMEAS": true,
+                "DEFAULT_INFERENCE": true,
+                "EXECUTE_COUNT": true,
+                "IGNORE_SHARED_QUERIES": false,
+                "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
+    });
+});
+
+Cypress.Commands.add('deleteUser', (username = {}) => {
+    cy.request({
+        method: 'DELETE',
+        url: `/rest/security/users/${username}`,
+        // Prevent Cypress from failing the test on non-2xx status codes
+        failOnStatusCode: false
+    });
+});

package/fixtures/ttyg/chats/get-chat-1.json

@@ -1,43 +0,0 @@
-{
-    "id": "{chatId}",
-    "name": "Han Solo is a fictional character in the...",
-    "messages": [
-        {
-            "id": "msg_YbtWCL64HPu9Kf7SbsssseRlrwCc",
-            "conversationId": "thread_gy2K7D3efStfchq2v5VvpEvn",
-            "agentId": "asst_uoKp5kgnPlyZHhRXY7P2r9D7",
-            "role": "assistant",
-            "message": "Han Solo is a fictional character in the Star ",
-            "timestamp": "1725875332",
-            "name": null
-        },
-        {
-            "id": "msg_1niL7yYidTfiGZynCiryiMMd",
-            "conversationId": "thread_gy2K7D3efStfchq2v5VvpEvn",
-            "agentId": null,
-            "role": "user",
-            "message": "Who are the Han Solo's children?",
-            "timestamp": "1725875483",
-            "name": null
-        },
-        {
-            "id": "msg_YbtWCL64HPu9Kf7SbeRlrwCc",
-            "conversationId": "thread_gy2K7D3efStfchq2v5VvpEvn",
-            "agentId": "asst_uoKp5kgnPlyZHhRXY7P2r9D7",
-            "role": "assistant",
-            "message": "Han Solo is a fictional character in the Star Wars franchise.",
-            "timestamp": "1725875332",
-            "name": null
-        },
-        {
-            "id": "msg_A9UeOFT9SF3pKzJzar1HwM7d",
-            "conversationId": "thread_gy2K7D3efStfchq2v5VvpEvn",
-            "agentId": null,
-            "role": "user",
-            "message": "Who is Han Solo?",
-            "timestamp": "1725875323",
-            "name": null
-        }
-    ],
-    "timestamp": "1725875483"
-}