Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Backport 2.x] Add Dataset Selector Tests #9317

Open
wants to merge 1 commit into
base: 2.x
Choose a base branch
from
+273 −118
Open

[Backport 2.x] Add Dataset Selector Tests #9317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
222 changes: 124 additions & 98 deletions ...nsearch_dashboards/opensearch_dashboards/apps/query_enhancements/dataset_selector.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,111 +3,137 @@
* SPDX-License-Identifier: Apache-2.0
*/

import { DATASOURCE_NAME, START_TIME, END_TIME } from '../../../../../utils/apps/constants';
import { SECONDARY_ENGINE } from '../../../../../utils/constants';
import { getRandomizedWorkspaceName } from '../../../../../utils/apps/query_enhancements/shared';

const workspace = getRandomizedWorkspaceName();

describe('dataset selector', { scrollBehavior: false }, () => {
before(() => {
cy.setupTestData(
SECONDARY_ENGINE.url,
['cypress/fixtures/query_enhancements/data_logs_1/data_logs_small_time_1.mapping.json'],
['cypress/fixtures/query_enhancements/data_logs_1/data_logs_small_time_1.data.ndjson']
);

// Add data source
cy.addDataSource({
name: `${DATASOURCE_NAME}`,
url: `${SECONDARY_ENGINE.url}`,
authType: 'no_auth',
});
});
after(() => {
cy.deleteDataSourceByName(`${DATASOURCE_NAME}`);
cy.deleteIndex('data_logs_small_time_1');
});
beforeEach(() => {
// Create workspace
cy.deleteWorkspaceByName(workspace);
cy.visit('/app/home');
cy.osd.createInitialWorkspaceWithDataSource(DATASOURCE_NAME, workspace);
cy.navigateToWorkSpaceSpecificPage({
workspaceName: workspace,
page: 'discover',
isEnhancement: true,
});
});

afterEach(() => {
cy.deleteWorkspaceByName(`${workspace}`);
});

describe('select indices', () => {
it('with SQL as default language', function () {
cy.setIndexAsDataset('data_logs_small_time_1', DATASOURCE_NAME, 'OpenSearch SQL');

// SQL should already be selected
cy.getElementByTestId('queryEditorLanguageSelector').should('contain', 'OpenSearch SQL');
cy.waitForLoader(true);

// SQL query should be executed and sending back result
cy.get(`[data-test-subj="queryResultCompleteMsg"]`).should('be.visible');

// Switch language to PPL
cy.setQueryLanguage('PPL');
cy.setTopNavDate(START_TIME, END_TIME);

cy.waitForLoader(true);
cy.get(`[data-test-subj="queryResultCompleteMsg"]`).should('be.visible');
});

it('with PPL as default language', function () {
cy.setIndexAsDataset('data_logs_small_time_1', DATASOURCE_NAME, 'PPL');

// PPL should already be selected
cy.getElementByTestId('queryEditorLanguageSelector').should('contain', 'PPL');

cy.setTopNavDate(START_TIME, END_TIME);

cy.waitForLoader(true);

// Query should finish running with timestamp and finish time in the footer
cy.getElementByTestId('queryResultCompleteMsg').should('be.visible');
cy.getElementByTestId('queryEditorFooterTimestamp').should('contain', 'timestamp');

// Switch language to SQL
cy.setQueryLanguage('OpenSearch SQL');

cy.waitForLoader(true);
cy.getElementByTestId('queryResultCompleteMsg').should('be.visible');
cy.getElementByTestId('queryEditorFooterTimestamp').should('contain', 'timestamp');
});
});
import {
INDEX_PATTERN_WITH_TIME,
INDEX_WITH_TIME_1,
INDEX_WITH_TIME_2,
SECONDARY_ENGINE,
} from '../../../../../utils/constants';

import {
generateAllTestConfigurations,
getRandomizedWorkspaceName,
getRandomizedDatasourceName,
setDatePickerDatesAndSearchIfRelevant,
getDefaultQuery,
} from '../../../../../utils/apps/query_enhancements/shared';

import { verifyDiscoverPageState } from '../../../../../utils/apps/query_enhancements/saved';

import {
generateDatasetSelectorTestConfiguration,
verifyBaseState,
setUpBaseState,
} from '../../../../../utils/apps/query_enhancements/dataset_selector';

const workspaceName = getRandomizedWorkspaceName();
const dataSourceName = getRandomizedDatasourceName();

export const runDatasetSelectorTests = () => {
describe('dataset selector', { scrollBehavior: false }, () => {
beforeEach(() => {
// Load test data
cy.setupTestData(
SECONDARY_ENGINE.url,
[
`cypress/fixtures/query_enhancements/data_logs_1/${INDEX_WITH_TIME_1}.mapping.json`,
`cypress/fixtures/query_enhancements/data_logs_2/${INDEX_WITH_TIME_2}.mapping.json`,
],
[
`cypress/fixtures/query_enhancements/data_logs_1/${INDEX_WITH_TIME_1}.data.ndjson`,
`cypress/fixtures/query_enhancements/data_logs_2/${INDEX_WITH_TIME_2}.data.ndjson`,
]
);
// Add data source
cy.addDataSource({
name: dataSourceName,
url: SECONDARY_ENGINE.url,
authType: 'no_auth',
});

describe('index pattern', () => {
it('create index pattern and select it', function () {
// Create and select index pattern for data_logs_small_time_1*
// Create workspace
cy.deleteWorkspaceByName(workspaceName);
cy.visit('/app/home');
cy.osd.createInitialWorkspaceWithDataSource(dataSourceName, workspaceName);
cy.createWorkspaceIndexPatterns({
workspaceName: workspace,
indexPattern: 'data_logs_small_time_1',
workspaceName: workspaceName,
indexPattern: INDEX_PATTERN_WITH_TIME.replace('*', ''),
timefieldName: 'timestamp',
indexPatternHasTimefield: true,
dataSource: DATASOURCE_NAME,
dataSource: dataSourceName,
isEnhancement: true,
});
});

cy.navigateToWorkSpaceHomePage(workspace);
afterEach(() => {
cy.deleteWorkspaceByName(workspaceName);
// TODO: Modify deleteIndex to handle an array of index and remove hard code
cy.deleteDataSourceByName(dataSourceName);
cy.deleteIndex(INDEX_WITH_TIME_1);
cy.deleteIndex(INDEX_WITH_TIME_2);
});

cy.waitForLoader(true);
cy.setIndexPatternAsDataset('data_logs_small_time_1*', DATASOURCE_NAME);
// setting OpenSearch SQL as the code following it does not work if this test is isolated
cy.setQueryLanguage('OpenSearch SQL');
generateAllTestConfigurations(generateDatasetSelectorTestConfiguration).forEach((config) => {
it(`should be able to select and load ${config.testName} dataset-language combination using advanced dataset selector`, () => {
cy.navigateToWorkSpaceSpecificPage({
workspaceName,
page: 'discover',
isEnhancement: true,
});

if (config.datasetType === 'INDEX_PATTERN') {
cy.setIndexPatternFromAdvancedSelector(config.dataset, dataSourceName, config.language);
} else {
cy.setIndexAsDataset(config.dataset, dataSourceName, config.language);
}
setDatePickerDatesAndSearchIfRelevant(config.language);

verifyDiscoverPageState({
dataset: config.dataset,
queryString: getDefaultQuery(config.dataset, config.language),
language: config.language,
hitCount: config.hitCount,
});

// verify time field is present in the result
cy.getElementByTestId('docTableHeaderField').contains('Time');
});

cy.waitForLoader(true);
cy.waitForSearch();
cy.getElementByTestId(`queryResultCompleteMsg`).should('be.visible');
it(`select the ${config.testName} dataset-language combination and cancelling the workflow restores the original state`, () => {
cy.navigateToWorkSpaceSpecificPage({
workspaceName,
page: 'discover',
isEnhancement: true,
});

// Setup the base state
setUpBaseState(INDEX_PATTERN_WITH_TIME, dataSourceName);

// Verify if the base state is setup properly
verifyBaseState(INDEX_PATTERN_WITH_TIME);

// Try setting the dataset-language combination but click on cancel
if (config.datasetType === 'INDEX_PATTERN') {
cy.setIndexPatternFromAdvancedSelector(
config.dataset,
dataSourceName,
config.language,
'cancel'
);
} else {
cy.setIndexAsDataset(
config.dataset,
dataSourceName,
config.language,
'timestamp',
'cancel'
);
}

// Verify if the base state is retained
verifyBaseState(INDEX_PATTERN_WITH_TIME);
});
});
});
});
};

runDatasetSelectorTests();
78 changes: 58 additions & 20 deletions cypress/utils/apps/query_enhancements/commands.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,28 +139,36 @@ Cypress.Commands.add('deleteAllDataSources', () => {
});
});

Cypress.Commands.add('setIndexAsDataset', (index, dataSourceName, language) => {
cy.getElementByTestId('datasetSelectorButton').should('be.visible').click();
cy.getElementByTestId(`datasetSelectorAdvancedButton`).click();
cy.get(`[title="Indexes"]`).click();
cy.get(`[title="${dataSourceName}"]`).click();
// this element is sometimes dataSourceName masked by another element
cy.get(`[title="${index}"]`).should('be.visible').click({ force: true });
cy.getElementByTestId('datasetSelectorNext').click();

if (language) {
cy.getElementByTestId('advancedSelectorLanguageSelect').select(language);
}
Cypress.Commands.add(
'setIndexAsDataset',
(index, dataSourceName, language, timeFieldName = 'timestamp', finalAction = 'submit') => {
cy.getElementByTestId('datasetSelectorButton').should('be.visible').click();
cy.getElementByTestId(`datasetSelectorAdvancedButton`).click();
cy.get(`[title="Indexes"]`).click();
cy.get(`[title="${dataSourceName}"]`).click();
// this element is sometimes dataSourceName masked by another element
cy.get(`[title="${index}"]`).should('be.visible').click({ force: true });
cy.getElementByTestId('datasetSelectorNext').click();

if (language) {
cy.getElementByTestId('advancedSelectorLanguageSelect').select(language);
}

cy.getElementByTestId('advancedSelectorTimeFieldSelect').select('timestamp');
cy.getElementByTestId('advancedSelectorConfirmButton').click();
cy.getElementByTestId('advancedSelectorTimeFieldSelect').select(timeFieldName);

// verify that it has been selected
cy.getElementByTestId('datasetSelectorButton').should(
'contain.text',
`${dataSourceName}::${index}`
);
});
if (finalAction === 'submit') {
cy.getElementByTestId('advancedSelectorConfirmButton').click();

// verify that it has been selected
cy.getElementByTestId('datasetSelectorButton').should(
'contain.text',
`${dataSourceName}::${index}`
);
} else {
cy.get('[type="button"]').contains('Cancel').click();
}
}
);

Cypress.Commands.add('setIndexPatternAsDataset', (indexPattern, dataSourceName) => {
cy.getElementByTestId('datasetSelectorButton').should('be.visible').click();
Expand All @@ -173,6 +181,36 @@ Cypress.Commands.add('setIndexPatternAsDataset', (indexPattern, dataSourceName)
);
});

Cypress.Commands.add(
'setIndexPatternFromAdvancedSelector',
(indexPattern, dataSourceName, language, finalAction = 'submit') => {
cy.getElementByTestId('datasetSelectorButton').should('be.visible').click();
cy.getElementByTestId(`datasetSelectorAdvancedButton`).click();
cy.get(`[title="Index Patterns"]`).click();

cy.get(`[title="${dataSourceName}::${indexPattern}"]`)
.should('be.visible')
.click({ force: true });
cy.getElementByTestId('datasetSelectorNext').click();

if (language) {
cy.getElementByTestId('advancedSelectorLanguageSelect').select(language);
}

if (finalAction === 'submit') {
cy.getElementByTestId('advancedSelectorConfirmButton').click();

// verify that it has been selected
cy.getElementByTestId('datasetSelectorButton').should(
'contain.text',
`${dataSourceName}::${indexPattern}`
);
} else {
cy.get('[type="button"]').contains('Cancel').click();
}
}
);

Cypress.Commands.add('setDataset', (dataset, dataSourceName, type) => {
switch (type) {
case 'INDEX_PATTERN':
Expand Down
Loading
Loading