.github/workflows/test-release.yaml

@@ -1,24 +1,21 @@
 ---
-name: Unit Test, E to E Test and Github Release (if on master)
+name: Testing and Github Release (if on master)
 on: [push, pull_request]
 jobs:
   unittest:
     runs-on: ubuntu-18.04
-    strategy:
-      matrix:
-        test: ['test']
-    name: ${{ matrix.test }}
+    name: Unit Test
     steps:
       - name: Checkout Code
         uses: actions/checkout@v2
       - name: Setup Golang
         uses: actions/setup-go@v2
         with:
           go-version: 1.13.5
-      - run: make ${{ matrix.test }}
+      - run: make test
   integrationtest:
     runs-on: ubuntu-18.04
-    name: integrationtest
+    name: Integration Test
     steps:
       - name: Checkout Code
         uses: actions/checkout@v2
@@ -27,24 +24,21 @@ jobs:
         with:
           go-version: 1.13.5
       - run: sudo make integration-test-suite
-  e2etest:
+  declarativetest:
     runs-on: ubuntu-18.04
-    strategy:
-      matrix:
-        test: ['e2e-test']
-    name: ${{ matrix.test }}
+    name: Declarative Test
     steps:
       - name: Checkout Code
         uses: actions/checkout@v2
       - name: Setup Golang
         uses: actions/setup-go@v2
         with:
           go-version: 1.13.5
-      - run: sudo make ${{ matrix.test }}
+      - run: sudo make declarative-test-suite
   release:
     name: Make Github Release
     runs-on: ubuntu-18.04
-    needs: ['unittest', 'e2etest', 'integrationtest']
+    needs: ['unittest', 'declarativetest', 'integrationtest']
     steps:
       - name: Checkout Code
         uses: actions/checkout@v1

.gitignore

@@ -3,7 +3,7 @@ tools/d-action/vendor/
 d-operators
 test/bin/
 test/kubebin/
-test/e2e/uninstall-k3s.txt
+test/declarative/uninstall-k3s.txt
 test/integration/uninstall-k3s.txt
 uninstall-k3s.txt
 dope

Makefile

@@ -35,12 +35,14 @@ testv:
 	@go test ./... -cover -v -args --logtostderr -v=2
 
 .PHONY: integration-test
-integration-test: 
+integration-test:
+	# Uncomment to list verbose output
+	# @go test ./... -cover --tags=integration -v -args --logtostderr -v=1
 	@go test ./... -cover --tags=integration
 
-.PHONY: e2e-test
-e2e-test: 
-	@cd test/e2e && ./suite.sh
+.PHONY: declarative-test-suite
+declarative-test-suite: 
+	@cd test/declarative && ./suite.sh
 
 .PHONY: integration-test-suite
 integration-test-suite:

README.md

@@ -54,34 +54,40 @@ It is important to understand that these declarative patterns are built upon pro
 ### When to use D-operators
 D-operators is not meant to build complex controller logic like Deployment, StatefulSet or Pod in a declarative yaml. However, if one needs to use available Kubernetes resources to build new k8s controller(s) then d-operators should be considered to build one. D-operators helps implement the last mile automation needed to manage applications & infrastructure in Kubernetes clusters.
 
-### E to E testing
+### Declarative Testing
 D-operators make use of its custom resource(s) to test its controllers. One can imagine these custom resources acting as the building blocks to implement a custom CI framework. One of the primary advantages with this approach, is to let custom resources remove the need to write code to implement test cases.
 
-_NOTE: One can make use of these YAMLs (kind: Recipe) to test their own Kubernetes controllers declaratively_
+_NOTE: One can make use of these YAMLs (kind: Recipe) to test any Kubernetes controllers declaratively_
 
-Navigate to test/experiments to learn more on these YAMLs.
+Navigate to test/declarative/experiments to learn more on these YAMLs.
 
 ```sh
-# Following runs the e2e test suite
+# Following runs the declarative test suite
 #
-# NOTE: test/e2e/suite.sh does the following:
+# NOTE: test/declarative/suite.sh does the following:
 # - d-operators' image known as 'dope' is built
 # - a docker container is started & acts as the image registry
 # - dope image is pushed to this image registry
 # - k3s is installed with above image registry
 # - d-operators' manifests are applied
 # - experiments _(i.e. test code written as YAMLs)_ are applied
 # - experiments are asserted
-# - if all experiments pass then e2e is a success else it failed
+# - if all experiments pass then this testing is a success else it failed
 # - k3s is un-installed
 # - local image registry is stopped
-sudo make e2e-test
+sudo make declarative-test-suite
 ```
 
-### Deploying experiments using D-operators
-To deploy experiments using d-operators apply the below commands:
-- kubectl apply -f deploy/
-- kubectl apply -f test/experiments/<experiment-yaml>
+### Programmatic Testing
+D-operators also lets one to write testing Kubernetes controllers using Golang. This involves building the docker image (refer Dockerfile.testing) of the entire codebase and letting it run as a Kubernetes pod (refer test/integration/it.yaml). The setup required run these tests can be found at test/integration folder. Actual test logic are regular _test.go files found in respective packages. These _test.go files need to be tagged appropriately. These mode of testing has the additional advantage of getting the code coverage.
+
+```go
+// +build integration
+```
+
+```sh
+make integration-test-suite
+```
 
 ### Available Kubernetes controllers
 - [x] kind: Recipe

