tests: enable brew style in linters

This adds a `brew style` linter to make sure that our generated Homebrew formulas will pass Homebrew's `brew style` for users who have enabled Homebrew's default CI setup for their taps. I've also ensured our snapshots contain the auto-restyled copies after `brew style --fix` is run. This required one stylistic change: the hashmap for binary aliases would violate the line length lint, and unfortunately Rubocop's line length autoformatter was consistently getting the formatting wrong. This instead (ab)uses the fact that JSON hashmaps have a compatible syntax to Ruby 1.9+ hashmaps so long as symbols are the keys - and we were already using symbolized keys. The resulting hashmap is slightly strange-looking by Ruby standards, since symbolized keys usually aren't quoted, but Rubocop isn't mad about it.
axodotdev · Aug 21, 2024 · d8130cf · d8130cf
1 parent a663e04
commit d8130cf
Show file tree

Hide file tree

Showing 38 changed files with 368 additions and 37 deletions.
diff --git a/cargo-dist/templates/installer/homebrew.rb.j2 b/cargo-dist/templates/installer/homebrew.rb.j2
@@ -66,7 +66,7 @@ class {{ formula_class }} < Formula
   {%- endfor %}
   {%- endif %}
 
-  BINARY_ALIASES = {{ inner.bin_aliases }}
+  BINARY_ALIASES = {{ inner.bin_aliases | tojson(indent=2) | indent(2) }}
 
   def target_triple
     cpu = Hardware::CPU.arm? ? "aarch64" : "x86_64"

diff --git a/cargo-dist/tests/gallery/dist.rs b/cargo-dist/tests/gallery/dist.rs
@@ -346,6 +346,9 @@ impl DistResult {
             // If we have shellcheck, check our shell script
             app.shellcheck(ctx)?;
 
+            // If we have Homebrew, check our Homebrew installers
+            app.brew_style(ctx)?;
+
             // If we have PsScriptAnalyzer, check our powershell script
             app.psanalyzer(ctx)?;
         }

diff --git a/cargo-dist/tests/gallery/dist/homebrew.rs b/cargo-dist/tests/gallery/dist/homebrew.rs
@@ -46,4 +46,52 @@ impl AppResult {
         }
         Ok(())
     }
+
+    pub fn brew_style(&self, ctx: &TestContext<Tools>) -> Result<()> {
+        // only do this if the formula exists
+        let Some(formula_path) = &self.homebrew_installer_path else {
+            return Ok(());
+        };
+
+        // Only do this if Homebrew is installed
+        let Some(homebrew) = &ctx.tools.homebrew else {
+            return Ok(());
+        };
+
+        // Homebrew fails to guess that this is a formula
+        // file if it's not in a path named Formula,
+        // so we need to put the formula in a temp path
+        // to hint it correctly.
+        // (We could also skip individual lints via
+        // --except-cop on the `brew style` CLI, but that's
+        // a bit too much of a game of whack a mole.)
+        let temp_root = temp_dir::TempDir::new().unwrap();
+        let formula_temp_root = temp_root.path().join("Formula");
+        std::fs::create_dir(&formula_temp_root).unwrap();
+        let formula_temp_path = formula_temp_root.join(formula_path.file_name().unwrap());
+        std::fs::copy(formula_path, &formula_temp_path).unwrap();
+
+        let output = homebrew.output(|cmd| {
+            cmd.arg("style")
+                // This style nit is valid, but only shows up
+                // in the case no homepage was specified. It's
+                // expected that a user might see this one, and
+                // we don't want to fail ourselves on it.
+                // We add FormulaAuditStrict because that's the
+                // default exclusion, and adding anything to
+                // --except-cops overrides it.
+                .arg("--except-cops")
+                .arg("FormulaAudit/Homepage,FormulaAuditStrict")
+                // Applying --fix will ensure that fixable
+                // style issues won't be treated as errors.
+                .arg("--fix")
+                .arg(&formula_temp_path)
+        })?;
+
+        if !output.status.success() {
+            eprintln!("{}", String::from_utf8_lossy(&output.stdout));
+            return Err(miette!("brew style found issues"));
+        }
+        Ok(())
+    }
 }
diff --git a/cargo-dist/tests/snapshots/akaikatana_basic.snap b/cargo-dist/tests/snapshots/akaikatana_basic.snap
@@ -1159,7 +1159,12 @@ class AkaikatanaRepack < Formula
   end
   license "GPL-2.0-or-later"
 
