mask_test.go

// promconfig
// Copyright 2020 Percona LLC
//
// Based on Prometheus systems and service monitoring server.
// Copyright 2015 The Prometheus 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 promconfig

import (
	"testing"

	"github.com/stretchr/testify/assert"
)

func TestMaskSecret(t *testing.T) {
	t.Parallel()

	testCases := []struct {
		Name     string
		Config   *Config
		Expected *Config
	}{
		{
			Name: "http configuration variables should be masked",
			Config: &Config{
				ScrapeConfigs: []*ScrapeConfig{
					&ScrapeConfig{
						HTTPClientConfig: HTTPClientConfig{
							BasicAuth: &BasicAuth{
								Username:     "username",
								Password:     "password",
								PasswordFile: "/etc/passwd",
							},
							Authorization: &Authorization{
								Type:            "bearer",
								Credentials:     "Something",
								CredentialsFile: "Meaningful",
							},
							OAuth2: &OAuth2{
								ClientID:         "supersecret",
								ClientSecret:     "13r-0ihgf2r2n-i",
								ClientSecretFile: "/etc/passwd",
							},
							BearerToken: "Bearer xoxoxoxo",
						},
					},
				},
			},
			Expected: &Config{
				ScrapeConfigs: []*ScrapeConfig{
					&ScrapeConfig{
						HTTPClientConfig: HTTPClientConfig{
							BasicAuth: &BasicAuth{
								Username:     "username",
								Password:     secretToken,
								PasswordFile: "/etc/passwd",
							},
							Authorization: &Authorization{
								Type:            "bearer",
								Credentials:     secretToken,
								CredentialsFile: "Meaningful",
							},
							OAuth2: &OAuth2{
								ClientID:         "supersecret",
								ClientSecret:     secretToken,
								ClientSecretFile: "/etc/passwd",
							},
							BearerToken: secretToken,
						},
					},
				},
			},
		},
	}

	for _, testCase := range testCases {
		testCase := testCase
		t.Run(testCase.Name, func(t *testing.T) {
			t.Parallel()
			MaskSecret(testCase.Config)
			assert.Equal(t, testCase.Config, testCase.Expected)
		})
	}
}