Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kyma-incubator/octopus
The test runner for acceptance tests
https://github.com/kyma-incubator/octopus
k8s kubernetes testing
Last synced: 2 months ago
JSON representation
The test runner for acceptance tests
- Host: GitHub
- URL: https://github.com/kyma-incubator/octopus
- Owner: kyma-incubator
- License: apache-2.0
- Archived: true
- Created: 2019-02-20T12:59:34.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-10-27T07:26:21.000Z (about 2 years ago)
- Last Synced: 2024-08-29T18:33:25.730Z (4 months ago)
- Topics: k8s, kubernetes, testing
- Language: Go
- Size: 409 KB
- Stars: 117
- Watchers: 8
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
## :warning: **Archived**
This repository has been deprecated and archived on Oct 27th, 2022.
# Octopus
## Overview
Octopus is a testing framework that allows you to run tests defined as Docker images on a running cluster.
It was created to replace the `helm test` by providing these additional features:
- Selective testing, which is especially useful for local development when you want to execute only tests that local changes can affect.
- Automatic retries on failed tests, which is a remedy for flaky tests.
- Running tests multiple times, which is helpful when you add a new test and you want to validate if it is stable, or when you want to reproduce a problem that occurs on CI.
- Full support for concurrent testing, which allows you to specify how many tests should be executed at the same time.
Octopus provides extensions for kubectl. For more information, read [this](docs/kubectl-extensions.md) document.
## Prerequisites
Use the following tools to set up the project:
* Version 1.12 or higher of [Go](https://golang.org/dl/)
* Version 2.0.0 of [Kustomize](https://github.com/kubernetes-sigs/kustomize)
* Version 1.0.7 of [Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder)
* The latest version of [Docker](https://www.docker.com/)
* The latest version of [Mockery](https://github.com/vektra/mockery)
## Installation
To install the Octopus [helm](https://helm.sh/) chart on a cluster, run the following command:
```
helm install ./chart/octopus/ --name={release name} --namespace={namepsace}
```
## Development
### Install dependencies
This project uses `go modules` as the dependency manager. To install all required dependencies, use the following command:
```bash
make resolve
```
### Run tests
To test your changes before each commit, use the following command:
```bash
make validate
```
### Regenerate mocks
To regenerate mocks in this project, use the following script:
```bash
./hack/mocks-gen.sh
```
### Upgrade chart
Chart `chart/octopus` is upgraded manually, by copying respective files from the `config` directory.