Add copy_directory binary tool (bazel-contrib#324)

Author: gregmagolan

docs/copy_directory.md

@@ -22,7 +22,7 @@ def _copy_cmd(ctx, src, dst):
     # NB: robocopy return non-zero exit codes on success so we must exit 0 after calling it
     cmd_tmpl = "@robocopy \"{src}\" \"{dst}\" /E >NUL & @exit 0"
     mnemonic = "CopyDirectory"
-    progress_message = "Copying directory %s" % src.path
+    progress_message = "Copying directory %{input}"
 
     ctx.actions.write(
         output = bat,
@@ -49,7 +49,7 @@ def _copy_cmd(ctx, src, dst):
 def _copy_bash(ctx, src, dst):
     cmd = "rm -Rf \"$2\" && cp -fR \"$1/\" \"$2\""
     mnemonic = "CopyDirectory"
-    progress_message = "Copying directory %s" % src.path
+    progress_message = "Copying directory %{input}"
 
     ctx.actions.run_shell(
         tools = [src],
@@ -63,7 +63,7 @@ def _copy_bash(ctx, src, dst):
     )
 
 def copy_directory_action(ctx, src, dst, is_windows = None):
-    """Helper function that creates an action to copy a directory from src to dst.
+    """Factory function that creates an action to copy a directory from src to dst.
 
     This helper is used by copy_directory. It is exposed as a public API so it can be used within
     other rule implementations.
@@ -90,6 +90,57 @@ def copy_directory_action(ctx, src, dst, is_windows = None):
     else:
         _copy_bash(ctx, src, dst)
 
+def copy_directory_bin_action(
+        ctx,
+        src,
+        dst,
+        copy_directory_bin,
+        hardlink = "auto",
+        verbose = False):
+    """Factory function that creates an action to copy a directory from src to dst using a tool binary.
+
+    The tool binary will typically be the `@aspect_bazel_lib//tools/copy_directory` `go_binary`
+    either built from source or provided by a toolchain.
+
+    This helper is used by the copy_directory rule. It is exposed as a public API so it can be used
+    within other rule implementations.
+
+    Args:
+        ctx: The rule context.
+
+        src: The source directory to copy.
+
+        dst: The directory to copy to. Must be a TreeArtifact.
+
+        copy_directory_bin: Copy to directory tool binary.
+
+        hardlink: Controls when to use hardlinks to files instead of making copies.
+            See copy_directory rule documentation for more details.
+
+        verbose: If true, prints out verbose logs to stdout
+    """
+    args = [
+        src.path,
+        dst.path,
+    ]
+    if verbose:
+        args.append("--verbose")
+
+    if hardlink == "on":
+        args.append("--hardlink")
+    elif hardlink == "auto" and not src.is_source:
+        args.append("--hardlink")
+
+    ctx.actions.run(
+        inputs = [src],
+        outputs = [dst],
+        executable = copy_directory_bin,
+        arguments = args,
+        mnemonic = "CopyDirectory",
+        progress_message = "Copying directory %{input}",
+        execution_requirements = _COPY_EXECUTION_REQUIREMENTS,
+    )
+
 def _copy_directory_impl(ctx):
     dst = ctx.actions.declare_directory(ctx.attr.out)
     copy_directory_action(ctx, ctx.file.src, dst)

docs/copy_file.md

@@ -85,7 +85,7 @@ def _copy_bash(ctx, src, src_path, dst):
     )
 
 def copy_file_action(ctx, src, dst, dir_path = None, is_windows = None):
-    """Helper function that creates an action to copy a file from src to dst.
+    """Factory function that creates an action to copy a file from src to dst.
 
     If src is a TreeArtifact, dir_path must be specified as the path within
     the TreeArtifact to the file to copy.

docs/copy_to_bin.md

@@ -18,7 +18,7 @@ load("@bazel_skylib//lib:paths.bzl", "paths")
 load(":copy_file.bzl", "copy_file_action")
 
 def copy_file_to_bin_action(ctx, file, is_windows = None):
-    """Helper function that creates an action to copy a file to the output tree.
+    """Factory function that creates an action to copy a file to the output tree.
 
     File are copied to the same workspace-relative path. The resulting files is
     returned.
@@ -92,7 +92,7 @@ target to {file_package} using:
     )
 
 def copy_files_to_bin_actions(ctx, files, is_windows = None):
-    """Helper function that creates actions to copy files to the output tree.
+    """Factory function that creates actions to copy files to the output tree.
 
     Files are copied to the same workspace-relative path. The resulting list of
     files is returned.

docs/copy_to_directory.md

@@ -632,7 +632,7 @@ def copy_to_directory_bin_action(
         replace_prefixes = {},
         allow_overwrites = False,
         verbose = False):
-    """Helper function to copy files to a directory using a tool binary.
+    """Factory function to copy files to a directory using a tool binary.
 
     The tool binary will typically be the `@aspect_bazel_lib//tools/copy_to_directory` `go_binary`
     either built from source or provided by a toolchain.
