Merge pull request #137 from rabbitmq/eunit-rule-target

Generate more compact eunit rules with gazelle

Author: HoloRin

eunit2.bzl

@@ -1,6 +1,5 @@
 load("//private:eunit.bzl", "eunit_test")
 
-# maybe just call this eunit_test, and rename this file?
 def eunit(
         name = "eunit",
         **kwargs):

gazelle/erlang_app.go

@@ -703,7 +703,7 @@ func (erlangApp *ErlangApp) dialyzeRule() *rule.Rule {
 	return r
 }
 
-func (erlangApp *ErlangApp) eunitRule() *rule.Rule {
+func (erlangApp *ErlangApp) EunitRule() *rule.Rule {
 	// eunit_mods is the list of source modules, plus any test module which is
 	// not among the source modules with a "_tests" suffix appended
 	modMap := make(map[string]string)
@@ -736,9 +736,10 @@ func (erlangApp *ErlangApp) eunitRule() *rule.Rule {
 	}
 
 	eunit := rule.NewRule(eunitKind, "eunit")
-	eunit.SetAttr("compiled_suites", compiled_suites.Values(strings.Compare))
-	eunit.SetAttr("eunit_mods", eunit_mods.Values(strings.Compare))
-	eunit.SetAttr("deps", []string{":test_erlang_app"})
+	if !compiled_suites.IsEmpty() {
+		eunit.SetAttr("compiled_suites", compiled_suites.Values(strings.Compare))
+	}
+	eunit.SetAttr("target", ":test_erlang_app")
 
 	return eunit
 }

gazelle/generate.go

@@ -619,7 +619,7 @@ func (erlang *erlangLang) GenerateRules(args language.GenerateArgs) language.Gen
 		maybeAppendRule(erlangConfig, dialyzeRule, &result)
 
 		if erlangApp.hasTestSuites() {
-			eunitRule := erlangApp.eunitRule()
+			eunitRule := erlangApp.EunitRule()
 			maybeAppendRule(erlangConfig, eunitRule, &result)
 
 			ctSuiteRules := erlangApp.CtSuiteRules(testDirBeamFilesRules)

gazelle/kinds.go

@@ -157,13 +157,13 @@ func (l *erlangLang) Kinds() map[string]rule.KindInfo {
 			MatchAny: true,
 			NonEmptyAttrs: map[string]bool{
 				"compiled_suites": true,
-				"eunit_mods":      true,
+				"target":          true,
 				"visibility":      true,
 			},
 			SubstituteAttrs: map[string]bool{},
 			MergeableAttrs: map[string]bool{
 				"compiled_suites": true,
-				"eunit_mods":      true,
+				"target":          true,
 			},
 			ResolveAttrs: map[string]bool{
 				"deps": true,

private/eunit.bzl

@@ -4,7 +4,7 @@ load(
     "path_join",
     "windows_path",
 )
-load(":util.bzl", "erl_libs_contents")
+load(":util.bzl", "erl_libs_contents2")
 load(
     "//tools:erlang_toolchain.bzl",
     "erlang_dirs",
@@ -35,13 +35,37 @@ def package_relative_dirnames(package, files):
             dirs.append(rel)
     return dirs
 
-def _to_atom_list(l):
-    return "[" + ",".join(["'{}'".format(i) for i in l]) + "]"
+def _to_atom_list(atoms):
+    return "[" + ",".join(["'%s'" % a for a in atoms]) + "]"
 
 def _impl(ctx):
+    if ctx.attr.eunit_mods == [] and ctx.attr.target == None:
+        fail("Either eunit_mods or target must be set")
+    if ctx.attr.eunit_mods != [] and ctx.attr.target != None:
+        fail("eunit_mods and target cannot be set simultaneously")
+
+    deps = list(ctx.attr.deps)
+    eunit_mods = list(ctx.attr.eunit_mods)
+    if ctx.attr.target != None:
+        lib_info = ctx.attr.target[ErlangAppInfo]
+        deps.extend(lib_info.deps)
+        for m in lib_info.beam:
+            if m.extension == "beam":
+                module_name = m.basename.removesuffix(".beam")
+                if not module_name.endswith("_tests"):
+                    eunit_mods.append(module_name)
+        for s in ctx.files.compiled_suites:
+            module_name = s.basename.removesuffix(".beam")
+            if not module_name.endswith("_tests"):
+                eunit_mods.append(module_name)
+
     erl_libs_dir = ctx.label.name + "_deps"
 
-    erl_libs_files = erl_libs_contents(ctx, dir = erl_libs_dir)
+    erl_libs_files = erl_libs_contents2(
+        ctx,
+        deps = deps,
+        dir = erl_libs_dir,
+    )
 
     package = ctx.label.package
 
@@ -66,7 +90,9 @@ def _impl(ctx):
 {maybe_install_erlang}
 
 export HOME=${{TEST_TMPDIR}}
-export ERL_LIBS=$TEST_SRCDIR/$TEST_WORKSPACE/{erl_libs_path}
+if [ -n "{erl_libs_path}" ]; then
+    export ERL_LIBS=$TEST_SRCDIR/$TEST_WORKSPACE/{erl_libs_path}
+fi
 
 {test_env}
 
@@ -81,10 +107,10 @@ set -x
 """.format(
             maybe_install_erlang = maybe_install_erlang(ctx, short_path = True),
             erlang_home = erlang_home,
-            erl_libs_path = erl_libs_path,
+            erl_libs_path = erl_libs_path if len(erl_libs_files) > 0 else "",
             package = package,
             pa_args = " ".join(pa_args),
-            eunit_mods_term = _to_atom_list(ctx.attr.eunit_mods),
+            eunit_mods_term = _to_atom_list(eunit_mods),
             eunit_opts_term = eunit_opts_term,
             test_env = "\n".join(test_env_commands),
         )
@@ -95,9 +121,11 @@ set -x
 
         output = ctx.actions.declare_file(ctx.label.name + ".bat")
         script = """@echo off
+if [{erl_libs_path}] == [] goto :env
 REM TEST_SRCDIR is provided by bazel but with unix directory separators
 set ERL_LIBS=%TEST_SRCDIR%/%TEST_WORKSPACE%/{erl_libs_path}
 set ERL_LIBS=%ERL_LIBS:/=\\%
+:env
 
 {test_env}
 
@@ -110,9 +138,9 @@ echo on
 """.format(
             package = package,
             erlang_home = windows_path(erlang_home),
-            erl_libs_path = erl_libs_path,
+            erl_libs_path = erl_libs_path if len(erl_libs_files) > 0 else "",
             pa_args = " ".join(pa_args),
-            eunit_mods_term = _to_atom_list(ctx.attr.eunit_mods),
+            eunit_mods_term = _to_atom_list(eunit_mods),
             eunit_opts_term = eunit_opts_term,
             test_env = "\n".join(test_env_commands),
         )
@@ -131,6 +159,8 @@ echo on
             for tool in ctx.attr.tools
         ],
     )
+    if ctx.attr.target != None:
+        runfiles = runfiles.merge(ctx.attr.target[DefaultInfo].default_runfiles)
 
     return [DefaultInfo(
         runfiles = runfiles,
@@ -143,9 +173,9 @@ eunit_test = rule(
         "is_windows": attr.bool(mandatory = True),
         "compiled_suites": attr.label_list(
             allow_files = [".beam"],
-            mandatory = True,
         ),
-        "eunit_mods": attr.string_list(mandatory = True),
+        "eunit_mods": attr.string_list(),
+        "target": attr.label(providers = [ErlangAppInfo]),
         "eunit_opts": attr.string_list(),
         "data": attr.label_list(allow_files = True),
         "deps": attr.label_list(providers = [ErlangAppInfo]),

test/gazelle/erlang_test.go

@@ -170,8 +170,10 @@ var _ = Describe("an ErlangApp", func() {
 
 		BeforeEach(func() {
 			app.AddFile("src/foo.erl")
+			app.AddFile("src/bar.erl")
 			app.AddFile("test/foo_SUITE.erl")
 			app.AddFile("test/foo_helper.erl")
+			app.AddFile("test/bar_tests.erl")
 
 			fakeParser = fakeErlParser(map[string]*erlang.ErlAttrs{
 				"src/foo.erl": &erlang.ErlAttrs{},
@@ -194,13 +196,26 @@ var _ = Describe("an ErlangApp", func() {
 
 		Describe("TestDirBeamFilesRules", func() {
 			It("Adds runtime deps to the suite", func() {
-				Expect(testDirRules).To(HaveLen(2))
+				Expect(testDirRules).To(HaveLen(3))
+
+				Expect(testDirRules[0].Name()).To(Equal("test_bar_tests_beam"))
 
-				Expect(testDirRules[0].Name()).To(Equal("foo_SUITE_beam_files"))
-				Expect(testDirRules[0].AttrStrings("beam")).To(
+				Expect(testDirRules[1].Name()).To(Equal("foo_SUITE_beam_files"))
+				Expect(testDirRules[1].AttrStrings("beam")).To(
 					ContainElements("ebin/foo.beam"))
 
-				Expect(testDirRules[1].Name()).To(Equal("test_foo_helper_beam"))
+				Expect(testDirRules[2].Name()).To(Equal("test_foo_helper_beam"))
+			})
+		})
+
+		Describe("EunitRule", func() {
+			It("Adds runtime deps to the suite", func() {
+				r := app.EunitRule()
+
+				Expect(r.Name()).To(Equal("eunit"))
+				Expect(r.AttrStrings("compiled_suites")).To(
+					ContainElements(":test_foo_helper_beam"))
+				Expect(r.AttrString("target")).To(Equal(":test_erlang_app"))
 			})
 		})
 

test/gazelle/testdata/basic_rebar/BUILD.out

@@ -255,15 +255,7 @@ eunit(
         ":test_seshat_counters_server_test_beam",
         ":test_seshat_test_beam",
     ],
-    eunit_mods = [
-        "seshat",
-        "seshat_app",
-        "seshat_counters_server",
-        "seshat_counters_server_test",
-        "seshat_sup",
-        "seshat_test",
-    ],
-    deps = [":test_erlang_app"],
+    target = ":test_erlang_app",
 )
 
 assert_suites2()

test/gazelle/testdata/basic_rebar_gen_macro/BUILD.out

@@ -110,15 +110,7 @@ eunit(
         ":test_seshat_counters_server_test_beam",
         ":test_seshat_test_beam",
     ],
-    eunit_mods = [
-        "seshat",
-        "seshat_app",
-        "seshat_counters_server",
-        "seshat_counters_server_test",
-        "seshat_sup",
-        "seshat_test",
-    ],
-    deps = [":test_erlang_app"],
+    target = ":test_erlang_app",
 )
 
 assert_suites2()

test/gazelle/testdata/rebar_with_ct_suites/BUILD.out

@@ -91,25 +91,7 @@ dialyze(
 
 eunit(
     name = "eunit",
-    compiled_suites = [],
-    eunit_mods = [
-        "osiris",
-        "osiris_app",
-        "osiris_bench",
-        "osiris_counters",
-        "osiris_log",
-        "osiris_log_shared",
-        "osiris_replica",
-        "osiris_replica_reader",
-        "osiris_replica_reader_sup",
-        "osiris_retention",
-        "osiris_server_sup",
-        "osiris_sup",
-        "osiris_tracking",
-        "osiris_util",
-        "osiris_writer",
-    ],
-    deps = [":test_erlang_app"],
+    target = ":test_erlang_app",
 )
 
 ct_test(