Skip to content

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

Merged
tsullivan merged 10 commits intoelastic:masterfrom
tsullivan:test/dashboard-pdf
Jan 16, 2021
Merged

[Test] Add tag cloud visualization to dashboard in functional test for reporting#87600
tsullivan merged 10 commits intoelastic:masterfrom
tsullivan:test/dashboard-pdf

Conversation

@tsullivan
Copy link
Member

@tsullivan tsullivan commented Jan 7, 2021 •
edited
Loading

Summary

Problem: A blocking issue came up that a Tag Cloud panel in a Dashboard shows blank in PDF and PNG reports. That problem should have been caught by automated testing when it was first introduced.

I looked into it and found there is a PNG test in the Dashboard x-pack functional app tests, but the dashboard used for the test is a custom one that doesn't have a tag cloud visualization.

This PR updates the test to include a tag cloud panel. Its saved object data can be found in the data.json.gz file that is changed in this PR.

It has changes to clarify how the comparePNGs function works and lowers the threshold of delta percentage to 85%

Checklist

Delete any items that are not applicable to this PR.

@tsullivan tsullivan marked this pull request as ready for review January 7, 2021 23:47
@tsullivan tsullivan added release_note:skip Skip the PR/issue when compiling release notes zDeprecated Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead v7.11.0 v7.12 v7.13.0 v7.14.0 v8.0.0 labels Jan 7, 2021
@elasticmachine
Copy link
Contributor

elasticmachine commented Jan 7, 2021

Pinging @elastic/kibana-app-services (Team:AppServices)

tsullivan
tsullivan commented Jan 7, 2021
View reviewed changes
x-pack/test/functional/apps/dashboard/reporting/screenshots.ts Outdated
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.

@tsullivan tsullivan mentioned this pull request Jan 7, 2021
Closed
@timroes timroes added v7.12.0 and removed v7.12 labels Jan 11, 2021
@tsullivan tsullivan requested a review from a team January 12, 2021 04:13
@tsullivan
Copy link
Member Author

tsullivan commented Jan 14, 2021

@elasticmachine merge upstream

@tsullivan
Copy link
Member Author

tsullivan commented Jan 14, 2021

@elasticmachine merge upstream

rashmivkulkarni
rashmivkulkarni reviewed Jan 15, 2021
View reviewed changes
x-pack/test/functional/apps/dashboard/reporting/screenshots.ts
);

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.

@kibanamachine
Copy link
Contributor

kibanamachine commented Jan 15, 2021

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

rashmivkulkarni
rashmivkulkarni approved these changes Jan 15, 2021
View reviewed changes
Copy link
Contributor

@rashmivkulkarni rashmivkulkarni left a comment

Choose a reason for hiding this comment

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

LGTM - post the changes - it is passing locally and on CI.

Thanks Tim!

