annotation

README

Test how Skupper handles annotated resources

Description

The "TestAnnotatedResources" test validates how Skupper reacts when supported resources (Service and Deployment) are updated with Skupper related annotations.

It uses an nginx server, as the target component for the exposed services, created by Skupper, from an annotated Deployment and two annotated services (one uses a target address while the other does not).

Each test case, from the test table, runs a different scenario, performing modifications to the initially annotated resources.

The final validation, for all test cases, is the same.

They all validate:

• From http://skupper-controller:8080/DATA:
  • The number of connected sites
  • The final list of services
    • Number of services
    • The exposed service list and their respective protocol
• Each exposed service should be accessible
  • Return code is 200
  • Response body is not empty

Pre-requisites

• At least one cluster must be available, through:
  • KUBECONFIG environment variable (defaults to: ${USER}/.kube/config)
  • Or specifying one or two clusters through:
    • --kubeconfig
    • --edgekubeconfig
• Test will create two namespaces
  • annotation-1
  • annotation-2
  • Note: If using 2 clusters, each one will be created in a distinct cluster

Setup and TearDown

The Setup creates the namespaces, deploys the initial set of resources (Deployment and Services) and creates the Skupper network between the two namespaces (or clusters). This happens only once for all test cases.

The TearDown is executed when test finishes or is interrupted, and it deletes the created namespaces (if namespace creation fails, it does not delete anything).

Test steps and validations (common for all test cases)

1. Run the modification function (if any provided)
2. Retrieve services list from http://skupper-controller:8080/DATA
3. Validate number of sites
4. Validate exposed list of services and their protocols
5. Communicate with all exposed services from both clusters
   1. Expects HTTP status code to be 200
   2. Response body cannot be empty

Test cases

services-pre-annotated

First iteration to run. It creates an nginx deployment and two services on each cluster/ns. They are created with Skupper annotations, before Skupper is deployed to the clusters, to validate if Skupper is detecting the existing services and exposing them as per the annotations.

Here are the annotations on each:

• Cluster1

  • nginx (Deployment)
    • skupper.io/proxy = tcp
    • skupper.io/address = nginx-1-dep-web
  • nginx-1-svc-exp-notarget (Service)
    • skupper.io/proxy = tcp
  • nginx-1-svc-target (Service)
    • skupper.io/proxy = http
    • skupper.io/address = nginx-1-svc-exp-target

• Cluster2

  • nginx (Deployment)
    • skupper.io/proxy = tcp
    • skupper.io/address = nginx-2-dep-web
  • nginx-2-svc-exp-notarget (Service)
    • skupper.io/proxy = tcp
  • nginx-2-svc-target (Service)
    • skupper.io/proxy = http
    • skupper.io/address = nginx-2-svc-exp-target

services-protocol-switch

Switches the protocols for all exposed resources. If resource is using TCP, it will set the protocol to HTTP and vice-versa.

services-annotation-removed

Removes all Skupper annotations from previously annotated resources.

services-annotated

Adds the annotations back to the initial resources (now with Skupper already running) and validate that it has been restored to the initial state.

Documentation

Index

• func AddAnnotation(t *testing.T, testRunner base.ClusterTestRunner)
• func AddPorts(t *testing.T, testRunner base.ClusterTestRunner)
• func ChangeAddress(t *testing.T, testRunner base.ClusterTestRunner)
• func DebugAnnotatedResources(t *testing.T, testRunner base.ClusterTestRunner)
• func DeployResources(testRunner base.ClusterTestRunner) error
• func RemoveAnnotation(t *testing.T, testRunner base.ClusterTestRunner)
• func RemovePorts(t *testing.T, testRunner base.ClusterTestRunner)
• func RevertAddress(t *testing.T, testRunner base.ClusterTestRunner)
• func SwitchProtocols(t *testing.T, testRunner base.ClusterTestRunner)
• func UndeployResources(testRunner base.ClusterTestRunner) error

Functions

func AddAnnotation

func AddAnnotation(t *testing.T, testRunner base.ClusterTestRunner)

AddAnnotation adds the default annotations to the nginx deployment as well as for the two services (the one without target and the other that uses a target address). For more info, see: DeployResources

func AddPorts

func AddPorts(t *testing.T, testRunner base.ClusterTestRunner)

AddPorts adds extra ports to already annotated resources

func ChangeAddress

func ChangeAddress(t *testing.T, testRunner base.ClusterTestRunner)

ChangeAddress target address to use not owned service

func DebugAnnotatedResources

func DebugAnnotatedResources(t *testing.T, testRunner base.ClusterTestRunner)

DebugAnnotatedResources prints current status for the exposed resources

func DeployResources

func DeployResources(testRunner base.ClusterTestRunner) error

DeployResources provides common setup for kicking off all annotated resource tests. It deploys a static set of resources: - Deployments - Services.

And it also includes static annotations to the deployed resources.

The default resources and annotations (if true) that will be added to both cluster1 and cluster2 are: deployment/nginx ## cluster1

annotations:
  skupper.io/proxy: tcp
  skupper.io/address: nginx-1-dep-web
  skupper.io/port: 8080:8080,9090:8080

statefulset/nginx ## cluster1

annotations:
  skupper.io/proxy: tcp
  skupper.io/address: nginx-1-ss-web

daemonset/nginx ## cluster1

annotations:
  skupper.io/proxy: tcp
  skupper.io/address: nginx-1-ds-web

service/nginx-1-svc-exp-notarget ## cluster1

annotations:
  skupper.io/proxy: tcp

service/nginx-1-svc-target ## cluster1

annotations:
  skupper.io/proxy: http
  skupper.io/address: nginx-1-svc-exp-target

deployment/nginx ## cluster2

annotations:
  skupper.io/proxy: tcp
  skupper.io/address: nginx-2-dep-web
  skupper.io/port: 8080:8080,9090:8080

statefulset/nginx ## cluster2

annotations:
  skupper.io/proxy: tcp
  skupper.io/address: nginx-2-ss-web

daemonset/nginx ## cluster2

annotations:
  skupper.io/proxy: tcp
  skupper.io/address: nginx-2-ds-web

service/nginx-2-svc-exp-notarget ## cluster2

annotations:
  skupper.io/proxy: tcp

service/nginx-2-svc-target ## cluster2

annotations:
  skupper.io/proxy: http
  skupper.io/address: nginx-1-svc-exp-target

func RemoveAnnotation

func RemoveAnnotation(t *testing.T, testRunner base.ClusterTestRunner)

RemoveAnnotation will remove annotation from the nginx deployment as well as from all services with the label "app=nginx"

func RemovePorts

func RemovePorts(t *testing.T, testRunner base.ClusterTestRunner)

RemovePorts remove the extra ports from already annotated resources

func RevertAddress

func RevertAddress(t *testing.T, testRunner base.ClusterTestRunner)

RevertAddress target address to use owned service

func SwitchProtocols

func SwitchProtocols(t *testing.T, testRunner base.ClusterTestRunner)

SwitchProtocols switches the annotated resources protocols from http to tcp and vice versa

func UndeployResources

func UndeployResources(testRunner base.ClusterTestRunner) error