-  BINARY_ALIASES = {"aarch64-apple-darwin": {}, "x86_64-apple-darwin": {}, "x86_64-pc-windows-gnu": {}, "x86_64-unknown-linux-gnu": {}}
+  BINARY_ALIASES = {
+    "aarch64-apple-darwin": {},
+    "x86_64-apple-darwin": {},
+    "x86_64-pc-windows-gnu": {},
+    "x86_64-unknown-linux-gnu": {}
+  }
 
   def target_triple
     cpu = Hardware::CPU.arm? ? "aarch64" : "x86_64"

diff --git a/cargo-dist/tests/snapshots/akaikatana_one_alias_among_many_binaries.snap b/cargo-dist/tests/snapshots/akaikatana_one_alias_among_many_binaries.snap
@@ -1171,7 +1171,28 @@ class AkaikatanaRepack < Formula
   end
   license "GPL-2.0-or-later"
 
-  BINARY_ALIASES = {"aarch64-apple-darwin": {"akextract": ["akextract-link"]}, "x86_64-apple-darwin": {"akextract": ["akextract-link"]}, "x86_64-pc-windows-gnu": {"akextract.exe": ["akextract-link.exe"]}, "x86_64-unknown-linux-gnu": {"akextract": ["akextract-link"]}}
+  BINARY_ALIASES = {
+    "aarch64-apple-darwin": {
+      "akextract": [
+        "akextract-link"
+      ]
+    },
+    "x86_64-apple-darwin": {
+      "akextract": [
+        "akextract-link"
+      ]
+    },
+    "x86_64-pc-windows-gnu": {
+      "akextract.exe": [
+        "akextract-link.exe"
+      ]
+    },
+    "x86_64-unknown-linux-gnu": {
+      "akextract": [
+        "akextract-link"
+      ]
+    }
+  }
 
   def target_triple
     cpu = Hardware::CPU.arm? ? "aarch64" : "x86_64"

diff --git a/cargo-dist/tests/snapshots/akaikatana_two_bin_aliases.snap b/cargo-dist/tests/snapshots/akaikatana_two_bin_aliases.snap
@@ -1183,7 +1183,40 @@ class AkaikatanaRepack < Formula
   end
   license "GPL-2.0-or-later"
 
-  BINARY_ALIASES = {"aarch64-apple-darwin": {"akextract": ["akextract-link"], "akmetadata": ["akmetadata-link"]}, "x86_64-apple-darwin": {"akextract": ["akextract-link"], "akmetadata": ["akmetadata-link"]}, "x86_64-pc-windows-gnu": {"akextract.exe": ["akextract-link.exe"], "akmetadata.exe": ["akmetadata-link.exe"]}, "x86_64-unknown-linux-gnu": {"akextract": ["akextract-link"], "akmetadata": ["akmetadata-link"]}}
+  BINARY_ALIASES = {
+    "aarch64-apple-darwin": {
+      "akextract": [
+        "akextract-link"
+      ],
+      "akmetadata": [
+        "akmetadata-link"
+      ]
+    },
+    "x86_64-apple-darwin": {
+      "akextract": [
+        "akextract-link"
+      ],
+      "akmetadata": [
+        "akmetadata-link"
+      ]
+    },
+    "x86_64-pc-windows-gnu": {
+      "akextract.exe": [
+        "akextract-link.exe"
+      ],
+      "akmetadata.exe": [
+        "akmetadata-link.exe"
+      ]
+    },
+    "x86_64-unknown-linux-gnu": {
+      "akextract": [
+        "akextract-link"
+      ],
+      "akmetadata": [
+        "akmetadata-link"
+      ]
+    }
+  }
 
   def target_triple
     cpu = Hardware::CPU.arm? ? "aarch64" : "x86_64"

diff --git a/cargo-dist/tests/snapshots/akaikatana_updaters.snap b/cargo-dist/tests/snapshots/akaikatana_updaters.snap
@@ -1159,7 +1159,12 @@ class AkaikatanaRepack < Formula
   end
   license "GPL-2.0-or-later"
 
