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.

Example:

Let's use Upgrade Manager functional test to easily show how to setup Kubedog around Godog. The example below assumes you know how Godog works. Some idea of what Upgrade Manager is, would help, but it is not necessary.

Let’s jump right into it:

Step 1: the feature file

First we need the *.feature file defining the desired behavior. You can define this file as you would normally do when using Godog, but utilizing Kubedog syntax. As mentioned, you can also redefine the steps and use custom syntax.

Feature: UM's RollingUpgrade Create
  In order to create RollingUpgrades
  As an EKS cluster operator
  I need to submit the custom resource

  Background:
    Given valid AWS Credentials
    And a Kubernetes cluster
    And an Auto Scaling Group named upgrademgr-eks-nightly-ASG

  Scenario: The ASG had a launch config update that allows nodes to join
    Given the current Auto Scaling Group has the required initial settings
    Then 1 node(s) with selector bdd-test=preUpgrade-label should be ready
    Given I update the current Auto Scaling Group with LaunchConfigurationName set to upgrade-eks-nightly-LC-postUpgrade
    And I submit the resource rolling-upgrade.yaml
    Then the resource rolling-upgrade.yaml should be created
    When the resource rolling-upgrade.yaml converge to selector .status.currentStatus=completed
    Then 1 node(s) with selector bdd-test=postUpgrade-label should be ready

Step 2: setting Kubedog around Godog

Minimum required setup

We would need the functions InitializeTestSuite and InitializeScenario in the *_test.go file as required by Godog. We have to pass the suite and scenario context pointers with the methods SetTestSuite and SetScenario of kubedog.Test and call the Run method:

var t kubedog.Test

func InitializeTestSuite(ctx *godog.TestSuiteContext) {
	t.SetTestSuite(ctx)
}

func InitializeScenario(ctx *godog.ScenarioContext) {
	t.SetScenario(ctx)
	t.Run()
}

Before and After Suite, Scenario and Step hooks

Again, kubedog is a simple wrapper – if you want to take advantage of the hooks, you can do so by defining your own functions or calling kubedog’s functions/methods.

func InitializeTestSuite(ctx *godog.TestSuiteContext) {

	ctx.BeforeSuite(func() {
		log.Info("BDD >> trying to delete any existing test RollingUpgrade")
		err := t.KubeContext.DeleteAllTestResources()
		if err != nil {
			log.Errorf("Failed deleting the test resources: %v", err)
		}
	})

	ctx.AfterSuite(func() {
		log.Infof("BDD >> scaling down the ASG %v", t.AwsContext.AsgName)
		err := t.AwsContext.ScaleCurrentASG(0, 0)
		if err != nil {
			log.Errorf("Failed scaling down the ASG %v: %v", t.AwsContext.AsgName, err)
		}

		log.Info("BDD >> deleting any existing test RollingUpgrade")
		err = t.KubeContext.DeleteAllTestResources()
		if err != nil {
			log.Errorf("Failed deleting the test resources: %v", err)
		}
	})

	t.SetTestSuite(ctx)
}

func InitializeScenario(ctx *godog.ScenarioContext) {

	ctx.AfterStep(func(s *godog.Step, err error) {
		time.Sleep(time.Second * 5)
	})

	t.SetScenario(ctx)
	t.Run()
}

Custom steps definition

You are welcome to define new steps and pass kubedog's methods or define your own functions:

func InitializeScenario(ctx *godog.ScenarioContext) {
	ctx.AfterStep(func(s *godog.Step, err error) {
		time.Sleep(time.Second * 5)
	})

	ctx.Step(`^the current Auto Scaling Group has the required initial settings$`, theRequiredInitialSettings)

	t.SetScenario(ctx)
	t.Run()
}

func theRequiredInitialSettings() error {
	// Making sure the ASG has the pre-test launch config and 1 node with correct config
	err := t.AwsContext.UpdateFieldOfCurrentASG("LaunchConfigurationName", "upgrade-eks-nightly-LC-preUpgrade")
	if err != nil {
		return err
	}
	err = t.AwsContext.ScaleCurrentASG(0, 0)
	if err != nil {
		return err
	}
	err = t.KubeContext.NodesWithSelectorShouldBe(0, "bdd-test=preUpgrade-label", "found")
	if err != nil {
		return err
	}
	err = t.KubeContext.NodesWithSelectorShouldBe(0, "bdd-test=postUpgrade-label", "found")
	if err != nil {
		return err
	}
	err = t.AwsContext.ScaleCurrentASG(1, 1)
	if err != nil {
		return err
	}
	return nil
}

Golang test

We can also set up go test compatibility, as explained in Godog’s repository.

Resources:

• Steps syntax

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.