mocks

package
v0.0.20 Latest Latest
Warning

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

 Go to latest Published: Sep 30, 2019 License: Apache-2.0 Imports: 20 Imported by: 0

README

Kubernetes API Mocks

This folder contains all mocks and machinery to interact with a fake Kubernetes API.

Usage

1. Instantiate Fake

Inside a testing function, instantiate Fake by sharing the test context t and namespace name:

import "github.com/redhat-developer/service-binding-operator/test/mocks"

f := mocks.NewFake(t, "namespace")
2. Add Mocked Objects

Add mocked objects are you need.

f.AddMockedSecret("db-credentials")
3. Instantiate API Clients

Instantiate a fake API client, with:

fakeClient := f.FakeClient()
fakeDynamicClient := f.FakeDynClient()

Unstructured List vs. Typed Resource

As you may notice, in mocks.go we have methods returning typed Kubernetes objects, and sometimes returning unstructured.Unstructured. That happens because when using List with the dynamic client, it fails on parsing objects inside:

item[0]: can't assign or convert v1alpha1.ClusterServiceVersion into unstructured.Unstructured

However, using Unstructured it does not fail during testing.

Documentation

Index

Constants

View Source 
const (
	CRDName            = "postgresql.baiju.dev"
	CRDVersion         = "v1alpha1"
	CRDKind            = "Database"
	OperatorKind       = "ServiceBindingRequest"
	OperatorAPIVersion = "apps.openshift.io/v1alpha1"
)

resource details employed in mocks

Variables

View Source 
var (
	// DBNameSpecDesc default spec descriptor to inform the database name.
	DBNameSpecDesc = olmv1alpha1.SpecDescriptor{
		DisplayName:  "Database Name",
		Description:  "Database Name",
		Path:         "dbName",
		XDescriptors: []string{"binding:env:attribute"},
	}
	ImageSpecDesc = olmv1alpha1.SpecDescriptor{
		Path:         "image",
		DisplayName:  "Image",
		Description:  "Image Name",
		XDescriptors: nil,
	}
	// DBNameSpecDesc default spec descriptor to inform the database name.
	DBNameSpecIp = olmv1alpha1.SpecDescriptor{
		DisplayName:  "Database IP",
		Description:  "Database IP",
		Path:         "dbConnectionIp",
		XDescriptors: []string{"binding:env:attribute"},
	}
	// DBConfigMapSpecDesc spec descriptor to describe a operator that export username and password
	// via config-map, instead of a usual secret.
	DBConfigMapSpecDesc = olmv1alpha1.SpecDescriptor{
		DisplayName: "DB ConfigMap",
		Description: "Database ConfigMap",
		Path:        "dbConfigMap",
		XDescriptors: []string{
			"urn:alm:descriptor:io.kubernetes:ConfigMap",
			"binding:env:object:configmap:user",
			"binding:env:object:configmap:password",
		},
	}
	// DBPasswordCredentialsOnEnvStatusDesc status descriptor to describe a database operator that
	// publishes username and password over a secret. Default approach.
	DBPasswordCredentialsOnEnvStatusDesc = olmv1alpha1.StatusDescriptor{
		DisplayName: "DB Password Credentials",
		Description: "Database credentials secret",
		Path:        "dbCredentials",
		XDescriptors: []string{
			"urn:alm:descriptor:io.kubernetes:Secret",
			"binding:env:object:secret:user",
			"binding:env:object:secret:password",
		},
	}
	// DBPasswordCredentialsOnVolumeMountStatusDesc status descriptor to describe a operator that
	// informs credentials via a volume.
	DBPasswordCredentialsOnVolumeMountStatusDesc = olmv1alpha1.StatusDescriptor{
		DisplayName: "DB Password Credentials",
		Description: "Database credentials secret",
		Path:        "dbCredentials",
		XDescriptors: []string{
			"urn:alm:descriptor:io.kubernetes:Secret",
			"binding:volumemount:secret:user",
			"binding:volumemount:secret:password",
		},
	}
)

Functions

func CRDDescriptionConfigMapMock 

func CRDDescriptionConfigMapMock() olmv1alpha1.CRDDescription

CRDDescriptionConfigMapMock based on PostgreSQL operator, returns a mock using configmap based spec-descriptor

func CRDDescriptionMock 

func CRDDescriptionMock() olmv1alpha1.CRDDescription

CRDDescriptionMock based on PostgreSQL operator, returning a mock using default third party operator setup.

func CRDDescriptionVolumeMountMock 

