mirror of
https://github.com/1Password/onepassword-operator.git
synced 2025-10-21 23:18:06 +00:00
Make testhelper as a standalone module to install as dependency into kubernetes-secrets-injector
This commit is contained in:
115
pkg/testhelper/README.md
Normal file
115
pkg/testhelper/README.md
Normal file
@@ -0,0 +1,115 @@
|
||||
# OnePassword Operator Test Helper
|
||||
|
||||
This is a standalone Go module that provides testing utilities for Kubernetes operators, specifically designed for testing OnePassword operators but can be used for any Kubernetes operator testing.
|
||||
|
||||
## Installation
|
||||
|
||||
To use this module in your project, add it as a dependency:
|
||||
|
||||
```bash
|
||||
go get github.com/1Password/onepassword-operator/pkg/testhelper@<commit-hash>
|
||||
```
|
||||
|
||||
### Basic Setup
|
||||
|
||||
```go
|
||||
import (
|
||||
"github.com/1Password/onepassword-operator/pkg/testhelper/kube"
|
||||
"github.com/1Password/onepassword-operator/pkg/testhelper/defaults"
|
||||
)
|
||||
|
||||
// Create a kube client for testing
|
||||
kubeClient := kube.NewKubeClient(&kube.Config{
|
||||
Namespace: "default",
|
||||
ManifestsDir: "manifests",
|
||||
TestConfig: &kube.TestConfig{
|
||||
Timeout: defaults.E2ETimeout,
|
||||
Interval: defaults.E2EInterval,
|
||||
},
|
||||
CRDs: []string{
|
||||
"path/to/your/crd.yaml",
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
### Working with Secrets
|
||||
|
||||
```go
|
||||
// Create a secret from environment variable
|
||||
secret := kubeClient.Secret("my-secret")
|
||||
secret.CreateFromEnvVar(ctx, "MY_ENV_VAR")
|
||||
|
||||
// Create a secret from file
|
||||
data := []byte("secret content")
|
||||
secret.CreateFromFile(ctx, "filename", data)
|
||||
|
||||
// Check if secret exists
|
||||
secret.CheckIfExists(ctx)
|
||||
|
||||
// Get secret
|
||||
secretObj := secret.Get(ctx)
|
||||
```
|
||||
|
||||
### Working with Deployments
|
||||
|
||||
```go
|
||||
deployment := kubeClient.Deployment("my-deployment")
|
||||
|
||||
// Read environment variable from deployment
|
||||
envVar := deployment.ReadEnvVar(ctx, "MY_ENV_VAR")
|
||||
|
||||
// Patch environment variables
|
||||
deployment.PatchEnvVars(ctx,
|
||||
[]corev1.EnvVar{
|
||||
{Name: "NEW_VAR", Value: "new_value"},
|
||||
},
|
||||
[]string{"OLD_VAR"}, // variables to remove
|
||||
)
|
||||
|
||||
// Wait for deployment rollout
|
||||
deployment.WaitDeploymentRolledOut(ctx)
|
||||
```
|
||||
|
||||
### Working with Pods
|
||||
|
||||
```go
|
||||
pod := kubeClient.Pod(map[string]string{"app": "my-app"})
|
||||
pod.WaitingForRunningPod(ctx)
|
||||
```
|
||||
|
||||
### Working with Namespaces
|
||||
|
||||
```go
|
||||
namespace := kubeClient.Namespace("my-namespace")
|
||||
namespace.LabelNamespace(ctx, map[string]string{
|
||||
"environment": "test",
|
||||
})
|
||||
```
|
||||
|
||||
### System Utilities
|
||||
|
||||
```go
|
||||
import "github.com/1Password/onepassword-operator/pkg/testhelper/system"
|
||||
|
||||
// Run shell commands
|
||||
output, err := system.Run("kubectl", "get", "pods")
|
||||
|
||||
// Get project root directory
|
||||
rootDir, err := system.GetProjectRoot()
|
||||
|
||||
// Replace files
|
||||
err := system.ReplaceFile("source.yaml", "dest.yaml")
|
||||
```
|
||||
|
||||
### Kind Integration
|
||||
|
||||
```go
|
||||
import "github.com/1Password/onepassword-operator/pkg/testhelper/kind"
|
||||
|
||||
// Load Docker image to Kind cluster
|
||||
kind.LoadImageToKind("my-image:latest")
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT License - see the main project LICENSE file for details.
|
Reference in New Issue
Block a user