-  BINARY_ALIASES = {"aarch64-apple-darwin": {}, "x86_64-apple-darwin": {}, "x86_64-pc-windows-gnu": {}, "x86_64-unknown-linux-gnu": {}}
+  BINARY_ALIASES = {
+    "aarch64-apple-darwin": {},
+    "x86_64-apple-darwin": {},
+    "x86_64-pc-windows-gnu": {},
+    "x86_64-unknown-linux-gnu": {}
+  }
 
   def target_triple
     cpu = Hardware::CPU.arm? ? "aarch64" : "x86_64"

diff --git a/cargo-dist/tests/snapshots/axolotlsay_abyss.snap b/cargo-dist/tests/snapshots/axolotlsay_abyss.snap
@@ -1159,7 +1159,12 @@ class Axolotlsay < Formula
   end
   license any_of: ["MIT", "Apache-2.0"]
 
-  BINARY_ALIASES = {"aarch64-apple-darwin": {}, "x86_64-apple-darwin": {}, "x86_64-pc-windows-gnu": {}, "x86_64-unknown-linux-gnu": {}}
+  BINARY_ALIASES = {
+    "aarch64-apple-darwin": {},
+    "x86_64-apple-darwin": {},
+    "x86_64-pc-windows-gnu": {},
+    "x86_64-unknown-linux-gnu": {}
+  }
 
   def target_triple
     cpu = Hardware::CPU.arm? ? "aarch64" : "x86_64"

diff --git a/cargo-dist/tests/snapshots/axolotlsay_abyss_only.snap b/cargo-dist/tests/snapshots/axolotlsay_abyss_only.snap
@@ -1159,7 +1159,12 @@ class Axolotlsay < Formula
   end
   license any_of: ["MIT", "Apache-2.0"]
 
-  BINARY_ALIASES = {"aarch64-apple-darwin": {}, "x86_64-apple-darwin": {}, "x86_64-pc-windows-gnu": {}, "x86_64-unknown-linux-gnu": {}}
+  BINARY_ALIASES = {
+    "aarch64-apple-darwin": {},
+    "x86_64-apple-darwin": {},
+    "x86_64-pc-windows-gnu": {},
+    "x86_64-unknown-linux-gnu": {}
+  }
 
   def target_triple
     cpu = Hardware::CPU.arm? ? "aarch64" : "x86_64"

diff --git a/cargo-dist/tests/snapshots/axolotlsay_alias.snap b/cargo-dist/tests/snapshots/axolotlsay_alias.snap
@@ -1171,7 +1171,28 @@ class Axolotlsay < Formula
   end
   license any_of: ["MIT", "Apache-2.0"]
 
-  BINARY_ALIASES = {"aarch64-apple-darwin": {"axolotlsay": ["axolotlsay-link"]}, "x86_64-apple-darwin": {"axolotlsay": ["axolotlsay-link"]}, "x86_64-pc-windows-gnu": {"axolotlsay.exe": ["axolotlsay-link.exe"]}, "x86_64-unknown-linux-gnu": {"axolotlsay": ["axolotlsay-link"]}}
+  BINARY_ALIASES = {
+    "aarch64-apple-darwin": {
+      "axolotlsay": [
+        "axolotlsay-link"
+      ]
+    },
+    "x86_64-apple-darwin": {
+      "axolotlsay": [
+        "axolotlsay-link"
+      ]
+    },
+    "x86_64-pc-windows-gnu": {
+      "axolotlsay.exe": [
+        "axolotlsay-link.exe"
+      ]
+    },
+    "x86_64-unknown-linux-gnu": {
+      "axolotlsay": [
+        "axolotlsay-link"
+      ]
+    }
+  }
 
   def target_triple
     cpu = Hardware::CPU.arm? ? "aarch64" : "x86_64"

diff --git a/cargo-dist/tests/snapshots/axolotlsay_alias_ignores_missing_bins.snap b/cargo-dist/tests/snapshots/axolotlsay_alias_ignores_missing_bins.snap
@@ -1171,7 +1171,32 @@ class Axolotlsay < Formula
   end
   license any_of: ["MIT", "Apache-2.0"]
 
