OpenMetadata/openmetadata-ui/src/main/resources/ui/cypress/e2e/Pages/DataInsight.spec.js

/*
 *  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.
 */
// eslint-disable-next-line spaced-comment
/// <reference types="Cypress" />
import {
  customFormatDateTime,
  getCurrentMillis,
  getEpochMillisForFutureDays,
} from '../../../src/utils/date-time/DateTimeUtils';
import {
  BASE_WAIT_TIME,
  descriptionBox,
  interceptURL,
  RETRY_TIMES,
  verifyResponseStatusCode,
} from '../../common/common';

const KPI_DATA = [
  {
    dataInsightChart: 'Percentage of Entities With Description',
    displayName: 'Cypress description with percentage',
    metricType: 'completedDescriptionFraction (PERCENTAGE)',
  },
  {
    dataInsightChart: 'Percentage of Entities With Owner',
    displayName: 'Cypress Owner with percentage',
    metricType: 'hasOwnerFraction (PERCENTAGE)',
  },
];

const deleteKpiRequest = () => {
  cy.get('[data-menu-id*="kpi"]').click();
  cy.wait('@getKpi').then(({ response }) => {
    const data = response.body.data;
    if (data.length > 0) {
      const token = localStorage.getItem('oidcIdToken');
      data.forEach((element) => {
        cy.request({
          method: 'DELETE',
          url: `/api/v1/kpi/${element.id}?hardDelete=true&recursive=false`,
          headers: { Authorization: `Bearer ${token}` },
        }).then((response) => {
          expect(response.status).to.eq(200);
        });
      });
      cy.reload();
    }
  });
};

const checkSuccessStatus = (count = 1, timer = BASE_WAIT_TIME) => {
  cy.get('[data-testid="ingestion-details-container"]')
    .find('[data-testid="pipeline-status"]')
    .as('checkRun');
  // the latest run should be success
  cy.get('@checkRun').then(($ingestionStatus) => {
    if (
      $ingestionStatus.text() !== 'Success' &&
      $ingestionStatus.text() !== 'Failed' &&
      count <= RETRY_TIMES
    ) {
      // retry after waiting with log1 method [20s,40s,80s,160s,320s]
      cy.wait(timer);
      timer *= 2;
      cy.reload();
      checkSuccessStatus(++count, timer * 2);
    } else {
      cy.get('@checkRun').should('have.text', 'Success');
    }
  });
};

const addKpi = (data) => {
  const startDate = customFormatDateTime(getCurrentMillis(), 'yyyy-MM-dd');
  const endDate = customFormatDateTime(
    getEpochMillisForFutureDays(1),
    'yyyy-MM-dd'
  );
  interceptURL('POST', '/api/v1/kpi', 'createKpi');
  cy.get('#dataInsightChart').click();
  cy.get(`.ant-select-dropdown [title="${data.dataInsightChart}"]`).click();
  cy.get('[data-testid="displayName"]').type(data.displayName);
  cy.get('#metricType').click();
  cy.get(`.ant-select-dropdown [title="${data.metricType}"]`).click();
  cy.get('[data-testid="metric-percentage-input"] [role="spinbutton"]')
    .scrollIntoView()
    .type(100);
  cy.get('[data-testid="start-date"]').click().type(`${startDate}{enter}`);
  cy.clickOutside();
  cy.get('[data-testid="end-date"]')
    .scrollIntoView()
    .click()
    .type(`${endDate}{enter}`);
  cy.clickOutside();
  cy.get(descriptionBox).scrollIntoView().type('cypress test');
  cy.get('[data-testid="submit-btn"]').scrollIntoView().click();
  verifyResponseStatusCode('@createKpi', 201);
};

