feat:wire nil test in pre ci pipeline

Makefile

@@ -40,17 +40,13 @@ test-unit:
 	go test ./pkg/pipeline
 
 test-integration:
-	export INTEGRATION_TEST_ENV_ID=$(docker run --env TEST_BRANCH=$TEST_BRANCH --env LATEST_HASH=$LATEST_HASH --privileged -d --name dind-test -v $PWD/tests/integrationTesting/:/tmp/ docker:dind)
-	docker exec ${INTEGRATION_TEST_ENV_ID} sh /tmp/create-test-env.sh
-	docker exec ${INTEGRATION_TEST_ENV_ID} sh /tests/integrationTesting/run-integration-test.sh
-
+	docker run --env-file=wireNilChecker.env  --privileged -d --name dind-test -v $(PWD)/:/wirenil/:ro -v $(PWD)/temp/:/tempfile docker:dind
+	docker exec dind-test sh -c "mkdir test && cp -r wirenil/* test/ && ./test/tests/integrationTesting/exportEnvsExecuteWireNilChecker.sh"
 run: build
 	./devtron
-
 .PHONY: build
 docker-build-image:  build
 	 docker build -t devtron:$(TAG) .
-
 .PHONY: build, all, wire, clean, run, set-docker-build-env, docker-build-push, devtron,
 docker-build-push: docker-build-image
 	docker tag devtron:${TAG}  ${REGISTRY}/devtron:${TAG}

WiringNilCheck.go

@@ -0,0 +1,138 @@
+package main
+
+import (
+	"fmt"
+	"log"
+	"os"
+	"reflect"
+	"strings"
+	"unsafe"
+)
+
+func CheckIfNilInWire() {
+	app, err := InitializeApp()
+	if err != nil {
+		log.Panic(err)
+	}
+	nilFieldsMap := make(map[string]bool)
+	checkNilFields(app, nilFieldsMap)
+	fmt.Println("NIL Fields present in impls are: ", nilFieldsMap)
+	//Writes the length of nilFieldsMap to a file (e.g., output.env) so that we can export this file's data in a pre-CI pipeline bash script and fail the pre-CI pipeline if the length of nilFieldsMap is greater than zero.
+	err = writeResultToFile(len(nilFieldsMap))
+	if err != nil {
+		return
+	}
+}
+
+func checkNilFields(obj interface{}, nilObjMap map[string]bool) {
+	val := reflect.ValueOf(obj)
+	if val.Kind() == reflect.Ptr {
+		val = val.Elem()
+	}
+	if val.Kind() != reflect.Struct {
+		return
+	}
+	valName := val.Type().Name()
+	for i := 0; i < val.NumField(); i++ {
+		field := val.Field(i)
+		fieldName := val.Type().Field(i).Name
+		pkgPath := val.Type().PkgPath()
+		if pkgPath != "main" && !strings.Contains(pkgPath, "devtron-labs/devtron") {
+			//package not from this repo, ignoring
+			continue
+		}
+		if skipUnnecessaryFieldsForCheck(fieldName, valName) { // skip unnecessary fileds and values
+			continue
+		}
+		if !canFieldTypeBeNil(field) { // field can not be nil, skip
+			continue
+		} else if field.IsNil() { // check if the field is nil
+			mapEntry := fmt.Sprintf("%s.%s", valName, fieldName)
+			nilObjMap[mapEntry] = true
+			continue
+		}
+		if canSkipFieldStructCheck(fieldName, valName) {
+			continue
+		}
+		if !isExported(fieldName) && !field.CanInterface() {
+			unexportedField := GetUnexportedField(field)
+			checkNilFields(unexportedField, nilObjMap)
+		} else {
+			// Recurse
+			checkNilFields(field.Interface(), nilObjMap)
+		}
+	}
+}
+
+func canFieldTypeBeNil(field reflect.Value) bool {
+	kind := field.Kind()
+	switch kind {
+	case reflect.Chan, reflect.Func, reflect.Map, reflect.Pointer, reflect.UnsafePointer,
+		reflect.Interface, reflect.Slice:
+		return true
+	default: //other types can not be nil
+		return false
+	}
+}
+
+func canSkipFieldStructCheck(fieldName, valName string) bool {
+	fieldName = strings.ToLower(fieldName)
+	valName = strings.ToLower(valName)
+	if valName == "githubclient" && (fieldName == "client" || fieldName == "gitopshelper") {
+		return true
+	}
+	for _, str := range []string{"logger", "dbconnection", "syncedenforcer"} {
+		if fieldName == str {
+			return true
+		}
+	}
+	return false
+}
+
+func skipUnnecessaryFieldsForCheck(fieldName, valName string) bool {
+	fieldName = strings.ToLower(fieldName)
+	valName = strings.ToLower(valName)
+	if valName == "cicdconfig" {
+		return true
+	}
+	fieldAndValName := map[string][]string{
+		"app":                          {"enforcerv2", "server"},
+		"gitfactory":                   {"client"},
+		"argocdconnectionmanagerimpl":  {"argocdsettings"},
+		"enforcerimpl":                 {"cache", "enforcerv2"},
+		"helmappclientimpl":            {"applicationserviceclient"},
+		"modulecronserviceimpl":        {"cron"},
+		"oteltracingserviceimpl":       {"traceprovider"},
+		"terminalaccessrepositoryimpl": {"templatescache"},
+	}
+	if _, ok := fieldAndValName[valName]; ok {
+		for _, ignoreFieldName := range fieldAndValName[valName] {
+			if ignoreFieldName == fieldName {
+				return true
+			}
+		}
+	}
+	return false
+}
+func GetUnexportedField(field reflect.Value) interface{} {
+	return reflect.NewAt(field.Type(), unsafe.Pointer(field.UnsafeAddr())).Elem().Interface()
+}
+
+func isExported(fieldName string) bool {
+	return strings.ToUpper(fieldName[0:1]) == fieldName[0:1]
+}
+
+func writeResultToFile(data int) error {
+	file, err := os.Create("/test/output.env")
+	if err != nil {
+		log.Println("Failed to create file:", err)
+		return err
+	}
+	defer file.Close()
+	_, err = file.WriteString(fmt.Sprintf("OUTPUT=%d", data))
+	if err != nil {
+		log.Println("Failed to write to file:", err)
+		return err
+	}
+	return nil
+}

