kibana/x-pack/test/functional/apps/dashboard/reporting/README.md
Tim Sullivan 5b6028a3aa
[7.x] [Reporting/Test] move functional tests to apps (#64368) (#64590)
* [Reporting/Test] move functional tests to apps (#64368)

* Squashed commit of the following:

commit 5953089c03bea6b2d091f7723fea25bb1c210ee8
Author: Timothy Sullivan <tsullivan@elastic.co>
Date:   Thu Apr 9 18:29:55 2020 -0700

    move tests to apps

commit 39adeaae6d3502d2c6da4e6111c2a396f2a7aedb
Author: Timothy Sullivan <tsullivan@elastic.co>
Date:   Thu Apr 9 17:49:20 2020 -0700

    update archive with better dashboard

commit 55b600748356c1adc5e75669b0c5588a812e401d
Author: Timothy Sullivan <tsullivan@elastic.co>
Date:   Thu Apr 9 17:16:53 2020 -0700

    fix the refactoring bugs

commit 11aff10cd8009aeb9bb78aa5ce0b37a72d47776e
Author: Timothy Sullivan <tsullivan@elastic.co>
Date:   Thu Apr 9 17:16:28 2020 -0700

    remove unused fixtuers

commit 05c33817c8eb67c461ac012cf2f71a9c01f1a91e
Author: Timothy Sullivan <tsullivan@elastic.co>
Date:   Thu Apr 9 16:37:36 2020 -0700

    Start of refactoring

commit b63c182b5f32b19dc3ca715efdbc5f18fcc02f67
Author: Timothy Sullivan <tsullivan@elastic.co>
Date:   Thu Apr 9 16:32:50 2020 -0700

    Todo comments

commit 1e0105e673
Author: Timothy Sullivan <tsullivan@elastic.co>
Date:   Thu Apr 9 14:31:58 2020 -0700

    revert unrelated change

commit 206fd14b77
Merge: 0d4c2ad29a 834306458a
Author: Timothy Sullivan <tsullivan@elastic.co>
Date:   Thu Apr 9 14:28:45 2020 -0700

    Merge branch 'master' into reporting/test-better

commit 0d4c2ad29a
Author: Timothy Sullivan <tsullivan@elastic.co>
Date:   Wed Apr 8 10:41:19 2020 -0700

    fix ts

commit 890128c47d
Merge: d9ce4024ec 3598b8c44c
Author: Timothy Sullivan <tsullivan@elastic.co>
Date:   Wed Apr 8 10:31:09 2020 -0700

    Merge branch 'master' into reporting/test-better

commit d9ce4024ec
Author: Timothy Sullivan <tsullivan@elastic.co>
Date:   Tue Apr 7 08:31:58 2020 -0700

    [Reporting] convert all server unit tests to TypeScript

* fix imports and readmes

* remove not-needed readme

* remove extra info from readme

* correct some comments

* log the error that was caught

* fix config path in readme

* fix readme instructions to point to updated paths

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

* revert

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-04-28 12:43:12 -07:00

1.2 KiB

The Dashboard Reporting Tests

Baseline snapshots

The reporting tests create a few PNG reports and do a snapshot comparison against stored baselines. The baseline images are stored in ./reports/baseline.

Updating the baselines

Every now and then visual changes will be made that will require the snapshots to be updated. This is how you go about updating it.

  1. Load the ES Archive containing the dashboard and data. This will load the test data into an Elasticsearch instance running via the functional test server:
node scripts/es_archiver load reporting/ecommerce --config=x-pack/test/functional/config.js
node scripts/es_archiver load reporting/ecommerce_kibana --config=x-pack/test/functional/config.js
  1. Generate the reports of the E-commerce dashboard in the Kibana UI. Navigate to http://localhost:5620, find the archived dashboard, and generate all the types of reports for which there are stored baseline images.
  2. Download the reports, and save them into the reports/baseline folder. Change the names of the PNG/PDF files to overwrite the stored baselines.

The next time functional tests run, the generated reports will be compared to the latest image that you have saved :bowtie: