edit/fix_test.go

/*
Copyright 2020 Google LLC

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

    https://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 edit

import (
	"fmt"
	"strings"
	"testing"

	"github.com/bazel-contrib/buildtools/v10/build"
	"github.com/google/go-cmp/cmp"
)

func TestMovePackageDeclarationToTheTop(t *testing.T) {
	tests := []struct {
		input, expected string
		shouldMove      bool
	}{
		{`"""Docstring."""

load(":path.bzl", "x")

foo()

package(attr = "val")`,
			`"""Docstring."""

load(":path.bzl", "x")

package(attr = "val")

foo()`,
			true},
		{`"""Docstring."""

load(":path.bzl", "x")

package(attr = "val")

foo()`,
			`"""Docstring."""

load(":path.bzl", "x")

package(attr = "val")

foo()`,
			false},
		{`"""Docstring."""

load(":path.bzl", "x")

foo()`,
			`"""Docstring."""

load(":path.bzl", "x")

foo()`,
			false,
		},
	}

	for i, tst := range tests {
		t.Run(fmt.Sprintf("case %d", i), func(t *testing.T) {
			bld, err := build.Parse("BUILD", []byte(tst.input))
			if err != nil {
				t.Fatalf("Failed to parse %s; %v", tst.input, err)
			}
			if result := movePackageDeclarationToTheTop(bld); result != tst.shouldMove {
				t.Errorf("TestMovePackageDeclarationToTheTop: expected %v, got %v", tst.shouldMove, result)
			}

			got := strings.TrimSpace(string(build.Format(bld)))
			want := strings.TrimSpace(tst.expected)
			if diff := cmp.Diff(want, got); diff != "" {
				t.Errorf("TestMovePackageDeclarationToTheTop: (-want +got): %s", diff)
			}
		})
	}
}

// Test cases for the full fix process.
func TestFixAll(t *testing.T) {
	tests := []struct {
		name  string
		input string
		want  string
	}{
		{
			name: "no empty package",
			input: `load(":path.bzl", "x")

x()
`,
			want: `load(":path.bzl", "x")

x()
`,
		},
		{
			name: "preserve visibility when default_visibility is not set",
			input: `cc_library(
    name = "native_lib",
    visibility = ["//visibility:private"],
)
`,
			want: `cc_library(
    name = "native_lib",
    visibility = ["//visibility:private"],
)
`,
		},
		{
			name: "remove redundant visibility with different slice order",
			input: `package(default_visibility = [
    "//foo",
    "//bar",
])

cc_library(
    name = "native_lib",
    visibility = [
        "//bar",
        "//foo",
    ],
)
`,
			want: `package(default_visibility = [
    "//bar",
    "//foo",
])

cc_library(name = "native_lib")
`,
		},
		{
			name: "remove redundant visibility matching ident",
			input: `package(default_visibility = PUBLIC)

cc_library(
    name = "native_lib",
    visibility = PUBLIC,
)

cc_library(
    name = "other_lib",
    visibility = PRIVATE,
)
`,
			want: `package(default_visibility = PUBLIC)

cc_library(name = "native_lib")

cc_library(
    name = "other_lib",
    visibility = PRIVATE,
)
`,
		},
		{
			name: "preserve non-matching visibility",
			input: `package(default_visibility = ["//visibility:public"])

cc_library(
    name = "native_lib",
    visibility = ["//visibility:private"],
)
`,
			want: `package(default_visibility = ["//visibility:public"])

cc_library(
    name = "native_lib",
    visibility = ["//visibility:private"],
)
`,
		},
	}

	for _, tc := range tests {
		t.Run(tc.name, func(t *testing.T) {
			bld, err := build.Parse("BUILD", []byte(tc.input))
			if err != nil {
				t.Fatalf("Failed to parse %s; %v", tc.input, err)
			}
			FixFile(bld, "//who/cares", []string{})
			if diff := cmp.Diff(tc.want, string(build.Format(bld))); diff != "" {
				t.Errorf("%s: (-want +got): %s", tc.name, diff)
			}
		})
	}
}