Make bazel run //bazel/buildifier work on Windows

Author: rdesgroppes

.gitlab/bazel/build-deps.yaml

@@ -47,5 +47,4 @@ bazel:build-deps:windows-amd64:
     ARCH: x64
     SCRIPT: |-
       echo "🟡 TODO(regis): compilation errors remain - limiting to a working subset for the time being"
-      bazel build '@zlib//...' '@libffi'
-      # bazel build @bzip2//...
+      bazel run //bazel/buildifier

MODULE.bazel

@@ -23,7 +23,13 @@ http_archive = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "ht
 http_archive(
     name = "com_github_bazelbuild_buildtools",
     patch_strip = 1,
-    patches = ["//bazel/patches:buildifier.patch"],
+    patches = [
+        # pending https://github.com/bazelbuild/buildtools/pull/1398:
+        "//bazel/patches:buildifier-build.patch",
+        # pending https://github.com/bazelbuild/buildtools/pull/1399 & https://github.com/bazelbuild/buildtools/pull/1400:
+        "//bazel/patches:buildifier-internal-factory.patch",
+        "//bazel/patches:buildifier-runner-bat-template.patch",
+    ],
     sha256 = "53119397bbce1cd7e4c590e117dcda343c2086199de62932106c80733526c261",
     strip_prefix = "buildtools-8.2.1",
     urls = ["https://github.com/bazelbuild/buildtools/archive/refs/tags/v8.2.1.tar.gz"],

bazel/buildifier/BUILD.bazel

@@ -1,8 +1,7 @@
 load("@com_github_bazelbuild_buildtools//buildifier:def.bzl", "buildifier", "buildifier_test")
 
 exclude_patterns = [
-    "./.bazelbsp/**",
-    "./.cache/**",
+    "./.*",  # all "hidden" directories at the root of the workspace: ./.bazelbsp, ./.cache, ./.git, etc.
 ]
 
 buildifier(

bazel/patches/buildifier.patch renamed to bazel/patches/buildifier-build.patch

@@ -6,12 +6,12 @@ index 1f1cd67..2f2a5b1 100644
 +INHIBITED_IN_FAVOR_OF_PREBUILT = """
  load("@io_bazel_rules_go//go:def.bzl", "go_binary", "go_library")
  load("@rules_shell//shell:sh_test.bzl", "sh_test")
- 
+
 @@ -108,6 +109,7 @@ go_library(
          "//wspace",
      ],
  )
 +"""
- 
+
  exports_files(
      [

bazel/patches/buildifier-internal-factory.patch

@@ -0,0 +1,19 @@
+diff --git a/buildifier/internal/factory.bzl b/buildifier/internal/factory.bzl
+index 0ad56ff..c33f0b6 100644
+--- a/buildifier/internal/factory.bzl
++++ b/buildifier/internal/factory.bzl
+@@ -159,8 +159,12 @@ def buildifier_impl_factory(ctx, test_rule = False):
+     if ctx.attr.exclude_patterns:
+         if test_rule and not ctx.attr.no_sandbox:
+             fail("Cannot use 'exclude_patterns' in a test rule without 'no_sandbox'")
+-        exclude_patterns = ["\\! -path %s" % shell.quote(pattern) for pattern in ctx.attr.exclude_patterns]
+-        exclude_patterns_str = " ".join(exclude_patterns)
++        if ctx.executable.buildifier.extension.lower() == "exe":
++            exclude_patterns = [shell.quote(pattern.replace("/", "\\")) for pattern in ctx.attr.exclude_patterns]
++            exclude_patterns_str = ", ".join(exclude_patterns)
++        else:
++            exclude_patterns = ["\\! -path %s" % shell.quote(pattern) for pattern in ctx.attr.exclude_patterns]
++            exclude_patterns_str = " ".join(exclude_patterns)
+ 
+     workspace = ""
+     if test_rule and ctx.attr.no_sandbox:

bazel/patches/buildifier-runner-bat-template.patch

@@ -0,0 +1,55 @@
+diff --git a/buildifier/runner.bat.template b/buildifier/runner.bat.template
+index 13ca3fa..480b2bd 100644
+--- a/buildifier/runner.bat.template
++++ b/buildifier/runner.bat.template
+@@ -9,14 +9,38 @@ rem Unquote the arguments
+ set stripped_args=%stripped_args:'=%
+ 
+ rem Get the absolute path to the buildifier executable
+-for /f "tokens=2" %%i in ('findstr /r "\<buildifier\.exe\>" MANIFEST') do (set buildifier_abs_path=%%i)
++if exist MANIFEST (
++    set manifest_file=MANIFEST
++) else if exist "%RUNFILES_MANIFEST_FILE%" (
++    set "manifest_file=%RUNFILES_MANIFEST_FILE:/=\%"
++) else (
++    >&2 echo Error: manifest file not found
++    exit /b 1
++)
++for /f "tokens=2" %%i in ('findstr /r "\<buildifier\.exe\>" "%manifest_file%"') do (set buildifier_abs_path=%%i)
+ 
+ powershell ^
++function Should-Exclude($Path)^
++{^
++    $relPath = '.' + (Resolve-Path $Path).Path.Substring('%BUILD_WORKSPACE_DIRECTORY%'.Length);^
++    foreach ($pattern in @(@@EXCLUDE_PATTERNS@@))^
++    {^
++        if ($relPath -clike $pattern)^
++        {^
++            return $true;^
++        };^
++    };^
++    return $false;^
++};^
+ function Buildify($Root)^
+ {^
++    if (Should-Exclude $Root)^
++    {^
++        return;^
++    };^
+     $Folder = (New-Object -Com Scripting.FileSystemObject).GetFolder($Root);^
+     $Files = $Folder.Files ^| Where-Object {^
+-        $_.Name -eq 'BUILD.bazel' `^
++        ($_.Name -eq 'BUILD.bazel' `^
+         -or $_.Name -eq 'BUILD' `^
+         -or $_.Name -eq 'WORKSPACE' `^
+         -or $_.Name -eq 'WORKSPACE.bazel' `^
+@@ -27,7 +51,8 @@ function Buildify($Root)^
+         -or $_.Name -clike 'BUILD.*.bazel' `^
+         -or $_.Name -clike 'BUILD.*.oss' `^
+         -or $_.Name -clike 'WORKSPACE.*.bazel' `^
+-        -or $_.Name -clike 'WORKSPACE.*.oss'^
++        -or $_.Name -clike 'WORKSPACE.*.oss') `^
++        -and -not (Should-Exclude $_.Path)^
+     };^
+     foreach ($File in $Files)^
+     {^