Introducing ruby_rspec_test and a bunch of others

 * refactoring rules
 * moving some definitions to constants

Author: Konstantin Gredeskoul

.circleci/config.yml

@@ -68,17 +68,25 @@ jobs:
       - run:
           name: "Bazel Simple Script Example Build"
           command: |
-            cd examples/simple_script && bazel ${BAZEL_OPTS} build ${BAZEL_BUILD_OPTS} -- //...
+            cd examples/simple_script && bazel ${BAZEL_OPTS} build ${BAZEL_BUILD_OPTS} -- :all
+
+      - run:
+          name: "Bazel Simple Script Example Rubocop Check"
+          command: |
+            cd examples/simple_script && bazel ${BAZEL_OPTS} run ${BAZEL_BUILD_OPTS} -- :rubocop || true
 
       - run:
           name: "Bazel Simple Script Example Test"
           command: |
-            cd examples/simple_script && bazel ${BAZEL_OPTS} test ${BAZEL_BUILD_OPTS} ${BAZEL_TEST_OPTS} -- //...
+            cd examples/simple_script
+            bazel ${BAZEL_OPTS} test -s --verbose_failures --sandbox_debug \
+              --test_output=streamed --test_verbose_timeout_warnings :all-specs
 
       - run:
-          name: "Bazel Simple Script Example Rubocop Check"
+          name: "Print output log"
           command: |
-            cd examples/simple_script && bazel ${BAZEL_OPTS} run ${BAZEL_BUILD_OPTS} -- :rubocop
+            cat /home/circleci/.cache/bazel/_bazel_circleci/86ef9d8d260271208b18f4c01debfa13/execroot/bazelruby_ruby_rules_example/bazel-out/k8-fastbuild/testlogs/all-specs/test.log
+
 
   buildifier:
     <<: *bazel_defaults

WORKSPACE

@@ -1,11 +1,9 @@
 workspace(name = "bazelruby_ruby_rules")
 
-load("@//ruby:deps.bzl", "ruby_register_toolchains", "ruby_rules_dependencies")
+load("@//ruby/private:dependencies.bzl", "ruby_rules_dependencies")
 
 ruby_rules_dependencies()
 
-ruby_register_toolchains()
-
 load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
 
 bazel_skylib_workspace()
@@ -14,6 +12,10 @@ load("@bazel_skylib//lib:versions.bzl", "versions")
 
 versions.check("1.2.1")
 
