context

README

Binding Context Generator

Binding Context Generator allows to generate binding context values for hook testing purpose.

Usage example:

1. Declare the hook config

config := `
configVersion: v1
schedule:
- name: every_minute
  crontab: '* * * * *'
  includeSnapshotsFrom:
  - pod
kubernetes:
- apiVersion: v1
  name: pod
  kind: Pod
  watchEvent:
  - Added
  - Modified
  - Deleted
  namespace:
    nameSelector:
      matchNames:
      - default`

1. Declare initial state of kubernetes objects

initialState := `
---
apiVersion: v1
kind: Pod
metadata:
  name: pod-0
---
apiVersion: v1
kind: Pod
metadata:
  name: pod-1
`

1. Declare new state (one of pods are deleted)

newState := `
---
apiVersion: v1
kind: Pod
metadata:
  name: pod-0
`

1. Create new binding context controller

c, err := context.NewBindingContextController(config, initialState)
if err != nil {
  return err
}

1. Register CRD (if you use some in tests) in format [Group, Version, Kind, isNamespaced]:

c.RegisterCRD("example.com", "v1", "Example", true)
c.RegisterCRD("example.com", "v1", "ClusterExample", false)

1. Run controller to get initial binding context

contexts, err := c.Run()
if err != nil {
  return err
}
testContexts(contexts)

1. Change state to new get binding contexts

contexts, err = c.ChangeState(newState)
if err != nil {
  return err
}
testNewContexts(contexts)

1. Run schedule to get binding contexts

contexts, err = c.RunSchedule("* * * * *")
if err != nil {
  return err
}
testScheduleContexts(contexts)

Documentation

Index

• Constants
• Variables
• type BindingContextController
  • func NewBindingContextController(config string) (*BindingContextController, error)
  • func (b *BindingContextController) ChangeState(newState ...string) (GeneratedBindingContexts, error)
  • func (b *BindingContextController) ChangeStateAndWaitForBindingContexts(desiredQuantity int, newState string) (GeneratedBindingContexts, error)
  • func (b *BindingContextController) RegisterCRD(group, version, kind string, namespaced bool)
  • func (b *BindingContextController) Run(initialState string) (GeneratedBindingContexts, error)
  • func (b *BindingContextController) RunBindingWithAllSnapshots(binding types.BindingType) (GeneratedBindingContexts, error)
  • func (b *BindingContextController) RunSchedule(crontab string) (GeneratedBindingContexts, error)
  • func (b *BindingContextController) Stop()
  • func (b *BindingContextController) WithHook(h *hook.Hook)
• type ContextCombiner
  • func NewContextCombiner() *ContextCombiner
  • func (c *ContextCombiner) AddBindingContext(bindingType types.BindingType, info controller.BindingExecutionInfo)
  • func (c *ContextCombiner) Combined() []binding_context.BindingContext
  • func (c *ContextCombiner) CombinedAndUpdated(hookCtrl controller.HookController) (GeneratedBindingContexts, error)
  • func (c *ContextCombiner) QueueLen() int
• type GeneratedBindingContexts
  • func ConvertToGeneratedBindingContexts(bindingContexts []binding_context.BindingContext) (GeneratedBindingContexts, error)
• type StateController
  • func NewStateController() *StateController
  • func (c *StateController) ChangeState(newRawState string) (int, error)
  • func (c *StateController) SetInitialState(initialState string) error

Constants

const TestQueueName string = "test-queue"

TestQueueName is a name of the queue created by ContextCombiner.

const TestTaskType task.TaskType = "TestTask"

TestTaskType is a type for tasks created by ContextCombiner.

Variables

var FakeCluster *fake.FakeCluster

FakeCluster is global for now. It can be encapsulated in BindingContextController lately.

Types

type BindingContextController

type BindingContextController struct {
	Hook       *hook.Hook
	HookCtrl   controller.HookController
	HookMap    map[string]string
	HookConfig string

	Controller        *StateController
	KubeEventsManager kubeeventsmanager.KubeEventsManager
	ScheduleManager   schedulemanager.ScheduleManager

	UpdateTimeout time.Duration
}

func NewBindingContextController

func NewBindingContextController(config string) (*BindingContextController, error)

func (*BindingContextController) ChangeState

func (b *BindingContextController) ChangeState(newState ...string) (GeneratedBindingContexts, error)

func (*BindingContextController) ChangeStateAndWaitForBindingContexts

func (b *BindingContextController) ChangeStateAndWaitForBindingContexts(desiredQuantity int, newState string) (GeneratedBindingContexts, error)

func (*BindingContextController) RegisterCRD

func (b *BindingContextController) RegisterCRD(group, version, kind string, namespaced bool)

RegisterCRD registers custom resources for the cluster

func (*BindingContextController) Run

func (b *BindingContextController) Run(initialState string) (GeneratedBindingContexts, error)

BindingContextsGenerator generates binding contexts for hook tests

func (*BindingContextController) RunBindingWithAllSnapshots

func (b *BindingContextController) RunBindingWithAllSnapshots(binding types.BindingType) (GeneratedBindingContexts, error)

func (*BindingContextController) RunSchedule

func (b *BindingContextController) RunSchedule(crontab string) (GeneratedBindingContexts, error)

func (*BindingContextController) Stop

func (b *BindingContextController) Stop()

func (*BindingContextController) WithHook

func (b *BindingContextController) WithHook(h *hook.Hook)

type ContextCombiner

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

ContextCombiner is used to bring logic behind the CombineBindingContextForHook method into tests. This method requires a ShellOperator instance with at least one queue with tasks.

func NewContextCombiner

func NewContextCombiner() *ContextCombiner

func (*ContextCombiner) AddBindingContext

func (c *ContextCombiner) AddBindingContext(bindingType types.BindingType, info controller.BindingExecutionInfo)

func (*ContextCombiner) Combined

func (c *ContextCombiner) Combined() []binding_context.BindingContext

CombinedContext returns a combined context or a binding context from the first task.

func (*ContextCombiner) CombinedAndUpdated

func (c *ContextCombiner) CombinedAndUpdated(hookCtrl controller.HookController) (GeneratedBindingContexts, error)

func (*ContextCombiner) QueueLen

func (c *ContextCombiner) QueueLen() int

type GeneratedBindingContexts

type GeneratedBindingContexts struct {
	Rendered        string
	BindingContexts []BindingContext
}

func ConvertToGeneratedBindingContexts

func ConvertToGeneratedBindingContexts(bindingContexts []binding_context.BindingContext) (GeneratedBindingContexts, error)

type StateController

type StateController struct {
	CurrentState map[string]manifest.Manifest
}

StateController holds objects state for FakeCluster

func NewStateController

func NewStateController() *StateController

NewStateController creates controller to apply state changes

func (*StateController) ChangeState

func (c *StateController) ChangeState(newRawState string) (int, error)

ChangeState apply changes to current objects state

func (*StateController) SetInitialState

func (c *StateController) SetInitialState(initialState string) error