Skip to content

TESTING.md

Latest commit

 

History

History
116 lines (94 loc) · 3.9 KB

TESTING.md

File metadata and controls

116 lines (94 loc) · 3.9 KB
Raw

E2E Testing

Prerequisites:

Install Ginkgo

$ go get -u github.com/onsi/ginkgo/ginkgo

Setup backup storage configuration

To get started, the test suite expects 2 files to use as configuration for Velero's backup storage. One file that contains your credentials, and another that contains additional configuration options (for now the name of the bucket).

The default test suite expects these files in /var/run/oadp-credentials, but can be overridden with the environment variables OADP_AWS_CRED_FILE and OADP_S3_BUCKET.

To get started, create these 2 files: OADP_AWS_CRED_FILE:

[<INSERT_PROFILE_NAME>]
aws_access_key_id=<access_key>
aws_secret_access_key=<secret_key>

OADP_S3_BUCKET:

{
  "velero-bucket-name": <bucket>
}

Run all e2e tests

$ make test-e2e

Run selected test

You can run a particular e2e test(s) by placing an F at the beginning of a Describe, Context, and It.

 FDescribe("test description", func() { ... })
 FContext("test scenario", func() { ... })
 FIt("the assertion", func() { ... })

These need to be removed to run all specs.

Debugging e2e tests with Visual Studio

Optionally developers can debug the ginko driven tests in tests/e2e with Visual Studio Code.

  • Ensure you have a properly configured launch.json in your .vscode directory. Ensure that your kubeconfig provides access to the k8s or OpenShift environment.

Example Configuration: launch.json

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Launch Package Test",
            "type": "go",
            "request": "launch",
            "mode": "test",
            "program": "${fileDirname}",
            "env": {
                "KUBECONFIG": "/home/user/my_kubeconfig",
                "KUBERNETES_MASTER": "http://localhost:8080"
            }
        }

    ]
}
  • The e2e_suite_test.go file must be overridden with parameters specific to your environment and aws buckets.
    • The critical paramaters to change are under func init():
      • cloud
      • s3BucketFilePath
      • namespace
      • region
      • provider

Example Configuration: e2e_suite_test.go

func init() {
	flag.StringVar(&cloud, "cloud", "/home/user/oadp_e2e/aws_credentials", "Cloud Credentials file path location")
	flag.StringVar(&s3BucketFilePath, "s3_bucket", "/home/user/oadp_e2e/oadp_s3_bucket", "AWS S3 data file path location")
	flag.StringVar(&namespace, "velero_namespace", "oadp-operator", "Velero Namespace")
	flag.StringVar(&region, "region", "us-east-1", "BSL region")
	flag.StringVar(&provider, "provider", "aws", "BSL provider")
	flag.StringVar(&credSecretRef, "creds_secret_ref", "cloud-credentials", "Credential secret ref for backup storage location")
	flag.StringVar(&instanceName, "velero_instance_name", "example-velero", "Velero Instance Name")
	timeoutMultiplierInput := flag.Int64("timeout_multiplier", 1, "Customize timeout multiplier from default (1)")
	timeoutMultiplier = 1
	if timeoutMultiplierInput != nil && *timeoutMultiplierInput >= 1 {
		timeoutMultiplier = time.Duration(*timeoutMultiplierInput)
	}
}
  • Note that your shell overrides documented here are not accessable to Visual Studio Code.

Execute

  • Ensure the file you intend to set break points on has focus in Visual Studio Code
  • Set break points as needed in Visual Studio Code
  • Launch and debug according to Visual Studio Code's debug instructions