-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Bring up cmd/flags test coverage to 100% (#3691)
- Loading branch information
1 parent
24d2ccf
commit 07af654
Showing
5 changed files
with
164 additions
and
138 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| // Copyright (c) 2022 The Jaeger 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 flags | ||
|
|
||
| import ( | ||
| "flag" | ||
| "os" | ||
| "reflect" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| "go.uber.org/atomic" | ||
|
|
||
| "github.com/jaegertracing/jaeger/pkg/config" | ||
| "github.com/jaegertracing/jaeger/pkg/healthcheck" | ||
| ) | ||
|
|
||
| func TestAddFlags(t *testing.T) { | ||
| s := NewService(0) | ||
| s.AddFlags(new(flag.FlagSet)) | ||
|
|
||
| s.NoStorage = true | ||
| s.AddFlags(new(flag.FlagSet)) | ||
| } | ||
|
|
||
| func TestStartErrors(t *testing.T) { | ||
| scenarios := []struct { | ||
| name string | ||
| flags []string | ||
| expErr string | ||
| }{ | ||
| { | ||
| name: "bad config", | ||
| flags: []string{"--config-file=invalid-file-name"}, | ||
| expErr: "cannot load config file", | ||
| }, | ||
| { | ||
| name: "bad log level", | ||
| flags: []string{"--log-level=invalid-log-level"}, | ||
| expErr: "cannot create logger", | ||
| }, | ||
| { | ||
| name: "bad metrics backend", | ||
| flags: []string{"--metrics-backend=invalid-metrics-backend"}, | ||
| expErr: "cannot create metrics factory", | ||
| }, | ||
| { | ||
| name: "bad admin TLS", | ||
| flags: []string{"--admin.http.tls.enabled=true", "--admin.http.tls.cert=invalid-cert"}, | ||
| expErr: "cannot initialize admin server", | ||
| }, | ||
| { | ||
| name: "bad host:port", | ||
| flags: []string{"--admin.http.host-port=invalid"}, | ||
| expErr: "cannot start the admin server", | ||
| }, | ||
| { | ||
| name: "clean start", | ||
| flags: []string{}, | ||
| }, | ||
| } | ||
| for _, test := range scenarios { | ||
| t.Run(test.name, func(t *testing.T) { | ||
| s := NewService( /*default port=*/ 0) | ||
| v, cmd := config.Viperize(s.AddFlags) | ||
| err := cmd.ParseFlags(test.flags) | ||
| assert.NoError(t, err) | ||
| err = s.Start(v) | ||
| if test.expErr != "" { | ||
| require.Error(t, err) | ||
| assert.Contains(t, err.Error(), test.expErr) | ||
| return | ||
| } | ||
| assert.NoError(t, err) | ||
|
|
||
| stopped := atomic.NewBool(false) | ||
| shutdown := func() { | ||
| stopped.Store(true) | ||
| } | ||
| go s.RunAndThen(shutdown) | ||
|
|
||
| waitForEqual(t, healthcheck.Ready, func() interface{} { return s.HC().Get() }) | ||
| s.SetHealthCheckStatus(healthcheck.Unavailable) | ||
| waitForEqual(t, healthcheck.Unavailable, func() interface{} { return s.HC().Get() }) | ||
|
|
||
| s.signalsChannel <- os.Interrupt | ||
| waitForEqual(t, true, func() interface{} { return stopped.Load() }) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func waitForEqual(t *testing.T, expected interface{}, getter func() interface{}) { | ||
| for i := 0; i < 1000; i++ { | ||
| value := getter() | ||
| if reflect.DeepEqual(value, expected) { | ||
| return | ||
| } | ||
| time.Sleep(10 * time.Millisecond) | ||
| } | ||
| assert.Equal(t, expected, getter()) | ||
| } |