cmd/main.go

@@ -62,13 +62,15 @@ func main() {
 
 	// controller name & corresponding controller reconcile function
 	var controllers = map[string]generic.InlineInvokeFn{
-		"sync/recipe":     recipe.Sync,
-		"finalize/recipe": recipe.Finalize,
-		"sync/http":       http.Sync,
-		"sync/doperator":  doperator.Sync,
-		"sync/run":        run.Sync,
-		"sync/command":    command.Sync,
+		"sync/recipe":      recipe.Sync,
+		"finalize/recipe":  recipe.Finalize,
+		"sync/http":        http.Sync,
+		"sync/doperator":   doperator.Sync,
+		"sync/run":         run.Sync,
+		"sync/command":     command.Sync,
+		"finalize/command": command.Finalize,
 	}
+
 	for name, ctrl := range controllers {
 		generic.AddToInlineRegistry(name, ctrl)
 	}

config/metac.yaml

@@ -64,4 +64,52 @@ spec:
   hooks:
     sync:
       inline:
-        funcName: sync/command
+        funcName: sync/command
+---
+apiVersion: dope/v1
+kind: GenericController
+metadata:
+  name: finalize-command
+  namespace: dope
+spec:
+  watch:
+    apiVersion: dope.mayadata.io/v1
+    resource: commands
+  attachments:
+  # Delete pod
+  - apiVersion: v1
+    resource: pods
+    advancedSelector:
+      selectorTerms:
+      # select Pod if its labels has following
+      - matchReferenceExpressions:
+        - key: metadata.namespace
+          operator: EqualsWatchNamespace
+        - key: metadata.labels.job-name
+          operator: EqualsWatchName # match this lbl value against watch Name
+  # Delete job
+  - apiVersion: batch/v1
+    resource: jobs
+    advancedSelector:
+      selectorTerms:
+      # select job if its labels has following
+      - matchLabels:
+          command.dope.mayadata.io/controller: "true"
+        matchReferenceExpressions:
+        - key: metadata.labels.command\.dope\.mayadata\.io/uid
+          operator: EqualsWatchUID # match this lbl value against watch UID
+  - apiVersion: v1
+    resource: configmaps
+    advancedSelector:
+      selectorTerms:
+      # select ConfigMap if its labels has following
+      - matchLabels:
+          command.dope.mayadata.io/lock: "true"
+        matchReferenceExpressions:
+        - key: metadata.labels.command\.dope\.mayadata\.io/uid
+          operator: EqualsWatchUID # match this lbl value against watch Name
+  hooks:
+    finalize:
+      inline:
+        funcName: finalize/command
+---

controller/command/finalizer.go

@@ -0,0 +1,57 @@
+/*
+Copyright 2020 The MayaData Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package command
+
+import (
+	"openebs.io/metac/controller/generic"
+)
+
+var (
+	defaultDeletionResyncTime = float64(30)
+)
+
+// Finalize implements the idempotent logic that gets executed when
+// Command instance is deleted. A Command instance may have child job &
+// dedicated lock in form of a ConfigMap.
+// Finalize logic tries to delete child pod, job & ConfigMap
+//
+// NOTE:
+// 	When finalize hook is set in the config metac automatically sets
+// a finalizer entry against the Command metadata's finalizers field .
+// This finalizer entry is removed when SyncHookResponse's Finalized
+// field is set to true
+//
+// NOTE:
+// 	SyncHookRequest is the payload received as part of finalize
+// request. Similarly, SyncHookResponse is the payload sent as a
+// response as part of finalize request.
+//
+// NOTE:
+//	Returning error will panic this process. We would rather want this
+// controller to run continuously. Hence, the errors are handled.
+func Finalize(request *generic.SyncHookRequest, response *generic.SyncHookResponse) error {
+	if request.Attachments.IsEmpty() {
+		// Since no Dependents found it is safe to delete Command
+		response.Finalized = true
+		return nil
+	}
+
+	response.ResyncAfterSeconds = defaultDeletionResyncTime
+	// Observed attachments will get deleted
+	response.ExplicitDeletes = request.Attachments.List()
+	return nil
+}

controller/command/reconciler.go

@@ -61,6 +61,17 @@ func (r *Reconciler) eval() {
 }
 
 func (r *Reconciler) sync() {
+	// Check for deletion timestamp on command resource
+	// if set then command is marked for deletion
+	if !r.observedCommand.DeletionTimestamp.IsZero() {
+		klog.V(1).Infof(
+			"Will skip command reconciliation: It is marked for deletion: Command %q / %q",
+			r.observedCommand.GetNamespace(),
+			r.observedCommand.GetName(),
+		)
+		return
+	}
+
 	// creating / deleting a Kubernetes Job is part of Command reconciliation
 	jobBuilder := command.NewJobBuilder(
 		command.JobBuildingConfig{

deploy/crd.yaml

@@ -83,4 +83,4 @@ spec:
   versions:
   - name: v1
     served: true
-    storage: true
+    storage: true

go.mod

@@ -3,6 +3,7 @@ module mayadata.io/d-operators
 go 1.13
 
 require (
+	github.com/ghodss/yaml v1.0.0
 	github.com/go-resty/resty/v2 v2.2.0
 	github.com/google/go-cmp v0.4.0
 	github.com/pkg/errors v0.9.1