Restructure ruleset to conform to style guide (#114)

Follows
https://docs.google.com/document/d/1L1JFgjpZ7SrBinb24DC_5nTIELeYDacikcme-YcA7xs/edit.

Also test coverage with JDK 8 and 21.

.bazelrc

@@ -1,7 +1,13 @@
 test --test_output=errors
 
 # Isolate sandboxed build actions from each other.
-build --sandbox_tmpfs_path=/tmp
+common --sandbox_tmpfs_path=/tmp
 
 # Prevent PATH from being inherited from the environment.
-build --incompatible_strict_action_env
+common --incompatible_strict_action_env
+
+common --java_language_version=8
+common --java_runtime_version=remotejdk_21
+
+common --tool_java_language_version=21
+common --tool_java_runtime_version=remotejdk_21

.github/workflows/run-tests-externally.yml

@@ -82,7 +82,7 @@ jobs:
         run: bazelisk test --config=ci --disk_cache=${{ matrix.cache }} --profile=${{ github.workspace }}/profile.gz ${{ matrix.bazel_extra_args }} //...
 
       - name: Check coverage
-        if: ${{ (matrix.os == 'ubuntu-latest') && (matrix.jdk == '17') }}
+        if: ${{ (matrix.os == 'ubuntu-latest') && (matrix.jdk == '8' || matrix.jdk == '21') }}
         env:
           USE_BAZEL_VERSION: ${{ matrix.bazel }}
         working-directory: ./tests

MODULE.bazel

@@ -9,7 +9,7 @@ bazel_dep(name = "platforms", version = "0.0.5")
 bazel_dep(name = "rules_license", version = "0.0.7")
 
 download_jdk_deps = use_extension(
-    "@rules_jni//bzlmod:extensions.bzl",
+    "@rules_jni//jni/private/extensions:download_jdk_deps.bzl",
     "download_jdk_deps",
 )
 use_repo(

README.md

@@ -44,8 +44,8 @@ rules_jni_dependencies()
 
 ## Documentation
 
-See the documentation for [targets](docs/targets.md), [rules](docs/rules.md)
-and [workspace macros](docs/workspace_macros.md) provided by rules_jni.
+See the documentation for [targets](docs/targets.md), [rules](docs-gen/rules.md)
+and [workspace macros](docs-gen/workspace_macros.md) provided by rules_jni.
 
 ## Examples
 

docs-gen/BUILD.bazel

@@ -0,0 +1,4 @@
+exports_files(
+    glob(["*.md"]),
+    visibility = ["//docs:__pkg__"],
+)

docs/BUILD.bazel

@@ -10,7 +10,7 @@ javadoc(
 
 stardoc(
     name = "rules",
-    out = "rules_gen.md",
+    out = "rules.md",
     input = "//jni:defs.bzl",
     deps = ["//jni:all_rules"],
 )
@@ -19,12 +19,12 @@ diff_test(
     name = "rules_test",
     failure_message = "Please run:\n    bazel run //docs:update",
     file1 = "rules.md",
-    file2 = "rules_gen.md",
+    file2 = "//docs-gen:rules.md",
 )
 
 stardoc(
     name = "workspace_macros",
-    out = "workspace_macros_gen.md",
+    out = "workspace_macros.md",
     input = "//jni:repositories.bzl",
     deps = ["//jni:all_rules"],
 )
@@ -33,18 +33,7 @@ diff_test(
     name = "workspace_macros_test",
     failure_message = "Please run:\n    bazel run //docs:update",
     file1 = "workspace_macros.md",
-    file2 = "workspace_macros_gen.md",
-)
-
-write_file(
-    name = "update_script",
-    out = "update.sh",
-    content = [
-        "#!/bin/sh",
-        "cd $BUILD_WORKSPACE_DIRECTORY",
-        "cp -fv bazel-bin/docs/rules_gen.md docs/rules.md",
-        "cp -fv bazel-bin/docs/workspace_macros_gen.md docs/workspace_macros.md",
-    ],
+    file2 = "//docs-gen:workspace_macros.md",
 )
 
 sh_binary(

docs/update_docs.sh → docs/update.sh

@@ -1,4 +1,4 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 # Copyright 2021 Fabian Meumertzheim
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,8 +13,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-bazel_bin_dir=$(bazel info bazel-bin)
-docs_dir=$(realpath "$(dirname "$0")")
+set -euo pipefail
 
-bazel build //docs:all
-cp -f "${bazel_bin_dir}/docs/rules.md" "${bazel_bin_dir}/docs/workspace_macros.md" "${docs_dir}"
+cd "$BUILD_WORKSPACE_DIRECTORY"
+
+bazel build $(bazel query 'kind(stardoc, //docs:all)')
+
+mkdir -p docs-gen
+cp -fv bazel-bin/docs/rules.md docs-gen/rules.md
+cp -fv bazel-bin/docs/workspace_macros.md docs-gen/workspace_macros.md

jni/BUILD.bazel

@@ -4,31 +4,34 @@ exports_files(glob(["*.bzl"]))
 
 alias(
     name = "jni",
-    actual = "//jni/internal:jni",
+    actual = "//jni/private:jni",
     applicable_licenses = ["//:jdk_license"],
     visibility = ["//visibility:public"],
 )
 
 alias(
     name = "libjvm",
-    actual = "//jni/tools/libjvm_stub:libjvm_stub_with_jni",
+    actual = "//jni/private/tools/libjvm_stub:libjvm_stub_with_jni",
     visibility = ["//visibility:public"],
 )
 
 alias(
     name = "libjvm_lite",
-    actual = "//jni/tools/libjvm_stub:libjvm_stub_release_with_jni",
+    actual = "//jni/private/tools/libjvm_stub:libjvm_stub_release_with_jni",
     visibility = ["//visibility:public"],
 )
 
 bzl_library(
     name = "all_rules",
     srcs = [
+        "cc_jni_library.bzl",
         "defs.bzl",
+        "java_jni_library.bzl",
+        "jni_headers.bzl",
         "repositories.bzl",
     ],
     visibility = ["//visibility:public"],
     deps = [
-        "//jni/internal:all_rules",
+        "//jni/private:all_rules",
     ],
 )

jni/cc_jni_library.bzl

@@ -0,0 +1,19 @@
+# Copyright 2024 Fabian Meumertzheim
+#
+# 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.
+
+load("//jni/private:cc_jni_library.bzl", _cc_jni_library = "cc_jni_library")
+
+visibility("public")
+
+cc_jni_library = _cc_jni_library

jni/defs.bzl

@@ -12,10 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-load("//jni/internal:cc_jni_library.bzl", _cc_jni_library = "cc_jni_library")
-load("//jni/internal:java_jni_library.bzl", _java_jni_library = "java_jni_library")
-load("//jni/internal:jni_headers.bzl", _jni_headers = "jni_headers")
+load(":cc_jni_library.bzl", _cc_jni_library = "cc_jni_library")
+load(":java_jni_library.bzl", _java_jni_library = "java_jni_library")
+load(":jni_headers.bzl", _jni_headers = "jni_headers")
 
+visibility("public")
+
+cc_jni_library = _cc_jni_library
 java_jni_library = _java_jni_library
 jni_headers = _jni_headers
-cc_jni_library = _cc_jni_library

jni/java_jni_library.bzl

@@ -0,0 +1,19 @@
+# Copyright 2024 Fabian Meumertzheim
+#
+# 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.
+
+load("//jni/private:java_jni_library.bzl", _java_jni_library = "java_jni_library")
+
+visibility("public")
+
+java_jni_library = _java_jni_library

jni/jni_headers.bzl

@@ -0,0 +1,19 @@
+# Copyright 2024 Fabian Meumertzheim
+#
+# 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.
+
+load("//jni/private:jni_headers.bzl", _jni_headers = "jni_headers")
+
+visibility("public")
+
+jni_headers = _jni_headers

jni/internal/BUILD.bazel → jni/private/BUILD.bazel

@@ -13,8 +13,8 @@ cc_library(
 cc_library(
     name = "jni_md",
     hdrs = select({
-        "@platforms//os:windows": ["//jni/internal/windows:jni_md_h"],
-        "//conditions:default": ["//jni/internal/unix:jni_md_h"],
+        "@platforms//os:windows": ["//jni/private/windows:jni_md_h"],
+        "//conditions:default": ["//jni/private/unix:jni_md_h"],
     }),
     includes = select({
         "@platforms//os:windows": ["windows"],

jni/internal/cc_jni_library.bzl → jni/private/cc_jni_library.bzl

@@ -16,6 +16,8 @@ load(":jni_headers.bzl", "jni_headers")
 load(":os_cpu_utils.bzl", "SELECT_TARGET_CPU", "SELECT_TARGET_OS")
 load(":transitions.bzl", "multi_platform_transition")
 
+visibility("//jni")
+
 SinglePlatformArtifactInfo = provider(
     fields = ["cpu", "file", "os", "platform"],
 )

jni/internal/common.bzl → jni/private/common.bzl

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+visibility("//jni/private/tools/...")
+
 def _merge_default_infos(ctx, infos):
     return DefaultInfo(
         files = depset(transitive = [info.files for info in infos]),

bzlmod/extensions.bzl → jni/private/extensions/download_jdk_deps.bzl

@@ -13,6 +13,6 @@
 # limitations under the License.
 
 load("@bazel_skylib//lib:modules.bzl", "modules")
-load("//jni/internal:repositories.bzl", "jdk_deps")
+load("//jni/private:repositories.bzl", "jdk_deps")
 
 download_jdk_deps = modules.as_extension(jdk_deps)

jni/internal/java_jni_library.bzl → jni/private/java_jni_library.bzl

@@ -15,6 +15,8 @@
 load(":common.bzl", "merge_java_infos")
 load(":jni_headers.bzl", "jni_headers")
 
+visibility("//jni")
+
 def java_jni_library(
         name,
         native_libs = [],

jni/internal/jni_headers.bzl → jni/private/jni_headers.bzl

@@ -15,6 +15,8 @@
 load("@bazel_tools//tools/cpp:toolchain_utils.bzl", "find_cpp_toolchain")
 load(":transitions.bzl", "return_to_original_target_platforms_transition")
 
+visibility("//jni")
+
 def _jni_headers_impl(ctx):
     # Giving the include directory a name with a header extension ensures
     # compatibility with Bazel 4.0.0, which only considers the extension and not

jni/internal/os_cpu_utils.bzl → jni/private/os_cpu_utils.bzl

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+visibility("private")
+
 CPUS = [
     "aarch64",
     "arm",

jni/internal/repositories.bzl → jni/private/repositories.bzl

@@ -15,6 +15,8 @@
 load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive", "http_file")
 load("@bazel_tools//tools/build_defs/repo:utils.bzl", "maybe")
 
+visibility("//jni/...")
+
 def jdk_deps():
     maybe(
         http_file,

jni/tools/libjvm_stub/BUILD.bazel → jni/private/tools/libjvm_stub/BUILD.bazel

@@ -1,4 +1,4 @@
-load("//jni/internal:common.bzl", "make_root_relative", "merge_cc_infos")
+load("//jni/private:common.bzl", "make_root_relative", "merge_cc_infos")
 load(":current_java_runtime.bzl", "current_java_runtime")
 load(":current_repository.bzl", "RULES_JNI_REPOSITORY_DEFINE")
 
@@ -69,7 +69,7 @@ cc_library(
         "//conditions:default": ["-ldl"],
     }),
     local_defines = select({
-        "//jni/internal:collect_coverage": ["RULES_JNI_COLLECT_COVERAGE=1"],
+        "//jni/private:collect_coverage": ["RULES_JNI_COLLECT_COVERAGE=1"],
         "//conditions:default": [],
     }),
     deps = [
@@ -88,11 +88,11 @@ cc_library(
         "rules_jni_internal.h",
     ],
     data = select({
-        "//jni/internal:collect_coverage": ["//jni/tools/libjvm_stub/coverage:CoverageAgent_deploy.jar"],
+        "//jni/private:collect_coverage": ["//jni/private/tools/libjvm_stub/coverage:CoverageAgent_deploy.jar"],
         "//conditions:default": [],
     }),
     local_defines = [RULES_JNI_REPOSITORY_DEFINE] + select({
-        "//jni/internal:collect_coverage": ["RULES_JNI_COLLECT_COVERAGE=1"],
+        "//jni/private:collect_coverage": ["RULES_JNI_COLLECT_COVERAGE=1"],
         "//conditions:default": [],
     }),
     deps = [

jni/tools/libjvm_stub/bazel.cpp → jni/private/tools/libjvm_stub/bazel.cpp

@@ -20,7 +20,7 @@
 #include <utility>
 #include <vector>
 
-#include "jni/tools/libjvm_stub/current_java_runtime.h"
+#include "jni/private/tools/libjvm_stub/current_java_runtime.h"
 #include "rules_jni_internal.h"
 #include "tools/cpp/runfiles/runfiles.h"
 
@@ -155,7 +155,7 @@ jint rules_jni_create_java_vm_for_coverage(
     if (runfiles != nullptr) {
       coverage_agent = runfiles->Rlocation(
           RULES_JNI_REPOSITORY
-          "/jni/tools/libjvm_stub/coverage/CoverageAgent_deploy.jar");
+          "/jni/private/tools/libjvm_stub/coverage/CoverageAgent_deploy.jar");
     } else if (getenv(RULES_JNI_COVERAGE_AGENT_JAR) != nullptr) {
       // This should only every happen in tests.
       coverage_agent = getenv(RULES_JNI_COVERAGE_AGENT_JAR);

jni/tools/libjvm_stub/coverage/BUILD.bazel → jni/private/tools/libjvm_stub/coverage/BUILD.bazel

@@ -5,7 +5,7 @@ java_binary(
     deploy_manifest_lines = [
         "Premain-Class: com.github.fmeum.rules_jni.libjvm_stub.CoverageAgent",
     ],
-    visibility = ["//jni/tools/libjvm_stub:__pkg__"],
+    visibility = ["//jni/private/tools/libjvm_stub:__pkg__"],
     deps = [
         "@bazel_tools//tools/jdk:JacocoCoverageRunner",
     ],

jni/tools/libjvm_stub/current_java_runtime.bzl → jni/private/tools/libjvm_stub/current_java_runtime.bzl

@@ -15,6 +15,8 @@
 load("@bazel_skylib//lib:paths.bzl", "paths")
 load("@bazel_tools//tools/cpp:toolchain_utils.bzl", "find_cpp_toolchain")
 
+visibility("private")
+
 def rlocation_path(ctx, short_path):
     return paths.normalize(ctx.workspace_name + "/" + short_path)
 

jni/tools/libjvm_stub/current_repository.bzl → jni/private/tools/libjvm_stub/current_repository.bzl

@@ -12,4 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+visibility("private")
+
 RULES_JNI_REPOSITORY_DEFINE = "RULES_JNI_REPOSITORY=\\\"%s\\\"" % Label("//:LICENSE").workspace_name

jni/internal/transitions.bzl → jni/private/transitions.bzl

@@ -12,8 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+visibility("private")
+
 _COMMAND_LINE_OPTION_PLATFORMS = "//command_line_option:platforms"
-_SETTING_PRE_TRANSITION_PLATFORMS = str(Label("//jni/internal:pre_transition_platforms"))
+_SETTING_PRE_TRANSITION_PLATFORMS = str(Label("//jni/private:pre_transition_platforms"))
 
 def _multi_platform_transition_impl(settings, attrs):
     if not attrs.platforms:

jni/internal/unix/BUILD.bazel → jni/private/unix/BUILD.bazel

@@ -5,5 +5,5 @@ copy_file(
     src = "@com_github_openjdk_jdk_unix_jni_md_h//file",
     out = "jni_md.h",
     is_executable = False,
-    visibility = ["//jni/internal:__pkg__"],
+    visibility = ["//jni/private:__pkg__"],
 )