-  BINARY_ALIASES = {"aarch64-apple-darwin": {"nosuchbin": ["axolotlsay-link1", "axolotlsay-link2"]}, "x86_64-apple-darwin": {"nosuchbin": ["axolotlsay-link1", "axolotlsay-link2"]}, "x86_64-pc-windows-gnu": {"nosuchbin.exe": ["axolotlsay-link1.exe", "axolotlsay-link2.exe"]}, "x86_64-unknown-linux-gnu": {"nosuchbin": ["axolotlsay-link1", "axolotlsay-link2"]}}
+  BINARY_ALIASES = {
+    "aarch64-apple-darwin": {
+      "nosuchbin": [
+        "axolotlsay-link1",
+        "axolotlsay-link2"
+      ]
+    },
+    "x86_64-apple-darwin": {
+      "nosuchbin": [
+        "axolotlsay-link1",
+        "axolotlsay-link2"
+      ]
+    },
+    "x86_64-pc-windows-gnu": {
+      "nosuchbin.exe": [
+        "axolotlsay-link1.exe",
+        "axolotlsay-link2.exe"
+      ]
+    },
+    "x86_64-unknown-linux-gnu": {
+      "nosuchbin": [
+        "axolotlsay-link1",
+        "axolotlsay-link2"
+      ]
+    }
+  }
 
   def target_triple
     cpu = Hardware::CPU.arm? ? "aarch64" : "x86_64"

diff --git a/cargo-dist/tests/snapshots/axolotlsay_basic.snap b/cargo-dist/tests/snapshots/axolotlsay_basic.snap
@@ -1159,7 +1159,12 @@ class Axolotlsay < Formula
   end
   license any_of: ["MIT", "Apache-2.0"]
 
-  BINARY_ALIASES = {"aarch64-apple-darwin": {}, "x86_64-apple-darwin": {}, "x86_64-pc-windows-gnu": {}, "x86_64-unknown-linux-gnu": {}}
+  BINARY_ALIASES = {
+    "aarch64-apple-darwin": {},
+    "x86_64-apple-darwin": {},
+    "x86_64-pc-windows-gnu": {},
+    "x86_64-unknown-linux-gnu": {}
+  }
 
   def target_triple
     cpu = Hardware::CPU.arm? ? "aarch64" : "x86_64"

diff --git a/cargo-dist/tests/snapshots/axolotlsay_basic_lies.snap b/cargo-dist/tests/snapshots/axolotlsay_basic_lies.snap
@@ -1162,7 +1162,12 @@ class Axolotlsay < Formula
   end
   license any_of: ["MIT", "Apache-2.0"]
 
-  BINARY_ALIASES = {"aarch64-apple-darwin": {}, "x86_64-apple-darwin": {}, "x86_64-pc-windows-gnu": {}, "x86_64-unknown-linux-gnu": {}}
+  BINARY_ALIASES = {
+    "aarch64-apple-darwin": {},
+    "x86_64-apple-darwin": {},
+    "x86_64-pc-windows-gnu": {},
+    "x86_64-unknown-linux-gnu": {}
+  }
 
   def target_triple
     cpu = Hardware::CPU.arm? ? "aarch64" : "x86_64"

diff --git a/cargo-dist/tests/snapshots/axolotlsay_build_setup_steps.snap b/cargo-dist/tests/snapshots/axolotlsay_build_setup_steps.snap
@@ -1159,7 +1159,12 @@ class Axolotlsay < Formula
   end
   license any_of: ["MIT", "Apache-2.0"]
 
-  BINARY_ALIASES = {"aarch64-apple-darwin": {}, "x86_64-apple-darwin": {}, "x86_64-pc-windows-gnu": {}, "x86_64-unknown-linux-gnu": {}}
+  BINARY_ALIASES = {
+    "aarch64-apple-darwin": {},
+    "x86_64-apple-darwin": {},
+    "x86_64-pc-windows-gnu": {},
+    "x86_64-unknown-linux-gnu": {}
+  }
 
   def target_triple
     cpu = Hardware::CPU.arm? ? "aarch64" : "x86_64"

diff --git a/cargo-dist/tests/snapshots/axolotlsay_custom_formula.snap b/cargo-dist/tests/snapshots/axolotlsay_custom_formula.snap
@@ -22,7 +22,12 @@ class AxolotlBrew < Formula
   end
   license any_of: ["MIT", "Apache-2.0"]
 
-  BINARY_ALIASES = {"aarch64-apple-darwin": {}, "x86_64-apple-darwin": {}, "x86_64-pc-windows-gnu": {}, "x86_64-unknown-linux-gnu": {}}
+  BINARY_ALIASES = {
+    "aarch64-apple-darwin": {},
+    "x86_64-apple-darwin": {},
+    "x86_64-pc-windows-gnu": {},
+    "x86_64-unknown-linux-gnu": {}
+  }
 
   def target_triple
     cpu = Hardware::CPU.arm? ? "aarch64" : "x86_64"

