github-mirrors/logstash
1
0
Fork 0
mirror of https://github.com/elastic/logstash.git synced 2025-04-24 14:47:19 -04:00
Code Issues Projects Releases Packages Wiki Activity

Add more setup info

Browse source 
Fixes #5917
This commit is contained in:
Suyog Rao 2016-08-24 17:56:44 +00:00 • committed by Suyog Rao
parent d71112da0e
commit 735f684aa5
1 changed files with 36 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

47
qa/integration/README.md
View file

@ -1,14 +1,39 @@
## Logstash Integration Tests
## Logstash Integration Tests aka RATS
These set of tests are full integration tests as in they start LS from a binary, run config using `-e` and can use any external services
These set of tests are full integration tests as in: they can start LS from a binary, run configs using `-e` and can use any external services like Kafka, ES and S3. This framework is hybrid -- a combination of bash scripts (to mainly setup services), Ruby service files, and RSpec. All test assertions are done in RSpec.
## Setting up
## Dependencies
* An existing Logstash binary, defaults to `LS_HOME/build/logstash-<version>`
* `rspec`
* Not a VM in sight
* From LS_HOME source directory, run `rake artifact:tar`
* `cd build`
* Unzip the recently built file: `tar xvf logstash-<version>.tar.gz`
* `cd LS_HOME/qa/integration`
* `bundle install`
This will install test specific dependency gems.
* You are ready to run any tests
* `rspec specs/es_output_how_spec.rb`
## Preparing a test run
1. If you already have a LS binary in `LS_HOME/build/logstash-<version>`, skip to step 5
2. From Logstash git source directory or `LS_HOME` run `rake artifact:tar` to build a package
2. Untar the newly built package
3. `cd build`
4. `tar xvf logstash-<version>.tar.gz`
5. `cd LS_HOME/qa/integration`
6. `bundle install`: This will install test dependency gems.
You are now ready to run any tests from `qa/integration`.
* Run all tests: `rspec specs/*`
* Run single test: `rspec specs/es_output_how_spec.rb`
### Directory Layout
* `fixtures`: In this dir you will test settings in form of `test_name.yml`. Here you specify services to run, LS config, test specific scripts ala `.travis.yml`
* `services`: This dir has bash scripts that download and bootstrap binaries for services. This is where services like ES will be downloaded and run from. Service can have 3 files: `<service>_setup.sh`, `<service>_teardown.sh` and `<service>`.rb. The bash scripts deal with downloading and bootstrapping, but the ruby source will trigger them from the test as a shell out (using backticks). The tests are blocked until the setup/teardown completes. For example, Elasticsearch service has `elasticsearch_setup.sh`, `elasticsearch_teardown.sh` and `elasticsearch.rb`. The service name in yml is "elasticsearch".
* `framework`: Test framework source code.
* `specs`: Rspec tests that use services and validates stuff
### Adding a new test
1. Creating a new test -- lets call it "test_file_input". This brings up LS to read from a file and assert if file contents were as expected.
2. You'll have to create a yml file in `fixtures` called `test_file_input_spec.yml`. Here you define any external services you need and any LS config.
3. Create a corresponding `test_file_input_spec.rb` in `specs` folder and use the `fixtures` object to get all services, config etc. You can start LS, and assume all external services have already been started. Write rspec code to validate.
## Future Improvements
1. Perform setup and teardown from Ruby and get rid of bash files altogether.