forked from knative/pkg
/
apicoverage_recorder.go
263 lines (225 loc) · 9.04 KB
/
apicoverage_recorder.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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
/*
Copyright 2018 The Knative 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
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 webhook
import (
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
"os"
"reflect"
"go.uber.org/zap"
"k8s.io/api/admission/v1beta1"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/runtime/serializer"
"knative.dev/pkg/test/webhook-apicoverage/coveragecalculator"
"knative.dev/pkg/test/webhook-apicoverage/resourcetree"
"knative.dev/pkg/test/webhook-apicoverage/view"
"knative.dev/pkg/webhook/resourcesemantics"
)
var (
decoder = serializer.NewCodecFactory(runtime.NewScheme()).UniversalDeserializer()
)
const (
// ResourceQueryParam query param name to provide the resource.
ResourceQueryParam = "resource"
// ResourceCoverageEndPoint is the endpoint for Resource Coverage API
ResourceCoverageEndPoint = "/resourcecoverage"
// TotalCoverageEndPoint is the endpoint for Total Coverage API
TotalCoverageEndPoint = "/totalcoverage"
// ResourcePercentageCoverageEndPoint is the end point for Resource Percentage
// coverages API
ResourcePercentageCoverageEndPoint = "/resourcepercentagecoverage"
// resourceChannelQueueSize size of the queue maintained for resource channel.
resourceChannelQueueSize = 10
)
type resourceChannelMsg struct {
resourceType schema.GroupVersionKind
rawResourceValue []byte
}
// APICoverageRecorder type contains resource tree to record API coverage for resources.
type APICoverageRecorder struct {
Logger *zap.SugaredLogger
ResourceForest resourcetree.ResourceForest
ResourceMap map[schema.GroupVersionKind]resourcesemantics.GenericCRD
NodeRules resourcetree.NodeRules
FieldRules resourcetree.FieldRules
DisplayRules view.DisplayRules
resourceChannel chan resourceChannelMsg
}
// Init initializes the resources trees for set resources.
func (a *APICoverageRecorder) Init() {
for resourceKind, resourceObj := range a.ResourceMap {
a.ResourceForest.AddResourceTree(resourceKind.Kind, reflect.ValueOf(resourceObj).Elem().Type())
}
a.resourceChannel = make(chan resourceChannelMsg, resourceChannelQueueSize)
go a.updateResourceCoverageTree()
}
// updateResourceCoverageTree updates the resource coverage tree.
func (a *APICoverageRecorder) updateResourceCoverageTree() {
for {
channelMsg := <-a.resourceChannel
if err := json.Unmarshal(channelMsg.rawResourceValue, a.ResourceMap[channelMsg.resourceType]); err != nil {
a.Logger.Errorf("Failed unmarshalling review.Request.Object.Raw for type: %s Error: %v", channelMsg.resourceType.Kind, err)
continue
}
resourceTree := a.ResourceForest.TopLevelTrees[channelMsg.resourceType.Kind]
resourceTree.UpdateCoverage(reflect.ValueOf(a.ResourceMap[channelMsg.resourceType]).Elem())
a.Logger.Info("Successfully recorded coverage for resource ", channelMsg.resourceType.Kind)
}
}
// RecordResourceCoverage updates the resource tree with the request.
func (a *APICoverageRecorder) RecordResourceCoverage(w http.ResponseWriter, r *http.Request) {
var (
body []byte
err error
)
review := &v1beta1.AdmissionReview{}
if body, err = ioutil.ReadAll(r.Body); err != nil {
a.Logger.Errorf("Failed reading request body: %v", err)
a.appendAndWriteAdmissionResponse(review, false, "Admission Denied", w)
return
}
if _, _, err := decoder.Decode(body, nil, review); err != nil {
a.Logger.Errorf("Unable to decode request: %v", err)
a.appendAndWriteAdmissionResponse(review, false, "Admission Denied", w)
return
}
gvk := schema.GroupVersionKind{
Group: review.Request.Kind.Group,
Version: review.Request.Kind.Version,
Kind: review.Request.Kind.Kind,
}
// We only care about resources the repo has setup.
if _, ok := a.ResourceMap[gvk]; !ok {
a.Logger.Info("By-passing resource coverage update for resource : %s", gvk.Kind)
a.appendAndWriteAdmissionResponse(review, true, "Welcome Aboard", w)
return
}
a.resourceChannel <- resourceChannelMsg{
resourceType: gvk,
rawResourceValue: review.Request.Object.Raw,
}
a.appendAndWriteAdmissionResponse(review, true, "Welcome Aboard", w)
}
func (a *APICoverageRecorder) appendAndWriteAdmissionResponse(review *v1beta1.AdmissionReview, allowed bool, message string, w http.ResponseWriter) {
review.Response = &v1beta1.AdmissionResponse{
Allowed: allowed,
Result: &v1.Status{
Message: message,
},
}
responseInBytes, err := json.Marshal(review)
if err != nil {
a.Logger.Errorf("Failing mashalling review response: %v", err)
}
if _, err := w.Write(responseInBytes); err != nil {
a.Logger.Errorf("%v", err)
}
}
// GetResourceCoverage retrieves resource coverage data for the passed in resource via query param.
func (a *APICoverageRecorder) GetResourceCoverage(w http.ResponseWriter, r *http.Request) {
resource := r.URL.Query().Get(ResourceQueryParam)
if _, ok := a.ResourceForest.TopLevelTrees[resource]; !ok {
fmt.Fprintf(w, "Resource information not found for resource: %s", resource)
return
}
var ignoredFields coveragecalculator.IgnoredFields
ignoredFieldsFilePath := os.Getenv("KO_DATA_PATH") + "/ignoredfields.yaml"
if err := ignoredFields.ReadFromFile(ignoredFieldsFilePath); err != nil {
a.Logger.Errorf("Error reading file %s: %v", ignoredFieldsFilePath, err)
}
tree := a.ResourceForest.TopLevelTrees[resource]
typeCoverage := tree.BuildCoverageData(a.NodeRules, a.FieldRules, ignoredFields)
coverageValues := coveragecalculator.CalculateTypeCoverage(typeCoverage)
coverageValues.CalculatePercentageValue()
if htmlData, err := view.GetHTMLDisplay(typeCoverage, coverageValues); err != nil {
fmt.Fprintf(w, "Error generating html file %v", err)
} else {
fmt.Fprint(w, htmlData)
}
}
// GetTotalCoverage goes over all the resources setup for the apicoverage tool and returns total coverage values.
func (a *APICoverageRecorder) GetTotalCoverage(w http.ResponseWriter, r *http.Request) {
var (
ignoredFields coveragecalculator.IgnoredFields
err error
)
ignoredFieldsFilePath := os.Getenv("KO_DATA_PATH") + "/ignoredfields.yaml"
if err = ignoredFields.ReadFromFile(ignoredFieldsFilePath); err != nil {
a.Logger.Errorf("Error reading file %s: %v", ignoredFieldsFilePath, err)
}
totalCoverage := coveragecalculator.CoverageValues{}
for resource := range a.ResourceMap {
tree := a.ResourceForest.TopLevelTrees[resource.Kind]
typeCoverage := tree.BuildCoverageData(a.NodeRules, a.FieldRules, ignoredFields)
coverageValues := coveragecalculator.CalculateTypeCoverage(typeCoverage)
totalCoverage.TotalFields += coverageValues.TotalFields
totalCoverage.CoveredFields += coverageValues.CoveredFields
totalCoverage.IgnoredFields += coverageValues.IgnoredFields
}
totalCoverage.CalculatePercentageValue()
var body []byte
if body, err = json.Marshal(totalCoverage); err != nil {
fmt.Fprintf(w, "error marshalling total coverage response: %v", err)
return
}
if _, err = w.Write(body); err != nil {
fmt.Fprintf(w, "error writing total coverage response: %v", err)
}
}
// GetResourceCoveragePercentags goes over all the resources setup for the
// apicoverage tool and returns percentage coverage for each resource.
func (a *APICoverageRecorder) GetResourceCoveragePercentages(
w http.ResponseWriter, r *http.Request) {
var (
ignoredFields coveragecalculator.IgnoredFields
err error
)
ignoredFieldsFilePath :=
os.Getenv("KO_DATA_PATH") + "/ignoredfields.yaml"
if err = ignoredFields.ReadFromFile(ignoredFieldsFilePath); err != nil {
a.Logger.Errorf("Error reading file %s: %v",
ignoredFieldsFilePath, err)
}
totalCoverage := coveragecalculator.CoverageValues{}
percentCoverages := make(map[string]float64)
for resource := range a.ResourceMap {
tree := a.ResourceForest.TopLevelTrees[resource.Kind]
typeCoverage := tree.BuildCoverageData(a.NodeRules, a.FieldRules,
ignoredFields)
coverageValues := coveragecalculator.CalculateTypeCoverage(typeCoverage)
coverageValues.CalculatePercentageValue()
percentCoverages[resource.Kind] = coverageValues.PercentCoverage
totalCoverage.TotalFields += coverageValues.TotalFields
totalCoverage.CoveredFields += coverageValues.CoveredFields
totalCoverage.IgnoredFields += coverageValues.IgnoredFields
}
totalCoverage.CalculatePercentageValue()
percentCoverages["Overall"] = totalCoverage.PercentCoverage
var body []byte
if body, err = json.Marshal(
coveragecalculator.CoveragePercentages{
ResourceCoverages: percentCoverages,
}); err != nil {
fmt.Fprintf(w, "error marshalling percentage coverage response: %v",
err)
return
}
if _, err = w.Write(body); err != nil {
fmt.Fprintf(w, "error writing percentage coverage response: %v",
err)
}
}