diff options
Diffstat (limited to 'tests/core/nogo/custom/flags')
| -rw-r--r-- | tests/core/nogo/custom/flags/BUILD.bazel | 6 | ||||
| -rw-r--r-- | tests/core/nogo/custom/flags/README.rst | 19 | ||||
| -rw-r--r-- | tests/core/nogo/custom/flags/flags_test.go | 262 |
3 files changed, 287 insertions, 0 deletions
diff --git a/tests/core/nogo/custom/flags/BUILD.bazel b/tests/core/nogo/custom/flags/BUILD.bazel new file mode 100644 index 00000000..cdf4c76a --- /dev/null +++ b/tests/core/nogo/custom/flags/BUILD.bazel @@ -0,0 +1,6 @@ +load("@io_bazel_rules_go//go/tools/bazel_testing:def.bzl", "go_bazel_test") + +go_bazel_test( + name = "flags_test", + srcs = ["flags_test.go"], +) diff --git a/tests/core/nogo/custom/flags/README.rst b/tests/core/nogo/custom/flags/README.rst new file mode 100644 index 00000000..e525250b --- /dev/null +++ b/tests/core/nogo/custom/flags/README.rst @@ -0,0 +1,19 @@ +Custom nogo analyzer flags +===================== + +.. _nogo: /go/nogo.rst +.. _go_library: /docs/go/core/rules.md#_go_library + +Tests to ensure that custom `nogo`_ analyzers that consume flags can be +supplied those flags via nono config. + +.. contents:: + +flags_test +----------- +Verifies that a simple custom analyzer's behavior can be modified by setting +its analyzer flags in the nogo driver, and that these flags can be provided to +the driver via the nogo config `analyzer_flags` field. Also checks that +invalid flags as defined by the `flag` package cause the driver to immediately +return an error. + diff --git a/tests/core/nogo/custom/flags/flags_test.go b/tests/core/nogo/custom/flags/flags_test.go new file mode 100644 index 00000000..7381a3f0 --- /dev/null +++ b/tests/core/nogo/custom/flags/flags_test.go @@ -0,0 +1,262 @@ +// Copyright 2019 The Bazel Authors. All rights reserved. +// +// 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_test + +import ( + "bytes" + "fmt" + "io/ioutil" + "regexp" + "testing" + + "github.com/bazelbuild/rules_go/go/tools/bazel_testing" +) + +const origConfig = `# config = "",` + +func TestMain(m *testing.M) { + bazel_testing.TestMain(m, bazel_testing.Args{ + Nogo: "@//:nogo", + Main: ` +-- BUILD.bazel -- +load("@io_bazel_rules_go//go:def.bzl", "go_library", "nogo") + +nogo( + name = "nogo", + deps = [ + ":flagger", + ], + # config = "", + visibility = ["//visibility:public"], +) + +go_library( + name = "flagger", + srcs = ["flagger.go"], + importpath = "flaggeranalyzer", + deps = [ + "@org_golang_x_tools//go/analysis", + ], + visibility = ["//visibility:public"], +) + +go_library( + name = "some_file", + srcs = ["some_file.go"], + importpath = "somefile", + deps = [":dep"], +) + +go_library( + name = "dep", + srcs = ["dep.go"], + importpath = "dep", +) + +-- flagger.go -- +// flagger crashes when three flags are set in the config or else it no-ops +package flagger + +import ( + "errors" + + "golang.org/x/tools/go/analysis" +) + +var ( + boolSwitch bool + stringSwitch string + intSwitch int +) + +var Analyzer = &analysis.Analyzer{ + Name: "flagger", + Run: run, + Doc: "Dummy analyzer that crashes when all its flags are set correctly", +} + +func init() { + Analyzer.Flags.BoolVar(&boolSwitch, "bool-switch", false, "Bool must be set to true to run") + Analyzer.Flags.StringVar(&stringSwitch, "string-switch", "no", "String must be set to \"yes\" to run") + Analyzer.Flags.IntVar(&intSwitch, "int-switch", 0, "Int must be set to 1 to run") +} + +func run(pass *analysis.Pass) (interface{}, error) { + if !boolSwitch { + return nil, nil + } + if stringSwitch != "yes" { + return nil, nil + } + if intSwitch != 1 { + return nil, nil + } + return nil, errors.New("all switches were set -> fail") +} + +-- all_flags_set.json -- +{ + "flagger": { + "description": "this will crash on every file", + "analyzer_flags": { + "bool-switch": "true", + "int-switch": "1", + "string-switch": "yes" + } + } +} + +-- two_flags_set.json -- +{ + "flagger": { + "description": "this will succeed on every file", + "analyzer_flags": { + "bool-switch": "true", + "int-switch": "1" + } + } +} + +-- invalid_int.json -- +{ + "flagger": { + "description": "this will crash immediately due to an invalid int flag", + "analyzer_flags": { + "int-switch": "one", + "string-switch": "yes" + } + } +} + +-- nonexistent_flag.json -- +{ + "flagger": { + "description": "this will crash immediately due to a nonexistent flag", + "analyzer_flags": { + "int-switch": "1", + "bool-switch": "true", + "string-switch": "yes", + "description": "This is a good analyzer" + } + } +} + +-- hyphenated_flag.json -- +{ + "flagger": { + "description": "this will crash immediately due to a hyphenated flag", + "analyzer_flags": { + "-int-switch": "1" + } + } +} + +-- some_file.go -- +// package somefile contains a file and has a dep +package somefile + +import "dep" + +func Baz() int { + dep.D() + return 1 +} + +-- dep.go -- +package dep + +func D() { +} + +`, + }) +} + +func Test(t *testing.T) { + for _, test := range []struct { + desc, config string + wantSuccess bool + includes, excludes []string + }{ + { + desc: "config_flags_triggering_error", + wantSuccess: false, + config: "all_flags_set.json", + includes: []string{"all switches were set -> fail"}, + }, { + desc: "config_flags_triggering_success", + wantSuccess: true, + config: "two_flags_set.json", + }, { + desc: "invalid_int_triggering_error", + wantSuccess: false, + config: "invalid_int.json", + includes: []string{"flagger: invalid value for flag: int-switch=one"}, + }, { + desc: "nonexistent_flag_triggering_error", + wantSuccess: false, + config: "nonexistent_flag.json", + includes: []string{"flagger: unrecognized flag: description"}, + }, { + desc: "hyphenated_flag_triggering_error", + wantSuccess: false, + config: "hyphenated_flag.json", + includes: []string{"flagger: flag should not begin with '-': -int-switch"}, + }, + } { + t.Run(test.desc, func(t *testing.T) { + if test.config != "" { + customConfig := fmt.Sprintf("config = %q,", test.config) + if err := replaceInFile("BUILD.bazel", origConfig, customConfig); err != nil { + t.Fatal(err) + } + defer replaceInFile("BUILD.bazel", customConfig, origConfig) + } + + cmd := bazel_testing.BazelCmd("build", "//:some_file") + stderr := &bytes.Buffer{} + cmd.Stderr = stderr + if err := cmd.Run(); err == nil && !test.wantSuccess { + t.Fatal("unexpected success") + } else if err != nil && test.wantSuccess { + t.Fatalf("unexpected error: %v", err) + } + + for _, pattern := range test.includes { + if matched, err := regexp.Match(pattern, stderr.Bytes()); err != nil { + t.Fatal(err) + } else if !matched { + t.Errorf("got output:\n %s\n which does not contain pattern: %s", string(stderr.Bytes()), pattern) + } + } + for _, pattern := range test.excludes { + if matched, err := regexp.Match(pattern, stderr.Bytes()); err != nil { + t.Fatal(err) + } else if matched { + t.Errorf("output contained pattern: %s", pattern) + } + } + }) + } +} + +func replaceInFile(path, old, new string) error { + data, err := ioutil.ReadFile(path) + if err != nil { + return err + } + data = bytes.ReplaceAll(data, []byte(old), []byte(new)) + return ioutil.WriteFile(path, data, 0666) +} |