Skip to content

Commit

Permalink
Merge pull request #1253 from christopherhein/bug/rename-getcontrolle…
Browse files Browse the repository at this point in the history
…rmanagerconfig

✨ rename GetControllerManagerConfiguration to Complete
  • Loading branch information
k8s-ci-robot committed Nov 10, 2020
2 parents 114431a + eb5a018 commit 3e4e60c
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 16 deletions.
10 changes: 5 additions & 5 deletions pkg/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ import (
type ControllerManagerConfiguration interface {
runtime.Object

// GetControllerManagerConfiguration returns the versioned configuration
GetControllerManagerConfiguration() (v1alpha1.ControllerManagerConfigurationSpec, error)
// Complete returns the versioned configuration
Complete() (v1alpha1.ControllerManagerConfigurationSpec, error)
}

// DeferredFileLoader is used to configure the decoder for loading controller
Expand Down Expand Up @@ -62,13 +62,13 @@ func File() *DeferredFileLoader {
}
}

// GetControllerManagerConfiguration will use sync.Once to set the scheme
func (d *DeferredFileLoader) GetControllerManagerConfiguration() (v1alpha1.ControllerManagerConfigurationSpec, error) {
// Complete will use sync.Once to set the scheme
func (d *DeferredFileLoader) Complete() (v1alpha1.ControllerManagerConfigurationSpec, error) {
d.once.Do(d.loadFile)
if d.err != nil {
return v1alpha1.ControllerManagerConfigurationSpec{}, d.err
}
return d.ControllerManagerConfiguration.GetControllerManagerConfiguration()
return d.ControllerManagerConfiguration.Complete()
}

// AtPath will set the path to load the file for the decoder
Expand Down
4 changes: 2 additions & 2 deletions pkg/config/config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ var _ = Describe("config", func() {

It("should error loading from non existent file", func() {
loader := config.File()
_, err := loader.GetControllerManagerConfiguration()
_, err := loader.Complete()
Expect(err).ToNot(BeNil())
})

Expand All @@ -37,7 +37,7 @@ var _ = Describe("config", func() {
loader := config.File().AtPath("./testdata/config.yaml").OfKind(&conf)
Expect(conf.CacheNamespace).To(Equal(""))

_, err := loader.GetControllerManagerConfiguration()
_, err := loader.Complete()
Expect(err).To(BeNil())

Expect(*conf.LeaderElection.LeaderElect).To(Equal(true))
Expand Down
10 changes: 5 additions & 5 deletions pkg/config/example_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ func init() {
_ = v1alpha1.AddToScheme(scheme)
}

// This example will load a file using GetControllerManagerConfiguration with only
// This example will load a file using Complete with only
// defaults set.
func ExampleFile() {
// This will load a config file from ./config.yaml
loader := config.File()
_, err := loader.GetControllerManagerConfiguration()
_, err := loader.Complete()
if err != nil {
fmt.Println("failed to load config")
os.Exit(1)
Expand All @@ -47,7 +47,7 @@ func ExampleFile() {
// This example will load the file from a custom path
func ExampleDeferredFileLoader_atPath() {
loader := config.File().AtPath("/var/run/controller-runtime/config.yaml")
_, err := loader.GetControllerManagerConfiguration()
_, err := loader.Complete()
if err != nil {
fmt.Println("failed to load config")
os.Exit(1)
Expand All @@ -63,7 +63,7 @@ func ExampleDeferredFileLoader_injectScheme() {
os.Exit(1)
}

_, err = loader.GetControllerManagerConfiguration()
_, err = loader.Complete()
if err != nil {
fmt.Println("failed to load config")
os.Exit(1)
Expand All @@ -78,7 +78,7 @@ func ExampleDeferredFileLoader_ofKind() {
fmt.Println("failed to inject scheme")
os.Exit(1)
}
_, err = loader.GetControllerManagerConfiguration()
_, err = loader.Complete()
if err != nil {
fmt.Println("failed to load config")
os.Exit(1)
Expand Down
4 changes: 2 additions & 2 deletions pkg/config/v1alpha1/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ type ControllerManagerConfiguration struct {
ControllerManagerConfigurationSpec `json:",inline"`
}

// GetControllerManagerConfiguration returns the configuration for controller-runtime
func (c *ControllerManagerConfigurationSpec) GetControllerManagerConfiguration() (ControllerManagerConfigurationSpec, error) {
// Complete returns the configuration for controller-runtime
func (c *ControllerManagerConfigurationSpec) Complete() (ControllerManagerConfigurationSpec, error) {
return *c, nil
}
2 changes: 1 addition & 1 deletion pkg/manager/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,7 @@ func (o Options) AndFrom(loader config.ControllerManagerConfiguration) (Options,
}
}

newObj, err := loader.GetControllerManagerConfiguration()
newObj, err := loader.Complete()
if err != nil {
return o, err
}
Expand Down
2 changes: 1 addition & 1 deletion pkg/manager/manager_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1610,7 +1610,7 @@ type fakeDeferredLoader struct {
*v1alpha1.ControllerManagerConfiguration
}

func (f *fakeDeferredLoader) GetControllerManagerConfiguration() (v1alpha1.ControllerManagerConfigurationSpec, error) {
func (f *fakeDeferredLoader) Complete() (v1alpha1.ControllerManagerConfigurationSpec, error) {
return f.ControllerManagerConfiguration.ControllerManagerConfigurationSpec, nil
}

Expand Down

0 comments on commit 3e4e60c

Please sign in to comment.