build(bazel): add buildifier and format build files (#1863)

BUILD.bazel

@@ -1,3 +1,7 @@
+package(default_visibility = ["//visibility:public"])
 
+load("@com_github_bazelbuild_buildtools//buildifier:def.bzl", "buildifier")
 
-
+buildifier(
+    name = "buildifier",
+)

Makefile

@@ -45,6 +45,10 @@ build: ## build all targets (excluding docs)
 check-for-outdated-deps: ## check for outdated maven dependencies
 	@bazel run @maven//:outdated
 
+.PHONY: buildifier
+buildifier: ## format Bazel WORKSPACE and BUILD.bazel files
+	@bazel run :buildifier
+
 #################################
 # Docker targets
 #################################

WORKSPACE

@@ -5,111 +5,140 @@ load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive", "http_file"
 
 # bazel-skylib 1.0.2 released 2019.10.09 (https://github.com/bazelbuild/bazel-skylib/releases/tag/1.0.2)
 skylib_version = "1.0.2"
+
 http_archive(
     name = "bazel_skylib",
-    type = "tar.gz",
-    url = "https://github.com/bazelbuild/bazel-skylib/releases/download/{}/bazel-skylib-{}.tar.gz".format (skylib_version, skylib_version),
     sha256 = "97e70364e9249702246c0e9444bccdc4b847bed1eb03c5a3ece4f83dfe6abc44",
+    type = "tar.gz",
+    url = "https://github.com/bazelbuild/bazel-skylib/releases/download/{}/bazel-skylib-{}.tar.gz".format(skylib_version, skylib_version),
 )
 
 # download rules_scala repository
-rules_scala_version="0ac75d3a044b8e316d1b11b90a7d044685bd72e8" # 22.04.2021
-rules_scala_version_sha256="7624c95c19b60df943dbde90c54d09ecad9aca9432b1211da8352f131776ac36"
+rules_scala_version = "0ac75d3a044b8e316d1b11b90a7d044685bd72e8"  # 22.04.2021
+
+rules_scala_version_sha256 = "7624c95c19b60df943dbde90c54d09ecad9aca9432b1211da8352f131776ac36"
+
 http_archive(
     name = "io_bazel_rules_scala",
+    sha256 = rules_scala_version_sha256,
     strip_prefix = "rules_scala-%s" % rules_scala_version,
     type = "zip",
     url = "https://github.com/bazelbuild/rules_scala/archive/%s.zip" % rules_scala_version,
-    sha256 = rules_scala_version_sha256,
 )
 
 # Stores Scala version and other configuration
 # 2.12 is a default version, other versions can be use by passing them explicitly:
 # scala_config(scala_version = "2.11.12")
 load("@io_bazel_rules_scala//:scala_config.bzl", "scala_config")
+
 scala_config(scala_version = "2.13.5")
 
 # register default and our custom scala toolchain
 load("@io_bazel_rules_scala//scala:toolchains.bzl", "scala_register_toolchains")
+
 scala_register_toolchains()
+
 register_toolchains("//toolchains:dsp_api_scala_toolchain")
 
 # needed by rules_scala
 load("@io_bazel_rules_scala//scala:scala.bzl", "scala_repositories")
+
 scala_repositories()
 
 # register the test toolchain for rules_scala
 load("@io_bazel_rules_scala//testing:scalatest.bzl", "scalatest_repositories", "scalatest_toolchain")
+
 scalatest_repositories()
+
 scalatest_toolchain()
 
 #
 # Download the protobuf repository (needed by go and rules_scala_annex)
 #
 protobuf_tag = "3.12.3"
+
 protobuf_sha256 = "e5265d552e12c1f39c72842fa91d84941726026fa056d914ea6a25cd58d7bbf8"
+
 http_archive(
     name = "com_google_protobuf",
+    sha256 = protobuf_sha256,
     strip_prefix = "protobuf-{}".format(protobuf_tag),
     type = "zip",
     url = "https://github.com/protocolbuffers/protobuf/archive/v{}.zip".format(protobuf_tag),
-    sha256 = protobuf_sha256,
 )
 
 load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")
+
 protobuf_deps()
 
 #
 # download rules_jvm_external used for maven dependency resolution
 # defined in the third_party sub-folder
 #
-rules_jvm_external_version = "4.0" # 6.01.2021
+rules_jvm_external_version = "4.0"  # 6.01.2021
+
 rules_jvm_external_version_sha256 = "31701ad93dbfe544d597dbe62c9a1fdd76d81d8a9150c2bf1ecf928ecdf97169"
 
 http_archive(
     name = "rules_jvm_external",
+    sha256 = rules_jvm_external_version_sha256,
     strip_prefix = "rules_jvm_external-%s" % rules_jvm_external_version,
     url = "https://github.com/bazelbuild/rules_jvm_external/archive/%s.zip" % rules_jvm_external_version,
-    sha256 = rules_jvm_external_version_sha256,
 )
 
 # load the dependencies defined in the third_party sub-folder
 load("//third_party:dependencies.bzl", "dependencies")
+
 dependencies()
 
 # pin dependencies to the ones stored in maven_install.json in the third_party sub-folder
 # to update: bazel run @maven//:pin
 load("@maven//:defs.bzl", "pinned_maven_install")
+
 pinned_maven_install()
 
 #
 # Load rules_scala_annex, required by rules_twirl
 #
-rules_scala_annex_version = "2503b72a166610c14170b117c51033b42a32e48b" # 29.06.2020
+rules_scala_annex_version = "2503b72a166610c14170b117c51033b42a32e48b"  # 29.06.2020
+
 rules_scala_annex_sha256 = "52d677dc8205db25a49824aade45984e3ef1b79c3bf761efede35d921033c3a4"
+
 http_archive(
     name = "rules_scala_annex",
+    sha256 = rules_scala_annex_sha256,
     strip_prefix = "rules_scala-{}".format(rules_scala_annex_version),
     url = "https://github.com/higherkindness/rules_scala/archive/{}.zip".format(rules_scala_annex_version),
-    sha256 = rules_scala_annex_sha256,
 )
 
 load("@rules_scala_annex//rules/scala:workspace.bzl", "scala_register_toolchains", "scala_repositories")
+
 scala_repositories()
+
 load("@annex//:defs.bzl", annex_pinned_maven_install = "pinned_maven_install")
+
 annex_pinned_maven_install()
+
 scala_register_toolchains()
 
 load("@rules_scala_annex//rules/scalafmt:workspace.bzl", "scalafmt_default_config", "scalafmt_repositories")
+
 scalafmt_repositories()
+
 load("@annex_scalafmt//:defs.bzl", annex_scalafmt_pinned_maven_install = "pinned_maven_install")
+
 annex_scalafmt_pinned_maven_install()
+
 scalafmt_default_config()
 
-load("@rules_scala_annex//rules/scala_proto:workspace.bzl", "scala_proto_register_toolchains", "scala_proto_repositories",)
+load("@rules_scala_annex//rules/scala_proto:workspace.bzl", "scala_proto_register_toolchains", "scala_proto_repositories")
+
 scala_proto_repositories()
+
 load("@annex_proto//:defs.bzl", annex_proto_pinned_maven_install = "pinned_maven_install")
+
 annex_proto_pinned_maven_install()
+
 scala_proto_register_toolchains()
 
 # Specify the scala compiler we wish to use; in this case, we'll use the default one specified in rules_scala_annex
@@ -121,50 +150,77 @@ bind(
 #
 # download the rules_twirl repository (needed to compile twirl templates)
 #
-rules_twirl_version = "35389750d178f17f7ddd85b9335f7b8b8d662f78" # 29.04.2020
+rules_twirl_version = "35389750d178f17f7ddd85b9335f7b8b8d662f78"  # 29.04.2020
+
 rules_twirl_version_sha256 = "d072049d0917b87e1eb677a4255509a7133ca71fc21c8de4b4536ca030eb3d3a"
+
 http_archive(
-  name = "io_bazel_rules_twirl",
-  strip_prefix = "rules_twirl-%s" % rules_twirl_version,
-  type = "zip",
-  url = "https://github.com/lucidsoftware/rules_twirl/archive/%s.zip" % rules_twirl_version,
-  sha256 = rules_twirl_version_sha256,
+    name = "io_bazel_rules_twirl",
+    sha256 = rules_twirl_version_sha256,
+    strip_prefix = "rules_twirl-%s" % rules_twirl_version,
+    type = "zip",
+    url = "https://github.com/lucidsoftware/rules_twirl/archive/%s.zip" % rules_twirl_version,
 )
 
 load("@io_bazel_rules_twirl//:workspace.bzl", "twirl_repositories")
+
 twirl_repositories()
 
 load("@twirl//:defs.bzl", twirl_pinned_maven_install = "pinned_maven_install")
+
 twirl_pinned_maven_install()
 
 #
 # Download the rules_go repository
 #
+# buildifier is written in Go and hence needs rules_go to be built.
+# See https://github.com/bazelbuild/rules_go for the up to date setup instructions.
 http_archive(
     name = "io_bazel_rules_go",
+    sha256 = "d1ffd055969c8f8d431e2d439813e42326961d0942bdf734d2c95dc30c369566",
     urls = [
-        "https://storage.googleapis.com/bazel-mirror/github.com/bazelbuild/rules_go/releases/download/v0.20.1/rules_go-v0.20.1.tar.gz",
-        "https://github.com/bazelbuild/rules_go/releases/download/v0.20.1/rules_go-v0.20.1.tar.gz",
+        "https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/v0.24.5/rules_go-v0.24.5.tar.gz",
+        "https://github.com/bazelbuild/rules_go/releases/download/v0.24.5/rules_go-v0.24.5.tar.gz",
     ],
-    sha256 = "842ec0e6b4fbfdd3de6150b61af92901eeb73681fd4d185746644c338f51d4c0",
 )
 
-load("@io_bazel_rules_go//go:deps.bzl", "go_rules_dependencies", "go_register_toolchains")
+load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")
 
 go_rules_dependencies()
 
 go_register_toolchains()
 
+http_archive(
+    name = "bazel_gazelle",
+    sha256 = "b85f48fa105c4403326e9525ad2b2cc437babaa6e15a3fc0b1dbab0ab064bc7c",
+    urls = [
+        "https://mirror.bazel.build/github.com/bazelbuild/bazel-gazelle/releases/download/v0.22.2/bazel-gazelle-v0.22.2.tar.gz",
+        "https://github.com/bazelbuild/bazel-gazelle/releases/download/v0.22.2/bazel-gazelle-v0.22.2.tar.gz",
+    ],
+)
+
+load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
+
+# bazel buildtools providing buildifier
+http_archive(
+    name = "com_github_bazelbuild_buildtools",
+    strip_prefix = "buildtools-master",
+    url = "https://github.com/bazelbuild/buildtools/archive/master.zip",
+)
+
 # legacy variant used by rules_docker. Remove after rules_docker was updated to
 # newest rules_python
 load("@rules_python//python:pip.bzl", "pip_import", "pip_repositories")
+
 pip_repositories()
 
 #
 # Download the rules_docker repository at release v0.14.4
 #
-rules_docker_version="0.14.4"
-rules_docker_version_sha256="4521794f0fba2e20f3bf15846ab5e01d5332e587e9ce81629c7f96c793bb7036"
+rules_docker_version = "0.14.4"
+
+rules_docker_version_sha256 = "4521794f0fba2e20f3bf15846ab5e01d5332e587e9ce81629c7f96c793bb7036"
+
 http_archive(
     name = "io_bazel_rules_docker",
     sha256 = rules_docker_version_sha256,
@@ -176,6 +232,7 @@ load(
     "@io_bazel_rules_docker//repositories:repositories.bzl",
     container_repositories = "repositories",
 )
+
 container_repositories()
 
 load("@io_bazel_rules_docker//repositories:deps.bzl", container_deps = "deps")
@@ -194,63 +251,68 @@ load(
 
 # get distroless java
 container_pull(
-  name = "java_base",
-  registry = "gcr.io",
-  repository = "distroless/java",
-  # 'tag' is also supported, but digest is encouraged for reproducibility.
-  digest = "sha256:deadbeef",
+    name = "java_base",
+    # 'tag' is also supported, but digest is encouraged for reproducibility.
+    digest = "sha256:deadbeef",
+    registry = "gcr.io",
+    repository = "distroless/java",
 )
 
 # get openjdk
 container_pull(
     name = "openjdk11",
+    digest = "sha256:0e51b455654bd162c485a6a6b5b120cc82db453d9265cc90f0c4fb5d14e2f62e",
     registry = "docker.io",
     repository = "adoptopenjdk",
     tag = "11-jre-hotspot-bionic",
-    digest = "sha256:0e51b455654bd162c485a6a6b5b120cc82db453d9265cc90f0c4fb5d14e2f62e",
 )
 
 # get sipi
-load("//third_party:versions.bzl", "SIPI_REPOSITORY", "SIPI_VERSION", "SIPI_IMAGE_DIGEST")
+load("//third_party:versions.bzl", "SIPI_IMAGE_DIGEST", "SIPI_REPOSITORY", "SIPI_VERSION")
+
 container_pull(
     name = "sipi",
+    digest = SIPI_IMAGE_DIGEST,
     registry = "docker.io",
     repository = SIPI_REPOSITORY,
     tag = SIPI_VERSION,
-    digest = SIPI_IMAGE_DIGEST,
 )
 
 # get fuseki
-load("//third_party:versions.bzl", "FUSEKI_REPOSITORY", "FUSEKI_VERSION", "FUSEKI_IMAGE_DIGEST")
+load("//third_party:versions.bzl", "FUSEKI_IMAGE_DIGEST", "FUSEKI_REPOSITORY", "FUSEKI_VERSION")
+
 container_pull(
     name = "jenafuseki",
+    digest = FUSEKI_IMAGE_DIGEST,
     registry = "docker.io",
     repository = FUSEKI_REPOSITORY,
     tag = FUSEKI_VERSION,
-    digest = FUSEKI_IMAGE_DIGEST,
 )
 
 #
 # download rules_pkg - basic packaging rules
 #
-rules_package_version="0.2.4"
-rules_package_version_sha256="4ba8f4ab0ff85f2484287ab06c0d871dcb31cc54d439457d28fd4ae14b18450a"
+rules_package_version = "0.2.4"
+
+rules_package_version_sha256 = "4ba8f4ab0ff85f2484287ab06c0d871dcb31cc54d439457d28fd4ae14b18450a"
+
 http_archive(
     name = "rules_pkg",
+    sha256 = rules_package_version_sha256,
     url = "https://github.com/bazelbuild/rules_pkg/releases/download/%s/rules_pkg-%s.tar.gz" % (rules_package_version, rules_package_version),
-    sha256 = rules_package_version_sha256
 )
 
 # load further dependencies of this rule
 load("@rules_pkg//:deps.bzl", "rules_pkg_dependencies")
+
 rules_pkg_dependencies()
 
 #
 # download rules_stamp - stamping helper
 #
 http_archive(
     name = "ecosia_rules_stamp",
-    url = "https://github.com/ecosia/rules_stamp/archive/48d5ef2bc0d93bd65fddddbe02f3ae410e25169d.tar.gz",
-    strip_prefix = "rules_stamp-48d5ef2bc0d93bd65fddddbe02f3ae410e25169d",
     sha256 = "36d7ea381bfb2520f9353299b162434b25c77365d3c9e9459195c536da5e837d",
+    strip_prefix = "rules_stamp-48d5ef2bc0d93bd65fddddbe02f3ae410e25169d",
+    url = "https://github.com/ecosia/rules_stamp/archive/48d5ef2bc0d93bd65fddddbe02f3ae410e25169d.tar.gz",
 )

docker/knora-api/BUILD.bazel

@@ -6,7 +6,11 @@ load("@io_bazel_rules_docker//container:container.bzl", "container_image", "cont
 container_image(
     name = "image",
     base = "@openjdk11//image",
-    cmd = ["java", "-jar", "app_cli_deploy.jar"],
+    cmd = [
+        "java",
+        "-jar",
+        "app_cli_deploy.jar",
+    ],
     # entrypoint = ["java", "-jar", "webapi_deploy.jar"],
     files = [
         "//webapi/src/main/scala/org/knora/webapi/app:app_cli_deploy.jar",
@@ -21,12 +25,12 @@ container_image(
 
 # push to dockerhub
 container_push(
-   name = "push",
-   image = ":image",
-   format = "Docker",
-   registry = "index.docker.io",
-   repository = "daschswiss/knora-api",
-   tag = "{BUILD_SCM_TAG}"
+    name = "push",
+    format = "Docker",
+    image = ":image",
+    registry = "index.docker.io",
+    repository = "daschswiss/knora-api",
+    tag = "{BUILD_SCM_TAG}",
 )
 
 # use in targets needing an up-to-date docker image locally