README.md

elastic-stack-testing

[WIP] Elastic Stack Testing Framework (ESTF)

This project is a work in progress to provide a common automation framework for elastic stack testing.
The goal is to provide a powerful, easy to use and maintain framework to build test suites.

One main project for this framework is the development of a product integration test suite.

• Automated Integration Testing (AIT)

This project is in early stage development and many things are still being ironed out.

More details can be found:

• Wiki
• Kanban Board

Infrastructure

• Software products under test: Elasticsearch, Kibana, Logstash, Beats, Cloud, APM, ML
• Ansible is used to install and configure the software products under test
• Python, Pytest and Selenium/Webium will be used for the test framework
• Automated virtual machine support for Vagrant boxes, AWS EC2 and GCP

Environment Setup

• Install Python 3*

  *In this repo see version file: .python-version

  https://www.python.org/downloads/

• Install Vagrant*

  *In this repo see version: .vagrant-version

  https://www.vagrantup.com/downloads.html

• Install Virtualbox*

  *In this repo see version file: .virtualbox-version

  https://www.virtualbox.org/wiki/Downloads

Quick Start

Running a playbook for provisioning

1. Clone repository: git clone https://github.com/elastic/elastic-stack-testing.git
2. cd elastic-stack-testing
3. Edit file: buildenv.sh
4. Fill in information
   • export AIT_RUN_LOCAL=true
   • export ES_BUILD_URL=artifacts.elastic.co/[version] ex: 6.2.3
   • export ES_BUILD_PKG_EXT=tar
   • export AIT_ANSIBLE_PLAYBOOK=install_xpack
   • export AIT_VM=vagrant_vm
   • export AIT_SKIP_VM_CLEANUP=true
5. Execute file: ./buildenv.sh

For more options see file: CONTRIBUTING.md

Currently Supported

• Machine: Vagrant, Virtualbox
• Machine OS: Ubuntu-16.04-x86_64
• Node: Single
• Product Versions: 5.6.x, 6.x, 7.x
• Product Packages: tar.gz
• Product Types: Regular and OSS

Cloud Environment

Building the ci/cloud project requires a github API token. The API key will need repo access (repo checkbox).

Once a github API token has been acquired three environment variables must be set: GH_OWNER, GH_TOKEN, and SDK_VERSION.

GH_OWNER should be set to elastic but can be overridden to your fork if necessary.

chmod +x getJavaSdk.sh

GH_OWNER=elastic GH_TOKEN=mytoken SDK_VERSION=1.2.0-SNAPSHOT ./getJavaSdk.sh

Contributing

Please use the issue tracker to report any bugs or enhancement requests. Pull requests are welcome.

Authors

Elastic Stack Testing Framework created by Liza Dayoub.

Also see a list of contributors who participated in the project.

License

Apache License 2.0