@tsullivan tsullivan merged commit abffb19 into elastic:master Jan 16, 2021
@tsullivan tsullivan deleted the test/dashboard-pdf branch January 16, 2021 05:05
@tsullivan tsullivan mentioned this pull request Jan 16, 2021
Merged
@tsullivan tsullivan mentioned this pull request Jan 16, 2021
Closed
gmmorris added a commit to gmmorris/kibana that referenced this pull request Jan 18, 2021
@gmmorris
Merge branch 'master' into tm/cancel-expired-tasks-on-hung-tm
1ded8b6 
* master: (33 commits)
  [Security Solution][Case] Fix patch cases integration test with alerts (elastic#88311)
  [Security Solutions][Detection Engine] Removes duplicate API calls (elastic#88420)
  Fix log msg (elastic#88370)
  [Test] Add tag cloud visualization to dashboard in functional test for reporting (elastic#87600)
  removing kibana-core-ui from codeowners (elastic#88111)
  [Alerting] Migrate Event Log plugin to TS project references (elastic#81557)
  [Maps] fix zooming while drawing shape filter logs errors in console (elastic#88413)
  Porting fixes 1 (elastic#88477)
  [APM] Explicitly set environment for cross-service links (elastic#87481)
  chore(NA): remove mocha junit ci integrations (elastic#88129)
  [APM] Only display relevant sections for rum agent in service overview (elastic#88410)
  [Enterprise Search] Automatically mock shared logic files (elastic#88494)
  [APM] Disable Create custom link button on Transaction details page for read-only users
  [Docs] clean-up vega map reference documenation (elastic#88487)
  [Security Solution] Fix Timeline event details layout (elastic#88377)
  Change DELETE to POST for _bulk_delete to avoid incompatibility issues (elastic#87914)
  [Monitoring] Change cloud messaging on no data page (elastic#88375)
  [Uptime] clear ping state when PingList component in unmounted (elastic#88321)
  [APM] Consistent terminology for latency and throughput (elastic#88452)
  fix copy (elastic#88481)
  ...
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Jan 19, 2021
@kibanamachine
Copy link
Contributor

kibanamachine commented Jan 19, 2021

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

tsullivan added a commit to tsullivan/kibana that referenced this pull request Jan 19, 2021
@tsullivan @kibanamachine
[Test] Add tag cloud visualization to dashboard in functional test fo…
96cef6f 
…r reporting (elastic#87600)

* add tag cloud to dashboard in kibana archive

* add pdf snapshot testing to downloaded pdfs

* update png baseline image

* remove pdf snapshot testing

* rename mislabeled variable

* fix test comparison

* remove unnecessary pdf utf8 checks

* Update screenshots.ts

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
tsullivan added a commit to tsullivan/kibana that referenced this pull request Jan 19, 2021
@tsullivan @kibanamachine
[Test] Add tag cloud visualization to dashboard in functional test fo…
63d62d3 
…r reporting (elastic#87600)

* add tag cloud to dashboard in kibana archive

* add pdf snapshot testing to downloaded pdfs

* update png baseline image

* remove pdf snapshot testing

* rename mislabeled variable

* fix test comparison

* remove unnecessary pdf utf8 checks

* Update screenshots.ts

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
tsullivan added a commit that referenced this pull request Jan 19, 2021
@tsullivan @kibanamachine
[Test] Add tag cloud visualization to dashboard in functional test fo…
1d10640 
…r reporting (#87600) (#88557)

* add tag cloud to dashboard in kibana archive

* add pdf snapshot testing to downloaded pdfs

* update png baseline image

* remove pdf snapshot testing

* rename mislabeled variable

* fix test comparison

* remove unnecessary pdf utf8 checks

* Update screenshots.ts

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
@kibanamachine
Copy link
Contributor

kibanamachine commented Jan 20, 2021

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

8 similar comments
@kibanamachine
Copy link
Contributor

kibanamachine commented Jan 21, 2021

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

@kibanamachine
Copy link
Contributor

kibanamachine commented Jan 22, 2021

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

@kibanamachine
Copy link
Contributor

kibanamachine commented Jan 25, 2021

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

@kibanamachine
Copy link
Contributor

kibanamachine commented Jan 26, 2021

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

@kibanamachine
Copy link
Contributor

kibanamachine commented Jan 27, 2021

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

@kibanamachine
Copy link
Contributor

kibanamachine commented Jan 28, 2021

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

@kibanamachine
Copy link
Contributor

kibanamachine commented Jan 29, 2021

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

@kibanamachine
Copy link
Contributor

kibanamachine commented Feb 1, 2021

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

@kibanamachine kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Feb 2, 2021
@tsullivan tsullivan mentioned this pull request Feb 25, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@rashmivkulkarni rashmivkulkarni rashmivkulkarni approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

release_note:skip Skip the PR/issue when compiling release notes v7.11.0 v7.12.0 v7.13.0 v7.14.0 v8.0.0 zDeprecated Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@tsullivan @elasticmachine @kibanamachine @rashmivkulkarni @timroes