kubedog

README

Kubedog

This is a simple wrapper of Godog v0.10.0 with some predefined steps and their implementations. It is limited to Kubernetes and AWS, more precisely, it targets the functional testing of Kubernetes components working in AWS. Additionally, you can take advantage of Godog’s before and after suite, scenario and step hooks and call Kubedog’s functions and methods from there.

The library has a one and only purpose – it saves you from the hassle of implementing common/basic steps and hooks with the compromise of using predefined syntax. Of course, you could always redefine the steps using custom syntax and pass the corresponding kubedog methods.

Resources:

• Steps syntax
• Usage example: upgrade-manager's BDD
• Kubernetes manifests: templating yaml files

GoDocs

• Kubedog
• Kube
• AWS

Documentation

Index

• type Test
  • func (kdt *Test) Run()
  • func (kdt *Test) SetScenario(scenario *godog.ScenarioContext)
  • func (kdt *Test) SetTestFilesPath(testFilesPath string)
  • func (kdt *Test) SetTestSuite(testSuite *godog.TestSuiteContext)

Types

type Test

type Test struct {
	KubeContext kube.Client
	AwsContext  aws.Client
	// contains filtered or unexported fields
}

func (*Test) Run

func (kdt *Test) Run()

Run contains the steps definition, should be called in the InitializeScenario function required by godog. Check https://github.com/keikoproj/kubedog/blob/master/docs/syntax.md for steps syntax details.

func (*Test) SetScenario

func (kdt *Test) SetScenario(scenario *godog.ScenarioContext)

SetScenario sets the ScenarioContext, should be use in the InitializeScenario function required by godog.

func (*Test) SetTestFilesPath

func (kdt *Test) SetTestFilesPath(testFilesPath string)

SetTestFilesPath sets the path for the test files. If SetTestFilesPath was not used, the methods that operate with/on files will look for them in ./templates by default.

func (*Test) SetTestSuite

func (kdt *Test) SetTestSuite(testSuite *godog.TestSuiteContext)

SetTestSuite sets the TestSuiteContext, should be use in the InitializeTestSuite function required by godog.