Skip to content

Commit

Permalink
runtime/controller: fix RateLimiterOptions.BindFlags
Browse files Browse the repository at this point in the history
Signed-off-by: Paulo Gomes <[email protected]>
  • Loading branch information
Paulo Gomes committed Apr 13, 2022
1 parent 4046043 commit 16210f4
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 3 deletions.
5 changes: 2 additions & 3 deletions runtime/controller/rate_limiter.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ limitations under the License.
package controller

import (
"flag"
"time"

"github.com/spf13/pflag"
Expand Down Expand Up @@ -47,9 +46,9 @@ type RateLimiterOptions struct {
// BindFlags will parse the given pflag.FlagSet for the controller and
// set the RateLimiterOptions accordingly.
func (o *RateLimiterOptions) BindFlags(fs *pflag.FlagSet) {
flag.DurationVar(&o.MinRetryDelay, flagMinRetryDelay, defaultMinRetryDelay,
fs.DurationVar(&o.MinRetryDelay, flagMinRetryDelay, defaultMinRetryDelay,
"The minimum amount of time for which an object being reconciled will have to wait before a retry.")
flag.DurationVar(&o.MaxRetryDelay, flagMaxRetryDelay, defaultMaxRetryDelay,
fs.DurationVar(&o.MaxRetryDelay, flagMaxRetryDelay, defaultMaxRetryDelay,
"The maximum amount of time for which an object being reconciled will have to wait before a retry.")
}

Expand Down
79 changes: 79 additions & 0 deletions runtime/controller/rate_limiter_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
/*
Copyright 2022 The Flux 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 controller

import (
"testing"
"time"

. "github.com/onsi/gomega"

"github.com/spf13/pflag"
)

func Test_RateLimiterOptions_BindFlags(t *testing.T) {
tests := []struct {
name string
commandLine []string
expectedMinRetryDelay time.Duration
expectedMaxRetryDelay time.Duration
}{
{
name: "empty flags gets default values",
commandLine: []string{""},
expectedMinRetryDelay: 750 * time.Millisecond,
expectedMaxRetryDelay: 15 * time.Minute,
},
{
name: "min retry delay only",
commandLine: []string{"--min-retry-delay=1s"},
expectedMinRetryDelay: 1 * time.Second,
expectedMaxRetryDelay: 15 * time.Minute,
},
{
name: "max retry delay only",
commandLine: []string{"--max-retry-delay=5h"},
expectedMinRetryDelay: 750 * time.Millisecond,
expectedMaxRetryDelay: 5 * time.Hour,
},
{
name: "min and max retry set",
commandLine: []string{
"--min-retry-delay=30s",
"--max-retry-delay=24h",
},
expectedMinRetryDelay: 30 * time.Second,
expectedMaxRetryDelay: 24 * time.Hour,
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
g := NewWithT(t)

f := pflag.NewFlagSet("test", pflag.ContinueOnError)
opts := RateLimiterOptions{}
opts.BindFlags(f)

err := f.Parse(tt.commandLine)
g.Expect(err).NotTo(HaveOccurred())

g.Expect(opts.MaxRetryDelay).To(Equal(tt.expectedMaxRetryDelay))
g.Expect(opts.MinRetryDelay).To(Equal(tt.expectedMinRetryDelay))
})
}
}

0 comments on commit 16210f4

Please sign in to comment.