diff --git a/cargo-dist/tests/snapshots/axolotlsay_disable_source_tarball.snap b/cargo-dist/tests/snapshots/axolotlsay_disable_source_tarball.snap
@@ -1159,7 +1159,12 @@ class Axolotlsay < Formula
   end
   license any_of: ["MIT", "Apache-2.0"]
 
-  BINARY_ALIASES = {"aarch64-apple-darwin": {}, "x86_64-apple-darwin": {}, "x86_64-pc-windows-gnu": {}, "x86_64-unknown-linux-gnu": {}}
+  BINARY_ALIASES = {
+    "aarch64-apple-darwin": {},
+    "x86_64-apple-darwin": {},
+    "x86_64-pc-windows-gnu": {},
+    "x86_64-unknown-linux-gnu": {}
+  }
 
   def target_triple
     cpu = Hardware::CPU.arm? ? "aarch64" : "x86_64"

diff --git a/cargo-dist/tests/snapshots/axolotlsay_edit_existing.snap b/cargo-dist/tests/snapshots/axolotlsay_edit_existing.snap
@@ -1159,7 +1159,12 @@ class Axolotlsay < Formula
   end
   license any_of: ["MIT", "Apache-2.0"]
 
-  BINARY_ALIASES = {"aarch64-apple-darwin": {}, "x86_64-apple-darwin": {}, "x86_64-pc-windows-gnu": {}, "x86_64-unknown-linux-gnu": {}}
+  BINARY_ALIASES = {
+    "aarch64-apple-darwin": {},
+    "x86_64-apple-darwin": {},
+    "x86_64-pc-windows-gnu": {},
+    "x86_64-unknown-linux-gnu": {}
+  }
 
   def target_triple
     cpu = Hardware::CPU.arm? ? "aarch64" : "x86_64"

diff --git a/cargo-dist/tests/snapshots/axolotlsay_generic_workspace_basic.snap b/cargo-dist/tests/snapshots/axolotlsay_generic_workspace_basic.snap
@@ -1158,7 +1158,12 @@ class AxolotlsayJs < Formula
   end
   license "MIT-or-Apache2.0"
 
-  BINARY_ALIASES = {"aarch64-apple-darwin": {}, "x86_64-apple-darwin": {}, "x86_64-pc-windows-gnu": {}, "x86_64-unknown-linux-gnu": {}}
+  BINARY_ALIASES = {
+    "aarch64-apple-darwin": {},
+    "x86_64-apple-darwin": {},
+    "x86_64-pc-windows-gnu": {},
+    "x86_64-unknown-linux-gnu": {}
+  }
 
   def target_triple
     cpu = Hardware::CPU.arm? ? "aarch64" : "x86_64"
@@ -2796,7 +2801,12 @@ class Axolotlsay < Formula
   end
   license any_of: ["MIT", "Apache-2.0"]
 
-  BINARY_ALIASES = {"aarch64-apple-darwin": {}, "x86_64-apple-darwin": {}, "x86_64-pc-windows-gnu": {}, "x86_64-unknown-linux-gnu": {}}
+  BINARY_ALIASES = {
+    "aarch64-apple-darwin": {},
+    "x86_64-apple-darwin": {},
+    "x86_64-pc-windows-gnu": {},
+    "x86_64-unknown-linux-gnu": {}
+  }
 
   def target_triple
     cpu = Hardware::CPU.arm? ? "aarch64" : "x86_64"

diff --git a/cargo-dist/tests/snapshots/axolotlsay_homebrew_packages.snap b/cargo-dist/tests/snapshots/axolotlsay_homebrew_packages.snap
@@ -1159,7 +1159,12 @@ class Axolotlsay < Formula
   end
   license any_of: ["MIT", "Apache-2.0"]
 
-  BINARY_ALIASES = {"aarch64-apple-darwin": {}, "x86_64-apple-darwin": {}, "x86_64-pc-windows-gnu": {}, "x86_64-unknown-linux-gnu": {}}
+  BINARY_ALIASES = {
+    "aarch64-apple-darwin": {},
+    "x86_64-apple-darwin": {},
+    "x86_64-pc-windows-gnu": {},
+    "x86_64-unknown-linux-gnu": {}
+  }
 
   def target_triple
     cpu = Hardware::CPU.arm? ? "aarch64" : "x86_64"