testkube

module
v1.8.14-beta004 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 5, 2023 License: MIT

README

Testkube Logo Light Testkube Logo Dark

Welcome to Testkube - Your friendly cloud-native testing framework for Kubernetes

Website |  Documentation |  Twitter |  Discord |  Blog

Click on the image or this link to watch the "Intro to Testkube" short video (3 mins)

Welcome to Testkube

Your friendly cloud-native testing framework for Kubernetes.

Testkube natively integrates test orchestration and execution into Kubernetes and your CI/CD/GitOps pipeline. It decouples test artifacts and execution from CI/CD tooling; tests are meant to be part of your clusters state and can be executed as needed:

  • Kubectl plugin
  • Externally triggered via API (CI, external tooling, etc)
  • Automatically on deployment of annotated/labeled services/pods/etc (WIP)

Testkube advantages:

  • Avoids vendor lock-in for test orchestration and execution in CI/CD pipelines
  • Makes it easy to orchestrate and run any kind of tests - functional, load/performance, security, compliance, etc. in your clusters, without having to wrap them in docker-images or providing network access
  • Makes it possible to decouple test execution from build processes; engineers should be able to run specific tests whenever needed
  • Centralizes all test results in a consistent format for "actionable QA analytics"
  • Provides a modular architecture for adding new types of tests and executors

Main Testkube components are:

  • kubectl Testkube plugin - simple - installed w/o 3rd party repositories (like Krew etc), communicates with
  • API Server - work orchestrator, runs executors, gather execution results
  • CRDs Operator - watches Testkube CR, handles changes, communicates with API Server
  • Executors - runs tests defined for specific runner
  • Results DB - for centralized test results aggregation and analysis
  • Testkube Dashboard - standalone web application for viewing real-time Testkube test results

Getting Started

Check out the Installation and Getting Started guides to set up Testkube and run your first tests!

Documentation

Is available at https://kubeshop.github.io/testkube

Contributing

Shout-out to our contributors 🎉 - you're great!

Go to contribution document to read more how can you help us 🔥

Feedback

Whether it helps you or not - we'd LOVE to hear from you. Please let us know what you think and of course, how we can make it better. Please join our growing community on Discord

Directories

Path Synopsis
cmd
executor
gradle Module
internal
pkg/api/repository/result
Package result is a generated GoMock package.
Package result is a generated GoMock package.
pkg/api/repository/testresult
Package testresult is a generated GoMock package.
Package testresult is a generated GoMock package.
pkg
config
Package config is a generated GoMock package.
Package config is a generated GoMock package.
crd
executor/client
Package client is a generated GoMock package.
Package client is a generated GoMock package.
git
TODO consider checkout by some go-git library to limit external deps in docker container in time writing code "github.com/src-d/go-git" didn't have any filter options "github.com/go-git/go-git/v5" also
TODO consider checkout by some go-git library to limit external deps in docker container in time writing code "github.com/src-d/go-git" didn't have any filter options "github.com/go-git/go-git/v5" also
log
secret
Package secret is a generated GoMock package.
Package secret is a generated GoMock package.
tmp
triggers
Package triggers is a generated GoMock package.
Package triggers is a generated GoMock package.
ui
simple ui - TODO use something more sophisticated :)
simple ui - TODO use something more sophisticated :)
test

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL