Skip to content

Commit d84328f

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #566 from Liujingfang1/master
Use empty object status list when the StatusPolicyNone is used
2 parents 010f57a + ebbd19d commit d84328f

File tree

7 files changed

+73
-47
lines changed

7 files changed

+73
-47
lines changed

‎cmd/main.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ func main() {
5656
initCmd := initcmd.NewCmdInit(f, ioStreams)
5757
updateHelp(names, initCmd)
5858
loader := manifestreader.NewManifestLoader(f)
59-
invFactory := inventory.ClusterClientFactory{}
59+
invFactory := inventory.ClusterClientFactory{StatusPolicy: inventory.StatusPolicyNone}
6060
applyCmd := apply.Command(f, invFactory, loader, ioStreams)
6161
updateHelp(names, applyCmd)
6262
previewCmd := preview.Command(f, invFactory, loader, ioStreams)

‎pkg/apply/common_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ func newTestInventory(
123123
) inventory.Client {
124124
// Use an Client with a fakeInfoHelper to allow generating Info
125125
// objects that use the FakeRESTClient as the UnstructuredClient.
126-
invClient, err := inventory.ClusterClientFactory{}.NewClient(tf)
126+
invClient, err := inventory.ClusterClientFactory{StatusPolicy: inventory.StatusPolicyAll}.NewClient(tf)
127127
require.NoError(t, err)
128128
return invClient
129129
}

‎pkg/inventory/inventory-client.go‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,10 @@ func (cic *ClusterClient) Merge(localInv Info, objs object.ObjMetadataSet, dryRu
105105
}
106106
if clusterInv == nil {
107107
// Wrap inventory object and store the inventory in it.
108-
status := getObjStatus(nil, objs)
108+
var status []actuation.ObjectStatus
109+
if cic.statusPolicy == StatusPolicyAll {
110+
status = getObjStatus(nil, objs)
111+
}
109112
inv := cic.InventoryFactoryFunc(invObj)
110113
if err := inv.Store(objs, status); err != nil {
111114
return nil, err
@@ -132,7 +135,10 @@ func (cic *ClusterClient) Merge(localInv Info, objs object.ObjMetadataSet, dryRu
132135
}
133136
pruneIds = clusterObjs.Diff(objs)
134137
unionObjs := clusterObjs.Union(objs)
135-
status := getObjStatus(pruneIds, unionObjs)
138+
var status []actuation.ObjectStatus
139+
if cic.statusPolicy == StatusPolicyAll {
140+
status = getObjStatus(pruneIds, unionObjs)
141+
}
136142
klog.V(4).Infof("num objects to prune: %d", len(pruneIds))
137143
klog.V(4).Infof("num merged objects to store in inventory: %d", len(unionObjs))
138144
wrappedInv := cic.InventoryFactoryFunc(clusterInv)
@@ -203,6 +209,9 @@ func (cic *ClusterClient) Replace(localInv Info, objs object.ObjMetadataSet, sta
203209
// replaceInventory stores the passed objects into the passed inventory object.
204210
func (cic *ClusterClient) replaceInventory(inv *unstructured.Unstructured, objs object.ObjMetadataSet,
205211
status []actuation.ObjectStatus) (*unstructured.Unstructured, error) {
212+
if cic.statusPolicy == StatusPolicyNone {
213+
status = nil
214+
}
206215
wrappedInv := cic.InventoryFactoryFunc(inv)
207216
if err := wrappedInv.Store(objs, status); err != nil {
208217
return nil, err

‎pkg/inventory/inventory-client_test.go‎

Lines changed: 46 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@ func podData(name string) map[string]string {
3737
}
3838
}
3939

40+
func podDataNoStatus(name string) map[string]string {
41+
return map[string]string{
42+
fmt.Sprintf("test-inventory-namespace_%s__Pod", name): "",
43+
}
44+
}
45+
4046
func TestGetClusterInventoryInfo(t *testing.T) {
4147
tests := map[string]struct {
4248
statusPolicy StatusPolicy
@@ -125,18 +131,20 @@ func TestMerge(t *testing.T) {
125131
isError bool
126132
}{
127133
"Nil local inventory object is error": {
128-
localInv: nil,
129-
localObjs: object.ObjMetadataSet{},
130-
clusterObjs: object.ObjMetadataSet{},
131-
pruneObjs: object.ObjMetadataSet{},
132-
isError: true,
134+
localInv: nil,
135+
localObjs: object.ObjMetadataSet{},
136+
clusterObjs: object.ObjMetadataSet{},
137+
pruneObjs: object.ObjMetadataSet{},
138+
isError: true,
139+
statusPolicy: StatusPolicyAll,
133140
},
134141
"Cluster and local inventories empty: no prune objects; no change": {
135-
localInv: copyInventory(),
136-
localObjs: object.ObjMetadataSet{},
137-
clusterObjs: object.ObjMetadataSet{},
138-
pruneObjs: object.ObjMetadataSet{},
139-
isError: false,
142+
localInv: copyInventory(),
143+
localObjs: object.ObjMetadataSet{},
144+
clusterObjs: object.ObjMetadataSet{},
145+
pruneObjs: object.ObjMetadataSet{},
146+
isError: false,
147+
statusPolicy: StatusPolicyAll,
140148
},
141149
"Cluster and local inventories same: no prune objects; no change": {
142150
localInv: copyInventory(),
@@ -146,8 +154,9 @@ func TestMerge(t *testing.T) {
146154
clusterObjs: object.ObjMetadataSet{
147155
ignoreErrInfoToObjMeta(pod1Info),
148156
},
149-
pruneObjs: object.ObjMetadataSet{},
150-
isError: false,
157+
pruneObjs: object.ObjMetadataSet{},
158+
isError: false,
159+
statusPolicy: StatusPolicyAll,
151160
},
152161
"Cluster two obj, local one: prune obj": {
153162
localInv: copyInventory(),
@@ -161,7 +170,8 @@ func TestMerge(t *testing.T) {
161170
pruneObjs: object.ObjMetadataSet{
162171
ignoreErrInfoToObjMeta(pod3Info),
163172
},
164-
isError: false,
173+
statusPolicy: StatusPolicyAll,
174+
isError: false,
165175
},
166176
"Cluster multiple objs, local multiple different objs: prune objs": {
167177
localInv: copyInventory(),
@@ -176,7 +186,8 @@ func TestMerge(t *testing.T) {
176186
ignoreErrInfoToObjMeta(pod1Info),
177187
ignoreErrInfoToObjMeta(pod3Info),
178188
},
179-
isError: false,
189+
statusPolicy: StatusPolicyAll,
190+
isError: false,
180191
},
181192
}
182193

@@ -309,8 +320,9 @@ func TestReplace(t *testing.T) {
309320
clusterObjs: object.ObjMetadataSet{
310321
ignoreErrInfoToObjMeta(pod1Info),
311322
},
312-
objStatus: []actuation.ObjectStatus{podStatus(pod1Info)},
313-
data: podData("pod-1"),
323+
objStatus: []actuation.ObjectStatus{podStatus(pod1Info)},
324+
data: podData("pod-1"),
325+
statusPolicy: StatusPolicyAll,
314326
},
315327
"Cluster two obj, local one": {
316328
localObjs: object.ObjMetadataSet{
@@ -320,8 +332,9 @@ func TestReplace(t *testing.T) {
320332
ignoreErrInfoToObjMeta(pod1Info),
321333
ignoreErrInfoToObjMeta(pod3Info),
322334
},
323-
objStatus: []actuation.ObjectStatus{podStatus(pod1Info), podStatus(pod3Info)},
324-
data: podData("pod-1"),
335+
objStatus: []actuation.ObjectStatus{podStatus(pod1Info), podStatus(pod3Info)},
336+
data: podData("pod-1"),
337+
statusPolicy: StatusPolicyAll,
325338
},
326339
"Cluster multiple objs, local multiple different objs": {
327340
localObjs: object.ObjMetadataSet{
@@ -331,8 +344,21 @@ func TestReplace(t *testing.T) {
331344
ignoreErrInfoToObjMeta(pod1Info),
332345
ignoreErrInfoToObjMeta(pod2Info),
333346
ignoreErrInfoToObjMeta(pod3Info)},
334-
objStatus: []actuation.ObjectStatus{podStatus(pod2Info), podStatus(pod1Info), podStatus(pod3Info)},
335-
data: podData("pod-2"),
347+
objStatus: []actuation.ObjectStatus{podStatus(pod2Info), podStatus(pod1Info), podStatus(pod3Info)},
348+
data: podData("pod-2"),
349+
statusPolicy: StatusPolicyAll,
350+
},
351+
"Cluster multiple objs, local multiple different objs with StatusPolicyNone": {
352+
localObjs: object.ObjMetadataSet{
353+
ignoreErrInfoToObjMeta(pod2Info),
354+
},
355+
clusterObjs: object.ObjMetadataSet{
356+
ignoreErrInfoToObjMeta(pod1Info),
357+
ignoreErrInfoToObjMeta(pod2Info),
358+
ignoreErrInfoToObjMeta(pod3Info)},
359+
objStatus: []actuation.ObjectStatus{podStatus(pod2Info), podStatus(pod1Info), podStatus(pod3Info)},
360+
data: podDataNoStatus("pod-2"),
361+
statusPolicy: StatusPolicyNone,
336362
},
337363
}
338364

‎pkg/inventory/inventorycm.go‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -107,22 +107,19 @@ func (icm *ConfigMap) Store(objMetas object.ObjMetadataSet, status []actuation.O
107107
// or an error if one occurs.
108108
func (icm *ConfigMap) GetObject() (*unstructured.Unstructured, error) {
109109
// Create the objMap of all the resources, and compute the hash.
110-
objMap, err := buildObjMap(icm.objMetas, icm.objStatus)
111-
if err != nil {
112-
return nil, err
113-
}
110+
objMap := buildObjMap(icm.objMetas, icm.objStatus)
114111
// Create the inventory object by copying the template.
115112
invCopy := icm.inv.DeepCopy()
116113
// Adds the inventory map to the ConfigMap "data" section.
117-
err = unstructured.SetNestedStringMap(invCopy.UnstructuredContent(),
114+
err := unstructured.SetNestedStringMap(invCopy.UnstructuredContent(),
118115
objMap, "data")
119116
if err != nil {
120117
return nil, err
121118
}
122119
return invCopy, nil
123120
}
124121

125-
func buildObjMap(objMetas object.ObjMetadataSet, objStatus []actuation.ObjectStatus) (map[string]string, error) {
122+
func buildObjMap(objMetas object.ObjMetadataSet, objStatus []actuation.ObjectStatus) map[string]string {
126123
objMap := map[string]string{}
127124
objStatusMap := map[object.ObjMetadata]actuation.ObjectStatus{}
128125
for _, status := range objStatus {
@@ -132,12 +129,11 @@ func buildObjMap(objMetas object.ObjMetadataSet, objStatus []actuation.ObjectSta
132129
if status, found := objStatusMap[objMetadata]; found {
133130
objMap[objMetadata.String()] = stringFrom(status)
134131
} else {
135-
// This should never happen since the objStatus have captured all the
136-
// object status
137-
return nil, fmt.Errorf("object status not found for %s", objMetadata)
132+
// It's possible that the passed in status doesn't any object status
133+
objMap[objMetadata.String()] = ""
138134
}
139135
}
140-
return objMap, nil
136+
return objMap
141137
}
142138

143139
func stringFrom(status actuation.ObjectStatus) string {

‎pkg/inventory/inventorycm_test.go‎

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -54,21 +54,16 @@ func TestBuildObjMap(t *testing.T) {
5454
},
5555
"empty object status list": {
5656
objSet: object.ObjMetadataSet{ObjMetadataFromObjectReference(obj1), ObjMetadataFromObjectReference(obj2)},
57-
hasError: true,
57+
hasError: false,
58+
expected: map[string]string{
59+
"ns_na_group1_Kind": "",
60+
"ns_na_group2_Kind": "",
61+
},
5862
},
5963
}
6064
for name, tc := range tests {
6165
t.Run(name, func(t *testing.T) {
62-
actual, err := buildObjMap(tc.objSet, tc.objStatus)
63-
if tc.hasError {
64-
if err == nil {
65-
t.Fatalf("expected erroe, but not happened")
66-
}
67-
return
68-
}
69-
if err != nil {
70-
t.Fatal(err)
71-
}
66+
actual := buildObjMap(tc.objSet, tc.objStatus)
7267
if diff := cmp.Diff(actual, tc.expected); diff != "" {
7368
t.Errorf(diff)
7469
}

‎test/e2e/e2e_test.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -345,11 +345,11 @@ func deleteNamespace(ctx context.Context, c client.Client, namespace *v1.Namespa
345345
}
346346

347347
func newDefaultInvApplier() *apply.Applier {
348-
return newApplierFromInvFactory(inventory.ClusterClientFactory{})
348+
return newApplierFromInvFactory(inventory.ClusterClientFactory{StatusPolicy: inventory.StatusPolicyAll})
349349
}
350350

351351
func newDefaultInvDestroyer() *apply.Destroyer {
352-
return newDestroyerFromInvFactory(inventory.ClusterClientFactory{})
352+
return newDestroyerFromInvFactory(inventory.ClusterClientFactory{StatusPolicy: inventory.StatusPolicyAll})
353353
}
354354

355355
func defaultInvNotExistsFunc(ctx context.Context, c client.Client, name, namespace, id string) {

0 commit comments

Comments
 (0)