-
Notifications
You must be signed in to change notification settings - Fork 512
/
Copy pathWiringNilCheck.go
executable file
·148 lines (139 loc) · 4.23 KB
/
WiringNilCheck.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/*
* Copyright (c) 2024. Devtron Inc.
*
* 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
*
* http://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 main
import (
"fmt"
"github.com/devtron-labs/devtron/util/reflectUtil"
"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 {
return reflectUtil.IsNullableValue(field)
}
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
}