Skip to content
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

Jump to bottom

Add instructions for running reporting functional tests to x-pack README #22683

Merged
merged 5 commits into from Sep 5, 2018
Merged

Add instructions for running reporting functional tests to x-pack README #22683

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
be645bc
add instructions
nreese Sep 4, 2018
c1ca3a1
rest of instructions
nreese Sep 4, 2018
d51f11b
pdf-image requirements
nreese Sep 5, 2018
7c0f28b
typo
nreese Sep 5, 2018
c402959
add Ubutnu commands
nreese Sep 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 27 additions & 0 deletions x-pack/README.md
View file
Open in desktop
Expand Up @@ -100,6 +100,33 @@ 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

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
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Might want to add the Linux (Ubutnu) commands too:

sudo apt-get install imagemagick ghostscript poppler-utils

I don't see any instructions for Windows, so don't even know if x-pack tests will run there.


To run the reporting functional tests:

Start the test server
```sh
// Run from the directory KIBANA_HOME/x-pack
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:
Expand Down