go.mod

@@ -23,6 +23,7 @@ require (
 	github.com/evanphx/json-patch v5.6.0+incompatible
 	github.com/gammazero/workerpool v1.1.3
 	github.com/ghodss/yaml v1.0.1-0.20190212211648-25d852aebe32
+	github.com/go-errors/errors v1.4.2
 	github.com/go-git/go-billy/v5 v5.5.0
 	github.com/go-git/go-git/v5 v5.11.0
 	github.com/go-pg/pg v6.15.1+incompatible

main.go

@@ -21,14 +21,23 @@ import (
 	"fmt"
 	_ "github.com/argoproj/argo-cd/v2/pkg/apis/application/v1alpha1"
 	_ "github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1"
+	util2 "github.com/devtron-labs/devtron/util"
 	"log"
 	"os"
 	"os/signal"
 	"syscall"
 )
 
 func main() {
-
+	globalEnvVariables, err := util2.GetEnvironmentVariables()
+	if err != nil {
+		log.Println("error while getting env variables reason:", err)
+		return
+	}
+	if globalEnvVariables.GlobalEnvVariables.ExecuteWireNilChecker {
+		CheckIfNilInWire()
+		return
+	}
 	app, err := InitializeApp()
 	if err != nil {
 		log.Panic(err)

tests/integrationTesting/create-test-env.sh

@@ -16,8 +16,13 @@ install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl
 kubectl create ns devtroncd
 kubectl create ns devtron-cd
 kubectl create ns devtron-ci
+kubectl -n devtroncd create cm git-hash-cm --from-literal=GIT_HASH=$GIT_HASH
 kubectl -n devtroncd apply -f $PWD/tests/integrationTesting/postgresql-secret.yaml
 kubectl -ndevtroncd apply -f $PWD/tests/integrationTesting/postgresql.yaml
+kubectl -n devtroncd apply -f $PWD/tests/integrationTesting/devtron-secret.yaml
+kubectl -n devtroncd apply -f $PWD/tests/integrationTesting/nats-server.yaml
+# we are copying sql scripts into node container and this conainer's name is fixed
+docker cp $PWD/scripts/sql/ k3d-it-cluster-server-0:./tmp/scripts
 yq '(select(.metadata.name == "postgresql-migrate-devtron") | .spec.template.spec.containers[0].env[0].value) = env(TEST_BRANCH)' $PWD/tests/integrationTesting/migrator.yaml -i
 yq '(select(.metadata.name == "postgresql-migrate-devtron") | .spec.template.spec.containers[0].env[9].value) = env(LATEST_HASH)' $PWD/tests/integrationTesting/migrator.yaml -i
 kubectl -ndevtroncd apply -f $PWD/tests/integrationTesting/migrator.yaml
@@ -50,4 +55,4 @@ helm dependency up
 helm template devtron . --set installer.modules={cicd} -s templates/workflow.yaml >./argo_wf.yaml
 kubectl apply -f ./argo_wf.yaml
 while [ ! $(kubectl -n argo get deployment workflow-controller -o jsonpath="{.status.readyReplicas}")  ]; do sleep 10; done
-cd $PWD
+cd $PWD

tests/integrationTesting/devtron-secret.yaml

@@ -0,0 +1,14 @@
+apiVersion: v1
+data:
+  PG_PASSWORD: c2hhcmVkLWRldnRyb24tcGc=
+kind: Secret
+metadata:
+  annotations:
+    meta.helm.sh/release-name: orchestrator-oss-shared-cd-dcd
+    meta.helm.sh/release-namespace: devtroncd
+  creationTimestamp: "2024-03-19T13:58:54Z"
+  labels:
+    app.kubernetes.io/managed-by: Helm
+  name: devtron-secret
+  namespace: devtroncd
+type: Opaque

tests/integrationTesting/exportEnvsExecuteWireNilChecker.sh

@@ -0,0 +1,10 @@
+cd test
+./tests/integrationTesting/create-test-env.sh
+./tests/integrationTesting/run-integration-test.sh
+touch output.env
+export NODE_IP_ADDRESS=$(kubectl get node  --no-headers  -o custom-columns=INTERNAL-IP:status.addresses[0].address)
+export PG_ADDR=$NODE_IP_ADDRESS
+export NATS_SERVER_HOST=nats://$NODE_IP_ADDRESS:30236
+go mod tidy
+go run .
+cp output.env ../tempfile

tests/integrationTesting/migrator.yaml

@@ -7,14 +7,11 @@ spec:
     spec:
       containers:
         - name: postgresql-migrate-devtron
-          image: quay.io/devtron/migrator:71748de9-149-11112
+          image: quay.io/devtron/migrator:e026843e-866-11925
+          volumeMounts:
+            - mountPath: /tmp/app/
+              name: sql-scripts-volume
           env:
-            - name: GIT_BRANCH
-              value: main
-            - name: SCRIPT_LOCATION
-              value: scripts/sql/
-            - name: GIT_REPO_URL
-              value: https://github.com/devtron-labs/devtron.git
             - name: DB_TYPE
               value: postgres
             - name: DB_USER_NAME
@@ -27,12 +24,17 @@ spec:
               value: orchestrator
             - name: MIGRATE_TO_VERSION
               value: "0"
-            - name: GIT_HASH
-              value: be7da471e45a501eba19eaa5f8d08dfe5601598d
+            - name: SCRIPT_MOUNTED
+              value: "true"
           envFrom:
             - secretRef:
                 name: postgresql-migrator
       restartPolicy: OnFailure
+      volumes:
+        - name: sql-scripts-volume
+          hostPath:
+            path: /tmp/scripts/
+            type: DirectoryOrCreate
   backoffLimit: 20
   activeDeadlineSeconds: 1500
 ---
@@ -45,7 +47,7 @@ spec:
     spec:
       containers:
         - name: postgresql-migrate-casbin
-          image: quay.io/devtron/migrator:71748de9-149-11112
+          image: quay.io/devtron/migrator:e026843e-866-11925
           env:
             - name: SCRIPT_LOCATION
               value: scripts/casbin/
@@ -83,7 +85,7 @@ spec:
     spec:
       containers:
         - name: postgresql-migrate-gitsensor
-          image: quay.io/devtron/migrator:71748de9-149-11112
+          image: quay.io/devtron/migrator:e026843e-866-11925
           env:
             - name: SCRIPT_LOCATION
               value: scripts/sql/
@@ -121,7 +123,7 @@ spec:
     spec:
       containers:
         - name: postgresql-migrate-lens
-          image: quay.io/devtron/migrator:71748de9-149-11112
+          image: quay.io/devtron/migrator:e026843e-866-11925
           env:
             - name: SCRIPT_LOCATION
               value: scripts/sql/