func CRDDescriptionVolumeMountMock() olmv1alpha1.CRDDescription

CRDDescriptionVolumeMountMock based on PostgreSQL operator, returns a mock having credentials in a volume.

func ClusterServiceVersionListMock 

func ClusterServiceVersionListMock(ns, name string) *olmv1alpha1.ClusterServiceVersionList

ClusterServiceVersionListMock returns a list with a single CSV object inside, reusing mock.

func ClusterServiceVersionListVolumeMountMock 

func ClusterServiceVersionListVolumeMountMock(ns, name string) *olmv1alpha1.ClusterServiceVersionList

ClusterServiceVersionListVolumeMountMock returns a list with a single CSV object inside, reusing mock.

func ClusterServiceVersionMock 

func ClusterServiceVersionMock(ns, name string) olmv1alpha1.ClusterServiceVersion

ClusterServiceVersionMock based on PostgreSQL operator having what's expected as defaults.

func ClusterServiceVersionVolumeMountMock 

func ClusterServiceVersionVolumeMountMock(ns, name string) olmv1alpha1.ClusterServiceVersion

ClusterServiceVersionVolumeMountMock based on PostgreSQL operator.

func ConfigMapMock 

func ConfigMapMock(ns, name string) *corev1.ConfigMap

ConfigMapMock returns a dummy config-map object.

func ConvertToUnstructured added in v0.0.19 

func ConvertToUnstructured(cr interface{}) (*unstructured.Unstructured, error)

func DatabaseCRMock 

func DatabaseCRMock(ns, name string) *pgv1alpha1.Database

DatabaseCRMock based on PostgreSQL operator, returning a instantiated object.

func DeploymentListMock 

func DeploymentListMock(ns, name string, matchLabels map[string]string) appsv1.DeploymentList

DeploymentListMock returns a list of DeploymentMock.

func DeploymentMock 

func DeploymentMock(ns, name string, matchLabels map[string]string) appsv1.Deployment

DeploymentMock creates a mocked Deployment object of busybox.

func SecretMock 

func SecretMock(ns, name string) *corev1.Secret

SecretMock returns a Secret based on PostgreSQL operator usage.

func ServiceBindingRequestMock 

func ServiceBindingRequestMock(
	ns string,
	name string,
	backingServiceResourceRef string,
	applicationResourceRef string,
	matchLabels map[string]string,
) *v1alpha1.ServiceBindingRequest

ServiceBindingRequestMock return a binding-request mock of informed name and match labels.

func UnstructuredClusterServiceVersionMock 

func UnstructuredClusterServiceVersionMock(ns, name string) (*ustrv1.Unstructured, error)

UnstructuredClusterServiceVersionMock unstructured object based on ClusterServiceVersionMock.

func UnstructuredClusterServiceVersionVolumeMountMock 

func UnstructuredClusterServiceVersionVolumeMountMock(
	ns string,
	name string,
) (*ustrv1.Unstructured, error)

UnstructuredClusterServiceVersionVolumeMountMock returns ClusterServiceVersionVolumeMountMock as unstructured object

func UnstructuredDatabaseCRMock added in v0.0.19 

func UnstructuredDatabaseCRMock(ns, name string) (*unstructured.Unstructured, error)

UnstructuredDatabaseCRMock returns a unstructured version of DatabaseCRMock.

func UnstructuredDatabaseConfigMapMock added in v0.0.19 

func UnstructuredDatabaseConfigMapMock(ns, name, configMapName string) (*unstructured.Unstructured, error)

UnstructuredDatabaseConfigMapMock returns a unstructured version of DatabaseConfigMapMock.

func UnstructuredDeploymentMock 

func UnstructuredDeploymentMock(
	ns,
	name string,
	matchLabels map[string]string,
) (*ustrv1.Unstructured, error)

UnstructuredDeploymentMock converts the DeploymentMock to unstructured.

func UnstructuredNestedDatabaseCRMock added in v0.0.19 

func UnstructuredNestedDatabaseCRMock(ns, name string) (*unstructured.Unstructured, error)

UnstructuredNestedDatabaseCRMock returns a unstructured object from NestedDatabaseCRMock.

func UnstructuredServiceBindingRequestMock added in v0.0.19 

func UnstructuredServiceBindingRequestMock(
	ns string,
	name string,
	backingServiceResourceRef string,
	applicationResourceRef string,
	matchLabels map[string]string,
) (*unstructured.Unstructured, error)

UnstructuredServiceBindingRequestMock returns a unstructured version of SBR.

Types

