main_test.go

/*
Copyright 2021 The Kubernetes 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 main

import (
	"testing"

	"golang.org/x/tools/go/analysis/analysistest"

	"k8s.io/klog/hack/tools/logcheck/pkg"
)

func TestAnalyzer(t *testing.T) {
	tests := []struct {
		name        string
		enabled     map[string]string
		override    string
		testPackage string
	}{
		{
			name: "Allow unstructured logs",
			enabled: map[string]string{
				"unstructured": "false",
			},
			testPackage: "allowUnstructuredLogs",
		},
		{
			name:        "Do not allow unstructured logs",
			testPackage: "doNotAllowUnstructuredLogs",
		},
		{
			name: "Per-file config",
			enabled: map[string]string{
				"unstructured": "false",
			},
			override:    "testdata/src/mixed/structured_logging",
			testPackage: "mixed",
		},
		{
			name: "Function call parameters",
			enabled: map[string]string{
				"unstructured": "false",
			},
			testPackage: "parameters",
		},
		{
			name: "Do not allow klog",
			enabled: map[string]string{
				"unstructured": "true",
				"klog":         "true",
			},
			testPackage: "doNotAllowKlog",
		},
		{
			name: "Filter klog",
			enabled: map[string]string{
				"unstructured": "false",
				"klog":         "false",
			},
			override:    "testdata/src/doNotAllowKlog/klog_logging",
			testPackage: "doNotAllowKlog",
		},
		{
			name: "importrename",
			enabled: map[string]string{
				"unstructured": "true",
			},
			testPackage: "importrename",
		},
		{
			name: "verbose",
			enabled: map[string]string{
				"unstructured": "true",
			},
			testPackage: "verbose",
		},
		{
			name: "gologr",
			enabled: map[string]string{
				"klog": "true",
			},
			testPackage: "gologr",
		},
		{
			name: "contextual",
			enabled: map[string]string{
				"klog": "true",
			},
			testPackage: "contextual",
		},
		{
			name: "helpers",
			enabled: map[string]string{
				"with-helpers": "true",
			},
			testPackage: "helpers",
		},
	}
	for _, tc := range tests {
		t.Run(tc.name, func(t *testing.T) {
			analyzer := pkg.Analyser()
			set := func(flag, value string) {
				if value != "" {
					if err := analyzer.Flags.Set(flag, value); err != nil {
						t.Fatalf("unexpected error for %s: %v", flag, err)
					}
				}
			}
			for key, value := range tc.enabled {
				set("check-"+key, value)
			}
			if tc.override != "" {
				set("config", tc.override)
			}
			analysistest.Run(t, analysistest.TestData(), analyzer, tc.testPackage)
		})
	}
}