From be645bcd24d696daf8291b0509df520e162d1c9d Mon Sep 17 00:00:00 2001 From: Nathan Reese Date: Tue, 4 Sep 2018 13:33:54 -0600 Subject: [PATCH 1/5] add instructions --- x-pack/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/x-pack/README.md b/x-pack/README.md index 63722ac16ab10..e56975dfefdd5 100644 --- a/x-pack/README.md +++ b/x-pack/README.md @@ -100,6 +100,16 @@ We also have SAML API integration tests which set up Elasticsearch and Kibana wi node scripts/functional_tests --config test/saml_api_integration/config ``` +#### Running Reporting functional tests + +To run the reporting functional tests: + +Start the test server +```sh +// Run from the directory KIBANA_HOME/x-pack +node scripts/functional_tests_server +``` + #### Developing functional tests If you are **developing functional tests** then you probably don't want to rebuild Elasticsearch and wait for all that setup on every test run, so instead use this command to build and start just the Elasticsearch and Kibana servers: From c1ca3a1c54f1ac3eb07493468e80f7d543f1eb36 Mon Sep 17 00:00:00 2001 From: Nathan Reese Date: Tue, 4 Sep 2018 13:35:23 -0600 Subject: [PATCH 2/5] rest of instructions --- x-pack/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/x-pack/README.md b/x-pack/README.md index e56975dfefdd5..a05761b078d1d 100644 --- a/x-pack/README.md +++ b/x-pack/README.md @@ -110,6 +110,14 @@ Start the test server node scripts/functional_tests_server ``` +Start the test runner +```sh +// Run from the directory KIBANA_HOME/x-pack +node ../scripts/functional_test_runner --config test/reporting/configs/chromium_functional.js +``` + +**Note** Configurations from `kibana.dev.yml` are picked up when running the tests. Ensure that `kibana.dev.yml` does not contain any `xpack.reporting` configurations. + #### Developing functional tests If you are **developing functional tests** then you probably don't want to rebuild Elasticsearch and wait for all that setup on every test run, so instead use this command to build and start just the Elasticsearch and Kibana servers: From d51f11b652b83ce80ee369f8a84adc44399021c2 Mon Sep 17 00:00:00 2001 From: Nathan Reese Date: Wed, 5 Sep 2018 12:49:02 -0600 Subject: [PATCH 3/5] pdf-image requirements --- x-pack/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/x-pack/README.md b/x-pack/README.md index a05761b078d1d..8dfab9c63d648 100644 --- a/x-pack/README.md +++ b/x-pack/README.md @@ -102,6 +102,15 @@ node scripts/functional_tests --config test/saml_api_integration/config #### Running Reporting functional tests +prerequisites: +The reporting functional tests use [pdf-image](https://www.npmjs.com/package/pdf-image) to convert PDF's pages to png files for image comparisions between generated reports and baseline reports. +pdf-image requires the system commands `convert`, `gs`, and `pdfinfo` to function. Those can be set up be running the following. + +```sh +//OSX +brew install imagemagick ghostscript poppler +``` + To run the reporting functional tests: Start the test server From 7c0f28b36acf8dc5db2f4047369ac8d250e15a4d Mon Sep 17 00:00:00 2001 From: Nathan Reese Date: Wed, 5 Sep 2018 12:53:00 -0600 Subject: [PATCH 4/5] typo --- x-pack/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/x-pack/README.md b/x-pack/README.md index 8dfab9c63d648..49aa0854515ee 100644 --- a/x-pack/README.md +++ b/x-pack/README.md @@ -104,7 +104,7 @@ node scripts/functional_tests --config test/saml_api_integration/config prerequisites: The reporting functional tests use [pdf-image](https://www.npmjs.com/package/pdf-image) to convert PDF's pages to png files for image comparisions between generated reports and baseline reports. -pdf-image requires the system commands `convert`, `gs`, and `pdfinfo` to function. Those can be set up be running the following. +pdf-image requires the system commands `convert`, `gs`, and `pdfinfo` to function. Those can be set up by running the following. ```sh //OSX From c4029598dd69deda7ac9c542b4f004c1be46df96 Mon Sep 17 00:00:00 2001 From: Nathan Reese Date: Wed, 5 Sep 2018 12:58:26 -0600 Subject: [PATCH 5/5] add Ubutnu commands --- x-pack/README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/x-pack/README.md b/x-pack/README.md index 49aa0854515ee..177a88f6e9f43 100644 --- a/x-pack/README.md +++ b/x-pack/README.md @@ -109,6 +109,9 @@ pdf-image requires the system commands `convert`, `gs`, and `pdfinfo` to functio ```sh //OSX brew install imagemagick ghostscript poppler + +//Ubutnu +sudo apt-get install imagemagick ghostscript poppler-utils ``` To run the reporting functional tests: