Add more tests to check ruby_binary rule

Author: yugui

ruby/tests/BUILD.bazel

@@ -4,6 +4,45 @@ load(
     "ruby_test",
 )
 
+# Checks if args are correctly passed to the ruby script.
+ruby_test(
+    name = "args_check_ruby_test",
+    srcs = ["args_check.rb"],
+    args = [
+        "foo",
+        "bar",
+        "baz",
+    ],
+    main = "args_check.rb",
+)
+
+ruby_binary(
+    name = "args_check",
+    srcs = ["args_check.rb"],
+)
+
+# Checks if a ruby_binary is a valid src in sh_* rules
+sh_test(
+    name = "args_check_sh_test",
+    srcs = ["args_check"],
+    args = [
+        "foo",
+        "bar",
+        "baz",
+    ],
+)
+
+ruby_test(
+    name = "include_order_check",
+    srcs = ["include_order_check.rb"],
+    deps = [
+        "//ruby/tests/testdata:a",
+        "//ruby/tests/testdata:b",
+        "//ruby/tests/testdata:c",
+        "//ruby/tests/testdata:f",
+    ],
+)
+
 # Tests if :ruby_bin can run in sh_binary
 sh_test(
     name = "runtime_run_ruby_test",
@@ -36,46 +75,52 @@ genrule(
         "@org_ruby_lang_ruby_host//:ruby_bin",
         "@org_ruby_lang_ruby_host//:runtime",
     ],
+    message = "Running ruby_bin in genrule",
 )
 
 sh_test(
     name = "genrule_run_ruby_test",
     srcs = ["genrules_run_ruby_test.sh"],
 )
 
-ruby_binary(
-    name = "args_check",
-    srcs = ["args_check.rb"],
-)
-
-sh_test(
-    name = "args_test",
-    srcs = ["args_check"],
-    args = [
-        "foo",
-        "bar",
-        "baz",
-    ],
-)
+## Runfiles resolution tests
+#
+# As explained in
+#   https://github.com/bazelbuild/rules_nodejs/blob/be7232ecfd487432072938f3a39886be32f02606/internal/node/node_launcher.sh#L49,
+# the runfiles resolution in a program X need to support the following cases
+#
+#   1a) directly by a user, with $0 in the output tree
+#   1b) via 'bazel run' (similar to case 1a)
+#   2) directly by a user, with $0 in X's runfiles
+#   3) by another program Y which has a data dependency on X, with $0 in Y's
+#      runfiles
+#   4a) via 'bazel test'
+#   4b) case 3 in the context of a test
+#   5a) by a genrule cmd, with $0 in the output tree
+#   6a) case 3 in the context of a genrule
+#
+# Also all of the cases above must correctly configure environment variables
+# so that their subprocesses whose binaries are generated by Bazel can run with
+# their runfiles.
 
 ruby_binary(
-    name = "include_order_check",
-    srcs = ["include_order_check.rb"],
+    name = "load_path_in_runfiles",
+    srcs = ["load_path_in_runfiles_test.rb"],
+    main = "load_path_in_runfiles_test.rb",
     deps = [
-        "//ruby/tests/testdata:a",
-        "//ruby/tests/testdata:b",
-        "//ruby/tests/testdata:c",
-        "//ruby/tests/testdata:f",
+        "//ruby/tests/testdata:g",
+        "@bazelruby_ruby_rules_ruby_tests_testdata_another_workspace//baz/qux:j",
     ],
 )
 
-sh_test(
-    name = "include_order_test",
-    srcs = ["include_order_check"],
+sh_binary(
+    name = "load_path_in_runfiles_sh_binary",
+    srcs = [":load_path_in_runfiles"],
 )
 
+# runfiles resolution test (case 4a)
 ruby_test(
-    name = "load_path_in_runfiles",
+    name = "load_path_in_runfiles_test_4a",
     srcs = ["load_path_in_runfiles_test.rb"],
     main = "load_path_in_runfiles_test.rb",
     deps = [
@@ -84,6 +129,46 @@ ruby_test(
     ],
 )
 
+# runfiles resolution test (case 4b)
+sh_test(
+    name = "load_path_in_runfiles_test_4b",
+    srcs = ["load_path_in_runfiles_test_3.sh"],
+    data = [":load_path_in_runfiles_sh_binary"],
+)
+
+genrule(
+    name = "generate_loadpath_test_driver_3",
+    outs = ["load_path_in_runfiles_test_3.sh"],
+    cmd = " && ".join([
+        "echo '#!/bin/sh -e' > $@",
+        "echo 'exec ruby/tests/load_path_in_runfiles' >> $@",
+    ]),
+    executable = True,
+)
+
+# runfiles resolution test (case 5a)
+sh_test(
+    name = "load_path_in_runfiles_test_5a",
+    srcs = ["load_path_in_runfiles_test_5a.sh"],
+)
+
+genrule(
+    name = "dummy_genfile_load_path_in_runfiles",
+    message = "Running :load_path_in_runfiles in genrule",
+    outs = ["load_path_in_runfiles_test_5a.sh"],
+    tools = [":load_path_in_runfiles"],
+    cmd = " && ".join([
+        "$(location :load_path_in_runfiles)",
+        "echo '#!/bin/sh -e' > $@",
+        "echo 'true' >> $@",
+    ]),
+    executable = True,
+)
+
+# TODO(yugui) Add a test for case 6a.
+
+## end of Runfiles resolution tests
+
 cc_binary(
     name = "example_ext.so",
     testonly = True,