Clean up duplicate partner pod definition and reorganize the local-test-infra folder to test-target and test-partner (#64)

Author: jc-rh

.github/workflows/partner-pod.yaml

@@ -3,10 +3,9 @@ on: [push, pull_request]
 defaults:
   run:
     shell: bash
-    working-directory: test-partner
 
 jobs:
-  test-local-test-infra:
+  test-test-partner:
     name: 'Test the partner pod on minikube'
     runs-on: ubuntu-20.04
     env:
@@ -20,13 +19,9 @@ jobs:
       - name: Start the minikube cluster
         uses: ./.github/actions/start-minikube
 
-      - name: Add a proper label to the minikube node
-        run: oc label nodes minikube role=tnfpartner
-
       - name: Create the partner pod using the instructions in the README
         run: |
-          oc create -f ./namespace.yaml
-          oc create -f ./partner.yaml
+          make install-partner-pods
 
       - name: Wait for the partner pod to be ready
         run: oc wait pod --for=condition=ready -l 'app=tnfpartner' -n $DEFAULT_NAMESPACE --timeout=$DEFAULT_TIMEOUT

README.md

@@ -1,10 +1,11 @@
 # CNF Certification Partner
 
 This repository contains two main sections:
-* test-partner:  A partner pod definition for use on a k8s CNF Certification cluster.
-* local-test-infra:  A trivial example cluster, primarily intended to be used to run [test-network-function](https://github.com/test-network-function/test-network-function) test suites on a development machine.
-This is the basic infrastructure required for "testing the tester".
-Also includes a test operator.
+* test-partner:  Partner pods definition for use on a k8s CNF Certification cluster.
+* test-target:  A trivial example CNF (including a replicaset/deployment, a CRD and an operator), primarily intended to be used to run [test-network-function](https://github.com/test-network-function/test-network-function) test suites on a development machine.
+
+Together, they make up the basic infrastructure required for "testing the tester".
+
 # Glossary
 
 * Pod Under Test (PUT): The Vendor Pod, usually provided by a CNF Partner.
@@ -62,13 +63,11 @@ This will create a deployment named "partner" in the "default" namespace.  This
 For disconnected environments, override the default image repo `quay.io/testnetworkfunction` by setting the environment variable named `TNF_PARTNER_REPO` to the local repo.
 For environments with slow internet connection, override the default deployment timeout value (120s) by setting the environment variable named `TNF_DEPLOYMENT_TIMEOUT`.
 
-*Note*: Nodes have to be properly labeled (`role=tnfpartner`) for the partner pod to be started.
-
-# local-test-infra
+# Test-target
 
 Although any CNF Certification results should be generated using a proper CNF Certification cluster, there are times
-in which using a local emulator can greatly help with test development.  As such, [local-test-infra](./local-test-infra)
-provides a very simple PUT, OT, CRD, DP and TPP containing the minimal requirements to perform test cases.
+in which using a local emulator can greatly help with test development.  As such, [test-target](./test-target)
+provides a very simple PUT, OT, CRD, which satisfies the minimal requirements to perform test cases.
 These can be used in conjunction with a local kind or [minikube](https://minikube.sigs.k8s.io/docs/) cluster to perform local test development.
 
 
@@ -103,7 +102,7 @@ Or Alternatively, run:
 make rebuild-minikube
 ```
 
-## Start local-test-infra
+## Deploy both test target and test partner as a local-test-infra
 
 To create the resources, issue the following command:
 
@@ -144,9 +143,9 @@ You should see something like this (note that the 2 test pods are running on dif
 NAME                                                              NAME                          READY   STATUS    RESTARTS   AGE    IP           NODE           NOMINATED NODE   READINESS GATES
 tnfpartner-678db9858c-f9p4f   1/1     Running   0          142m   10.244.4.2   minikube-m05   <none>           <none>
 ```
-## Stop local-test-infra
+## Delete local-test-infra
 
-To tear down the local test cluster use the following command. It may take some time to completely stop the PUT, CRD, OT, DP and TPP:
+To tear down the local test infrastruture from the cluster, use the following command. It may take some time to completely stop the PUT, CRD, OT, DP and TPP:
 
 ```shell-script
 make clean

local-test-infra/debugpartner.yaml

@@ -14,7 +14,7 @@ then
 else
   echo "use registry $REDHAT_RHEL_REGISTRY"
   mkdir -p ./temp
-  cat ./local-test-infra/debugpartner.yaml | $SCRIPT_DIR/mo > ./temp/debugpartner.yaml
+  cat ./test-partner/debugpartner.yaml | $SCRIPT_DIR/mo > ./temp/debugpartner.yaml
   oc apply -f ./temp/debugpartner.yaml
   rm ./temp/debugpartner.yaml
 fi

scripts/deploy-debug-ds.sh

@@ -5,7 +5,7 @@ SCRIPT_DIR=$(dirname "$0")
 source $SCRIPT_DIR/init-env.sh
 
 mkdir -p ./temp
-cat ./local-test-infra/local-partner-deployment.yaml | $SCRIPT_DIR/mo > ./temp/rendered-partner-template.yaml
+cat ./test-partner/partner-deployment.yaml | $SCRIPT_DIR/mo > ./temp/rendered-partner-template.yaml
 oc apply -f ./temp/rendered-partner-template.yaml
 rm ./temp/rendered-partner-template.yaml
 sleep 3

scripts/deploy-partner-pods.sh

@@ -4,6 +4,6 @@
 SCRIPT_DIR=$(dirname "$0")
 source $SCRIPT_DIR/init-env.sh
 
-oc apply -f ./local-test-infra/local-crd-under-test.yaml
+oc apply -f ./test-target/local-crd-under-test.yaml
 
 oc wait crd crdexamples.test-network-function.com --timeout=5s --for=condition=established

scripts/deploy-test-crds.sh

@@ -8,7 +8,7 @@ source $SCRIPT_DIR/init-env.sh
 oc create namespace ${TNF_EXAMPLE_CNF_NAMESPACE} 2>/dev/null
 
 mkdir -p ./temp
-cat ./local-test-infra/local-pod-under-test.yaml | $SCRIPT_DIR/mo > ./temp/rendered-local-pod-under-test-template.yaml
+cat ./test-target/local-pod-under-test.yaml | $SCRIPT_DIR/mo > ./temp/rendered-local-pod-under-test-template.yaml
 oc apply -f ./temp/rendered-local-pod-under-test-template.yaml
 rm ./temp/rendered-local-pod-under-test-template.yaml
 sleep 3

scripts/deploy-test-pods.sh

@@ -5,7 +5,7 @@ metadata:
   annotations:
     debug.openshift.io/source-container: container-00
     openshift.io/scc: node-exporter
-  namespace: default
+  namespace: {{ DEFAULT_NAMESPACE }}
   name: debug
 spec:
   selector:

test-partner/debugpartner.yaml

@@ -1,6 +1,7 @@
+# This is for future when we need to deploy partner pods to namespaces other than "default"
 apiVersion: v1
 kind: Namespace
 metadata:
-  name: tnf
+  name: {{ DEFAULT_NAMESPACE }}
   labels:
-    name: tnf
+    name: {{ DEFAULT_NAMESPACE }}