type ConfigMapDatabase 

type ConfigMapDatabase struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec ConfigMapDatabaseSpec `json:"spec,omitempty"`
}

ConfigMapDatabase ...

func DatabaseConfigMapMock 

func DatabaseConfigMapMock(ns, name, configMapName string) *ConfigMapDatabase

DatabaseConfigMapMock returns a local ConfigMapDatabase object.

type ConfigMapDatabaseSpec 

type ConfigMapDatabaseSpec struct {
	DBConfigMap string `json:"dbConfigMap"`
	ImageName   string
	Image       string
}

ConfigMapDatabaseSpec ...

type Fake 

type Fake struct {
	S *runtime.Scheme // runtime client scheme
	// contains filtered or unexported fields
}

Fake defines all the elements to fake a kubernetes api client.

func NewFake 

func NewFake(t *testing.T, ns string) *Fake

NewFake instantiate Fake type.

func (*Fake) AddMockedCSVList 

func (f *Fake) AddMockedCSVList(name string)

AddMockedCSVList add mocked object from ClusterServiceVersionListMock.

func (*Fake) AddMockedCSVWithVolumeMountList 

func (f *Fake) AddMockedCSVWithVolumeMountList(name string)

AddMockedCSVWithVolumeMountList add mocked object from ClusterServiceVersionListVolumeMountMock.

func (*Fake) AddMockedConfigMap added in v0.0.19 

func (f *Fake) AddMockedConfigMap(name string)

AddMockedConfigMap add mocked object from ConfigMapMock.

func (*Fake) AddMockedDatabaseCR added in v0.0.19 

func (f *Fake) AddMockedDatabaseCR(ref string)

AddMockedDatabaseCR add mocked object from DatabaseCRMock.

func (*Fake) AddMockedSecret 

func (f *Fake) AddMockedSecret(name string)

AddMockedSecret add mocked object from SecretMock.

func (*Fake) AddMockedServiceBindingRequest 

func (f *Fake) AddMockedServiceBindingRequest(
	name string,
	backingServiceResourceRef string,
	applicationResourceRef string,
	matchLabels map[string]string,
) *v1alpha1.ServiceBindingRequest

AddMockedServiceBindingRequest add mocked object from ServiceBindingRequestMock.

func (*Fake) AddMockedUnstructuredCSV 

func (f *Fake) AddMockedUnstructuredCSV(name string)

AddMockedUnstructuredCSV add mocked unstructured CSV.

func (*Fake) AddMockedUnstructuredCSVWithVolumeMount 

func (f *Fake) AddMockedUnstructuredCSVWithVolumeMount(name string)

AddMockedUnstructuredCSVWithVolumeMount same than AddMockedCSVWithVolumeMountList but using unstructured object.

func (*Fake) AddMockedUnstructuredDatabaseCR added in v0.0.19 

func (f *Fake) AddMockedUnstructuredDatabaseCR(ref string)

func (*Fake) AddMockedUnstructuredDeployment 

func (f *Fake) AddMockedUnstructuredDeployment(name string, matchLabels map[string]string)

AddMockedUnstructuredDeployment add mocked object from UnstructuredDeploymentMock.

func (*Fake) AddMockedUnstructuredServiceBindingRequest added in v0.0.19 

func (f *Fake) AddMockedUnstructuredServiceBindingRequest(
	name string,
	backingServiceResourceRef string,
	applicationResourceRef string,
	matchLabels map[string]string,
) *unstructured.Unstructured

func (*Fake) FakeClient 

func (f *Fake) FakeClient() client.Client

FakeClient returns fake structured api client.

func (*Fake) FakeDynClient 

func (f *Fake) FakeDynClient() dynamic.Interface

FakeDynClient returns fake dynamic api client.

type NestedDatabase 

type NestedDatabase struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec NestedDatabaseSpec `json:"spec,omitempty"`
}

NestedDatabase ...

func NestedDatabaseCRMock 

func NestedDatabaseCRMock(ns, name string) NestedDatabase

NestedDatabaseCRMock based on PostgreSQL operator, returning a instantiated object.

type NestedDatabaseSpec 

type NestedDatabaseSpec struct {
	Image NestedImage `json:"image"`
}

NestedDatabaseSpec ...

type NestedImage 

type NestedImage struct {
	Name       string     `json:"name"`
	ThirdLevel ThirdLevel `json:"third"`
}

NestedImage ...

type ThirdLevel 

type ThirdLevel struct {
	Something string `json:"something"`
}

ThirdLevel ...

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.