+load("@//ruby:deps.bzl", "ruby_register_toolchains")
+
+ruby_register_toolchains()
+
 local_repository(
     name = "bazelruby_ruby_rules_ruby_tests_testdata_another_workspace",
     path = "ruby/tests/testdata/another_workspace",

bin/test-suite

@@ -148,7 +148,8 @@ test::simple-script() {
   __test::exec simple-script "
     cd examples/simple_script
     ${Bazel__BuildSteps}
-    bazel ${BAZEL_OPTS} run ${BAZEL_BUILD_OPTS} -- :rubocop ;
+    bazel ${BAZEL_OPTS} build ${BAZEL_BUILD_OPTS} :all; 
+    bazel ${BAZEL_OPTS} test ${BAZEL_BUILD_OPTS} :all-specs
   "
 }
 

examples/simple_script/BUILD

@@ -4,6 +4,7 @@ load(
     "@bazelruby_ruby_rules//ruby:defs.bzl",
     "ruby_binary",
     "ruby_library",
+    "ruby_rspec_test",
     "ruby_test",
 )
 
@@ -32,24 +33,46 @@ ruby_binary(
 )
 
 ruby_test(
-    name = "rspec",
+    name = "all-specs",
     timeout = "short",
-    srcs = [
+    srcs = glob([
         "script.rb",
-        "spec/lib/foo_spec.rb",
-        "spec/script_spec.rb",
-        "spec/spec_helper.rb",
-        "@bundle//:bin/rspec",
-    ],
+        "spec/**/*.rb",
+        "lib/**/*.rb",
+    ]),
     args = [
-        "spec",
+        "--format documentation",
+        "--force-color",
+        "spec/spec_helper.rb",
+        "spec/script_spec.rb",
+        "spec/lib/foo_spec.rb",
     ],
     includes = [
         ".",
         "lib",
         "spec",
     ],
     main = "spec/spec_helper.rb",
+    rubyopt = ["-rrspec/autorun"],
+    deps = [
+        "//lib:foo",
+        "@bundle//:awesome_print",
+        "@bundle//:colored2",
+        "@bundle//:rspec",
+        "@bundle//:rspec-its",
+    ],
+)
+
+ruby_rspec_test(
+    name = "all-rspecs",
+    srcs = [
+        "script.rb",
+        "spec/lib/foo_spec.rb",
+        "spec/script_spec.rb",
+        "spec/spec_helper.rb",
+    ],
+    rubyopt = ["-rrspec/autorun"],
+    spec_target = "spec/script_spec.rb",
     deps = [
         "//lib:foo",
         "@bundle//:awesome_print",
@@ -59,7 +82,6 @@ ruby_test(
     ],
 )
 
-# TODO: not the best way of defining this, should make `rubocop` rule like `buildifier`
 ruby_binary(
     name = "rubocop",
     srcs = [

examples/simple_script/WORKSPACE

@@ -8,19 +8,23 @@ local_repository(
 )
 
 load(
-    "@bazelruby_ruby_rules//ruby:deps.bzl",
-    "ruby_register_toolchains",
+    "@bazelruby_ruby_rules//ruby/private:dependencies.bzl",
     "ruby_rules_dependencies",
 )
 
 ruby_rules_dependencies()
 
-ruby_register_toolchains(version = "2.6.5")
-
 load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
 
 bazel_skylib_workspace()
 
+load(
+    "@bazelruby_ruby_rules//ruby:deps.bzl",
+    "ruby_register_toolchains",
+)
+
+ruby_register_toolchains(version = "2.6.5")
+
 load("@bazelruby_ruby_rules//ruby:defs.bzl", "bundle_install")
 
 bundle_install(

examples/simple_script/script.rb

@@ -11,5 +11,3 @@ def oss_rand
 end
 
 puts Foo.aha + ' ' + oss_rand
-
-ap Class.to_s

ruby/defs.bzl

@@ -15,10 +15,15 @@ load(
     "@bazelruby_ruby_rules//ruby/private:bundle.bzl",
     _ruby_bundle = "ruby_bundle",
 )
+load(
+    "@bazelruby_ruby_rules//ruby/private:rspec.bzl",
+    _ruby_rspec_test = "ruby_rspec_test",
+)
 
 ruby_toolchain = _toolchain
 ruby_library = _library
 ruby_binary = _binary
 ruby_test = _test
+ruby_rspec_test = _ruby_rspec_test
 bundle_install = _ruby_bundle
 ruby_bundle = _ruby_bundle

ruby/private/binary.bzl

@@ -1,5 +1,4 @@
-load(":constants.bzl", "TOOLCHAIN_TYPE_NAME")
-load(":providers.bzl", "RubyLibrary")
+load(":constants.bzl", "RUBY_ATTRS", "TOOLCHAIN_TYPE_NAME")
 load(
     "//ruby/private/tools:deps.bzl",
     _transitive_deps = "transitive_deps",
@@ -11,14 +10,19 @@ def _to_manifest_path(ctx, file):
     else:
         return ("%s/%s" % (ctx.workspace_name, file.short_path))
 
-def _ruby_binary_impl(ctx):
+# Having this function allows us to override otherwise frozen attributes
+# such as main, srcs and deps. We use this in ruby_rspec_test rule by
+# adding rspec as a main, and sources, and rspec gem as a dependency.
+#
+# There could be similar situations in the future where we might want
+# to create a rule (eg, rubocop) that does exactly the same.
+def ruby_binary_macro(ctx, main, srcs, deps, args):
     sdk = ctx.toolchains[TOOLCHAIN_TYPE_NAME].ruby_runtime
     interpreter = sdk.interpreter[DefaultInfo].files_to_run.executable
 
-    main = ctx.file.main
     if not main:
         expected_name = "%s.rb" % ctx.attr.name
-        for f in ctx.attr.srcs:
+        for f in srcs:
             if f.label.name == expected_name:
                 main = f.files.to_list()[0]
                 break
@@ -30,6 +34,7 @@ def _ruby_binary_impl(ctx):
         )
 
     executable = ctx.actions.declare_file(ctx.attr.name)
+
     deps = _transitive_deps(
         ctx,
         extra_files = [executable],
@@ -55,41 +60,25 @@ def _ruby_binary_impl(ctx):
         data_runfiles = deps.data_files,
     )]
 
-_ATTRS = {
-    "srcs": attr.label_list(
-        allow_files = True,
-    ),
-    "deps": attr.label_list(
-        providers = [RubyLibrary],
-    ),
-    "includes": attr.string_list(),
-    "rubyopt": attr.string_list(),
-    "data": attr.label_list(
-        allow_files = True,
-    ),
-    "main": attr.label(
-        allow_single_file = True,
-    ),
-    "_wrapper_template": attr.label(
-        allow_single_file = True,
-        default = "binary_wrapper.tpl",
-    ),
-    "_misc_deps": attr.label_list(
-        allow_files = True,
-        default = ["@bazel_tools//tools/bash/runfiles"],
-    ),
-}
+def ruby_binary_impl(ctx):
+    return ruby_binary_macro(
+        ctx,
+        ctx.file.main,
+        ctx.attr.srcs,
+        ctx.attr.deps,
+        ctx.attr.args,
+    )
 
 ruby_binary = rule(
-    implementation = _ruby_binary_impl,
-    attrs = _ATTRS,
+    implementation = ruby_binary_impl,
+    attrs = RUBY_ATTRS,
     executable = True,
     toolchains = [TOOLCHAIN_TYPE_NAME],
 )
 
 ruby_test = rule(
-    implementation = _ruby_binary_impl,
-    attrs = _ATTRS,
+    implementation = ruby_binary_impl,
+    attrs = RUBY_ATTRS,
     test = True,
     toolchains = [TOOLCHAIN_TYPE_NAME],
 )