Expose rake, erb and other commands as sh_binary (#28)

* Add binaries from default gems into the host_runtime

* Add tests for run bundled commands

* Ran buildifier before buildifier-check 2 fix tests

Author: yugui

Gemfile.lock

@@ -26,4 +26,4 @@ DEPENDENCIES
   rubocop (~> 0.76.0)
 
 BUNDLED WITH
-   1.17.3
+   2.0.2

ruby/private/BUILD.host_runtime.tpl

@@ -27,6 +27,36 @@ sh_binary(
     data = [":runtime"],
 )
 
+sh_binary(
+    name = "irb",
+    srcs = ["irb_bin"],
+)
+
+sh_binary(
+    name = "erb",
+    srcs = ["erb_bin"],
+)
+
+sh_binary(
+    name = "rake",
+    srcs = ["rake_bin"],
+)
+
+sh_binary(
+    name = "rdoc",
+    srcs = ["rdoc_bin"],
+)
+
+sh_binary(
+    name = "ri",
+    srcs = ["ri_bin"],
+)
+
+sh_binary(
+    name = "gem",
+    srcs = ["gem_bin"],
+)
+
 cc_import(
     name = "libruby",
     hdrs = glob({hdrs}),

ruby/private/host_runtime.bzl

@@ -37,9 +37,41 @@ def _install_dirs(ctx, ruby, *names):
             ctx.symlink(path, rel_path)
     return rel_paths
 
+def _bin_install_path(ctx, ruby, bin):
+    """Transform the given command name "bin" to actual file name.
+
+    Uses the same logic as "script_installer" in tools/rbinstall.rb in Ruby.
+    But it does not currently support RbConfig::CONFIG['program_transform_name']
+    """
+    install_name = ruby.expand_rbconfig(ruby, "${bindir}/${ruby_install_name}")
+    path = install_name.replace("ruby", bin, 1)
+    if ctx.path(path).exists:
+        return path
+
+    path = ruby.expand_rbconfig(ruby, "${bindir}/%s" % bin)
+    if ctx.path(path).exists:
+        return path
+    else:
+        return ctx.which(bin)
+
+# Commands installed together with ruby command.
+_DEFAULT_SCRIPTS = [
+    "irb",
+    "rdoc",
+    "ri",
+    "erb",
+    "rake",
+    "gem",
+]
+
 def _install_host_ruby(ctx, ruby):
     # Places SDK
     ctx.symlink(ruby.interpreter_realpath, ruby.rel_interpreter_path)
+    for bin_name in _DEFAULT_SCRIPTS:
+        script_path = _bin_install_path(ctx, ruby, bin_name)
+        if not script_path:
+            fail("Failed to locate %s" % bin_name)
+        ctx.symlink(script_path, "%s_bin" % bin_name)
 
     # Places the interpreter at a predictable place regardless of the actual binary name
     # so that bundle_install can depend on it.
@@ -67,8 +99,8 @@ def _install_host_ruby(ctx, ruby):
 
     return struct(
         includedirs = _install_dirs(ctx, ruby, "rubyarchhdrdir", "rubyhdrdir"),
-        static_library = _relativate(static_library),
         shared_library = _relativate(shared_library),
+        static_library = _relativate(static_library),
     )
 
 def _ruby_host_runtime_impl(ctx):
@@ -107,7 +139,6 @@ def _ruby_host_runtime_impl(ctx):
     )
 
 ruby_host_runtime = repository_rule(
-    implementation = _ruby_host_runtime_impl,
     attrs = {
         "interpreter_path": attr.string(),
         "_install_bundler": attr.label(
@@ -129,4 +160,5 @@ ruby_host_runtime = repository_rule(
             allow_single_file = True,
         ),
     },
+    implementation = _ruby_host_runtime_impl,
 )

ruby/tests/BUILD.bazel

@@ -264,3 +264,70 @@ sh_test(
     data = [":load_path_in_runfiles_container_image"],
     tags = ["docker"],
 )
+
+## Tests for bundled commands in the runtime
+
+ruby_binary(
+    name = "diff_test",
+    srcs = ["diff_test.rb"],
+)
+
+sh_test(
+    name = "irb_test",
+    srcs = [":diff_test"],
+    args = [
+        "--stdin",
+        "$(location //ruby/tests/testdata:bundled_commands/irb_input)",
+        "--golden",
+        "$(location //ruby/tests/testdata:bundled_commands/irb_golden)",
+        "--",
+        "$(location @org_ruby_lang_ruby_host//:irb)",
+        "--echo",
+        "--noverbose",
+        "--prompt=simple",
+        "--noreadline",
+    ],
+    data = [
+        "//ruby/tests/testdata:bundled_commands/irb_golden",
+        "//ruby/tests/testdata:bundled_commands/irb_input",
+        "@org_ruby_lang_ruby_host//:irb",
+    ],
+)
+
+sh_test(
+    name = "erb_test",
+    srcs = [":diff_test"],
+    args = [
+        "--stdin",
+        "$(location //ruby/tests/testdata:bundled_commands/erb_input)",
+        "--golden",
+        "$(location //ruby/tests/testdata:bundled_commands/erb_golden)",
+        "--",
+        "$(location @org_ruby_lang_ruby_host//:erb)",
+        "values=foo,bar,baz",
+    ],
+    data = [
+        "//ruby/tests/testdata:bundled_commands/erb_golden",
+        "//ruby/tests/testdata:bundled_commands/erb_input",
+        "@org_ruby_lang_ruby_host//:erb",
+    ],
+)
+
+sh_test(
+    name = "rake_test",
+    srcs = [":diff_test"],
+    args = [
+        "--golden",
+        "$(location //ruby/tests/testdata:bundled_commands/rake_golden)",
+        "--",
+        "$(location @org_ruby_lang_ruby_host//:rake)",
+        "-f",
+        "$(location //ruby/tests/testdata:bundled_commands/rake_input)",
+        "foo",
+    ],
+    data = [
+        "//ruby/tests/testdata:bundled_commands/rake_golden",
+        "//ruby/tests/testdata:bundled_commands/rake_input",
+        "@org_ruby_lang_ruby_host//:rake",
+    ],
+)

ruby/tests/diff_test.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby -w
+# frozen_string_literal: true
+
+require 'optparse'
+
+def parse_flags(args)
+  stdin = IO::NULL
+  golden = nil
+  parser = OptionParser.new do |opts|
+    opts.on('--stdin=PATH') do |v|
+      stdin = v
+    end
+
+    opts.on('--golden=PATH') do |v|
+      golden = v
+    end
+  end
+  args = parser.parse(args)
+
+  [args, stdin, golden]
+end
+
+def main(args)
+  args, stdin, golden = parse_flags(args)
+  args << { in: stdin }
+  stdout = IO.popen(args, &:read)
+
+  IO.popen(['diff', '-B', '-c', golden, '-'], 'w') { |io| io << stdout }
+  exit $?.exitstatus
+end
+
+if $0 == __FILE__
+  main(ARGV)
+end

ruby/tests/testdata/BUILD.bazel

@@ -5,6 +5,15 @@ load(
 
 package(default_visibility = ["//ruby/tests:__pkg__"])
 
+exports_files([
+    "bundled_commands/erb_golden",
+    "bundled_commands/erb_input",
+    "bundled_commands/irb_golden",
+    "bundled_commands/irb_input",
+    "bundled_commands/rake_golden",
+    "bundled_commands/rake_input",
+])
+
 #
 # Dependency Graph::
 #

ruby/tests/testdata/bundled_commands/erb_golden

@@ -0,0 +1,3 @@
+foo
+bar
+baz

ruby/tests/testdata/bundled_commands/erb_input

@@ -0,0 +1,3 @@
+% values.split(',').each do |value|
+<%= value %>
+% end

ruby/tests/testdata/bundled_commands/irb_golden

@@ -0,0 +1,2 @@
+=> T
+=> #<struct T a=1, b=2, c=3>

ruby/tests/testdata/bundled_commands/irb_input

@@ -0,0 +1,2 @@
+T = Struct.new(:a, :b, :c)
+T.new(1, 2, 3)