apptest-framework

module
v0.0.3 Latest Latest
Warning

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

Go to latest
Published: Mar 1, 2024 License: Apache-2.0

README

apptest-framework

A test framework for helping with E2E testing of Giant Swarm managed Apps within Giant Swarm clusters.

Installation

go get github.com/giantswarm/apptest-framework

Features

  • Handles test suite setup (using Ginkgo)
  • Provides shared state across test cases
  • Provides hooks for pre-install, pre-upgrade and post-install steps

Required Environment Variables

  • E2E_KUBECONFIG must be set to the kubeconfig of the test management cluster
  • E2E_KUBECONFIG_CONTEXT must be set to the context to use in the kubeconfig
  • E2E_WC_NAME must be set to the name of the test workload cluster
  • E2E_WC_NAMESPACE must be set to namespace the test workload cluster is in within the management cluster
  • E2E_APP_VERSION must be set to version of the app to test against

Documentation

Documentation can be found at: pkg.go.dev/github.com/giantswarm/apptest-framework.

Resources

Directories

Path Synopsis
pkg
state
package state provides a singleton that can be used to share data across all test cases within a test suite The state can contain the following: - Framework - An initialized `clustertest` framework client pointing at the test management cluster - Cluster - A Cluster object with details about the test workload cluster - Application - An Application object with details abou the App being tested - Context - A context instance
package state provides a singleton that can be used to share data across all test cases within a test suite The state can contain the following: - Framework - An initialized `clustertest` framework client pointing at the test management cluster - Cluster - A Cluster object with details about the test workload cluster - Application - An Application object with details abou the App being tested - Context - A context instance
suite
package suite provides a standard way of setting up and triggering an App test suite
package suite provides a standard way of setting up and triggering an App test suite

Jump to

Keyboard shortcuts

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