/* * Copyright 2023 Collate. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * http://www.apache.org/licenses/LICENSE-2.0 * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { DELETE_TERM, INVALID_NAMES, NAME_MIN_MAX_LENGTH_VALIDATION_ERROR_1_128, NAME_VALIDATION_ERROR, SEARCH_ENTITY_TABLE, } from '../constants/constants'; import { SidebarItem } from '../constants/Entity.interface'; import { descriptionBox, interceptURL, toastNotification, verifyResponseStatusCode, } from './common'; import { visitEntityDetailsPage } from './Utils/Entity'; const selectDomain = (domainObj) => { cy.get('[data-testid="domain-left-panel"]') .find(`li[data-menu-id$='${domainObj.fullyQualifiedName}']`) .click(); }; export const validateDomainForm = () => { // error messages cy.get('#name_help') .scrollIntoView() .should('be.visible') .contains('Name is required'); cy.get('#description_help') .should('be.visible') .contains('Description is required'); // max length validation cy.get('[data-testid="name"]') .scrollIntoView() .should('be.visible') .type(INVALID_NAMES.MAX_LENGTH); cy.get('#name_help').should( 'contain', NAME_MIN_MAX_LENGTH_VALIDATION_ERROR_1_128 ); // with special char validation cy.get('[data-testid="name"]') .should('be.visible') .clear() .type(INVALID_NAMES.WITH_SPECIAL_CHARS); cy.get('#name_help').should('be.visible').contains(NAME_VALIDATION_ERROR); }; const checkDisplayName = (displayName) => { cy.get('[data-testid="entity-header-display-name"]') .scrollIntoView() .should('exist') .and('be.visible') .within(() => { cy.contains(displayName); }); }; const checkDataProductsCount = (dataProductsCount) => { cy.get('[data-testid="data_products"] [data-testid="count"]') .scrollIntoView() .should('have.text', dataProductsCount); }; const checkAssetsCount = (assetsCount) => { cy.get('[data-testid="assets"] [data-testid="count"]') .scrollIntoView() .should('have.text', assetsCount); }; const updateOwner = (newOwner) => { interceptURL('PATCH', `/api/v1/domains/*`, 'patchOwner'); interceptURL('GET', '/api/v1/users?limit=25&isBot=false', 'getUsers'); cy.get('[data-testid="edit-owner"]').click(); cy.get('.ant-tabs [id*=tab-users]').click(); verifyResponseStatusCode('@getUsers', 200); interceptURL( 'GET', `api/v1/search/query?q=*${encodeURI(newOwner)}*`, 'searchOwner' ); cy.get('[data-testid="owner-select-users-search-bar"]').type(newOwner); verifyResponseStatusCode('@searchOwner', 200); cy.get(`.ant-popover [title="${newOwner}"]`).click(); verifyResponseStatusCode('@patchOwner', 200); cy.get(`[data-testid="domain-owner-name"]`).should('contain', newOwner); }; const goToAssetsTab = (domainObj) => { selectDomain(domainObj); checkDisplayName(domainObj.name); cy.get('[data-testid="assets"]').should('be.visible').click(); cy.get('.ant-tabs-tab-active').contains('Assets').should('be.visible'); }; const goToDataProductsTab = (domainObj) => { selectDomain(domainObj); checkDisplayName(domainObj.name); cy.get('[data-testid="data_products"]').click(); cy.get('.ant-tabs-tab-active').contains('Data Products').should('be.visible'); }; export const updateAssets = (domainObj) => { interceptURL( 'GET', `/api/v1/search/query?q=*&index=domain_search_index*`, 'searchDomain' ); const entity = SEARCH_ENTITY_TABLE.table_2; goToAssetsTab(domainObj); cy.contains('Adding a new Asset is easy, just give it a spin!').should( 'be.visible' ); visitEntityDetailsPage({ term: entity.term, serviceName: entity.serviceName, entity: entity.entity, }); cy.get('[data-testid="add-domain"]').click(); // Enter domain name cy.get('.domain-select-popover [data-testid="searchbar"]') .click() .type(domainObj.name); verifyResponseStatusCode('@searchDomain', 200); cy.get('[data-testid="selectable-list"]') .find(`[title="${domainObj.name}"]`) .click(); cy.get('[data-testid="domain-link"]').should('contain', domainObj.name); cy.sidebarClick(SidebarItem.DOMAIN); goToAssetsTab(domainObj); cy.get('.assets-data-container [data-testid="entity-header-display-name"]') .contains(entity.term) .should('be.visible'); }; export const removeAssets = (domainObj) => { const entity = SEARCH_ENTITY_TABLE.table_2; interceptURL('GET', '/api/v1/search/query*', 'assetTab'); // go assets tab goToAssetsTab(domainObj); verifyResponseStatusCode('@assetTab', 200); interceptURL('GET', '/api/v1/domain*', 'domains'); interceptURL('PATCH', '/api/v1/tables/*', 'patchDomain'); cy.get('[data-testid="entity-header-display-name"]') .contains(entity.term) .click(); cy.get('[data-testid="add-domain"]').click(); verifyResponseStatusCode('@domains', 200); cy.get('[data-testid="remove-owner"]').click(); verifyResponseStatusCode('@patchDomain', 200); cy.sidebarClick(SidebarItem.DOMAIN); goToAssetsTab(domainObj); cy.contains('Adding a new Asset is easy, just give it a spin!').should( 'be.visible' ); }; const updateDescription = (newDescription) => { interceptURL('PATCH', '/api/v1/domains/*', 'saveDomain'); cy.get('[data-testid="edit-description"]').should('be.visible').click(); cy.get('.ant-modal-wrap').should('be.visible'); cy.get(descriptionBox).should('be.visible').as('description'); cy.get('@description').clear(); cy.get('@description').type(newDescription); cy.get('[data-testid="save"]').click(); verifyResponseStatusCode('@saveDomain', 200); cy.get('.ant-modal-wrap').should('not.exist'); cy.get('[data-testid="viewer-container"]') .contains(newDescription) .should('be.visible'); }; const fillForm = (formObj, type) => { interceptURL('GET', '/api/v1/users?*isBot=false*', 'getUsers'); cy.get('[data-testid="name"]').scrollIntoView().clear().type(formObj.name); cy.get(descriptionBox) .scrollIntoView() .should('be.visible') .type(formObj.description); cy.get('[data-testid="add-owner"]').scrollIntoView().click(); cy.get('.ant-tabs [id*=tab-users]').click(); verifyResponseStatusCode('@getUsers', 200); interceptURL( 'GET', `api/v1/search/query?q=*${encodeURI(formObj.owner)}*`, 'searchOwner' ); cy.get('[data-testid="owner-select-users-search-bar"]').type(formObj.owner); verifyResponseStatusCode('@searchOwner', 200); cy.get(`.ant-popover [title="${formObj.owner}"]`).click(); cy.get('[data-testid="owner-container"]').children().should('have.length', 1); cy.get('[data-testid="add-experts"]').scrollIntoView().click(); verifyResponseStatusCode('@getUsers', 200); cy.get('[data-testid="loader"]').should('not.exist'); interceptURL( 'GET', `api/v1/search/query?q=*${encodeURI(formObj.experts)}*`, 'searchExpert' ); cy.get('.user-select-popover [data-testid="searchbar"]').type( formObj.experts ); verifyResponseStatusCode('@searchExpert', 200); cy.get(`.user-select-popover [title="${formObj.experts}"]`) .scrollIntoView() .click(); cy.get('[data-testid="selectable-list-update-btn"]').click(); cy.get('[data-testid="delete-modal"]').should('not.exist'); cy.get('[data-testid="experts-container"]') .children() .should('have.length', 1); if (type === 'domain') { cy.get('[data-testid="domainType"]').click(); cy.get(`.ant-select-dropdown [title="${formObj.domainType}"]`).click(); } }; /** * Creates a new domain. * * @param {Object} domainObj - An object containing the properties of the domain. * @param {boolean} validate - A flag indicating whether to validate the form. * @return {void} */ export const createDomain = (domainObj, validate) => { cy.get('[data-testid="add-domain"]').click(); interceptURL('POST', '/api/v1/domains', 'createDomain'); // Redirecting to add domain page cy.get('[data-testid="form-heading"]') .contains('Add Domain') .should('be.visible'); // validation should work cy.get('[data-testid="save-domain"]').scrollIntoView().click(); if (validate) { validateDomainForm(); } fillForm(domainObj, 'domain'); cy.get('[data-testid="save-domain"]').scrollIntoView().click(); cy.wait('@createDomain').then(({ request }) => { expect(request.body.name).equals(domainObj.name); expect(request.body.description).equals(domainObj.description); expect(request.body.experts).has.length(1); cy.url().should('include', '/domain/'); checkDisplayName(domainObj.name); checkAssetsCount(0); checkDataProductsCount(0); }); }; export const deleteDomain = (domainObj) => { cy.get('.ant-menu-item').contains(domainObj.updatedDisplayName).click(); cy.get('[data-testid="manage-button"]').click(); cy.get('[data-testid="delete-button"]').scrollIntoView().click(); cy.get('[data-testid="delete-modal"]').then(() => { cy.get('[role="dialog"]').should('be.visible'); }); cy.get('[data-testid="delete-modal"] .ant-modal-title').should( 'contain', domainObj.updatedDisplayName ); cy.get('[data-testid="confirmation-text-input"]').type(DELETE_TERM); interceptURL('DELETE', '/api/v1/domains/*', 'getDomains'); cy.get('[data-testid="confirm-button"]').click(); verifyResponseStatusCode('@getDomains', 200); toastNotification(`"${domainObj.updatedDisplayName}" deleted successfully!`); }; export const verifyDomain = (domainObj) => { selectDomain(domainObj); checkDisplayName(domainObj.name); cy.get('[data-testid="viewer-container"]') .invoke('text') .then((text) => { expect(text).to.contain(domainObj.description); }); cy.get(`[data-testid="domain-owner-name"]`) .invoke('text') .then((text) => { expect(text).to.contain(domainObj.owner); }); cy.get(`[data-testid="domain-expert-name"]`) .invoke('text') .then((text) => { expect(text).to.contain(domainObj.experts); }); }; export const updateDomainDetails = (domainObj) => { selectDomain(domainObj); checkDisplayName(domainObj.name); // Update description updateDescription(domainObj.updatedDescription); // Update Owner updateOwner(domainObj.updatedOwner); }; export const createDataProducts = (dataProduct, domainObj) => { selectDomain(domainObj); checkDisplayName(domainObj.name); cy.get('[data-testid="domain-details-add-button"]').click(); cy.get('.ant-dropdown-menu .ant-dropdown-menu-title-content') .contains('Data Products') .click(); interceptURL('POST', '/api/v1/dataProducts', 'createDataProducts'); cy.contains('Add Data Product').should('be.visible'); fillForm(dataProduct, 'dataProduct'); cy.get('[data-testid="save-data-product"]').scrollIntoView().click(); cy.wait('@createDataProducts').then(({ request }) => { expect(request.body.name).equals(dataProduct.name); expect(request.body.domain).equals(domainObj.fullyQualifiedName); expect(request.body.description).equals(dataProduct.description); expect(request.body.experts).has.length(1); }); }; export const renameDomain = (domainObj) => { interceptURL('PATCH', `/api/v1/domains/*`, 'patchName&DisplayName'); selectDomain(domainObj); checkDisplayName(domainObj.name); cy.get('[data-testid="manage-button"]').click(); cy.get('[data-testid="rename-button-details-container"]').click(); cy.get('#name').should('be.disabled'); cy.get('#displayName').should('not.be.disabled').clear(); cy.get('#displayName').type(domainObj.updatedDisplayName); cy.get('[data-testid="save-button"]').click(); verifyResponseStatusCode('@patchName&DisplayName', 200); checkDisplayName(domainObj.updatedDisplayName); }; export const addAssetsToDomain = (domainObj) => { goToAssetsTab(domainObj); checkAssetsCount(0); cy.contains('Adding a new Asset is easy, just give it a spin!').should( 'be.visible' ); cy.get('[data-testid="domain-details-add-button"]').click(); cy.get('.ant-dropdown-menu .ant-dropdown-menu-title-content') .contains('Assets') .click(); cy.get('[data-testid="asset-selection-modal"] .ant-modal-title').should( 'contain', 'Add Assets' ); domainObj.assets.forEach((asset) => { interceptURL('GET', '/api/v1/search/query*', 'searchAssets'); cy.get('[data-testid="asset-selection-modal"] [data-testid="searchbar"]') .click() .clear() .type(asset.name); verifyResponseStatusCode('@searchAssets', 200); cy.get( `[data-testid="table-data-card_${asset.fullyQualifiedName}"] input[type="checkbox"]` ).click(); }); cy.get('[data-testid="save-btn"]').click(); checkAssetsCount(domainObj.assets.length); }; export const removeAssetsFromDomain = (domainObj) => { goToAssetsTab(domainObj); checkAssetsCount(domainObj.assets.length); domainObj.assets.forEach((asset, index) => { interceptURL('GET', '/api/v1/search/query*', 'searchAssets'); cy.get(`[data-testid="manage-button-${asset.fullyQualifiedName}"]`).click(); cy.get('[data-testid="delete-button"]').click(); cy.get("[data-testid='save-button']").click(); goToDataProductsTab(domainObj); interceptURL('GET', '/api/v1/search/query*', 'assetTab'); // go assets tab goToAssetsTab(domainObj); verifyResponseStatusCode('@assetTab', 200); checkAssetsCount(domainObj.assets.length - (index + 1)); }); }; export const addAssetsToDataProduct = (dataProductObj, domainObj) => { interceptURL('GET', `/api/v1/search/query**`, 'getDataProductAssets'); interceptURL('GET', '/api/v1/dataProducts/**', 'getDataProductDetails'); goToDataProductsTab(domainObj); cy.get( `[data-testid="explore-card-${dataProductObj.name}"] [data-testid="entity-link"]` ).click(); verifyResponseStatusCode('@getDataProductDetails', 200); cy.get('[data-testid="assets"]').should('be.visible').click(); cy.get('.ant-tabs-tab-active').contains('Assets').should('be.visible'); verifyResponseStatusCode('@getDataProductAssets', 200); cy.contains('Adding a new Asset is easy, just give it a spin!').should( 'be.visible' ); cy.get('[data-testid="data-product-details-add-button"]').click(); cy.get('[data-testid="asset-selection-modal"] .ant-modal-title').should( 'contain', 'Add Assets' ); dataProductObj.assets.forEach((asset) => { interceptURL('GET', '/api/v1/search/query*', 'searchAssets'); cy.get('[data-testid="asset-selection-modal"] [data-testid="searchbar"]') .click() .clear() .type(asset.name); verifyResponseStatusCode('@searchAssets', 200); cy.get( `[data-testid="table-data-card_${asset.fullyQualifiedName}"] input[type="checkbox"]` ).click(); }); cy.get('[data-testid="save-btn"]').click(); checkAssetsCount(dataProductObj.assets.length); }; export const removeAssetsFromDataProduct = (dataProductObj, domainObj) => { goToDataProductsTab(domainObj); cy.get( `[data-testid="explore-card-${dataProductObj.name}"] [data-testid="entity-link"]` ).click(); cy.get('[data-testid="assets"]').should('be.visible').click(); cy.get('.ant-tabs-tab-active').contains('Assets').should('be.visible'); checkAssetsCount(dataProductObj.assets.length); dataProductObj.assets.forEach((asset, index) => { interceptURL('GET', '/api/v1/search/query*', 'searchAssets'); cy.get(`[data-testid="manage-button-${asset.fullyQualifiedName}"]`).click(); cy.get('[data-testid="delete-button"]').click(); cy.get("[data-testid='save-button']").click(); checkAssetsCount(domainObj.assets.length - (index + 1)); }); };