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

package/integration/explore/similarity-index/similarity.spec.js

@@ -1,628 +0,0 @@
-import {SparqlEditorSteps} from "../../../steps/sparql-editor-steps";
-import {YasqeSteps} from "../../../steps/yasgui/yasqe-steps";
-import {YasrSteps} from "../../../steps/yasgui/yasr-steps";
-import {SimilarityIndexCreateSteps} from "../../../steps/explore/similarity-index-create-steps";
-import {SimilarityIndexesSteps} from "../../../steps/explore/similarity-indexes-steps";
-import {ModalDialogSteps, VerifyConfirmationDialogOptions} from "../../../steps/modal-dialog-steps";
-import {ErrorSteps} from "../../../steps/error-steps";
-
-const INDEX_NAME = 'index-' + Date.now();
-const FILE_TO_IMPORT = 'people.zip';
-const INDEX_CREATE_URL = '/similarity/index/create';
-const BUILD_PARAM = ' -trainingcycles 4';
-const STOP_WORD = 'stopword';
-const LUCENE_ANALYZER = 'org.apache.lucene.analysis.de.GermanAnalyzer';
-const MODIFIED_SEARCH_QUERY = 'PREFIX :<http://www.ontotext.com/graphdb/similarity/> \n' +
-    'SELECT ?documentID ?score { \n' +
-    '?search a ?index ; \n' +
-    '?searchType ?query; \n' +
-    ':searchParameters ?parameters; \n' +
-    '?resultType ?result . \n' +
-    '?result :value ?documentID ; \n' +
-    ':score ?score. \n' +
-    'OPTIONAL { ?result <http://dbpedia.org/ontology/birthPlace> ?birthDate . }}';
-const MODIFIED_ANALOGICAL_QUERY = 'PREFIX :<http://www.ontotext.com/graphdb/similarity/>\n' +
-    'PREFIX psi:<http://www.ontotext.com/graphdb/similarity/psi/>\n' +
-    'PREFIX inst:<http://www.ontotext.com/graphdb/similarity/instance/>\n' +
-    '\n' +
-    'SELECT ?resultValue ?score {\n' +
-    '    ?search a ?index ;\n' +
-    '        psi:givenSubject ?givenSubject;\n' +
-    '        psi:givenObject ?givenObject;\n' +
-    '        psi:searchSubject ?searchSubject;\n' +
-    '        :searchParameters ?parameters;\n' +
-    '        psi:resultObject ?result .\n' +
-    '    ?result :value ?resultValue;\n' +
-    '            :score ?score .\n' +
-    'OPTIONAL { ?result <http://dbpedia.org/ontology/birthPlace> ?birthDate . }}';
-const MODIFIED_DATA_QUERY = 'SELECT ?documentID ?documentText { \n' +
-    '?documentID <http://dbpedia.org/ontology/birthDate> ?documentText . \n' +
-    'filter(isLiteral(?documentText)) \n' +
-    '}order by asc(str(?documentID))';
-
-describe('Similarity screen validation', () => {
-
-    let repositoryId;
-
-    afterEach(() => {
-        cy.deleteRepository(repositoryId);
-    });
-
-    it('Test similarity page default state', () => {
-        initRepositoryAndVisitSimilarityView();
-        checkSimilarityPageDefaultState();
-    });
-
-    context('Creating similarity index', () => {
-        beforeEach(() => {
-            initRepositoryAndVisitSimilarityView();
-        });
-
-        it('Create default text similarity index and view SPARQL query', () => {
-            openCreateNewIndexForm();
-            setIndexName();
-            createSimilarityIndex();
-            viewSPARQLQuery();
-            deleteSimilarityIndex();
-        });
-
-        it('Create default predication similarity index', () => {
-            openCreateNewIndexForm();
-            switchToPredicationIndex();
-            setIndexName();
-            createSimilarityIndex();
-        });
-
-        it('Create text similarity index with a build parameter, stop word and custom Lucene Analyzer', () => {
-            openCreateNewIndexForm();
-            setIndexName();
-            clickMoreOptionsMenu();
-            addBuildParam();
-            addStopWord();
-            addLuceneAnalyzer();
-            clickMoreOptionsMenu();
-            createSimilarityIndex();
-        });
-
-        it('Create predication similarity index with a build parameter', () => {
-            openCreateNewIndexForm();
-            switchToPredicationIndex();
-            setIndexName();
-            clickMoreOptionsMenu();
-            addBuildParam();
-            clickMoreOptionsMenu();
-            createSimilarityIndex();
-        });
-
-        it('Create text similarity - literal index', () => {
-            openCreateNewIndexForm();
-            setIndexName();
-            clickMoreOptionsMenu();
-            checkLiteralIndex();
-            createSimilarityIndex();
-        });
-
-        it('Should not allow create similarity index with name that already exist', () => {
-            // If we have a similarity index.
-            openCreateNewIndexForm();
-            setIndexName();
-            createSimilarityIndex();
-
-            // When I try to create a similarity index with same name.
-            openCreateNewIndexForm();
-            setIndexName();
-            getCreateIndexButton().click();
-            // Then I expect an error message to be displayed that describes me, that name is mandatory.
-            ErrorSteps.verifyError('Index with this name already exists.');
-        });
-    });
-
-    context('Index operations', () => {
-        beforeEach(() => {
-            initRepositoryAndVisitSimilarityView();
-        });
-
-        it('Change Data query in Create index', () => {
-            openCreateNewIndexForm();
-            setIndexName();
-            changeDataQuery();
-            createSimilarityIndex();
-        });
-
-        it('Change Search query in Create index', () => {
-            openCreateNewIndexForm();
-            setIndexName();
-            changeSearchQuery();
-            createSimilarityIndex();
-        });
-
-        it('Change Search query of existing text index', () => {
-            openCreateNewIndexForm();
-            setIndexName();
-            createSimilarityIndex();
-            openEditQueryView();
-            changeSearchQuery();
-            getSaveEditedQueryButton().click();
-            openEditQueryView();
-            verifyQueryIsChanged();
-        });
-
-        it('Change Analogical query of existing predication index', () => {
-            openCreateNewIndexForm();
-            switchToPredicationIndex();
-            setIndexName();
-            createSimilarityIndex();
-            openEditQueryView(true);
-            changeAnalogicalQuery();
-            getSaveEditedQueryButton().click();
-            openEditQueryView(true);
-            getAnalogicalQueryTab()
-                .scrollIntoView()
-                .should('be.visible')
-                .click()
-                .then(() => {
-                    verifyQueryIsChanged();
-                });
-        });
-
-        it('Clone existing similarity index', () => {
-            openCreateNewIndexForm();
-            setIndexName();
-            createSimilarityIndex();
-            cloneExistingIndex();
-        });
-
-        it('Rebuild existing similarity index', () => {
-            openCreateNewIndexForm();
-            setIndexName();
-            createSimilarityIndex();
-            rebuildIndex();
-        });
-    });
-
-    context('Searching in index', () => {
-        beforeEach(() => {
-            initRepositoryAndVisitSimilarityView();
-        });
-
-        it('Search for entity in index', () => {
-            // I have created similarity index
-            openCreateNewIndexForm();
-            setIndexName();
-            createSimilarityIndex();
-            // wait a bit for the edit icon to ensure index is created
-            cy.get('.icon-edit').should('be.visible');
-
-            // When I open the index
-            openIndex(0);
-
-            // Then I expect the indexes table to become hidden
-            cy.get('#indexes-table table').should('not.be.visible');
-
-            // And index search panel to be opened
-            cy.get('.index-search-panel').should('be.visible');
-            cy.get('.selected-index').should('be.visible').and('contain', `Search in ${INDEX_NAME}`);
-            getSearchIndexInput().should('be.visible');
-            // The search and result types should both be set to Term
-            SimilarityIndexesSteps.getSearchTypeButton().should('contain.text', 'Term');
-            SimilarityIndexesSteps.getResultTypeButton().should('contain.text', 'Term');
-
-            // When I search for "Neal" in the index
-            searchIndex('Neal');
-
-            // Then I expect search results to be displayed
-            // And showing 20 results
-            YasrSteps.getResults().should('have.length', 20);
-
-            // When I select Document as the search type
-            SimilarityIndexesSteps.selectSearchTypeOption('Document');
-
-            // The result type should remain Term
-            SimilarityIndexesSteps.getResultTypeButton().should('contain.text', 'Term');
-
-            // When I select Document as the result type
-            SimilarityIndexesSteps.selectResultTypeOption('Document');
-
-            // The search type should remain Document
-            SimilarityIndexesSteps.getSearchTypeButton().should('contain.text', 'Document');
-
-            // The result type should be Document
-            SimilarityIndexesSteps.getResultTypeButton().should('contain.text', 'Document');
-        });
-    });
-
-    it('Disable and enable similarity plugin', {
-        retries: {
-            openMode: 0,
-            runMode: 2
-        }
-    }, () => {
-        const disableSimilarityPlugin = 'INSERT DATA { <u:a> <http://www.ontotext.com/owlim/system#stopplugin> \'similarity\' . }';
-        initRepository();
-        cy.presetRepository(repositoryId);
-
-        SparqlEditorSteps.visitSparqlEditorPage();
-
-        // When I disable the plugin.
-        YasqeSteps.pasteQuery(disableSimilarityPlugin);
-        YasqeSteps.executeQuery();
-
-        // Then I expect a message to be displayed confirming that operation is complete.
-        YasrSteps.getResponseInfo().should('be.visible').and('contain', 'The number of statements did not change.');
-
-        // When I try to disable it while it's disabled.
-        YasqeSteps.executeErrorQuery();
-
-        // Then I expect an error message to be displayed informing me that the plugin has been already disabled.
-        YasrSteps.getErrorBody().should('be.visible').and('contain', 'Plugin similarity has been already disabled');
-
-        // When I visit similarity view while the plugin is disabled.
-        cy.visit('/similarity');
-        cy.window();
-
-        // Then I expect a message to be displayed informing me that the plugin is disabled.
-        cy.get('.plugin-not-active-warning').should('be.visible').and('contain', 'Similarity Plugin is not active for this repository.');
-        // cy.pause()
-        // When I enable the plugin
-        cy.get('.confirm-btn')
-            .should('be.visible')
-            .and('contain', 'Activate')
-            .click().then(() => {
-                // Should confirm that want to activate plugin
-                cy.get('.modal-footer > .btn-primary')
-                    .should('be.visible')
-                    .click()
-                    .then(() => {
-                        // Then I expect default similarity view with no indexes available
-                        // cy.pause()
-                        checkSimilarityPageDefaultState();
-                    });
-        });
-    });
-
-    context('Confirmations when try to change location', () => {
-
-        beforeEach(() => {
-            initRepositoryAndVisitSimilarityView();
-            openCreateNewIndexForm();
-        });
-
-        it('should not display confirm message when there are not changes', () => {
-            // Given I opened the create similarity view.
-            // When I click on cancel button.
-            SimilarityIndexCreateSteps.cancel();
-
-            // Then I expect to be redirected to similarity indexes view.
-            SimilarityIndexesSteps.verifyUrl();
-
-        });
-
-        it('should display confirm message if index name is filled', () => {
-            // Given I opened the create similarity view,
-            // and similarity index name is filled.
-            SimilarityIndexCreateSteps.typeSimilarityIndexName('index');
-
-            // When click on cancel button.
-            // Then I expect to be redirected to similarity indexes view.
-            ModalDialogSteps.verifyUrlChangedConfirmation(createVerifyConfirmationDialogOptions());
-        });
-
-        it('should display confirm message if data query is changed', () => {
-            // Given I opened the create similarity view,
-            // and data query is changed.
-            // During the initialization query is changed and this broke the test.
-            // Most the time the broken flow is:
-            // 1.   cypress start to type 's';
-            // 2.   query is changed
-            // 3.   cypress continuous to type 'ome changes'.
-            // as result query is 'ome changes<data query>. YasqeSteps.writeInEditor function has check if parameter is filled, in our case 'some changes',
-            // and this broke the test. Add a little wait time to give chance yasqe query to be filled.
-            cy.wait(1000);
-            YasqeSteps.writeInEditor('some changes');
-
-            // When click on cancel button.
-            // Then I expect to be redirected to similarity indexes view.
-            ModalDialogSteps.verifyUrlChangedConfirmation(createVerifyConfirmationDialogOptions());
-        });
-
-        it('should display confirm message if "Semantic Vectors create index parameters" is changed', () => {
-            // Given I opened the create similarity view,
-            // and "Semantic Vectors create index parameters" is changed.
-            SimilarityIndexCreateSteps.showMoreOptions();
-            SimilarityIndexCreateSteps.getSemanticVectorsInput().type('semantic vector');
-
-            // When click on cancel button.
-            // Then I expect to be redirected to similarity indexes view.
-            ModalDialogSteps.verifyUrlChangedConfirmation(createVerifyConfirmationDialogOptions());
-        });
-
-        it('should display confirm message if "Stop words" is changed', () => {
-            // Given I opened the create similarity view,
-            // and "Stop words" is changed.
-            SimilarityIndexCreateSteps.showMoreOptions();
-            SimilarityIndexCreateSteps.getStopWordsInput().type('stop words');
-
-            // When click on cancel button.
-            // Then I expect to be redirected to similarity indexes view.
-            ModalDialogSteps.verifyUrlChangedConfirmation(createVerifyConfirmationDialogOptions());
-        });
-
-        it('should display confirm message if "Analyzer Class" is changed', () => {
-            // Given I opened the create similarity view,
-            // and "Analyzer Class" is changed.
-            SimilarityIndexCreateSteps.showMoreOptions();
-            SimilarityIndexCreateSteps.getAnalyzerClassInput().type('BulgarianAnalyzer');
-
-            // When click on cancel button.
-            // Then I expect to be redirected to similarity indexes view.
-            ModalDialogSteps.verifyUrlChangedConfirmation(createVerifyConfirmationDialogOptions());
-        });
-
-        it('should display confirm message if "Literal index" is changed', () => {
-            // Given I opened the create similarity view,
-            // and "Literal index" is changed.
-            SimilarityIndexCreateSteps.showMoreOptions();
-            SimilarityIndexCreateSteps.checkLiteralIndex();
-
-            // When click on cancel button.
-            // Then I expect to be redirected to similarity indexes view.
-            ModalDialogSteps.verifyUrlChangedConfirmation(createVerifyConfirmationDialogOptions());
-        });
-
-        it('should display confirm message if "Search query" is changed', () => {
-            // Given I opened the create similarity view,
-            // and "Search query" is changed.
-            SimilarityIndexCreateSteps.switchToSearchQueryTab();
-            YasqeSteps.writeInEditor('some changes');
-
-            // When click on cancel button.
-            // Then I expect to be redirected to similarity indexes view.
-            ModalDialogSteps.verifyUrlChangedConfirmation(createVerifyConfirmationDialogOptions());
-        });
-
-        it('should display confirm message if "Analogical query" is changed', () => {
-            // Given I opened the create similarity view,
-            // and "Analogical query" is changed.
-            SimilarityIndexCreateSteps.switchToCreatePredictionIndexTab();
-            SimilarityIndexCreateSteps.switchToAnalogicalQueryTab();
-            YasqeSteps.writeInEditor('some changes');
-
-            // When click on cancel button.
-            // Then I expect to be redirected to similarity indexes view.
-            ModalDialogSteps.verifyUrlChangedConfirmation(createVerifyConfirmationDialogOptions());
-        });
-    });
-
-    function initRepository() {
-        repositoryId = 'similarity-repo-' + Date.now();
-        cy.createRepository({id: repositoryId});
-        cy.importServerFile(repositoryId, FILE_TO_IMPORT);
-    }
-
-    function initRepositoryAndVisitSimilarityView() {
-        initRepository();
-        cy.visit('/similarity', {
-            onBeforeLoad: (win) => {
-                win.localStorage.setItem('ls.repository-id', repositoryId);
-            }
-        });
-        cy.window()
-            .then(() => getExistingIndexesPanel());
-    }
-
-    function openIndex(index) {
-        getIndexLinks().eq(index).click();
-    }
-
-    function getSearchIndexInput() {
-        // There are 6 such fields and it's not obvious what selectors they should have.
-        // So we select it by placeholders.
-        return cy.get('input[placeholder="Search RDF resources for RDF entity"]');
-    }
-
-    function searchIndex(entity) {
-        getSearchIndexInput().type(entity);
-        // there are two buttons so we search in the context
-        getSearchIndexInput().closest('.input-group').find('.autocomplete-visual-btn').click();
-    }
-
-    function checkSimilarityPageDefaultState() {
-        //TODO: Should change the 'contain' method to 'eq' once GDB-3699 is fixed.
-        cy.url().should('contain', Cypress.config('baseUrl') + '/similarity');
-        getExistingIndexesPanel()
-            .find('.no-indexes')
-            .should('be.visible')
-            .and('contain', 'No Indexes');
-    }
-
-    function openCreateNewIndexForm() {
-        cy.get('.create-similarity-index').click();
-        cy.url().should('contain', `${Cypress.config('baseUrl')}/similarity/index/create`);
-        // Wait for query editor to become ready because consecutive command for index creation might
-        // fail because the query may not be submitted with the request.
-        YasqeSteps.waitUntilQueryIsVisible();
-    }
-
-    function setIndexName() {
-        cy.url().should('eq', Cypress.config('baseUrl') + INDEX_CREATE_URL);
-        getSimilarity().invoke('val', INDEX_NAME).trigger('change')
-            .then(() => getSimilarity().should('have.value', INDEX_NAME));
-    }
-
-    function clickMoreOptionsMenu() {
-        cy.get('.more-options-btn').click();
-    }
-
-    function addBuildParam() {
-        cy.get('#indexParameters').type(BUILD_PARAM);
-    }
-
-    function addStopWord() {
-        cy.get('.stop-words').type(STOP_WORD);
-    }
-
-    function addLuceneAnalyzer() {
-        cy.get('.analyzer-class').type(Cypress.env('modifierKey') + 'a{backspace}', {force: true})
-            .invoke('val', LUCENE_ANALYZER).trigger('change', {force: true});
-    }
-
-    function checkLiteralIndex() {
-        cy.get('.literal-index').click();
-    }
-
-    function createSimilarityIndex() {
-        getCreateIndexButton().click()
-            .then(() => {
-                cy.url().should('eq', `${Cypress.config('baseUrl')}/similarity`);
-                getExistingIndexesPanel();
-                cy.get('#indexes-table table').should('be.visible')
-                    .find('.index-row').should('have.length', 1);
-                // Just wait for the row in the table to appear and the cell with the index name to be
-                // visible. Waiting for the loading indicator to disappear is just too brittle.
-                // Also trying to check for the index name in the cell with `.and('contain', INDEX_NAME);`
-                // fails often because during completing the index name on a previous step the WB seems to
-                // cut off part of the name on the leading side.
-                getIndexLinks().should('be.visible');
-                cy.waitUntil(() =>
-                    cy.get('.edit-query-btn')
-                            .then((editBtn) => editBtn));
-            });
-    }
-
-    function deleteSimilarityIndex() {
-        waitForIndexBuildingIndicatorToHide();
-        getDeleteIndexButton().should('be.visible');
-        getDeleteIndexButton().click();
-        cy.get('.modal-footer .confirm-btn').click();
-        cy.get('.no-indexes').should('be.visible').and('contain', 'No Indexes');
-    }
-
-    function switchToPredicationIndex() {
-        cy.get('#create-predication-index').click();
-        // Wait for query editor to become ready because consecutive command for index creation might
-        // fail because the query may not be submitted with the request.
-        YasqeSteps.waitUntilQueryIsVisible();
-    }
-
-    function cloneExistingIndex() {
-        cy.url().should('eq', Cypress.config('baseUrl') + '/similarity');
-        cy.get('.clone-index-btn').click()
-            .then(() => cy.url().should('contain', `${Cypress.config('baseUrl')}/similarity/index/create`));
-
-        // Makes sure YASQE has loaded before we click the Create button
-        YasqeSteps.waitUntilQueryIsVisible();
-        getCreateIndexButton().should('be.visible').click();
-
-        getExistingIndexesPanel();
-        waitForIndexBuildingIndicatorToHide();
-        cy.waitUntil(() =>
-            cy.get('#indexes-table')
-                .find('.index-row')
-                .then((indexes) => indexes.length === 2));
-
-        cy.url().should('contain', Cypress.config('baseUrl') + '/similarity'); //Should change the 'contain' method to 'eq' once GDB-3699 is resolved
-    }
-
-    function getIndexLinks() {
-        return cy.get('#indexes-table .index-name');
-    }
-
-    function rebuildIndex() {
-        cy.get('.similarity-index-icon-reload').should('be.visible').click();
-        cy.get('.modal-footer .btn-primary').click();
-        cy.get('.similarity-index-building-loader').should('be.visible');
-        getDeleteIndexButton().should('be.visible');
-        waitForIndexBuildingIndicatorToHide();
-    }
-
-    function viewSPARQLQuery() {
-        cy.get('.view-sparql-query-btn').click();
-        cy.get('.modal-title').should('be.visible').and('contain', 'View SPARQL Query');
-        cy.get('.btn-primary').should('be.visible').and('contain', 'Copy to clipboard');
-        cy.get('.close').click();
-        cy.get('.modal').should('not.exist');
-        cy.get('.modal-backdrop').should('not.exist');
-    }
-
-    function openEditQueryView(isPredication) {
-        cy.url().should('contain', Cypress.config('baseUrl') + '/similarity');
-        // Open "Edit search query" view
-        cy.get('.edit-query-btn').should('be.visible').click();
-        // Verify that 'similarity-index-name' input field is disabled
-        getSimilarity().should('be.disabled');
-        getSearchQueryTab().should('be.visible');
-        YasqeSteps.waitUntilQueryIsVisible();
-        const shouldAnalogicalTabBeVisible = (isPredication ? '' : 'not.') + 'exist';
-        getAnalogicalQueryTab().should(shouldAnalogicalTabBeVisible);
-        if (isPredication) {
-            YasqeSteps.verifyQueryContains('SELECT ?entity ?score {');
-        }
-    }
-
-    function changeDataQuery() {
-        YasqeSteps.pasteQuery(MODIFIED_DATA_QUERY);
-        cy.get('.test-query-btn', {force: true}).click();
-        cy.get('.sparql-loader').should('not.exist');
-        YasrSteps.getResults().its('length').should('be.gt', 1);
-        YasrSteps.getResults().contains('http://dbpedia.org/resource/Aaron_Jay_Kernis');
-    }
-
-    function changeSearchQuery() {
-        SimilarityIndexCreateSteps.switchToSearchQueryTab();
-        YasqeSteps.pasteQuery(MODIFIED_SEARCH_QUERY);
-    }
-
-    function changeAnalogicalQuery() {
-        getAnalogicalQueryTab()
-            .scrollIntoView()
-            .should('be.visible').click()
-            .then(() => {
-                YasqeSteps.pasteQuery(MODIFIED_ANALOGICAL_QUERY);
-            });
-    }
-
-    function getDeleteIndexButton() {
-        return cy.get('.delete-index-btn');
-    }
-
-    function getCreateIndexButton() {
-        return cy.get('.create-similarity-index-btn');
-    }
-
-    function getSearchQueryTab() {
-        return cy.get('.search-query-tab');
-    }
-
-    function getAnalogicalQueryTab() {
-        return cy.get('.analogical-query-tab');
-    }
-
-    function getSaveEditedQueryButton() {
-        return cy.get('.save-query-btn').scrollIntoView().should('be.visible');
-    }
-
-    function getSimilarity() {
-        return cy.get('.similarity-index-name');
-    }
-
-    function getExistingIndexesPanel() {
-        return cy.get('.existing-indexes').should('be.visible');
-    }
-
-    function waitForIndexBuildingIndicatorToHide() {
-        cy.get('.similarity-index-building-loader').should('not.exist');
-    }
-
-    function verifyQueryIsChanged() {
-        const query = 'OPTIONAL { ?result <http://dbpedia.org/ontology/birthPlace> ?birthDate .';
-        YasqeSteps.verifyQueryContains(query);
-    }
-
-    function createVerifyConfirmationDialogOptions() {
-        return new VerifyConfirmationDialogOptions()
-            .setChangePageFunction(() => SimilarityIndexCreateSteps.getCancelButton().click())
-            .setConfirmationMessage('You have unsaved changes. Are you sure that you want to exit?')
-            .setVerifyCurrentUrl(() => cy.url().should('include', `${Cypress.config('baseUrl')}/similarity/index/create`))
-            .setVerifyRedirectedUrl(() => cy.url().should('eq', `${Cypress.config('baseUrl')}/similarity`));
-    }
-});