Skip to content

Commit

Permalink
[ML] Address comments from review on data viz tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@peteharverson
peteharverson committed Dec 2, 2019
1 parent 5638f70 commit fd1e6b4
Show file tree
Hide file tree
Showing 4 changed files with 111 additions and 54 deletions.
2 changes: 1 addition & 1 deletion x-pack/legacy/plugins/ml/public/application/datavisualizer/index_based/page.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -585,7 +585,7 @@ export const Page: FC = () => {
return (
<Fragment>
<NavigationMenu tabId="datavisualizer" />
<EuiPage data-test-subj="mlPageDataVisualizer">
<EuiPage data-test-subj="mlPageIndexDataVisualizer">
<EuiPageBody>
<EuiPageContentHeader>
<EuiPageContentHeaderSection>
Expand Down
132 changes: 91 additions & 41 deletions x-pack/test/functional/apps/machine_learning/data_visualizer/index_data_visualizer.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,11 @@
*/

import { FtrProviderContext } from '../../../ftr_provider_context';
import { ML_JOB_FIELD_TYPES } from '../../../../../legacy/plugins/ml/common/constants/field_types';
import { FieldVisConfig } from '../../../../../legacy/plugins/ml/public/application/datavisualizer/index_based/common';

interface FieldCard {
fieldName?: string;
type: string;
}

function getFieldTypes(cards: FieldCard[]) {
const fieldTypes: string[] = [];
function getFieldTypes(cards: FieldVisConfig[]) {
const fieldTypes: ML_JOB_FIELD_TYPES[] = [];
cards.forEach(card => {
const fieldType = card.type;
if (fieldTypes.includes(fieldType) === false) {
Expand Down Expand Up @@ -40,37 +37,61 @@ export default function({ getService }: FtrProviderContext) {
fieldsPanelCount: 2, // Metrics panel and Fields panel
metricCards: [
{
type: 'number', // document count card
type: ML_JOB_FIELD_TYPES.NUMBER, // document count card
existsInDocs: true,
aggregatable: true,
loading: false,
},
{
fieldName: 'responsetime',
type: 'number',
type: ML_JOB_FIELD_TYPES.NUMBER,
existsInDocs: true,
aggregatable: true,
loading: false,
},
],
nonMetricCards: [
{
fieldName: '@timestamp',
type: 'date',
type: ML_JOB_FIELD_TYPES.DATE,
existsInDocs: true,
aggregatable: true,
loading: false,
},
{
fieldName: '@version',
type: 'text',
type: ML_JOB_FIELD_TYPES.TEXT,
existsInDocs: true,
aggregatable: false,
loading: false,
},
{
fieldName: '@version.keyword',
type: 'keyword',
type: ML_JOB_FIELD_TYPES.KEYWORD,
existsInDocs: true,
aggregatable: true,
loading: false,
},
{
fieldName: '@timestamp',
type: 'date',
fieldName: 'airline',
type: ML_JOB_FIELD_TYPES.KEYWORD,
existsInDocs: true,
aggregatable: true,
loading: false,
},
{
fieldName: '@timestamp',
type: 'date',
fieldName: 'type',
type: ML_JOB_FIELD_TYPES.TEXT,
existsInDocs: true,
aggregatable: false,
loading: false,
},
{
fieldName: '@timestamp',
type: 'date',
fieldName: 'type.keyword',
type: ML_JOB_FIELD_TYPES.KEYWORD,
existsInDocs: true,
aggregatable: true,
loading: false,
},
],
nonMetricFieldsTypeFilterCardCount: 3,
Expand All @@ -89,37 +110,61 @@ export default function({ getService }: FtrProviderContext) {
fieldsPanelCount: 2, // Metrics panel and Fields panel
metricCards: [
{
type: 'number', // document count card
type: ML_JOB_FIELD_TYPES.NUMBER, // document count card
existsInDocs: true,
aggregatable: true,
loading: false,
},
{
fieldName: 'responsetime',
type: 'number',
type: ML_JOB_FIELD_TYPES.NUMBER,
existsInDocs: true,
aggregatable: true,
loading: false,
},
],
nonMetricCards: [
{
fieldName: '@timestamp',
type: 'date',
type: ML_JOB_FIELD_TYPES.DATE,
existsInDocs: true,
aggregatable: true,
loading: false,
},
{
fieldName: '@version',
type: 'text',
type: ML_JOB_FIELD_TYPES.TEXT,
existsInDocs: true,
aggregatable: false,
loading: false,
},
{
fieldName: '@version.keyword',
type: 'keyword',
type: ML_JOB_FIELD_TYPES.KEYWORD,
existsInDocs: true,
aggregatable: true,
loading: false,
},
{
fieldName: '@timestamp',
type: 'date',
fieldName: 'airline',
type: ML_JOB_FIELD_TYPES.KEYWORD,
existsInDocs: true,
aggregatable: true,
loading: false,
},
{
fieldName: '@timestamp',
type: 'date',
fieldName: 'type',
type: ML_JOB_FIELD_TYPES.TEXT,
existsInDocs: true,
aggregatable: false,
loading: false,
},
{
fieldName: '@timestamp',
type: 'date',
fieldName: 'type.keyword',
type: ML_JOB_FIELD_TYPES.KEYWORD,
existsInDocs: true,
aggregatable: true,
loading: false,
},
],
nonMetricFieldsTypeFilterCardCount: 3,
Expand All @@ -143,6 +188,7 @@ export default function({ getService }: FtrProviderContext) {
// - validating metrics displayed inside the cards
// - selecting a document sample size
// - clicking on the link to the Advanced job wizard
// - a test suite using a KQL based saved search
for (const testData of testDataList) {
describe(`${testData.suiteTitle}`, function() {
it('loads the data visualizer selector page', async () => {
Expand All @@ -160,26 +206,28 @@ export default function({ getService }: FtrProviderContext) {
);
});

it('index data visualizer displays the time range step', async () => {
it('displays the time range step', async () => {
await ml.dataVisualizerIndexBased.assertTimeRangeSelectorSectionExists();
});

it('index data visualizer loads data for full time range', async () => {
it('loads data for full time range', async () => {
await ml.dataVisualizerIndexBased.clickUseFullDataButton(testData.expected.totalDocCount);
});

it('index data visualizer displays the panels of fields', async () => {
it('displays the panels of fields', async () => {
await ml.dataVisualizerIndexBased.assertFieldsPanelsExist(
testData.expected.fieldsPanelCount
);
});

if (testData.expected.metricCards && testData.expected.metricCards.length > 0) {
it('index data visualizer displays the Metrics panel', async () => {
await ml.dataVisualizerIndexBased.assertFieldsPanelForTypesExist(['number']); // document_count not exposed as a type in the panel
it('displays the Metrics panel', async () => {
await ml.dataVisualizerIndexBased.assertFieldsPanelForTypesExist([
ML_JOB_FIELD_TYPES.NUMBER,
]); // document_count not exposed as a type in the panel
});

it('index data visualizer displays the expected metric field cards', async () => {
it('displays the expected metric field cards', async () => {
for (const fieldCard of testData.expected.metricCards) {
await ml.dataVisualizerIndexBased.assertCardExists(
fieldCard.type,
Expand All @@ -188,7 +236,7 @@ export default function({ getService }: FtrProviderContext) {
}
});

it('index data visualizer filters metric fields cards with search', async () => {
it('filters metric fields cards with search', async () => {
await ml.dataVisualizerIndexBased.filterFieldsPanelWithSearchString(
['number'],
testData.metricFieldsFilter,
Expand All @@ -198,13 +246,13 @@ export default function({ getService }: FtrProviderContext) {
}

if (testData.expected.nonMetricCards && testData.expected.nonMetricCards.length > 0) {
it('index data visualizer displays the non-metric Fields panel', async () => {
it('displays the non-metric Fields panel', async () => {
await ml.dataVisualizerIndexBased.assertFieldsPanelForTypesExist(
getFieldTypes(testData.expected.nonMetricCards)
);
});

it('index data visualizer displays the expected non-metric field cards', async () => {
it('displays the expected non-metric field cards', async () => {
for (const fieldCard of testData.expected.nonMetricCards) {
await ml.dataVisualizerIndexBased.assertCardExists(
fieldCard.type,
Expand All @@ -213,8 +261,10 @@ export default function({ getService }: FtrProviderContext) {
}
});

it('index data visualizer sets the non metric field types input', async () => {
const fieldTypes: string[] = getFieldTypes(testData.expected.nonMetricCards);
it('sets the non metric field types input', async () => {
const fieldTypes: ML_JOB_FIELD_TYPES[] = getFieldTypes(
testData.expected.nonMetricCards
);
await ml.dataVisualizerIndexBased.assertFieldsPanelTypeInputExists(fieldTypes);
await ml.dataVisualizerIndexBased.setFieldsPanelTypeInputValue(
fieldTypes,
Expand All @@ -223,7 +273,7 @@ export default function({ getService }: FtrProviderContext) {
);
});

it('index data visualizer filters non-metric fields cards with search', async () => {
it('filters non-metric fields cards with search', async () => {
await ml.dataVisualizerIndexBased.filterFieldsPanelWithSearchString(
getFieldTypes(testData.expected.nonMetricCards),
testData.nonMetricFieldsFilter,
Expand Down
29 changes: 18 additions & 11 deletions x-pack/test/functional/services/machine_learning/data_visualizer_index_based.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import expect from '@kbn/expect';

import { FtrProviderContext } from '../../ftr_provider_context';
import { ML_JOB_FIELD_TYPES } from '../../../../legacy/plugins/ml/common/constants/field_types';

export function MachineLearningDataVisualizerIndexBasedProvider({
getService,
Expand Down Expand Up @@ -33,10 +34,10 @@ export function MachineLearningDataVisualizerIndexBasedProvider({

async assertFieldsPanelsExist(expectedPanelCount: number) {
const allPanels = await testSubjects.findAll('~mlDataVisualizerFieldsPanel');
expect(allPanels).to.have.length(2);
expect(allPanels).to.have.length(expectedPanelCount);
},

async assertFieldsPanelForTypesExist(fieldTypes: string[]) {
async assertFieldsPanelForTypesExist(fieldTypes: ML_JOB_FIELD_TYPES[]) {
await testSubjects.existOrFail(`mlDataVisualizerFieldsPanel ${fieldTypes}`);
},

Expand All @@ -45,10 +46,21 @@ export function MachineLearningDataVisualizerIndexBasedProvider({
},

async assertFieldsPanelCardCount(panelFieldTypes: string[], expectedCardCount: number) {
const filteredCards = await testSubjects.findAll(
`mlDataVisualizerFieldsPanel ${panelFieldTypes} > ~mlFieldDataCard`
await retry.tryForTime(5000, async () => {
const filteredCards = await testSubjects.findAll(
`mlDataVisualizerFieldsPanel ${panelFieldTypes} > ~mlFieldDataCard`
);
expect(filteredCards).to.have.length(expectedCardCount);
});
},

async assertFieldsPanelSearchInputValue(fieldTypes: string[], expectedSearchValue: string) {
const searchBar = await testSubjects.find(
`mlDataVisualizerFieldsPanel ${fieldTypes} > mlDataVisualizerFieldsSearchBarDiv`
);
expect(filteredCards).to.have.length(expectedCardCount);
const searchBarInput = await searchBar.findByTagName('input');
const actualSearchValue = await searchBarInput.getAttribute('value');
expect(actualSearchValue).to.eql(expectedSearchValue);
},

async filterFieldsPanelWithSearchString(
Expand All @@ -63,6 +75,7 @@ export function MachineLearningDataVisualizerIndexBasedProvider({
await searchBarInput.clearValueWithKeyboard();
await searchBarInput.type(filter);
await searchBarInput.pressKeys(browser.keys.ENTER);
await this.assertFieldsPanelSearchInputValue(fieldTypes, filter);

await this.assertFieldsPanelCardCount(fieldTypes, expectedCardCount);
},
Expand All @@ -86,12 +99,6 @@ export function MachineLearningDataVisualizerIndexBasedProvider({
filterFieldType: string,
expectedCardCount: number
) {
const searchBar = await testSubjects.find(
`mlDataVisualizerFieldsPanel ${panelFieldTypes} > mlDataVisualizerFieldsSearchBarDiv`
);
const searchBarInput = await searchBar.findByTagName('input');
await searchBarInput.clearValueWithKeyboard();

await testSubjects.selectValue('mlDataVisualizerFieldTypesSelect', filterFieldType);
await this.assertFieldsPanelTypeInputValue(filterFieldType);
await this.assertFieldsPanelCardCount(panelFieldTypes, expectedCardCount);
Expand Down
2 changes: 1 addition & 1 deletion x-pack/test/functional/services/machine_learning/job_source_selection.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export function MachineLearningJobSourceSelectionProvider({ getService }: FtrPro
async selectSourceForIndexBasedDataVisualizer(sourceName: string) {
await this.filterSourceSelection(sourceName);
await testSubjects.clickWhenNotDisabled(`savedObjectTitle${sourceName}`);
await testSubjects.existOrFail('mlPageDataVisualizer');
await testSubjects.existOrFail('mlPageIndexDataVisualizer', { timeout: 10 * 1000 });
},
};
}

0 comments on commit fd1e6b4

Please sign in to comment.