Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/balena-os/leviathan
A distributed hardware testing framework
https://github.com/balena-os/leviathan
automation testing
Last synced: about 1 month ago
JSON representation
A distributed hardware testing framework
- Host: GitHub
- URL: https://github.com/balena-os/leviathan
- Owner: balena-os
- License: apache-2.0
- Created: 2017-06-21T13:00:04.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-17T19:05:21.000Z (8 months ago)
- Last Synced: 2024-04-17T22:21:55.772Z (8 months ago)
- Topics: automation, testing
- Language: JavaScript
- Homepage: https://balena-os.github.io/leviathan
- Size: 10.7 MB
- Stars: 20
- Watchers: 22
- Forks: 5
- Open Issues: 132
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Leviathan
[](https://github.com/balena-io/leviathan/issues)
[](https://github.com/balena-io/leviathan/pulls)
[](https://nodejs.org/download/release/v12.0.0/)
[](https://opensource.org/licenses/Apache-2.0) [](https://dashboard.balena-cloud.com/deploy?repoUrl=https://github.com/balena-os/leviathan)
Leviathan can be used to automate, test and control real/virtual devices in production or controlled environments. What can you do:
1. Stress testing the provisioning process for reliability, performance & fault tolerance.
2. Testing new balenaOS, balenaEngine and balena supervisor on different board revisions, prod/staging environments for managed and unmanaged scenarios.
3. Automate release deployment for balenaCloud fleets by testing codebase on real/virtual devices under test.
4. Automate support for new modems, sensors, components and eventually new boards.
The high-level overview of the leviathan architecture can be found [here](./documentation/architecture.md)
## Getting Started
Leviathan allows for running tests on a device controlled by a worker. A worker is a component that provides an interface to a device under test (DUT). The worker can be either real hardware or a virtualised environment. Leviathan is designed to work with multiple workers. At the moment, leviathan supports [testbot][quickstart-testbot](deprecated), [autokit][quickstart-autokit] and [qemu][quickstart-qemu] workers. Learn more about [Leviathan](https://balena-os.github.io/leviathan/pages/Getting-Started/learn-more.html).
### Clone the repository
- Clone this repository with `git clone --recursive` or
- Run `git clone` and then `git submodule update --init --recursive` to install submodules.
### Prerequisites
- Install Docker, node and npm in your system. We recommend installing [LTS versions from NVM](https://github.com/nvm-sh/nvm#install--update-script).
- Download the balenaOS image you want to test on your DUT from [balena.io/os](https://balena.io/os#download).
### Worker setup
Leviathan allows for running tests on a device under test (DUT) connected to and controlled by either a testbot worker, or on a virtualized device using the QEMU worker. Check out the following getting started guides to setup and run each type of worker.
1. [Testbot worker][quickstart-testbot]
2. [QEMU worker][quickstart-qemu]
3. [Autokit worker][quickstart-autokit]
## Instructions for rig-owners
Leviathan is made up of a client and worker. The client is the test runner while the worker is where tests get executed. For testbot workers, the worker component exists on the testbot device. The testbot devices are part of a [balenaCloud](https://balena.io) fleet. In order to update the worker component for testbot workers, you need to [push a new release](https://www.balena.io/docs/learn/deploy/deployment/) to the testbot fleet.
To push a new release of leviathan to balenaCloud, use the following command:
```bash
balena push
```
The `` is the name of the fleet you intend to push a new version of leviathan to. Keep in mind, the client and the test that run are independent of the worker. Hence, updates to the client or the tests don't need to be pushed to the balenaCloud fleet. In order to change the worker component, you need to push a new release to the balenaCloud fleet.
## Documentation for Leviathan Helpers
Documentation for Leviathan helpers can be found on [https://balena-os.github.io/leviathan](https://balena-os.github.io/leviathan). To generate the documentation, run the following command from either the root of the repository or the `core` directory.
```bash
npm install
npm run docs
```
If the docs are generated successfully, you will be getting the success line as:
```bash
Info: Documentation generated at /path/to/documentation
```
## Support
If you're having any problem, please [raise an issue][newissue] on GitHub and the balena team will be happy to help.
## License
The project is licensed under the Apache 2.0 license.
[issues]: https://github.com/balena-io/leviathan/issues
[newissue]: https://github.com/balena-io/leviathan/issues/new
[source]: https://github.com/balena-io/leviathan
[quickstart-qemu]: https://balena-os.github.io/leviathan/pages/Getting-Started/quickstart/quickstart-qemu.html
[quickstart-testbot]: https://balena-os.github.io/leviathan/pages/Getting-Started/quickstart/quickstart-testbot.html
[quickstart-autokit]: https://balena-os.github.io/leviathan/pages/Getting-Started/quickstart/quickstart-autokit.html