Skip to content

[Test] Add tag cloud visualization to dashboard in functional test for reporting #87600

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

Merged
tsullivan merged 10 commits into from
Jan 16, 2021
Merged

[Test] Add tag cloud visualization to dashboard in functional test for reporting #87600

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0f0350b
add tag cloud to dashboard in kibana archive
tsullivan Jan 7, 2021
1989cd4
add pdf snapshot testing to downloaded pdfs
tsullivan Jan 7, 2021
e393cc6
update png baseline image
tsullivan Jan 7, 2021
3f214a5
remove pdf snapshot testing
tsullivan Jan 7, 2021
0ffed41
rename mislabeled variable
tsullivan Jan 7, 2021
f9ca58c
fix test comparison
tsullivan Jan 7, 2021
51f48ea
remove unnecessary pdf utf8 checks
tsullivan Jan 7, 2021
3c0cc08
Merge branch 'master' into test/dashboard-pdf
kibanamachine Jan 14, 2021
55a1adc
Merge branch 'master' into test/dashboard-pdf
kibanamachine Jan 14, 2021
e388205
Update screenshots.ts
tsullivan Jan 15, 2021
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
Binary file modified ...ctional/apps/dashboard/reporting/reports/baseline/dashboard_preserve_layout.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 23 additions & 5 deletions x-pack/test/functional/apps/dashboard/reporting/screenshots.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
const es = getService('es');
const testSubjects = getService('testSubjects');

describe('Screenshots', () => {
describe('Dashboard Reporting Screenshots', () => {
before('initialize tests', async () => {
log.debug('ReportingPage:initTests');
await esArchiver.loadIfNeeded('reporting/ecommerce');
Expand Down Expand Up @@ -93,8 +93,8 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
});
});

describe('Preserve Layout', () => {
it('matches baseline report', async function () {
describe('PNG Layout', () => {
it('downloads a PNG file', async function () {
const writeSessionReport = async (name: string, rawPdf: Buffer, reportExt: string) => {
const sessionDirectory = path.resolve(REPORTS_FOLDER, 'session');
await mkdirAsync(sessionDirectory, { recursive: true });
Expand Down Expand Up @@ -122,14 +122,32 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
const reportData = await PageObjects.reporting.getRawPdfReportData(url);
const reportFileName = 'dashboard_preserve_layout';
const sessionReportPath = await writeSessionReport(reportFileName, reportData, 'png');
const percentSimilar = await checkIfPngsMatch(
const percentDiff = await checkIfPngsMatch(
sessionReportPath,
getBaselineReportPath(reportFileName, 'png'),
config.get('screenshots.directory'),
log
);

expect(percentSimilar).to.be.lessThan(0.1);
expect(percentDiff).to.be.lessThan(0.09);
Copy link
Contributor

@rashmivkulkarni rashmivkulkarni Jan 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

with value being (0.08) : I hit this error

       at Assertion.assert (/Users/rashmikulkarni/Documents/kibana/packages/kbn-expect/expect.js:100:11)
       at Assertion.lessThan.Assertion.below (/Users/rashmikulkarni/Documents/kibana/packages/kbn-expect/expect.js:336:8)
       at Function.lessThan (/Users/rashmikulkarni/Documents/kibana/packages/kbn-expect/expect.js:531:15)
       at Context.<anonymous> (test/functional/apps/dashboard/reporting/screenshots.ts:132:35)
       at Object.apply (/Users/rashmikulkarni/Documents/kibana/packages/kbn-test/src/functional_test_runner/lib/mocha/wrap_function.js:84:16)

changing it to (0.09) - solves it.

});
});

describe('Preserve Layout', () => {
it('downloads a PDF file', async function () {
// Generating and then comparing reports can take longer than the default 60s timeout because the comparePngs
// function is taking about 15 seconds per comparison in jenkins.
this.timeout(300000);
await PageObjects.common.navigateToApp('dashboard');
await PageObjects.dashboard.loadSavedDashboard('Ecom Dashboard');
await PageObjects.reporting.openPdfReportingPanel();
await PageObjects.reporting.clickGenerateReportButton();

const url = await PageObjects.reporting.getReportURL(60000);
const res = await PageObjects.reporting.getResponse(url);

expect(res.status).to.equal(200);
Copy link
Member Author

@tsullivan tsullivan Jan 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note

Unfortunately, all that the PDF tests are doing is verifying that the job completes successfully. That is ensured by the 200 response.

@elastic/kibana-app-services we need to think of a good way to validate the contents of a PDF file against a baseline. We have an implementation for PNG but not PDF.

expect(res.get('content-type')).to.equal('application/pdf');
});
});
});
Expand Down
2 changes: 1 addition & 1 deletion x-pack/test/functional/apps/visualize/reporting.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
'visEditor',
]);

describe('Visualize', () => {
describe('Visualize Reporting Screenshots', () => {
before('initialize tests', async () => {
log.debug('ReportingPage:initTests');
await esArchiver.loadIfNeeded('reporting/ecommerce');
Expand Down
Binary file modified x-pack/test/functional/es_archives/reporting/ecommerce_kibana/data.json.gz
View file
Open in desktop
Binary file not shown.
Loading