steps

README

kubernetes-godog

This project contains definition and implementation of Godog steps related to various Kubernetes objects. These steps can be easily added to existing test suite by passing ScenarioContext to the builder. Step implementations use standard kubeconfig approach to connect to Kubernetes cluster (using env variable to point to config file or config file in expected location)

Currently there are specified just namespace steps, more steps will come.

Usage

Register steps in InitializeScenario:

func InitializeScenario(ctx *godog.ScenarioContext) {
	steps.Builder().RegisterSteps(ctx)
}

Use registered steps in your feature files:

  Scenario: My complex scenario
    When create namespace dedicated-namespace

    Then namespace dedicated-namespace exists

Documentation

Index

• type KubernetesStepsBuilder
  • func Builder() *KubernetesStepsBuilder
  • func (builder *KubernetesStepsBuilder) RegisterSteps(ctx *godog.ScenarioContext)
  • func (builder *KubernetesStepsBuilder) WithCreateNamespaceListener(listener func(createdNamespace string)) *KubernetesStepsBuilder
  • func (builder *KubernetesStepsBuilder) WithDeleteNamespaceListener(listener func(deletedNamespace string)) *KubernetesStepsBuilder
  • func (builder *KubernetesStepsBuilder) WithNamespaceNameGenerator(generator func() string) *KubernetesStepsBuilder

Types

type KubernetesStepsBuilder

type KubernetesStepsBuilder struct {
	// contains filtered or unexported fields
}

KubernetesStepsBuilder builder for Kubernetes steps

func Builder

func Builder() *KubernetesStepsBuilder

Builder returns builder for Kubernetes steps

func (*KubernetesStepsBuilder) RegisterSteps

func (builder *KubernetesStepsBuilder) RegisterSteps(ctx *godog.ScenarioContext)

RegisterSteps register Kubernetes steps

func (*KubernetesStepsBuilder) WithCreateNamespaceListener

func (builder *KubernetesStepsBuilder) WithCreateNamespaceListener(listener func(createdNamespace string)) *KubernetesStepsBuilder

WithCreateNamespaceListener register listener listening for created namespace events

func (*KubernetesStepsBuilder) WithDeleteNamespaceListener

func (builder *KubernetesStepsBuilder) WithDeleteNamespaceListener(listener func(deletedNamespace string)) *KubernetesStepsBuilder

WithDeleteNamespaceListener register listener listening for deleted namespace events

func (*KubernetesStepsBuilder) WithNamespaceNameGenerator

func (builder *KubernetesStepsBuilder) WithNamespaceNameGenerator(generator func() string) *KubernetesStepsBuilder

WithNamespaceNameGenerator provide namespace name generator to use namespace steps with implicit names