Add Goland Standard "cmd" Pattern for Slasher Binaries (#8542)

* vis * gaz * imports * slasher img Co-authored-by: Victor Farazdagi <simple.square@gmail.com>
prysmaticlabs · Mar 3, 2021 · d215607 · d215607
1 parent ff329df
commit d215607
Show file tree

Hide file tree

Showing 13 changed files with 119 additions and 92 deletions.
diff --git a/cmd/slasher/BUILD.bazel b/cmd/slasher/BUILD.bazel
@@ -0,0 +1,88 @@
+load("@prysm//tools/go:def.bzl", "go_library")
+load("@io_bazel_rules_go//go:def.bzl", "go_binary", "go_test")
+load("@io_bazel_rules_docker//go:image.bzl", "go_image")
+load("@io_bazel_rules_docker//container:container.bzl", "container_bundle", "container_image")
+load("@io_bazel_rules_docker//contrib:push-all.bzl", "docker_push")
+
+go_library(
+    name = "go_default_library",
+    srcs = [
+        "log.go",
+        "main.go",
+        "usage.go",
+    ],
+    importpath = "github.com/prysmaticlabs/prysm/cmd/slasher",
+    visibility = ["//slasher:__subpackages__"],
+    deps = [
+        "//cmd/slasher/flags:go_default_library",
+        "//shared/cmd:go_default_library",
+        "//shared/debug:go_default_library",
+        "//shared/featureconfig:go_default_library",
+        "//shared/journald:go_default_library",
+        "//shared/logutil:go_default_library",
+        "//shared/tos:go_default_library",
+        "//shared/version:go_default_library",
+        "//slasher/db:go_default_library",
+        "//slasher/node:go_default_library",
+        "@com_github_joonix_log//:go_default_library",
+        "@com_github_sirupsen_logrus//:go_default_library",
+        "@com_github_urfave_cli_v2//:go_default_library",
+        "@com_github_x_cray_logrus_prefixed_formatter//:go_default_library",
+    ],
+)
+
+go_test(
+    name = "go_default_test",
+    size = "small",
+    srcs = ["usage_test.go"],
+    embed = [":go_default_library"],
+    visibility = ["//slasher:__pkg__"],
+    deps = [
+        "//shared/featureconfig:go_default_library",
+        "//shared/testutil/assert:go_default_library",
+        "@com_github_urfave_cli_v2//:go_default_library",
+    ],
+)
+
+go_image(
+    name = "image",
+    base = "//tools:cc_image",
+    binary = ":slasher",
+    tags = ["manual"],
+    visibility = ["//slasher:__pkg__"],
+)
+
+container_image(
+    name = "image_with_creation_time",
+    base = "image",
+    stamp = True,
+    visibility = ["//slasher:__pkg__"],
+)
+
+container_bundle(
+    name = "image_bundle",
+    images = {
+        "gcr.io/prysmaticlabs/prysm/slasher:latest": ":image_with_creation_time",
+        "gcr.io/prysmaticlabs/prysm/slasher:{DOCKER_TAG}": ":image_with_creation_time",
+        "index.docker.io/prysmaticlabs/prysm-slasher:latest": ":image_with_creation_time",
+        "index.docker.io/prysmaticlabs/prysm-slasher:{DOCKER_TAG}": ":image_with_creation_time",
+    },
+    tags = ["manual"],
+    visibility = ["//slasher:__pkg__"],
+)
+
+docker_push(
+    name = "push_images",
+    bundle = ":image_bundle",
+    tags = ["manual"],
+    visibility = ["//slasher:__pkg__"],
+)
+
+go_binary(
+    name = "slasher",
+    embed = [":go_default_library"],
+    visibility = [
+        "//endtoend:__pkg__",
+        "//slasher:__subpackages__",
+    ],
+)
diff --git a/slasher/flags/BUILD.bazel → cmd/slasher/flags/BUILD.bazel b/slasher/flags/BUILD.bazel → cmd/slasher/flags/BUILD.bazel
@@ -3,7 +3,10 @@ load("@prysm//tools/go:def.bzl", "go_library")
 go_library(
     name = "go_default_library",
     srcs = ["flags.go"],
-    importpath = "github.com/prysmaticlabs/prysm/slasher/flags",
-    visibility = ["//visibility:public"],
+    importpath = "github.com/prysmaticlabs/prysm/cmd/slasher/flags",
+    visibility = [
+        "//cmd/slasher:__subpackages__",
+        "//slasher:__subpackages__",
+    ],
     deps = ["@com_github_urfave_cli_v2//:go_default_library"],
 )
diff --git a/slasher/flags/flags.go → cmd/slasher/flags/flags.go b/slasher/flags/flags.go → cmd/slasher/flags/flags.go
diff --git a/slasher/log.go → cmd/slasher/log.go b/slasher/log.go → cmd/slasher/log.go
diff --git a/slasher/main.go → cmd/slasher/main.go b/slasher/main.go → cmd/slasher/main.go
@@ -9,6 +9,7 @@ import (
 	"runtime"
 
 	joonix "github.com/joonix/log"
+	"github.com/prysmaticlabs/prysm/cmd/slasher/flags"
 	"github.com/prysmaticlabs/prysm/shared/cmd"
 	"github.com/prysmaticlabs/prysm/shared/debug"
 	"github.com/prysmaticlabs/prysm/shared/featureconfig"
@@ -17,7 +18,6 @@ import (
 	"github.com/prysmaticlabs/prysm/shared/tos"
 	"github.com/prysmaticlabs/prysm/shared/version"
 	"github.com/prysmaticlabs/prysm/slasher/db"
-	"github.com/prysmaticlabs/prysm/slasher/flags"
 	"github.com/prysmaticlabs/prysm/slasher/node"
 	"github.com/sirupsen/logrus"
 	"github.com/urfave/cli/v2"

diff --git a/slasher/usage.go → cmd/slasher/usage.go b/slasher/usage.go → cmd/slasher/usage.go
@@ -5,10 +5,10 @@ import (
 	"io"
 	"sort"
 
+	"github.com/prysmaticlabs/prysm/cmd/slasher/flags"
 	"github.com/prysmaticlabs/prysm/shared/cmd"
 	"github.com/prysmaticlabs/prysm/shared/debug"
 	"github.com/prysmaticlabs/prysm/shared/featureconfig"
-	"github.com/prysmaticlabs/prysm/slasher/flags"
 	"github.com/urfave/cli/v2"
 )
 

diff --git a/slasher/usage_test.go → cmd/slasher/usage_test.go b/slasher/usage_test.go → cmd/slasher/usage_test.go
diff --git a/endtoend/BUILD.bazel b/endtoend/BUILD.bazel
@@ -14,7 +14,7 @@ go_test(
     args = ["-test.v"],
     data = [
         "//cmd/beacon-chain",
-        "//slasher",
+        "//cmd/slasher",
         "//tools/bootnode",
         "//cmd/validator",
         "@com_github_ethereum_go_ethereum//cmd/geth",

diff --git a/endtoend/components/slasher.go b/endtoend/components/slasher.go
@@ -15,7 +15,7 @@ import (
 
 // StartSlashers starts slasher clients for use within E2E, connected to all beacon nodes.
 func StartSlashers(t *testing.T) {
-	binaryPath, found := bazel.FindBinary("slasher", "slasher")
+	binaryPath, found := bazel.FindBinary("cmd/slasher", "slasher")
 	if !found {
 		t.Log(binaryPath)
 		t.Fatal("Slasher binary not found")

diff --git a/slasher/BUILD.bazel b/slasher/BUILD.bazel
@@ -1,83 +1,13 @@
-load("@prysm//tools/go:def.bzl", "go_library")
-load("@io_bazel_rules_go//go:def.bzl", "go_binary", "go_test")
-load("@io_bazel_rules_docker//go:image.bzl", "go_image")
-load("@io_bazel_rules_docker//container:container.bzl", "container_bundle", "container_image")
-load("@io_bazel_rules_docker//contrib:push-all.bzl", "docker_push")
-
-go_library(
-    name = "go_default_library",
-    srcs = [
-        "log.go",
-        "main.go",
-        "usage.go",
-    ],
-    importpath = "github.com/prysmaticlabs/prysm/slasher",
-    visibility = ["//slasher:__subpackages__"],
-    deps = [
-        "//shared/cmd:go_default_library",
-        "//shared/debug:go_default_library",
-        "//shared/featureconfig:go_default_library",
-        "//shared/journald:go_default_library",
-        "//shared/logutil:go_default_library",
-        "//shared/tos:go_default_library",
-        "//shared/version:go_default_library",
-        "//slasher/db:go_default_library",
-        "//slasher/flags:go_default_library",
-        "//slasher/node:go_default_library",
-        "@com_github_joonix_log//:go_default_library",
-        "@com_github_sirupsen_logrus//:go_default_library",
-        "@com_github_urfave_cli_v2//:go_default_library",
-        "@com_github_x_cray_logrus_prefixed_formatter//:go_default_library",
-    ],
-)
-
-go_test(
-    name = "go_default_test",
-    size = "small",
-    srcs = ["usage_test.go"],
-    embed = [":go_default_library"],
-    deps = [
-        "//shared/featureconfig:go_default_library",
-        "//shared/testutil/assert:go_default_library",
-        "@com_github_urfave_cli_v2//:go_default_library",
-    ],
-)
-
-go_image(
-    name = "image",
-    base = "//tools:cc_image",
-    binary = ":slasher",
-    tags = ["manual"],
-    visibility = ["//visibility:private"],
-)
-
-container_image(
-    name = "image_with_creation_time",
-    base = "image",
-    stamp = True,
-)
-
-container_bundle(
-    name = "image_bundle",
-    images = {
-        "gcr.io/prysmaticlabs/prysm/slasher:latest": ":image_with_creation_time",
-        "gcr.io/prysmaticlabs/prysm/slasher:{DOCKER_TAG}": ":image_with_creation_time",
-        "index.docker.io/prysmaticlabs/prysm-slasher:latest": ":image_with_creation_time",
-        "index.docker.io/prysmaticlabs/prysm-slasher:{DOCKER_TAG}": ":image_with_creation_time",
-    },
-    tags = ["manual"],
-)
-
-docker_push(
-    name = "push_images",
-    bundle = ":image_bundle",
-    tags = ["manual"],
-)
-
-go_binary(
-    name = "slasher",
-    embed = [":go_default_library"],
-    visibility = [
-        "//endtoend:__pkg__",
-    ],
+load("//tools:target_migration.bzl", "moved_targets")
+
+moved_targets(
+    [
+        ":push_images",
+        ":image_bundle",
+        ":image_with_creation_time",
+        ":image",
+        ":go_default_test",
+        ":slasher",
+    ],
+    "//cmd/slasher",
 )
diff --git a/slasher/db/BUILD.bazel b/slasher/db/BUILD.bazel
@@ -11,7 +11,10 @@ go_library(
         "restore.go",
     ],
     importpath = "github.com/prysmaticlabs/prysm/slasher/db",
-    visibility = ["//slasher:__subpackages__"],
+    visibility = [
+        "//cmd/slasher:__subpackages__",
+        "//slasher:__subpackages__",
+    ],
     deps = [
         "//shared/cmd:go_default_library",
         "//shared/fileutil:go_default_library",

diff --git a/slasher/node/BUILD.bazel b/slasher/node/BUILD.bazel
@@ -8,8 +8,12 @@ go_library(
         "node.go",
     ],
     importpath = "github.com/prysmaticlabs/prysm/slasher/node",
-    visibility = ["//slasher:__subpackages__"],
+    visibility = [
+        "//cmd/slasher:__subpackages__",
+        "//slasher:__subpackages__",
+    ],
     deps = [
+        "//cmd/slasher/flags:go_default_library",
         "//shared:go_default_library",
         "//shared/backuputil:go_default_library",
         "//shared/cmd:go_default_library",
@@ -25,7 +29,6 @@ go_library(
         "//slasher/db:go_default_library",
         "//slasher/db/kv:go_default_library",
         "//slasher/detection:go_default_library",
-        "//slasher/flags:go_default_library",
         "//slasher/rpc:go_default_library",
         "@com_github_pkg_errors//:go_default_library",
         "@com_github_sirupsen_logrus//:go_default_library",

diff --git a/slasher/node/node.go b/slasher/node/node.go
@@ -13,6 +13,7 @@ import (
 	"syscall"
 
 	"github.com/pkg/errors"
+	"github.com/prysmaticlabs/prysm/cmd/slasher/flags"
 	"github.com/prysmaticlabs/prysm/shared"
 	"github.com/prysmaticlabs/prysm/shared/backuputil"
 	"github.com/prysmaticlabs/prysm/shared/cmd"
@@ -28,7 +29,6 @@ import (
 	"github.com/prysmaticlabs/prysm/slasher/db"
 	"github.com/prysmaticlabs/prysm/slasher/db/kv"
 	"github.com/prysmaticlabs/prysm/slasher/detection"
-	"github.com/prysmaticlabs/prysm/slasher/flags"
 	"github.com/prysmaticlabs/prysm/slasher/rpc"
 	"github.com/sirupsen/logrus"
 	"github.com/urfave/cli/v2"