Intuit Tank is a load test platform that runs in a cloud environment. It currently supports Amazon web interfaces and utilizes services from EC2, S3, CloudWatch (Logs/Metrics).
Intuit Tank has two main components: A controller and agents.
The Controller is the central hub in the deployment. It supports the GUI for managing tests and for orchestrating. It utilizes Apache Tomcat for a web container and communicates with the agents via http. It exposes a RESTful interface for invoking services. Data is stored in a MySql database, on the file system, and reporting metrics can be stored in CloudWatch Metrics, S3, DynamoDB or Wavefront.
Agents are instantiated on demand and exist for the duration of a test. They communicate with the controller via RESTful interfaces.
All of Tank's documentation is at intuit.github.io/Tank: installation, configuration, the user guide, script functions, the tools, and the REST API reference.
The site is built with Material for MkDocs from the docs folder and published by the Docs GitHub Actions workflow on every merge to master. To preview your changes locally:
python3 -m venv venv && source venv/bin/activate
pip install -r docs-requirements.txt
mkdocs serve # http://127.0.0.1:8000, reloads as you edit
mkdocs build --strict # what CI runs; fails on broken linksThe API reference page reads docs/openapi-spec.json, which is generated from the code rather than committed. To include it locally:
mvn -pl rest-mvc/impl -am test -Dtest=OpenApiSpecExportTest -Dsurefire.failIfNoSpecifiedTests=false
cp rest-mvc/impl/target/openapi/tank-openapi.json docs/openapi-spec.jsonIntuit Tank uses Maven and should be able to be built using public repositories. You may need to increase the default memory settings for maven to build. e.g. export MAVEN_OPTS="-Xmx1g"
There are several profiles:
- default -- builds source but does not package tools.
- release -- default plus all tools and signs them using a self signed certificate.
- coverage -- runs jacoco code coverage.
- static-analysis -- runs checkstyle and findbugs.
mvn clean install runs all unit tests and integration tests by default under their respective maven stages - test and verify.
There are several artifacts that are important.
- web/web_ui/target/tank.war -- the main deployment file. Intended for deployment to a tomcat web server.
- agent/agentManager_pkg/target/agent-startup-pkg.zip -- the agent app that gets started when the agent starts and manages communicating with the tank controller and coordinating the tests.
- tools/agent_debugger_pkg/target/Tank-Debugger-all.jar -- the visual debugger jar. can be launched to debug scripts or projects. With --headless it replays a project from the command line and writes the authid and step results to output.log. See tools/agent_debugger/README.md.
- tools/script_filter_pkg/target/Tank-Script-Runner-all.jar -- the visual script filter tool for writing scripts to filter or manipulate scripts on import.
- proxy-parent/proxy_pkg/target/Tank-Proxy-pkg.jar -- the proxy recording tool. A Tool to record scripts using your browser.
all-in-one.sh installs a local controller (Tomcat with an H2 database) and a standalone agent on Mac or Linux,
using the artifacts you build here. It's for trying Tank out and small tests, not for large-scale or production testing.
mvn clean install -P release -DskipTests
./all-in-one.sh ~/tank-aio
~/tank-aio/start.sh # then open http://localhost:8080 (admin / admin)See the Quickstart for details.
The integration tests are located in the test_support module. They are designed to test the REST API endpoints against the QA Tank environment.
You can find more information in the README file in that module.
Please open an issue here on GitHub if you have a problem, suggestion, or other comment.
Pull requests are welcome and encouraged! There are eclipse code format templates in the dev_environment folder.
Any contributions should include new or updated unit tests as necessary to maintain thorough test coverage,
and an update to the docs folder for any change users will notice.
Tank is provided under the Eclipse Public License - Version 1.0
Please see the FAQ.