describe('Data Insight feature', () => {
  beforeEach(() => {
    interceptURL(
      'GET',
      '/api/v1/analytics/dataInsights/charts/aggregate?*',
      'dataInsightsChart'
    );
    interceptURL('GET', '/api/v1/kpi?fields=*', 'getKpi');
    cy.login();
  });

  it('Initial setup', () => {
    cy.get('[data-testid="app-bar-item-data-insight"]').click();
    verifyResponseStatusCode('@dataInsightsChart', 200);
    deleteKpiRequest();
  });

  it('Create description and owner KPI', () => {
    cy.get('[data-testid="app-bar-item-data-insight"]').click();
    verifyResponseStatusCode('@dataInsightsChart', 200);
    cy.get('[data-menu-id*="kpi"]').click();
    KPI_DATA.map((data) => {
      cy.get('[data-testid="add-kpi-btn"]').click();
      verifyResponseStatusCode('@getKpi', 200);
      addKpi(data);
    });
  });

  it('Deploy data insight index', () => {
    interceptURL(
      'GET',
      '/api/v1/services/ingestionPipelines?fields=pipelineStatuses&service=OpenMetadata&pipelineType=dataInsight',
      'ingestionPipeline'
    );
    interceptURL(
      'GET',
      '/api/v1/services/ingestionPipelines/OpenMetadata.OpenMetadata_dataInsight/pipelineStatus?*',
      'pipelineStatus'
    );
    interceptURL(
      'POST',
      '/api/v1/services/ingestionPipelines/deploy/*',
      'deploy'
    );
    interceptURL(
      'POST',
      '/api/v1/services/ingestionPipelines/trigger/*',
      'triggerPipeline'
    );
    cy.get('[data-testid="app-bar-item-settings"]').click();
    cy.get('[data-menu-id*="openMetadata.dataInsight"]')
      .scrollIntoView()
      .click();
    verifyResponseStatusCode('@ingestionPipeline', 200);
    cy.wait('@pipelineStatus').then(({ response }) => {
      const data = response.body.data;
      if (data.length > 0) {
        cy.get('[data-testid="re-deploy-btn"]').click();
      } else {
        cy.get('[data-testid="deploy"]').click();
      }
      cy.wait('@deploy');
    });
    cy.reload();
    verifyResponseStatusCode('@ingestionPipeline', 200);
    cy.get('[data-testid="run"]').click();
    verifyResponseStatusCode('@triggerPipeline', 200);
    checkSuccessStatus();
  });

  it('Verifying Data assets tab', () => {
    cy.get('[data-testid="app-bar-item-data-insight"]').click();
    verifyResponseStatusCode('@dataInsightsChart', 200);
    cy.get('[data-testid="search-dropdown-Team"]').should('be.visible');
    cy.get('[data-testid="search-dropdown-Tier"]').should('be.visible');
    cy.get('[data-testid="summary-card"]').should('be.visible');
    cy.get('[data-testid="kpi-card"]').should('be.visible');
    cy.get('#kpi-chart').scrollIntoView().should('be.visible');
    cy.get('#entity-summary-chart').scrollIntoView().should('be.visible');
    cy.get('#PercentageOfEntitiesWithDescriptionByType-graph')
      .scrollIntoView()
      .should('be.visible');
    cy.get('#PercentageOfServicesWithDescription-graph')
      .scrollIntoView()
      .should('be.visible');
    cy.get('#PercentageOfEntitiesWithOwnerByType-graph')
      .scrollIntoView()
      .should('be.visible');
    cy.get('#PercentageOfServicesWithOwner-graph')
      .scrollIntoView()
      .should('be.visible');
    cy.get('#TotalEntitiesByTier-graph').scrollIntoView().should('be.visible');
  });

  it('Verifying App analytics tab', () => {
    cy.get('[data-testid="app-bar-item-data-insight"]').click();
    verifyResponseStatusCode('@dataInsightsChart', 200);
    cy.get('[data-menu-id*="app-analytics"]').click();
    verifyResponseStatusCode('@dataInsightsChart', 200);
    cy.get('[data-testid="summary-card-content"]').should('be.visible');
    cy.get('[data-testid="entity-summary-card-percentage"]')
      .contains('Most Viewed Data Assets')
      .scrollIntoView()
      .should('be.visible');
    cy.get('[data-testid="entity-page-views-card"]')
      .scrollIntoView()
      .should('be.visible');
    cy.get('[data-testid="entity-active-user-card"]')
      .scrollIntoView()
      .should('be.visible');
    cy.get('[data-testid="entity-summary-card-percentage"]')
      .contains('Most Active Users')
      .scrollIntoView()
      .should('be.visible');
  });

  it('Verifying KPI tab', () => {
    cy.get('[data-testid="app-bar-item-data-insight"]').click();
    verifyResponseStatusCode('@dataInsightsChart', 200);
    cy.get('[data-menu-id*="kpi"]').click();
    verifyResponseStatusCode('@dataInsightsChart', 200);
    cy.get('[data-testid="kpi-card"]').should('be.visible');
    cy.get(
      '[data-row-key="cypress-description-with-percentage-completed-description-fraction"]'
    )
      .scrollIntoView()
      .should('be.visible');
    cy.get('[data-row-key="cypress-owner-with-percentage-has-owner-fraction"]')
      .scrollIntoView()
      .should('be.visible');
  });

  it('Update KPI', () => {
    interceptURL('GET', '/api/v1/kpi/name/*', 'fetchKpiByName');
    interceptURL('PATCH', '/api/v1/kpi/*', 'updateKpi');
    cy.get('[data-testid="app-bar-item-data-insight"]').click();
    verifyResponseStatusCode('@dataInsightsChart', 200);
    cy.get('[data-menu-id*="kpi"]').click();
    verifyResponseStatusCode('@dataInsightsChart', 200);
    KPI_DATA.map((data) => {
      cy.get(`[data-testid="edit-action-${data.displayName}"]`).click();
      verifyResponseStatusCode('@fetchKpiByName', 200);
      cy.get('[data-testid="metric-percentage-input"] [role="spinbutton"]')
        .scrollIntoView()
        .clear()
        .type(50);
      cy.get('[data-testid="submit-btn"]').scrollIntoView().click();
      verifyResponseStatusCode('@updateKpi', 200);
    });
  });

  it('Delete Kpi', () => {
    interceptURL('GET', '/api/v1/kpi/name/*', 'fetchKpiByName');
    interceptURL(
      'DELETE',
      '/api/v1/kpi/*?hardDelete=true&recursive=false',
      'deleteKpi'
    );
    cy.get('[data-testid="app-bar-item-data-insight"]').click();
    verifyResponseStatusCode('@dataInsightsChart', 200);
    cy.get('[data-menu-id*="kpi"]').click();
    verifyResponseStatusCode('@dataInsightsChart', 200);
    KPI_DATA.map((data) => {
      cy.get(`[data-testid="delete-action-${data.displayName}"]`).click();
      cy.get('[data-testid="confirmation-text-input"]').type('DELETE');
      cy.get('[data-testid="confirm-button"]').click();
      verifyResponseStatusCode('@deleteKpi', 200);
    });
  });
});