-
Notifications
You must be signed in to change notification settings - Fork 158
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
185 additions
and
5 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| // Copyright Splunk, Inc. | ||
| // Copyright The OpenTelemetry 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 configprovider | ||
|
|
||
| import ( | ||
| "io/ioutil" | ||
| "net/http" | ||
| "os" | ||
| "strconv" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| "go.opentelemetry.io/collector/testutil" | ||
| "go.uber.org/zap" | ||
| "gopkg.in/yaml.v2" | ||
| ) | ||
|
|
||
| func TestConfigServer_EnvVar(t *testing.T) { | ||
| alternativePort := strconv.FormatUint(uint64(testutil.GetAvailablePort(t)), 10) | ||
| tests := []struct { | ||
| name string | ||
| envVar string | ||
| endpoint string | ||
| setEnvVar bool | ||
| serverDown bool | ||
| }{ | ||
| { | ||
| name: "default", | ||
| }, | ||
| { | ||
| name: "disable_server", | ||
| setEnvVar: true, // Explicitly setting it to empty to disable the server. | ||
| serverDown: true, | ||
| }, | ||
| { | ||
| name: "change_port", | ||
| envVar: alternativePort, | ||
| endpoint: "http://localhost:" + alternativePort, | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| initial := map[string]interface{}{ | ||
| "key": "value", | ||
| } | ||
|
|
||
| if tt.envVar != "" || tt.setEnvVar { | ||
| require.NoError(t, os.Setenv(defaultConfigServerPortEnvVar, tt.envVar)) | ||
| defer func() { | ||
| assert.NoError(t, os.Unsetenv(defaultConfigServerPortEnvVar)) | ||
| }() | ||
| } | ||
|
|
||
| cs := newConfigServer(zap.NewNop(), initial, initial) | ||
| require.NoError(t, cs.start()) | ||
| defer func() { | ||
| assert.NoError(t, cs.shutdown()) | ||
| }() | ||
|
|
||
| endpoint := tt.endpoint | ||
| if endpoint == "" { | ||
| endpoint = "http://" + defaultConfigServerEndpoint | ||
| } | ||
|
|
||
| path := "/debug/configz/initial" | ||
| if tt.serverDown { | ||
| client := &http.Client{} | ||
| _, err := client.Get(endpoint + path) | ||
| assert.Error(t, err) | ||
| return | ||
| } | ||
|
|
||
| client := &http.Client{} | ||
| resp, err := client.Get(endpoint + path) | ||
| require.NoError(t, err) | ||
| assert.Equal(t, http.StatusOK, resp.StatusCode, "unsuccessful zpage %q GET", path) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestConfigServer_Serve(t *testing.T) { | ||
| initial := map[string]interface{}{ | ||
| "field": "not_redacted", | ||
| "api_key": "not_redacted_on_initial", | ||
| "int": 42, | ||
| "map": map[interface{}]interface{}{ | ||
| "k0": true, | ||
| "k1": -1, | ||
| "password": "$ENV_VAR", | ||
| }, | ||
| } | ||
| effective := map[string]interface{}{ | ||
| "field": "not_redacted", | ||
| "api_key": "<redacted>", | ||
| "int": 42, | ||
| "map": map[interface{}]interface{}{ | ||
| "k0": true, | ||
| "k1": -1, | ||
| "password": "<redacted>", | ||
| }, | ||
| } | ||
|
|
||
| cs := newConfigServer(zap.NewNop(), initial, initial) | ||
| require.NotNil(t, cs) | ||
|
|
||
| require.NoError(t, cs.start()) | ||
| t.Cleanup(func() { | ||
| require.NoError(t, cs.shutdown()) | ||
| }) | ||
|
|
||
| // Test for the pages to be actually valid YAML files. | ||
| assertValidYAMLPages(t, initial, "/debug/configz/initial") | ||
| assertValidYAMLPages(t, effective, "/debug/configz/effective") | ||
| } | ||
|
|
||
| func assertValidYAMLPages(t *testing.T, expected map[string]interface{}, path string) { | ||
| url := "http://" + defaultConfigServerEndpoint + path | ||
|
|
||
| client := &http.Client{} | ||
|
|
||
| // Anything other the GET should return 405. | ||
| resp, err := client.Head(url) | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, http.StatusMethodNotAllowed, resp.StatusCode) | ||
| assert.NoError(t, resp.Body.Close()) | ||
|
|
||
| resp, err = client.Get(url) | ||
| if !assert.NoError(t, err, "error retrieving zpage at %q", path) { | ||
| return | ||
| } | ||
| assert.Equal(t, http.StatusOK, resp.StatusCode, "unsuccessful zpage %q GET", path) | ||
| t.Cleanup(func() { | ||
| assert.NoError(t, resp.Body.Close()) | ||
| }) | ||
|
|
||
| respBytes, err := ioutil.ReadAll(resp.Body) | ||
| require.NoError(t, err) | ||
|
|
||
| // Use viper to unmarshal to the more friendly instead of yaml internal maps get unmarshalled | ||
| // as map[string]interface{} instead of map[interface{}]interface{}. | ||
| var unmarshalled map[string]interface{} | ||
| require.NoError(t, yaml.Unmarshal(respBytes, &unmarshalled)) | ||
|
|
||
| assert.Equal(t, expected, unmarshalled) | ||
| } |