Cypress: add cypress test for glossary part 2 (#10180)

* Cypress: added cypress for glossary part 2 * fixed add reviewer issue in create glossary term page * fixed failing cypress
2025-11-01 11:09:14 +00:00 · 2023-02-22 19:41:40 +05:30 · 2023-02-22 19:41:40 +05:30 · cb14bb6a63
commit cb14bb6a63
parent 0f3536f973
4 changed files with 181 additions and 5 deletions
--- a/openmetadata-ui/src/main/resources/ui/cypress/constants/constants.js
+++ b/openmetadata-ui/src/main/resources/ui/cypress/constants/constants.js
@ -235,6 +235,15 @@ export const NEW_GLOSSARY_TERMS = {
    synonyms: 'give,disposal,deal',
  },
 };
+export const GLOSSARY_TERM_WITH_DETAILS = {
+  name: 'Accounts',
+  description: 'This is the Accounts',
+  tag: 'PersonalData.Personal',
+  synonyms: 'book,ledger,results',
+  relatedTerms: 'Sales',
+  reviewer: 'Aaron Singh',
+  inheritedReviewer: 'Aaron Johnson',
+};

 export const NEW_GLOSSARY_1_TERMS = {
  term_1: {
--- a/openmetadata-ui/src/main/resources/ui/cypress/e2e/Pages/Glossary.spec.js
+++ b/openmetadata-ui/src/main/resources/ui/cypress/e2e/Pages/Glossary.spec.js
@ -21,6 +21,7 @@ import {
 } from '../../common/common';
 import {
  DELETE_TERM,
+  GLOSSARY_TERM_WITH_DETAILS,
  NEW_GLOSSARY,
  NEW_GLOSSARY_1,
  NEW_GLOSSARY_1_TERMS,
@ -38,7 +39,7 @@ const visitGlossaryTermPage = (termName) => {
  cy.get('.ant-tabs [id*=tab-summary]').should('be.visible').click();
 };

-const createGlossaryTerm = (term, glossary, isMutually = false) => {
+const fillGlossaryTermDetails = (term, glossary, isMutually = false) => {
  cy.get('[data-testid="breadcrumb-link"]')
    .scrollIntoView()
    .should('exist')
@ -77,6 +78,10 @@ const createGlossaryTerm = (term, glossary, isMutually = false) => {
    .scrollIntoView()
    .should('be.visible')
    .type('https://test.com');
+};
+
+const createGlossaryTerm = (term, glossary, isMutually = false) => {
+  fillGlossaryTermDetails(term, glossary, isMutually);

  interceptURL('POST', '/api/v1/glossaryTerms', 'createGlossaryTerms');
  cy.get('[data-testid="save-glossary-term"]')
@ -742,6 +747,159 @@ describe('Glossary page should work properly', () => {
      .should('be.visible');
  });

+  it('Create glossaryTerm with tags, related terms, synonyms, references and reviewer & verify API payload', () => {
+    interceptURL('GET', '/api/v1/search/query?q=*', 'searchGlossaryTerm');
+    interceptURL(
+      'GET',
+      '/api/v1/search/suggest?q=*&index=user_search_index',
+      'searchReviewer'
+    );
+    interceptURL('GET', '/api/v1/users/*?fields=profile', 'getProfile');
+    fillGlossaryTermDetails(GLOSSARY_TERM_WITH_DETAILS, NEW_GLOSSARY);
+    // Add Tags
+    interceptURL('GET', '/api/v1/tags?limit=1000', 'fetchTags');
+    cy.get('[data-testid="tags-container"] .ant-select-selection-overflow')
+      .scrollIntoView()
+      .should('be.visible')
+      .type(GLOSSARY_TERM_WITH_DETAILS.tag);
+    verifyResponseStatusCode('@fetchTags', 200);
+    cy.get(`[title="${GLOSSARY_TERM_WITH_DETAILS.tag}"]`)
+      .should('be.visible')
+      .click();
+    cy.get('#right-panel').click();
+
+    // Add Related terms
+    cy.get('[data-testid="add-related-terms"]')
+      .scrollIntoView()
+      .should('be.visible')
+      .click();
+    cy.get('.ant-modal-body').should('be.visible');
+    cy.get('[data-testid="searchbar"]')
+      .should('be.visible')
+      .type(GLOSSARY_TERM_WITH_DETAILS.relatedTerms);
+    cy.get('[data-testid="searchbar"]').should(
+      'have.value',
+      GLOSSARY_TERM_WITH_DETAILS.relatedTerms
+    );
+    verifyResponseStatusCode('@searchGlossaryTerm', 200);
+    cy.get('[data-testid="loader"]').should('be.visible');
+    cy.get('[data-testid="user-card-container"]').should('be.visible');
+    cy.get('[data-testid="checkboxAddUser"]').should('be.visible').click();
+    cy.get('[data-testid="saveButton"]').should('be.visible').click();
+    cy.get('.ant-modal-body').should('not.exist');
+
+    // Add reviewer
+    cy.get('[data-testid="add-reviewers"]')
+      .scrollIntoView()
+      .should('be.visible')
+      .click();
+
+    cy.get('.ant-modal-body').should('be.visible');
+    cy.get('[data-testid="searchbar"]')
+      .should('be.visible')
+      .type(GLOSSARY_TERM_WITH_DETAILS.reviewer);
+    verifyResponseStatusCode('@searchGlossaryTerm', 200);
+    cy.get('[data-testid="loader"]').should('be.visible');
+    cy.get('[data-testid="user-card-container"]').should('be.visible');
+    cy.get('[data-testid="checkboxAddUser"]').should('be.visible').click();
+    cy.get('[data-testid="save-button"]').should('be.visible').click();
+    cy.get('.ant-modal-body').should('not.exist');
+
+    interceptURL('POST', '/api/v1/glossaryTerms', 'createGlossaryTerms');
+    cy.get('[data-testid="save-glossary-term"]')
+      .scrollIntoView()
+      .should('be.visible')
+      .click();
+
+    cy.wait('@createGlossaryTerms').then(({ request }) => {
+      const synonym = GLOSSARY_TERM_WITH_DETAILS.synonyms.split(',');
+
+      expect(request.body).to.have.all.keys(
+        'description',
+        'displayName',
+        'mutuallyExclusive',
+        'name',
+        'glossary',
+        'references',
+        'relatedTerms',
+        'reviewers',
+        'tags',
+        'synonyms'
+      );
+      expect(request.body.displayName).equals(GLOSSARY_TERM_WITH_DETAILS.name);
+      expect(request.body.name).equals(GLOSSARY_TERM_WITH_DETAILS.name);
+      expect(request.body.description).equals(
+        GLOSSARY_TERM_WITH_DETAILS.description
+      );
+      expect(request.body.mutuallyExclusive).equals(false);
+      expect(request.body.glossary).equals(NEW_GLOSSARY.name);
+      expect(request.body.reviewers).has.length(2);
+      expect(request.body.references).has.length(1);
+      expect(request.body.references[0]).to.have.all.keys('name', 'endpoint');
+      expect(request.body.synonyms).has.length(synonym.length);
+      expect(request.body.synonyms).to.deep.equal(synonym);
+      expect(request.body.tags).has.length(1);
+      expect(request.body.tags[0]).to.deep.equal({
+        labelType: 'Manual',
+        state: 'Confirmed',
+        tagFQN: 'PersonalData.Personal',
+        source: 'Tag',
+      });
+    });
+  });
+
+  it('Verify details of created glossaryTerm', () => {
+    interceptURL(
+      'GET',
+      `/api/v1/glossaryTerms/name/*.${GLOSSARY_TERM_WITH_DETAILS.name}?fields=*`,
+      'getGlossaryTerm'
+    );
+    interceptURL(
+      'GET',
+      '/api/v1/permissions/glossaryTerm/*',
+      'waitForTermPermission'
+    );
+    visitGlossaryTermPage(GLOSSARY_TERM_WITH_DETAILS.name);
+
+    verifyResponseStatusCode('@getGlossaryTerm', 200);
+    verifyResponseStatusCode('@waitForTermPermission', 200);
+    cy.get('[data-testid="glossary-term"] > :nth-child(1)')
+      .scrollIntoView()
+      .as('glossaryTermDetailsPanel');
+    cy.get('@glossaryTermDetailsPanel').contains('admin').should('be.visible');
+    cy.get('@glossaryTermDetailsPanel')
+      .find(`[data-testid="reviewer-${GLOSSARY_TERM_WITH_DETAILS.reviewer}"]`)
+      .should('be.visible');
+    cy.get('@glossaryTermDetailsPanel')
+      .find(
+        `[data-testid="reviewer-${GLOSSARY_TERM_WITH_DETAILS.inheritedReviewer}"]`
+      )
+      .should('be.visible');
+    cy.get('[data-testid="add-tag"]')
+      .contains(GLOSSARY_TERM_WITH_DETAILS.tag)
+      .should('be.visible');
+  });
+
+  it('Search GlossaryTerm functionality', () => {
+    cy.get('[data-testid="glossary-left-panel"]')
+      .contains(NEW_GLOSSARY.name)
+      .should('be.visible');
+    cy.get('[data-testid="header"]')
+      .invoke('text')
+      .then((text) => {
+        expect(text).to.contain(NEW_GLOSSARY.name);
+      });
+    cy.get('[data-row-key="Accounts"]').should('be.visible');
+    cy.get('[data-row-key="Purchase"]').should('be.visible');
+    cy.get('[data-row-key="Sales"]').should('be.visible');
+    cy.get('[data-testid="glossary-details"] [data-testid="searchbar"]')
+      .should('be.visible')
+      .type(GLOSSARY_TERM_WITH_DETAILS.name);
+    cy.get('[data-row-key="Sales"]').should('not.exist');
+    cy.get('[data-row-key="Accounts"]').should('be.visible');
+    cy.get('[data-row-key="Purchase"]').should('not.exist');
+  });
+
  it('Remove Glossary term from entity should work properly', () => {
    const term = NEW_GLOSSARY_1_TERMS.term_1.name;
    const entity = SEARCH_ENTITY_TABLE.table_3;
--- a/openmetadata-ui/src/main/resources/ui/src/components/AddGlossaryTerm/AddGlossaryTerm.component.tsx
+++ b/openmetadata-ui/src/main/resources/ui/src/components/AddGlossaryTerm/AddGlossaryTerm.component.tsx
@ -356,7 +356,10 @@ const AddGlossaryTerm = ({
          </Field>

          <Field>
-            <Space className="w-full" direction="vertical">
+            <Space
+              className="w-full"
+              data-testid="tags-container"
+              direction="vertical">
              <label htmlFor="tags">{`${t('label.tag-plural')}:`}</label>
              <AddTags
                data-testid="tags"
@ -407,6 +410,7 @@ const AddGlossaryTerm = ({
                </label>
                <Button
                  className="tw-h-5 tw-px-2"
+                  data-testid="add-reference"
                  size="x-small"
                  theme="primary"
                  variant="contained"
@ -477,6 +481,7 @@ const AddGlossaryTerm = ({
              </p>
              <Button
                className="tw-h-5 tw-px-2"
+                data-testid="add-related-terms"
                size="x-small"
                theme="primary"
                variant="contained"
--- a/openmetadata-ui/src/main/resources/ui/src/components/Modals/ReviewerModal/ReviewerModal.component.tsx
+++ b/openmetadata-ui/src/main/resources/ui/src/components/Modals/ReviewerModal/ReviewerModal.component.tsx
@ -41,9 +41,7 @@ const ReviewerModal = ({
  const [searchText, setSearchText] = useState('');
  const [isLoading, setIsLoading] = useState(true);
  const [options, setOptions] = useState<User[]>([]);
-  const [selectedOption, setSelectedOption] = useState<User[]>(
-    reviewer?.map(getUserFromEntityReference) ?? []
-  );
+  const [selectedOption, setSelectedOption] = useState<User[]>([]);
  const { t } = useTranslation();

  const getSearchedReviewers = (searchedData: User[]) => {
@ -118,6 +116,12 @@ const ReviewerModal = ({
    querySearch();
  }, []);

+  useEffect(() => {
+    if (reviewer) {
+      setSelectedOption(reviewer.map(getUserFromEntityReference));
+    }
+  }, [reviewer]);
+
  return (
    <Modal
      centered