feat: Adjust run wrapper (#156)

- Adjust run wrapper to look for `githooks-runner` first. - Name all executables with `githooks-` prefix. - Fix Coverage generation. - Remove old binaries during install if still there.
gabyx · Apr 21, 2024 · ee2ec60 · ee2ec60
1 parent 9002369
commit ee2ec60
Show file tree

Hide file tree

Showing 192 changed files with 849 additions and 767 deletions.
diff --git a/.githooks/pre-commit/update-templates b/.githooks/pre-commit/update-templates
@@ -24,7 +24,9 @@ hook_names=$($SED -E '1,/ManagedHookNames.*\{/d;/\}/,$d ; s/\s+"(.*)",/\1/' gith
 
 for hook_name in $hook_names; do
   # shellcheck disable=SC2015
-  $SED -e "s|GITHOOKS_RUNNER=.*|GITHOOKS_RUNNER=\"\$(cd \"\$(dirname \"\$0\")/../\" \&\& pwd)/githooks/bin/runner\"|" \
+  $SED -e "s|GITHOOKS_RUNNER=.*|GITHOOKS_RUNNER=\"\$(cd \"\$(dirname \"\$0\")/../\" \&\& pwd)/githooks/bin/githooks-runner\"|" \
+    -e "/echo \" .*/d" \
+    -e "s|echo \"! .*|echo \"! The runner '\$GITHOOKS_RUNNER' is not existing\" \>\&2\n|g" \
     -e "s|\(various Git triggers.*\)|\1\n#\n# This file is auto-generated, do not edit!|" \
     <githooks/build/embedded/run-wrapper.sh >"hooks/$hook_name" &&
     chmod u+x "hooks/$hook_name" &&

diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -61,7 +61,7 @@
         "--listen=127.0.0.1:2345",
         "--log",
         "--api-version=2",
-        "./apps/cli",
+        "./apps/githooks-cli",
         "--",
         "installer",
         "--config",
@@ -98,7 +98,7 @@
         "--listen=127.0.0.1:2345",
         "--log",
         "--api-version=2",
-        "./apps/cli",
+        "./apps/githooks-cli",
         "--",
         "uninstaller"
       ],
@@ -133,7 +133,7 @@
         "--listen=127.0.0.1:2345",
         "--log",
         "--api-version=2",
-        "./apps/cli",
+        "./apps/githooks-cli",
         "--",
         "install",
         "--non-interactive"

diff --git a/docs/dialog/dialog.md b/docs/dialog/dialog.md
diff --git a/docs/dialog/githooks-dialog.md b/docs/dialog/githooks-dialog.md
@@ -0,0 +1,36 @@
+## githooks-dialog
+
+Githooks dialog application similar to `zenity`.
+
+### Synopsis
+
+See further information at https://github.com/gabyx/githooks/blob/main/README.md
+
+```
+githooks-dialog
+```
+
+### Options
+
+```
+      --json   Report the result as a JSON object on stdout.
+               Exit code:
+               	- `0` for success, and
+               	- '> 0' if creating the dialog failed.
+  -h, --help   help for githooks-dialog
+```
+
+### SEE ALSO
+
+- [githooks-dialog entry](githooks-dialog_entry.md) - Shows a entry dialog.
+- [githooks-dialog file-save](githooks-dialog_file-save.md) - Shows a file save
+  dialog.
+- [githooks-dialog file-selection](githooks-dialog_file-selection.md) - Shows a
+  file selection dialog.
+- [githooks-dialog message](githooks-dialog_message.md) - Shows a message
+  dialog.
+- [githooks-dialog notify](githooks-dialog_notify.md) - Shows a notification.
+- [githooks-dialog options](githooks-dialog_options.md) - Shows a options
+  selection dialog.
+
+###### Auto generated by spf13/cobra
diff --git a/docs/dialog/dialog_entry.md → docs/dialog/githooks-dialog_entry.md b/docs/dialog/dialog_entry.md → docs/dialog/githooks-dialog_entry.md
@@ -1,4 +1,4 @@
-## dialog entry
+## githooks-dialog entry
 
 Shows a entry dialog.
 
@@ -16,7 +16,7 @@ does not.
   button.
 
 ```
-dialog entry
+githooks-dialog entry
 ```
 
 ### Options
@@ -54,6 +54,7 @@ dialog entry
 
 ### SEE ALSO
 
-- [dialog](dialog.md) - Githooks dialog application similar to `zenity`.
+- [githooks-dialog](githooks-dialog.md) - Githooks dialog application similar to
+  `zenity`.
 
 ###### Auto generated by spf13/cobra
diff --git a/docs/dialog/dialog_file-save.md → docs/dialog/githooks-dialog_file-save.md b/docs/dialog/dialog_file-save.md → docs/dialog/githooks-dialog_file-save.md
@@ -1,4 +1,4 @@
-## dialog file-save
+## githooks-dialog file-save
 
 Shows a file save dialog.
 
@@ -14,7 +14,7 @@ Shows a file save dialog similar to `zenity`.
 - `5` : The dialog was closed due to timeout.
 
 ```
-dialog file-save
+githooks-dialog file-save
 ```
 
 ### Options
@@ -48,6 +48,7 @@ dialog file-save
 
 ### SEE ALSO
 
-- [dialog](dialog.md) - Githooks dialog application similar to `zenity`.
+- [githooks-dialog](githooks-dialog.md) - Githooks dialog application similar to
+  `zenity`.
 
 ###### Auto generated by spf13/cobra
diff --git a/docs/dialog/dialog_file-selection.md → .../dialog/githooks-dialog_file-selection.md b/docs/dialog/dialog_file-selection.md → .../dialog/githooks-dialog_file-selection.md
@@ -1,4 +1,4 @@
-## dialog file-selection
+## githooks-dialog file-selection
 
 Shows a file selection dialog.
 
@@ -14,7 +14,7 @@ Shows a file selection dialog similar to `zenity`.
 - `5` : The dialog was closed due to timeout.
 
 ```
-dialog file-selection
+githooks-dialog file-selection
 ```
 
 ### Options
@@ -47,6 +47,7 @@ dialog file-selection
 
 ### SEE ALSO
 
-- [dialog](dialog.md) - Githooks dialog application similar to `zenity`.
+- [githooks-dialog](githooks-dialog.md) - Githooks dialog application similar to
+  `zenity`.
 
 ###### Auto generated by spf13/cobra
diff --git a/docs/dialog/dialog_message.md → docs/dialog/githooks-dialog_message.md b/docs/dialog/dialog_message.md → docs/dialog/githooks-dialog_message.md
@@ -1,4 +1,4 @@
-## dialog message
+## githooks-dialog message
 
 Shows a message dialog.
 
@@ -17,7 +17,7 @@ supports multiple extra buttons. Use `options` to have more choices.
   button.
 
 ```
-dialog message
+githooks-dialog message
 ```
 
 ### Options
@@ -54,6 +54,7 @@ dialog message
 
 ### SEE ALSO
 
-- [dialog](dialog.md) - Githooks dialog application similar to `zenity`.
+- [githooks-dialog](githooks-dialog.md) - Githooks dialog application similar to
+  `zenity`.
 
 ###### Auto generated by spf13/cobra
diff --git a/docs/dialog/dialog_notify.md → docs/dialog/githooks-dialog_notify.md b/docs/dialog/dialog_notify.md → docs/dialog/githooks-dialog_notify.md
@@ -1,4 +1,4 @@
-## dialog notify
+## githooks-dialog notify
 
 Shows a notification.
 
@@ -12,7 +12,7 @@ Shows a notification similar to `zenity`.
 - > `0` : An error occurred.
 
 ```
-dialog notify
+githooks-dialog notify
 ```
 
 ### Options
@@ -38,6 +38,7 @@ dialog notify
 
 ### SEE ALSO
 
-- [dialog](dialog.md) - Githooks dialog application similar to `zenity`.
+- [githooks-dialog](githooks-dialog.md) - Githooks dialog application similar to
+  `zenity`.
 
 ###### Auto generated by spf13/cobra
diff --git a/docs/dialog/dialog_options.md → docs/dialog/githooks-dialog_options.md b/docs/dialog/dialog_options.md → docs/dialog/githooks-dialog_options.md
@@ -1,4 +1,4 @@
-## dialog options
+## githooks-dialog options
 
 Shows a options selection dialog.
 
@@ -20,7 +20,7 @@ instead of a listbox.
 - `5` : The dialog was closed due to timeout.
 
 ```
-dialog options
+githooks-dialog options
 ```
 
 ### Options
@@ -61,6 +61,7 @@ dialog options
 
 ### SEE ALSO
 
-- [dialog](dialog.md) - Githooks dialog application similar to `zenity`.
+- [githooks-dialog](githooks-dialog.md) - Githooks dialog application similar to
+  `zenity`.
 
 ###### Auto generated by spf13/cobra
diff --git a/githooks/apps/cli/cli_test.go b/githooks/apps/cli/cli_test.go
@@ -10,7 +10,7 @@ import (
 )
 
 func TestCoverage(t *testing.T) {
-	if coverage.Setup("cli") {
+	if coverage.Setup("githooks-cli") {
 		// Careful if you print to much stuff, certain tests might fail
 		// fmt.Printf("Forward args: %q\n", os.Args)
 

diff --git a/githooks/apps/dialog/cmd/cmd.go b/githooks/apps/dialog/cmd/cmd.go
@@ -37,7 +37,7 @@ func MakeDialogCtl(ctx *dcm.CmdContext) (rootCmd *cobra.Command) {
 	ccm.InitTemplates(title, firstPrefix, ctx.Log.GetIndent())
 
 	rootCmd = &cobra.Command{
-		Use:   "dialog",
+		Use:   "githooks-dialog",
 		Short: "Githooks dialog application similar to 'zenity'.",
 		Long:  "See further information at https://github.com/gabyx/githooks/blob/main/README.md"}
 

diff --git a/githooks/apps/dialog/dialog_test.go b/githooks/apps/dialog/dialog_test.go
@@ -9,7 +9,7 @@ import (
 )
 
 func TestCoverage(t *testing.T) {
-	if coverage.Setup("dialog") {
+	if coverage.Setup("githooks-dialog") {
 		// Careful if you print to much stuff, certain tests might fail
 		// fmt.Printf("Forward args: %q\n", os.Args)
 

diff --git a/githooks/apps/runner/runner_test.go b/githooks/apps/runner/runner_test.go
@@ -9,7 +9,7 @@ import (
 )
 
 func TestCoverage(t *testing.T) {
-	if coverage.Setup("runner") {
+	if coverage.Setup("githooks-runner") {
 		// Careful if you print to much stuff, certain tests might fail
 		// fmt.Printf("Forward args: %q\n", os.Args)
 

diff --git a/githooks/build/embedded/run-wrapper-coverage.sh b/githooks/build/embedded/run-wrapper-coverage.sh
@@ -5,13 +5,16 @@
 # its hooks to execute on various Git triggers.
 
 # Read the runner script from the local/global or system config
-GITHOOKS_RUNNER=$(git config githooks.runner)
+GITHOOKS_RUNNER=$(command -v "githooks-runner" 2>/dev/null || git config githooks.runner)
 
+# shellcheck disable=SC2181
 if [ ! -x "$GITHOOKS_RUNNER" ]; then
-    echo "! Githooks runner points to a non existing location" >&2
-    echo "   \`$GITHOOKS_RUNNER\`" >&2
-    echo " or it is not executable!" >&2
-    echo " Please run the Githooks install script again to fix it." >&2
+    echo "! Either 'githooks-runner' must be in your path or" >&2
+    echo "  Git config value in 'githooks.runner' must point to an " >&2
+    echo "  executable. The value:" >&2
+    echo "   '$GITHOOKS_RUNNER" >&2
+    echo "  is not existing or is not executable!" >&2
+    echo "  Please run the Githooks install script again to fix it." >&2
     exit 1
 fi
 
@@ -20,8 +23,8 @@ fi
     exit 1
 }
 
-COV_DATA="$GH_COVERAGE_DIR/runner.yaml"
-COUNTER=$(head -1 "$COV_DATA" | sed -E 's@counter: ([0-9]+)@\1@')
+COV_DATA="$GH_COVERAGE_DIR/githooks-runner.yaml"
+COUNTER=$(head -1 "$COV_DATA" 2>&1 | sed -E 's@counter: ([0-9]+)@\1@')
 [ -z "$COUNTER" ] && COUNTER="0"
 COV_FILE="$GH_COVERAGE_DIR/runner-$COUNTER.cov"
 [ -f "$COV_FILE" ] && {

diff --git a/githooks/build/embedded/run-wrapper.sh b/githooks/build/embedded/run-wrapper.sh
@@ -4,14 +4,16 @@
 # It allows you to have a .githooks folder per-project that contains
 # its hooks to execute on various Git triggers.
 
-# Read the runner script from the local/global or system config
-GITHOOKS_RUNNER=$(git config githooks.runner)
+GITHOOKS_RUNNER=$(command -v "githooks-runner" 2>/dev/null || git config githooks.runner)
 
+# shellcheck disable=SC2181
 if [ ! -x "$GITHOOKS_RUNNER" ]; then
-    echo "! Githooks runner points to a non existing location" >&2
-    echo "   \`$GITHOOKS_RUNNER\`" >&2
-    echo " or it is not executable!" >&2
-    echo " Please run the Githooks install script again to fix it." >&2
+    echo "! Either 'githooks-runner' must be in your path or" >&2
+    echo "  Git config value in 'githooks.runner' must point to an " >&2
+    echo "  executable. The value:" >&2
+    echo "   '$GITHOOKS_RUNNER" >&2
+    echo "  is not existing or is not executable!" >&2
+    echo "  Please run the Githooks install script again to fix it." >&2
     exit 1
 fi
 

diff --git a/githooks/builder/builder.go b/githooks/builder/builder.go
@@ -147,8 +147,10 @@ func Build(gitx *git.Context, buildTags []string, cleanUpX *cm.InterruptContext)
 	// Compile everything.
 	cmd := []string{"install", "-mod=vendor"}
 
+	ext := ""
 	if runtime.GOOS == cm.WindowsOsName {
 		buildTags = append(buildTags, cm.WindowsOsName)
+		ext = ".exe"
 	}
 
 	if len(buildTags) != 0 {
@@ -158,6 +160,16 @@ func Build(gitx *git.Context, buildTags []string, cleanUpX *cm.InterruptContext)
 	cmd = append(cmd, "./...")
 	out, err = gox.GetCombined(cmd...)
 
+	for _, name := range []string{"cli", "runner", "dialog"} {
+		src := path.Join(goBinPath, name+ext)
+		dest := path.Join(goBinPath, "githooks-"+name+ext)
+
+		err = os.Rename(src, dest)
+		if err != nil {
+			return "", cm.ErrorF("Could not rename executable '%s'.", name)
+		}
+	}
+
 	if err != nil {
 		return goBinPath,
 			cm.ErrorF("Compile command failed:\n'%s %q'\nOutput:\n%s",

diff --git a/githooks/cmd/installer/download-binaries-mock.go b/githooks/cmd/installer/download-binaries-mock.go
@@ -41,9 +41,9 @@ func downloadBinaries(
 	}
 
 	all := []string{
-		path.Join(tempDir, "cli"+ext),
-		path.Join(tempDir, "runner"+ext),
-		path.Join(tempDir, "dialog"+ext)}
+		path.Join(tempDir, "githooks-cli"+ext),
+		path.Join(tempDir, "githooks-runner"+ext),
+		path.Join(tempDir, "githooks-dialog"+ext)}
 
 	for _, exe := range all {
 		src := path.Join(bin, path.Base(exe))