Skip to content

Commit 862f9df

Browse files
ybettank8s-ci-robot
ybettan
authored and
k8s-ci-robot
committed
Moving the buildsign.Helper interface to module package.
This interface is combining between the global build/sign section and the kernel-mapping build/sign section, therefore, it belongs in the `Module` package. Signed-off-by: Yoni Bettan <[email protected]>
1 parent daf777b commit 862f9df

File tree

11 files changed

+145
-149
lines changed

11 files changed

+145
-149
lines changed

Diff for: ‎cmd/manager-hub/main.go

+3-4
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ import (
3636

3737
"github.com/kubernetes-sigs/kernel-module-management/api-hub/v1beta1"
3838
buildpod "github.com/kubernetes-sigs/kernel-module-management/internal/build/pod"
39-
"github.com/kubernetes-sigs/kernel-module-management/internal/buildsign"
4039
buildsignpod "github.com/kubernetes-sigs/kernel-module-management/internal/buildsign/pod"
4140
"github.com/kubernetes-sigs/kernel-module-management/internal/cluster"
4241
"github.com/kubernetes-sigs/kernel-module-management/internal/cmd"
@@ -110,11 +109,11 @@ func main() {
110109

111110
registryAPI := registry.NewRegistry()
112111
buildSignPodAPI := buildsignpod.NewBuildSignPodManager(client)
113-
buildSignHelper := buildsign.NewHelper()
112+
buildSignCombiner := module.NewCombiner()
114113

115114
buildAPI := buildpod.NewBuildManager(
116115
client,
117-
buildpod.NewMaker(client, buildSignHelper, buildSignPodAPI, scheme),
116+
buildpod.NewMaker(client, buildSignCombiner, buildSignPodAPI, scheme),
118117
buildSignPodAPI,
119118
registryAPI,
120119
)
@@ -126,7 +125,7 @@ func main() {
126125
registryAPI,
127126
)
128127

129-
kernelAPI := module.NewKernelMapper(buildSignHelper)
128+
kernelAPI := module.NewKernelMapper(buildSignCombiner)
130129

131130
ctrlLogger := setupLogger.WithValues("name", hub.ManagedClusterModuleReconcilerName)
132131
ctrlLogger.Info("Adding controller")

Diff for: ‎cmd/manager/main.go

+3-4
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ import (
2929

3030
"github.com/kubernetes-sigs/kernel-module-management/api/v1beta1"
3131
"github.com/kubernetes-sigs/kernel-module-management/api/v1beta2"
32-
"github.com/kubernetes-sigs/kernel-module-management/internal/buildsign"
3332
buildsignpod "github.com/kubernetes-sigs/kernel-module-management/internal/buildsign/pod"
3433
"github.com/kubernetes-sigs/kernel-module-management/internal/cmd"
3534
"github.com/kubernetes-sigs/kernel-module-management/internal/config"
@@ -117,9 +116,9 @@ func main() {
117116
metricsAPI.Register()
118117

119118
registryAPI := registry.NewRegistry()
120-
buildSignHelperAPI := buildsign.NewHelper()
119+
buildSignCombinerAPI := module.NewCombiner()
121120
nodeAPI := node.NewNode(client)
122-
kernelAPI := module.NewKernelMapper(buildSignHelperAPI)
121+
kernelAPI := module.NewKernelMapper(buildSignCombinerAPI)
123122
micAPI := mic.New(client, scheme)
124123
mbscAPI := mbsc.New(client, scheme)
125124
imagePullerAPI := pod.NewImagePuller(client, scheme)
@@ -182,7 +181,7 @@ func main() {
182181
cmd.FatalError(setupLogger, err, "unable to create controller", "name", controllers.NodeKernelClusterClaimReconcilerName)
183182
}
184183
} else {
185-
builSignAPI := buildsignpod.NewManager(client, buildSignHelperAPI, scheme)
184+
builSignAPI := buildsignpod.NewManager(client, buildSignCombinerAPI, scheme)
186185

187186
mbscr := controllers.NewMBSCReconciler(client, builSignAPI, mbscAPI)
188187
if err = mbscr.SetupWithManager(mgr); err != nil {

Diff for: ‎internal/buildsign/mock_helper.go

-87
This file was deleted.

Diff for: ‎internal/buildsign/pod/maker.go

+4-5
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ import (
1717

1818
kmmv1beta1 "github.com/kubernetes-sigs/kernel-module-management/api/v1beta1"
1919
"github.com/kubernetes-sigs/kernel-module-management/internal/api"
20-
"github.com/kubernetes-sigs/kernel-module-management/internal/buildsign"
2120
"github.com/kubernetes-sigs/kernel-module-management/internal/constants"
2221
"github.com/kubernetes-sigs/kernel-module-management/internal/module"
2322
)
@@ -38,7 +37,7 @@ type Maker interface {
3837

3938
type maker struct {
4039
client client.Client
41-
helper buildsign.Helper
40+
combiner module.Combiner
4241
buildSignPodManager BuildSignPodManager
4342
scheme *runtime.Scheme
4443
}
@@ -50,12 +49,12 @@ type buildHashData struct {
5049

5150
func NewMaker(
5251
client client.Client,
53-
helper buildsign.Helper,
52+
combiner module.Combiner,
5453
buildSignPodManager BuildSignPodManager,
5554
scheme *runtime.Scheme) Maker {
5655
return &maker{
5756
client: client,
58-
helper: helper,
57+
combiner: combiner,
5958
buildSignPodManager: buildSignPodManager,
6059
scheme: scheme,
6160
}
@@ -156,7 +155,7 @@ func (m *maker) containerArgs(
156155
{Name: "MOD_NAME", Value: mld.Name},
157156
{Name: "MOD_NAMESPACE", Value: mld.Namespace},
158157
}
159-
buildArgs := m.helper.ApplyBuildArgOverrides(
158+
buildArgs := m.combiner.ApplyBuildArgOverrides(
160159
buildConfig.BuildArgs,
161160
overrides...,
162161
)

Diff for: ‎internal/buildsign/pod/maker_test.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ import (
1818

1919
kmmv1beta1 "github.com/kubernetes-sigs/kernel-module-management/api/v1beta1"
2020
"github.com/kubernetes-sigs/kernel-module-management/internal/api"
21-
"github.com/kubernetes-sigs/kernel-module-management/internal/buildsign"
2221
"github.com/kubernetes-sigs/kernel-module-management/internal/client"
2322
"github.com/kubernetes-sigs/kernel-module-management/internal/constants"
23+
"github.com/kubernetes-sigs/kernel-module-management/internal/module"
2424
)
2525

2626
var _ = Describe("MakePodTemplate", func() {
@@ -39,16 +39,16 @@ var _ = Describe("MakePodTemplate", func() {
3939
ctrl *gomock.Controller
4040
clnt *client.MockClient
4141
m Maker
42-
mh *buildsign.MockHelper
42+
mc *module.MockCombiner
4343
mockBuildSignPodManager *MockBuildSignPodManager
4444
)
4545

4646
BeforeEach(func() {
4747
ctrl = gomock.NewController(GinkgoT())
4848
clnt = client.NewMockClient(ctrl)
49-
mh = buildsign.NewMockHelper(ctrl)
49+
mc = module.NewMockCombiner(ctrl)
5050
mockBuildSignPodManager = NewMockBuildSignPodManager(ctrl)
51-
m = NewMaker(clnt, mh, mockBuildSignPodManager, scheme)
51+
m = NewMaker(clnt, mc, mockBuildSignPodManager, scheme)
5252
})
5353

5454
AfterEach(func() {
@@ -232,7 +232,7 @@ var _ = Describe("MakePodTemplate", func() {
232232
expected.SetAnnotations(annotations)
233233

234234
gomock.InOrder(
235-
mh.EXPECT().ApplyBuildArgOverrides(buildArgs, defaultBuildArgs).Return(append(slices.Clone(buildArgs), defaultBuildArgs...)),
235+
mc.EXPECT().ApplyBuildArgOverrides(buildArgs, defaultBuildArgs).Return(append(slices.Clone(buildArgs), defaultBuildArgs...)),
236236
clnt.EXPECT().Get(ctx, types.NamespacedName{Name: dockerfileConfigMap.Name, Namespace: mld.Namespace}, gomock.Any()).DoAndReturn(
237237
func(_ interface{}, _ interface{}, cm *v1.ConfigMap, _ ...ctrlclient.GetOption) error {
238238
cm.Data = dockerfileCMData
@@ -298,7 +298,7 @@ var _ = Describe("MakePodTemplate", func() {
298298
}
299299

300300
gomock.InOrder(
301-
mh.EXPECT().ApplyBuildArgOverrides(nil, defaultBuildArgs),
301+
mc.EXPECT().ApplyBuildArgOverrides(nil, defaultBuildArgs),
302302
clnt.EXPECT().Get(ctx, types.NamespacedName{Name: dockerfileConfigMap.Name, Namespace: mod.Namespace}, gomock.Any()).DoAndReturn(
303303
func(_ interface{}, _ interface{}, cm *v1.ConfigMap, _ ...ctrlclient.GetOption) error {
304304
cm.Data = dockerfileCMData
@@ -377,7 +377,7 @@ var _ = Describe("MakePodTemplate", func() {
377377
}
378378

379379
gomock.InOrder(
380-
mh.EXPECT().ApplyBuildArgOverrides(buildArgs, defaultBuildArgs),
380+
mc.EXPECT().ApplyBuildArgOverrides(buildArgs, defaultBuildArgs),
381381
clnt.EXPECT().Get(ctx, types.NamespacedName{Name: dockerfileConfigMap.Name, Namespace: mld.Namespace}, gomock.Any()).DoAndReturn(
382382
func(_ interface{}, _ interface{}, cm *v1.ConfigMap, _ ...ctrlclient.GetOption) error {
383383
cm.Data = dockerfileCMData
@@ -414,7 +414,7 @@ var _ = Describe("MakePodTemplate", func() {
414414
expectedImageName := mld.ContainerImage + ":" + mld.Namespace + "_" + mld.Name + "_kmm_unsigned"
415415

416416
gomock.InOrder(
417-
mh.EXPECT().ApplyBuildArgOverrides(buildArgs, defaultBuildArgs),
417+
mc.EXPECT().ApplyBuildArgOverrides(buildArgs, defaultBuildArgs),
418418
clnt.EXPECT().Get(ctx, types.NamespacedName{Name: dockerfileConfigMap.Name, Namespace: mld.Namespace}, gomock.Any()).DoAndReturn(
419419
func(_ interface{}, _ interface{}, cm *v1.ConfigMap, _ ...ctrlclient.GetOption) error {
420420
cm.Data = dockerfileCMData

Diff for: ‎internal/buildsign/pod/manager.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ import (
1515
"github.com/kubernetes-sigs/kernel-module-management/internal/api"
1616
"github.com/kubernetes-sigs/kernel-module-management/internal/buildsign"
1717
"github.com/kubernetes-sigs/kernel-module-management/internal/kernel"
18+
"github.com/kubernetes-sigs/kernel-module-management/internal/module"
1819
"github.com/kubernetes-sigs/kernel-module-management/internal/utils"
1920
)
2021

@@ -25,9 +26,9 @@ type podManager struct {
2526
buildSignPodManager BuildSignPodManager
2627
}
2728

28-
func NewManager(client client.Client, helper buildsign.Helper, scheme *runtime.Scheme) buildsign.Manager {
29+
func NewManager(client client.Client, combiner module.Combiner, scheme *runtime.Scheme) buildsign.Manager {
2930
buildSignPodManager := NewBuildSignPodManager(client)
30-
maker := NewMaker(client, helper, buildSignPodManager, scheme)
31+
maker := NewMaker(client, combiner, buildSignPodManager, scheme)
3132
signer := NewSigner(client, scheme, buildSignPodManager)
3233
return &podManager{
3334
client: client,

Diff for: ‎internal/buildsign/helper.go renamed to ‎internal/module/combiner.go

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package buildsign
1+
package module
22

33
import (
44
"k8s.io/apimachinery/pkg/util/sets"
@@ -8,21 +8,21 @@ import (
88
"github.com/kubernetes-sigs/kernel-module-management/internal/utils"
99
)
1010

11-
//go:generate mockgen -source=helper.go -package=buildsign -destination=mock_helper.go
11+
//go:generate mockgen -source=combiner.go -package=module -destination=mock_combiner.go
1212

13-
type Helper interface {
13+
type Combiner interface {
1414
ApplyBuildArgOverrides(args []kmmv1beta1.BuildArg, overrides ...kmmv1beta1.BuildArg) []kmmv1beta1.BuildArg
1515
GetRelevantBuild(moduleBuild *kmmv1beta1.Build, mappingBuild *kmmv1beta1.Build) *kmmv1beta1.Build
1616
GetRelevantSign(moduleSign *kmmv1beta1.Sign, mappingSign *kmmv1beta1.Sign, kernel string) (*kmmv1beta1.Sign, error)
1717
}
1818

19-
type helper struct{}
19+
type combiner struct{}
2020

21-
func NewHelper() Helper {
22-
return &helper{}
21+
func NewCombiner() Combiner {
22+
return &combiner{}
2323
}
2424

25-
func (m *helper) ApplyBuildArgOverrides(args []kmmv1beta1.BuildArg, overrides ...kmmv1beta1.BuildArg) []kmmv1beta1.BuildArg {
25+
func (c *combiner) ApplyBuildArgOverrides(args []kmmv1beta1.BuildArg, overrides ...kmmv1beta1.BuildArg) []kmmv1beta1.BuildArg {
2626
overridesMap := make(map[string]kmmv1beta1.BuildArg, len(overrides))
2727

2828
for _, o := range overrides {
@@ -47,7 +47,7 @@ func (m *helper) ApplyBuildArgOverrides(args []kmmv1beta1.BuildArg, overrides ..
4747
return args
4848
}
4949

50-
func (m *helper) GetRelevantBuild(moduleBuild *kmmv1beta1.Build, mappingBuild *kmmv1beta1.Build) *kmmv1beta1.Build {
50+
func (c *combiner) GetRelevantBuild(moduleBuild *kmmv1beta1.Build, mappingBuild *kmmv1beta1.Build) *kmmv1beta1.Build {
5151
if moduleBuild == nil {
5252
return mappingBuild.DeepCopy()
5353
}
@@ -61,13 +61,13 @@ func (m *helper) GetRelevantBuild(moduleBuild *kmmv1beta1.Build, mappingBuild *k
6161
buildConfig.DockerfileConfigMap = mappingBuild.DockerfileConfigMap
6262
}
6363

64-
buildConfig.BuildArgs = m.ApplyBuildArgOverrides(buildConfig.BuildArgs, mappingBuild.BuildArgs...)
64+
buildConfig.BuildArgs = c.ApplyBuildArgOverrides(buildConfig.BuildArgs, mappingBuild.BuildArgs...)
6565

6666
buildConfig.Secrets = append(buildConfig.Secrets, mappingBuild.Secrets...)
6767
return buildConfig
6868
}
6969

70-
func (m *helper) GetRelevantSign(moduleSign *kmmv1beta1.Sign, mappingSign *kmmv1beta1.Sign, kernelVersion string) (*kmmv1beta1.Sign, error) {
70+
func (c *combiner) GetRelevantSign(moduleSign *kmmv1beta1.Sign, mappingSign *kmmv1beta1.Sign, kernelVersion string) (*kmmv1beta1.Sign, error) {
7171
var signConfig *kmmv1beta1.Sign
7272
if moduleSign == nil {
7373
// km.Sign cannot be nil in case mod.Sign is nil, checked above

0 commit comments

Comments
 (0)