@@ -824,7 +824,7 @@ def copy_to_directory_action(
         replace_prefixes = {},
         allow_overwrites = False,
         is_windows = None):
-    """Legacy helper function to copy files to a directory.
+    """Legacy factory function to copy files to a directory.
 
     This helper calculates copy paths in Starlark during analysis and performs the copies in a
     bash/bat script. For improved analysis and runtime performance, it is recommended the switch

lib/private/copy_directory.bzl

@@ -0,0 +1,36 @@
+load("//lib:diff_test.bzl", "diff_test")
+load(":pkg.bzl", "pkg")
+
+pkg(
+    name = "pkg",
+    src = "d",
+    out = "d2",
+)
+
+pkg(
+    name = "pkg2",
+    src = "pkg",
+    out = "d3",
+)
+
+diff_test(
+    name = "copy_test",
+    file1 = ":d",
+    file2 = ":pkg",
+    # Source directories are not support on remote execution.
+    tags = ["no-remote-exec"],
+)
+
+diff_test(
+    name = "hardlink_test",
+    file1 = ":d",
+    file2 = ":pkg2",
+    # Source directories are not support on remote execution.
+    tags = ["no-remote-exec"],
+)
+
+diff_test(
+    name = "sanity_test",
+    file1 = ":pkg",
+    file2 = ":pkg2",
+)

lib/private/copy_file.bzl

@@ -0,0 +1 @@
+1

lib/private/copy_to_bin.bzl

@@ -0,0 +1 @@
+1

lib/private/copy_to_directory.bzl

@@ -0,0 +1 @@
+1

lib/tests/copy_directory_bin_action/BUILD.bazel

@@ -0,0 +1 @@
+1

lib/tests/copy_directory_bin_action/d/1

@@ -0,0 +1 @@
+./1

lib/tests/copy_directory_bin_action/d/2

@@ -0,0 +1 @@
+./2

lib/tests/copy_directory_bin_action/d/d/1

@@ -0,0 +1 @@
+d

lib/tests/copy_directory_bin_action/d/d/2

@@ -0,0 +1 @@
+./1

lib/tests/copy_directory_bin_action/d/d/s1

@@ -0,0 +1 @@
+./2

lib/tests/copy_directory_bin_action/d/d/s2

@@ -0,0 +1,40 @@
+"""
+Test rule to create a pkg with DefaultInfo using copy_directory_bin_action
+"""
+
+load("@aspect_bazel_lib//lib/private:copy_directory.bzl", "copy_directory_bin_action")
+
+_attrs = {
+    "src": attr.label(
+        mandatory = True,
+        allow_single_file = True,
+    ),
+    "out": attr.string(mandatory = True),
+    "_tool": attr.label(
+        executable = True,
+        cfg = "exec",
+        default = "//tools/copy_directory",
+    ),
+}
+
+def _pkg_impl(ctx):
+    dst = ctx.actions.declare_directory(ctx.attr.out)
+
+    copy_directory_bin_action(
+        ctx,
+        src = ctx.file.src,
+        dst = dst,
+        copy_directory_bin = ctx.executable._tool,
+        hardlink = "auto",
+        verbose = True,
+    )
+
+    return [
+        DefaultInfo(files = depset([dst])),
+    ]
+
+pkg = rule(
+    implementation = _pkg_impl,
+    attrs = _attrs,
+    provides = [DefaultInfo],
+)

lib/tests/copy_directory_bin_action/d/ds

@@ -10,10 +10,17 @@ multi_platform_go_binaries(
     tags = ["manual"],
 )
 
+multi_platform_go_binaries(
+    name = "copy_directory",
+    embed = ["//tools/copy_directory:copy_directory_lib"],
+    tags = ["manual"],
+)
+
 release(
     name = "release",
     tags = ["manual"],
     targets = [
+        ":copy_directory",
         ":copy_to_directory",
     ],
 )

lib/tests/copy_directory_bin_action/d/s1

@@ -0,0 +1,28 @@
+load("@io_bazel_rules_go//go:def.bzl", "go_binary", "go_library")
+
+# Under --stamp, the Go linker will fill in these placeholders with VCS info
+# see https://github.com/bazelbuild/rules_go/blob/master/go/core.rst#stamping-with-the-workspace-status-script
+_GO_STAMP_X_DEFS = {
+    "BuildTime": "{BUILD_TIMESTAMP}",
+    "GitCommit": "{STABLE_BUILD_SCM_SHA}",
+    "GitStatus": "{STABLE_BUILD_SCM_LOCAL_CHANGES}",
+    "HostName": "{BUILD_HOST}",
+    "Release": "{STABLE_BUILD_SCM_TAG}",
+}
+
+go_library(
+    name = "copy_directory_lib",
+    srcs = [
+        "main.go",
+        "stamp.go",
+    ],
+    importpath = "github.com/aspect-build/bazel-lib/tools/copy_directory",
+    visibility = ["//visibility:public"],
+    x_defs = _GO_STAMP_X_DEFS,
+)
+
+go_binary(
+    name = "copy_directory",
+    embed = [":copy_directory_lib"],
+    visibility = ["//visibility:public"],
+)