Merge pull request #15861 from samford/node-add-shebang-rewriting

node: add shebang rewriting
This commit is contained in:
Mike McQuaid 2023-08-15 11:39:13 +01:00 committed by GitHub
commit 8c460bdde6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 226 additions and 32 deletions

View File

@ -85,5 +85,35 @@ module Language
--#{npm_cache_config}
]
end
# Mixin module for {Formula} adding shebang rewrite features.
module Shebang
module_function
# A regex to match potential shebang permutations.
NODE_SHEBANG_REGEX = %r{^#! ?/usr/bin/(?:env )?node( |$)}.freeze
# The length of the longest shebang matching `SHEBANG_REGEX`.
NODE_SHEBANG_MAX_LENGTH = "#! /usr/bin/env node ".length
# @private
sig { params(node_path: T.any(String, Pathname)).returns(Utils::Shebang::RewriteInfo) }
def node_shebang_rewrite_info(node_path)
Utils::Shebang::RewriteInfo.new(
NODE_SHEBANG_REGEX,
NODE_SHEBANG_MAX_LENGTH,
"#{node_path}\\1",
)
end
sig { params(formula: T.untyped).returns(Utils::Shebang::RewriteInfo) }
def detected_node_shebang(formula = self)
node_deps = formula.deps.map(&:name).grep(/^node(@.+)?$/)
raise ShebangDetectionError.new("Node", "formula does not depend on Node") if node_deps.empty?
raise ShebangDetectionError.new("Node", "formula has multiple Node dependencies") if node_deps.length > 1
node_shebang_rewrite_info(Formula[node_deps.first].opt_bin/"node")
end
end
end
end

View File

@ -0,0 +1,9 @@
# typed: strict
module Language
module Node
module Shebang
include Kernel
end
end
end

View File

@ -10,24 +10,35 @@ module Language
module Shebang
module_function
def detected_perl_shebang(formula = self)
perl_deps = formula.declared_deps.select { |dep| dep.name == "perl" }
perl_path = if perl_deps.present?
if perl_deps.any? { |dep| !dep.uses_from_macos? || !dep.use_macos_install? }
Formula["perl"].opt_bin/"perl"
else
"/usr/bin/perl#{MacOS.preferred_perl_version}"
end
else
raise ShebangDetectionError.new("Perl", "formula does not depend on Perl")
end
# A regex to match potential shebang permutations.
PERL_SHEBANG_REGEX = %r{^#! ?/usr/bin/(?:env )?perl( |$)}.freeze
# The length of the longest shebang matching `SHEBANG_REGEX`.
PERL_SHEBANG_MAX_LENGTH = "#! /usr/bin/env perl ".length
# @private
sig { params(perl_path: T.any(String, Pathname)).returns(Utils::Shebang::RewriteInfo) }
def perl_shebang_rewrite_info(perl_path)
Utils::Shebang::RewriteInfo.new(
%r{^#! ?/usr/bin/(?:env )?perl( |$)},
21, # the length of "#! /usr/bin/env perl "
PERL_SHEBANG_REGEX,
PERL_SHEBANG_MAX_LENGTH,
"#{perl_path}\\1",
)
end
sig { params(formula: T.untyped).returns(Utils::Shebang::RewriteInfo) }
def detected_perl_shebang(formula = self)
perl_deps = formula.declared_deps.select { |dep| dep.name == "perl" }
raise ShebangDetectionError.new("Perl", "formula does not depend on Perl") if perl_deps.empty?
perl_path = if perl_deps.any? { |dep| !dep.uses_from_macos? || !dep.use_macos_install? }
Formula["perl"].opt_bin/"perl"
else
"/usr/bin/perl#{MacOS.preferred_perl_version}"
end
perl_shebang_rewrite_info(perl_path)
end
end
end
end

View File

@ -94,21 +94,28 @@ module Language
module Shebang
module_function
# A regex to match potential shebang permutations.
PYTHON_SHEBANG_REGEX = %r{^#! ?/usr/bin/(?:env )?python(?:[23](?:\.\d{1,2})?)?( |$)}.freeze
# The length of the longest shebang matching `SHEBANG_REGEX`.
PYTHON_SHEBANG_MAX_LENGTH = "#! /usr/bin/env pythonx.yyy ".length
# @private
sig { params(python_path: T.any(String, Pathname)).returns(Utils::Shebang::RewriteInfo) }
def python_shebang_rewrite_info(python_path)
Utils::Shebang::RewriteInfo.new(
%r{^#! ?/usr/bin/(?:env )?python(?:[23](?:\.\d{1,2})?)?( |$)},
28, # the length of "#! /usr/bin/env pythonx.yyy "
PYTHON_SHEBANG_REGEX,
PYTHON_SHEBANG_MAX_LENGTH,
"#{python_path}\\1",
)
end
sig { params(formula: T.untyped, use_python_from_path: T::Boolean).returns(Utils::Shebang::RewriteInfo) }
def detected_python_shebang(formula = self, use_python_from_path: false)
python_path = if use_python_from_path
"/usr/bin/env python3"
else
python_deps = formula.deps.map(&:name).grep(/^python(@.*)?$/)
raise ShebangDetectionError.new("Python", "formula does not depend on Python") if python_deps.empty?
if python_deps.length > 1
raise ShebangDetectionError.new("Python", "formula has multiple Python dependencies")

View File

@ -0,0 +1,71 @@
# frozen_string_literal: true
require "language/node"
require "utils/shebang"
describe Language::Node::Shebang do
let(:file) { Tempfile.new("node-shebang") }
let(:f) do
f = {}
f[:node18] = formula "node@18" do
url "https://brew.sh/node-18.0.0.tgz"
end
f[:versioned_node_dep] = formula "foo" do
url "https://brew.sh/foo-1.0.tgz"
depends_on "node@18"
end
f[:no_deps] = formula "foo" do
url "https://brew.sh/foo-1.0.tgz"
end
f[:multiple_deps] = formula "foo" do
url "https://brew.sh/foo-1.0.tgz"
depends_on "node"
depends_on "node@18"
end
f
end
before do
file.write <<~EOS
#!/usr/bin/env node
a
b
c
EOS
file.flush
end
after { file.unlink }
describe "#detected_node_shebang" do
it "can be used to replace Node shebangs" do
allow(Formulary).to receive(:factory)
allow(Formulary).to receive(:factory).with(f[:node18].name).and_return(f[:node18])
Utils::Shebang.rewrite_shebang described_class.detected_node_shebang(f[:versioned_node_dep]), file.path
expect(File.read(file)).to eq <<~EOS
#!#{HOMEBREW_PREFIX/"opt/node@18/bin/node"}
a
b
c
EOS
end
it "errors if formula doesn't depend on node" do
expect { Utils::Shebang.rewrite_shebang described_class.detected_node_shebang(f[:no_deps]), file.path }
.to raise_error(ShebangDetectionError, "Cannot detect Node shebang: formula does not depend on Node.")
end
it "errors if formula depends on more than one node" do
expect { Utils::Shebang.rewrite_shebang described_class.detected_node_shebang(f[:multiple_deps]), file.path }
.to raise_error(ShebangDetectionError, "Cannot detect Node shebang: formula has multiple Node dependencies.")
end
end
end

View File

@ -5,17 +5,30 @@ require "utils/shebang"
describe Language::Perl::Shebang do
let(:file) { Tempfile.new("perl-shebang") }
let(:perl_f) do
formula "perl" do
let(:f) do
f = {}
f[:perl] = formula "perl" do
url "https://brew.sh/perl-1.0.tgz"
end
end
let(:f) do
formula "foo" do
f[:depends_on] = formula "foo" do
url "https://brew.sh/foo-1.0.tgz"
depends_on "perl"
end
f[:uses_from_macos] = formula "foo" do
url "https://brew.sh/foo-1.0.tgz"
uses_from_macos "perl"
end
f[:no_deps] = formula "foo" do
url "https://brew.sh/foo-1.0.tgz"
end
f
end
before do
@ -31,10 +44,23 @@ describe Language::Perl::Shebang do
after { file.unlink }
describe "#detected_perl_shebang" do
it "can be used to replace Perl shebangs" do
it "can be used to replace Perl shebangs when depends_on \"perl\" is used" do
allow(Formulary).to receive(:factory)
allow(Formulary).to receive(:factory).with(perl_f.name).and_return(perl_f)
Utils::Shebang.rewrite_shebang described_class.detected_perl_shebang(f), file.path
allow(Formulary).to receive(:factory).with(f[:perl].name).and_return(f[:perl])
Utils::Shebang.rewrite_shebang described_class.detected_perl_shebang(f[:depends_on]), file.path
expect(File.read(file)).to eq <<~EOS
#!#{HOMEBREW_PREFIX}/opt/perl/bin/perl
a
b
c
EOS
end
it "can be used to replace Perl shebangs when uses_from_macos \"perl\" is used" do
allow(Formulary).to receive(:factory)
allow(Formulary).to receive(:factory).with(f[:perl].name).and_return(f[:perl])
Utils::Shebang.rewrite_shebang described_class.detected_perl_shebang(f[:uses_from_macos]), file.path
expected_shebang = if OS.mac?
"/usr/bin/perl#{MacOS.preferred_perl_version}"
@ -49,5 +75,10 @@ describe Language::Perl::Shebang do
c
EOS
end
it "errors if formula doesn't depend on perl" do
expect { Utils::Shebang.rewrite_shebang described_class.detected_perl_shebang(f[:no_deps]), file.path }
.to raise_error(ShebangDetectionError, "Cannot detect Perl shebang: formula does not depend on Perl.")
end
end
end

View File

@ -5,17 +5,31 @@ require "utils/shebang"
describe Language::Python::Shebang do
let(:file) { Tempfile.new("python-shebang") }
let(:python_f) do
formula "python@3.11" do
let(:f) do
f = {}
f[:python311] = formula "python@3.11" do
url "https://brew.sh/python-1.0.tgz"
end
end
let(:f) do
formula "foo" do
f[:versioned_python_dep] = formula "foo" do
url "https://brew.sh/foo-1.0.tgz"
depends_on "python@3.11"
end
f[:no_deps] = formula "foo" do
url "https://brew.sh/foo-1.0.tgz"
end
f[:multiple_deps] = formula "foo" do
url "https://brew.sh/foo-1.0.tgz"
depends_on "python"
depends_on "python@3.11"
end
f
end
before do
@ -33,9 +47,9 @@ describe Language::Python::Shebang do
describe "#detected_python_shebang" do
it "can be used to replace Python shebangs" do
allow(Formulary).to receive(:factory)
allow(Formulary).to receive(:factory).with(python_f.name).and_return(python_f)
allow(Formulary).to receive(:factory).with(f[:python311].name).and_return(f[:python311])
Utils::Shebang.rewrite_shebang(
described_class.detected_python_shebang(f, use_python_from_path: false), file.path
described_class.detected_python_shebang(f[:versioned_python_dep], use_python_from_path: false), file.path
)
expect(File.read(file)).to eq <<~EOS
@ -48,7 +62,7 @@ describe Language::Python::Shebang do
it "can be pointed to a `python3` in PATH" do
Utils::Shebang.rewrite_shebang(
described_class.detected_python_shebang(f, use_python_from_path: true), file.path
described_class.detected_python_shebang(f[:versioned_python_dep], use_python_from_path: true), file.path
)
expect(File.read(file)).to eq <<~EOS
@ -58,5 +72,26 @@ describe Language::Python::Shebang do
c
EOS
end
it "errors if formula doesn't depend on python" do
expect do
Utils::Shebang.rewrite_shebang(
described_class.detected_python_shebang(f[:no_deps], use_python_from_path: false),
file.path,
)
end.to raise_error(ShebangDetectionError, "Cannot detect Python shebang: formula does not depend on Python.")
end
it "errors if formula depends on more than one python" do
expect do
Utils::Shebang.rewrite_shebang(
described_class.detected_python_shebang(f[:multiple_deps], use_python_from_path: false),
file.path,
)
end.to raise_error(
ShebangDetectionError,
"Cannot detect Python shebang: formula has multiple Python dependencies.",
)
end
end
end