chore: rework to use foreign exe mock

simschla · simschla · commit f6d365c50d0e · 2025-04-16T19:36:47.000+02:00
diff --git a/README.md b/README.md
@@ -196,10 +196,10 @@ output =
 -->
 
 ```
-Usage: spotless clang-format [-hV] [-p=<pathToExe>] [-s=<style>] [-v=<version>]
+Usage: spotless clang-format [-hV] [-p=<pathToExec>] [-s=<style>] [-v=<version>]
 Runs clang-format
   -h, --help            Show this help message and exit.
-  -p, --path-to-exe=<pathToExe>
+  -p, --path-to-exec=<pathToExec>
                         The path to the clang-format executable.
                         (default: looks on your PATH)
   -s, --style=<style>   The style to use for clang-format.
diff --git a/app/src/main/java/com/diffplug/spotless/cli/steps/ClangFormat.java b/app/src/main/java/com/diffplug/spotless/cli/steps/ClangFormat.java
@@ -37,10 +37,10 @@ public class ClangFormat extends SpotlessFormatterStep {
     String version;
 
     @CommandLine.Option(
-            names = {"--path-to-exe", "-p"},
+            names = {"--path-to-exec", "-p"},
             description = "The path to the clang-format executable." + OptionConstants.DEFAULT_VALUE_SUFFIX_BEGIN
                     + "looks on your PATH" + OptionConstants.DEFAULT_VALUE_SUFFIX_END)
-    Path pathToExe;
+    Path pathToExec;
 
     @CommandLine.Option(
             names = {"--style", "-s"},
@@ -50,8 +50,8 @@ public class ClangFormat extends SpotlessFormatterStep {
     @Override
     public @NotNull List<FormatterStep> prepareFormatterSteps() {
         ClangFormatStep clangFormatStep = ClangFormatStep.withVersion(version);
-        if (pathToExe != null) {
-            clangFormatStep = clangFormatStep.withPathToExe(pathToExe.toString());
+        if (pathToExec != null) {
+            clangFormatStep = clangFormatStep.withPathToExe(pathToExec.toString());
         }
         if (style != null) {
             clangFormatStep = clangFormatStep.withStyle(style);
diff --git a/app/src/test/java/com/diffplug/spotless/cli/steps/ClangFormatTest.java b/app/src/test/java/com/diffplug/spotless/cli/steps/ClangFormatTest.java
@@ -16,47 +16,40 @@
 package com.diffplug.spotless.cli.steps;
 
 import java.io.File;
-import java.util.regex.Pattern;
+import java.util.List;
 import java.util.stream.Stream;
 
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.condition.EnabledIf;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.Arguments;
 import org.junit.jupiter.params.provider.MethodSource;
 
-import com.diffplug.spotless.ProcessRunner;
 import com.diffplug.spotless.cli.CLIIntegrationHarness;
+import com.diffplug.spotless.cli.ForeignExeMock;
+import com.diffplug.spotless.cpp.ClangFormatStep;
 import com.diffplug.spotless.tag.CliNativeTest;
 import com.diffplug.spotless.tag.CliProcessTest;
 
 @CliProcessTest
 @CliNativeTest
-@EnabledIf("isClangFormatExecAvailable")
 class ClangFormatTest extends CLIIntegrationHarness {
 
-    static boolean isClangFormatExecAvailable() {
-        try (ProcessRunner processRunner = new ProcessRunner()) {
-            ProcessRunner.Result result = processRunner.exec("clang-format", "--version");
-            return result.exitCode() == 0;
-        } catch (Exception e) {
-            return false;
-        }
-    }
+    File clangFormatExec;
+
+    @BeforeEach
+    void prepareClangFormatExecMock() {
+        ForeignExeMock mock = ForeignExeMock.builder("clang-format", ClangFormatStep.defaultVersion())
+                .withStringConsumingOption("--style", List.of("LLVM", "Google", "Mozilla"))
+                .withStringConsumingOption("--assume-filename")
+                .withReadFromStdin()
+                .withWriteToStdout()
+                .build();
 
-    static String clangFormatVersion() throws Exception {
-        try (ProcessRunner processRunner = new ProcessRunner()) {
-            ProcessRunner.Result result = processRunner.exec("clang-format", "--version");
-            // extract semver from output
-            String versionOut = result.stdOutUtf8();
-            Pattern semVerPattern = Pattern.compile("\\d+\\.\\d+\\.\\d+");
-            java.util.regex.Matcher matcher = semVerPattern.matcher(versionOut);
-            if (matcher.find()) {
-                return matcher.group();
-            } else {
-                throw new IllegalStateException("Could not find version in output: " + versionOut);
-            }
-        }
+        clangFormatExec = setFile(mock.getFileName())
+                .toContent(mock.getContent())
+                .makeExecutable()
+                .getFile();
     }
 
     @ParameterizedTest
@@ -67,7 +60,8 @@ void itFormatsFileType(String testFileName, String resourceName) throws Exceptio
         cliRunner()
                 .withTargets(testFileName)
                 .withStep(ClangFormat.class)
-                .withOption("--clang-version", clangFormatVersion())
+                .withOption("--clang-version", ClangFormatStep.defaultVersion())
+                .withOption("--path-to-exec", clangFormatExec.getAbsolutePath())
                 .run();
 
         assertFile(testFile).notSameSasResource(resourceName);
@@ -92,8 +86,9 @@ void itFormatsWithSpecificStyle() throws Exception {
         cliRunner()
                 .withTargets("Test.java")
                 .withStep(ClangFormat.class)
-                .withOption("--clang-version", clangFormatVersion())
+                .withOption("--clang-version", ClangFormatStep.defaultVersion())
                 .withOption("--style", "Google")
+                .withOption("--path-to-exec", clangFormatExec.getAbsolutePath())
                 .run();
 
         assertFile(testFile).notSameSasResource("clang/example.java.dirty");
diff --git a/app/src/test/resources/com/diffplug/spotless/cli/steps/ClangFormatTest.ss b/app/src/test/resources/com/diffplug/spotless/cli/steps/ClangFormatTest.ss
@@ -1,67 +1,67 @@
 ╔═ itFormatsFileType/Test.java ═╗
-public class Java {
-  public static void main(String[] args) { System.out.println("hello"); }
-}
-╔═ itFormatsFileType/Test.js ═╗
-var numbers = [
-  1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20,
-];
-
-const p = {
-  first : "Peter",
-  last : "Pan",
-  get fullName() { return this.first + " " + this.last; }
-};
-
-const str = "Hello, world!";
-
-var str2 = str.charAt(3) + str[0];
-
-var multilinestr = "Hello \
-World";
-
-function test(a, b = "world") {
-  let combined = a + b;
-  return combined
-};
+public class Java {    
+public static void main(String[] args) {    
+System.out.println("hello");    
+}    
 
-test("Hello");
+╔═ itFormatsFileType/Test.js ═╗
+var numbers=[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,    
+];    
+    
+const p = {    
+    first: "Peter",    
+    last : "Pan",    
+    get fullName() { return this.first + " " + this.last;  }    
+};    
+    
+const str = "Hello, world!"    
+;    
+    
+var str2=str.charAt(3)+str[0];    
+    
+var multilinestr = "Hello \    
+World"    
+;    
+    
+function test (a,     b = "world") { let combined =a+   b; return combined};    
+    
+test  ("Hello");    
 
 ╔═ itFormatsFileType/Test.m ═╗
-- (int)method:(int)i {
-  return [self testing_123:i];
-}
+- (int)method:(int)i {    
+            return [self   testing_123:i];    
+
 ╔═ itFormatsFileType/Test.proto ═╗
-message Testing {
-  required string field1 = 1;
-  required int32 field2 = 2;
-  optional string field3 = 3;
-}
+message Testing {    
+  required string field1 = 1;    
+	required int32 field2 = 2;    
+ optional string field3 = 3;    
+
 ╔═ itFormatsFileType/test.c ═╗
-#include <stdio.h>
-int main() {
-  printf("Testing 123");
-  return 0;
-}
+#include <stdio.h>    
+
 ╔═ itFormatsFileType/test.cs ═╗
-using System;
-using System.Text;
-using System.Collections.Generic;
-using System.Threading.Tasks;
-using System.Linq;
+using System;    
+using System.Text;    
+using System.Collections.Generic;    
+using System.Threading.Tasks;    
+using System.Linq;    
+    
+namespace Testing    
+{    
+    class Program    
+    {    
+        static void Main(string[] args)    
+        {    
+            string message = "Testing 1, 2, 3";    
+            Console.WriteLine(message);    
+        }    
+    }    
 
-namespace Testing {
-class Program {
-  static void Main(string[] args) {
-    string message = "Testing 1, 2, 3";
-    Console.WriteLine(message);
-  }
-}
-}
 ╔═ itFormatsWithSpecificStyle ═╗
-public class Java {
-  public static void main(String[] args) {
-    System.out.println("hello");
-  }
-}
+public class Java {    
+public static void main(String[] args) {    
+System.out.println("hello");    
+}    
+
 ╔═ [end of file] ═╗
diff --git a/testlib/src/main/java/com/diffplug/spotless/cli/ForeignExeMock.java b/testlib/src/main/java/com/diffplug/spotless/cli/ForeignExeMock.java
@@ -89,7 +89,7 @@ public String getFileName() {
         return targetOs.asFileName(name);
     }
 
-    static Builder builder(@NotNull String name, @NotNull String version) {
+    public static Builder builder(@NotNull String name, @NotNull String version) {
         return new Builder(Objects.requireNonNull(name), Objects.requireNonNull(version));
     }
 
@@ -155,7 +155,7 @@ private String content(TargetOs os) {
                 ForeignExeMockWriter writer = os.mockWriter(printWriter);
                 writer = writer.writeIntro(optionDefaults())
                         .writeOptionParserIntro()
-                        .writeStringReturningOption("--version", version);
+                        .writeStringReturningOption("--version", "version " + version);
                 for (Map.Entry<String, String> entry : stringReturningOptions.entrySet()) {
                     writer = writer.writeStringReturningOption(entry.getKey(), entry.getValue());
                 }
@@ -220,22 +220,16 @@ private static class UnixForeignExeMockWriter implements ForeignExeMockWriter {
             this.output = Objects.requireNonNull(output);
         }
 
-        private String nonPrefixed(String optionName) {
-            if (optionName.startsWith("--")) {
-                return optionName.substring(2);
-            } else if (optionName.startsWith("-")) {
-                return optionName.substring(1);
-            } else {
-                return optionName;
-            }
+        private String asVarName(String optionName) {
+            return optionName.replaceAll("[^a-zA-Z0-9]", "_");
         }
 
         @Override
         public ForeignExeMockWriter writeIntro(@NotNull Map<String, String> optionDefaults) {
             Objects.requireNonNull(optionDefaults);
             output.println("#!/bin/bash");
             output.println();
-            optionDefaults.forEach((k, v) -> output.printf("%s=\"%s\"\n", nonPrefixed(k), v));
+            optionDefaults.forEach((k, v) -> output.printf("%s=\"%s\"\n", asVarName(k), v));
             // collect value from stdin
             output.println("stdin_value=\"\"");
             return this;
@@ -259,8 +253,12 @@ public ForeignExeMockWriter writeStringReturningOption(String optionName, @NotNu
 
         @Override
         public ForeignExeMockWriter writeStringConsumingOption(String optionName) {
+            output.printf("    %s=*)\n", optionName);
+            output.printf("      %s=\"${1#%s=}\"\n", asVarName(optionName), optionName);
+            output.println("      shift");
+            output.println("      ;;");
             output.printf("    %s)\n", optionName);
-            output.printf("      %s=\"$2\"\n", nonPrefixed(optionName));
+            output.printf("      %s=\"$2\"\n", asVarName(optionName));
             output.println("      shift 2");
             output.println("      ;;");
             return this;
@@ -269,19 +267,30 @@ public ForeignExeMockWriter writeStringConsumingOption(String optionName) {
         @Override
         public ForeignExeMockWriter writeStringConsumingOption(String optionName, @NotNull List<String> validValues) {
             // same as above, but with a list of valid values which are checked and failed if wrong
+            output.println("# check for --x=y writing variant");
+            output.printf("    %s=*)\n", optionName);
+            output.printf("      %s=\"${1#%s=}\"\n", asVarName(optionName), optionName);
+            writeValidValuesSubCheck(optionName, validValues);
+            output.println("      shift");
+            output.println("      ;;");
+            output.println("#check for --x y writing variant");
             output.printf("    %s)\n", optionName);
-            output.printf("      %s=\"$2\"\n", nonPrefixed(optionName));
-            output.println("      case \"$2\" in");
+            output.printf("      %s=\"$2\"\n", asVarName(optionName));
+            writeValidValuesSubCheck(optionName, validValues);
+            output.println("      shift 2");
+            output.println("      ;;");
+            return this;
+        }
+
+        private void writeValidValuesSubCheck(String optionName, @NotNull List<String> validValues) {
+            output.printf("      case \"$%s\" in\n", asVarName(optionName));
             output.printf("        %s)\n", validValues.stream().collect(Collectors.joining("|")));
             output.println("          ;;");
             output.println("        *)");
-            output.printf("          echo \"Unknown %s: $2\"\n", nonPrefixed(optionName));
+            output.printf("          echo \"Unknown %s: $2\"\n", asVarName(optionName));
             output.println("          exit 1");
             output.println("          ;;");
             output.println("      esac");
-            output.println("      shift 2");
-            output.println("      ;;");
-            return this;
         }
 
         @Override
@@ -308,8 +317,10 @@ public ForeignExeMockWriter writeReadFromStdin() {
 
         @Override
         public ForeignExeMockWriter writeWriteToStdout() {
-            // write the stdin_value to stdout but add 4 spaces at the end of each line
-            output.println("echo \"${stdin_value}\" | sed 's/$/    /'");
+            // write the stdin_value to stdout but add 4 spaces at the end of each line that does not already end with 4
+            // spaces
+            //            output.println("echo \"${stdin_value}\" | sed '/    $/! s/$/    /'");
+            output.println("printf \"%s\" \"$stdin_value\" | sed '/    $/! s/$/    /'");
             return this;
         }
 
