Introduce "runnables-recipe" resolver

This is an extension of the "runnable-recipe" feature, allowing not
just one, but many runnables to be defined in a single JSON file.

Signed-off-by: Cleber Rosa <[email protected]>

Author: clebergnu

avocado/core/nrunner/runnable.py

@@ -259,6 +259,25 @@ def _validate_recipe(cls, recipe):
                     "Additional properties are not allowed"
                 )
 
+    @classmethod
+    def from_dict(cls, recipe_dict):
+        """
+        Returns a runnable from a runnable dictionary
+
+        :param recipe_dict: a dictionary with runnable keys and values
+
+        :rtype: instance of :class:`Runnable`
+        """
+        cls._validate_recipe(recipe_dict)
+        config = ConfigDecoder.decode_set(recipe_dict.get("config", {}))
+        return cls.from_avocado_config(
+            recipe_dict.get("kind"),
+            recipe_dict.get("uri"),
+            *recipe_dict.get("args", ()),
+            config=config,
+            **recipe_dict.get("kwargs", {}),
+        )
+
     @classmethod
     def from_recipe(cls, recipe_path):
         """
@@ -269,16 +288,8 @@ def from_recipe(cls, recipe_path):
         :rtype: instance of :class:`Runnable`
         """
         with open(recipe_path, encoding="utf-8") as recipe_file:
-            recipe = json.load(recipe_file)
-            cls._validate_recipe(recipe)
-        config = ConfigDecoder.decode_set(recipe.get("config", {}))
-        return cls.from_avocado_config(
-            recipe.get("kind"),
-            recipe.get("uri"),
-            *recipe.get("args", ()),
-            config=config,
-            **recipe.get("kwargs", {}),
-        )
+            recipe_dict = json.load(recipe_file)
+        return cls.from_dict(recipe_dict)
 
     @classmethod
     def from_avocado_config(cls, kind, uri, *args, config=None, **kwargs):

avocado/plugins/resolvers.py

@@ -16,6 +16,7 @@
 Test resolver for builtin test types
 """
 
+import json
 import os
 import re
 
@@ -160,3 +161,38 @@ def resolve(self, reference):
         return ReferenceResolution(
             reference, ReferenceResolutionResult.SUCCESS, [runnable]
         )
+
+
+class RunnablesRecipeResolver(Resolver):
+    name = "runnables-recipe"
+    description = "Test resolver for multiple runnables in a JSON recipe file"
+
+    @staticmethod
+    def _validate_and_load_runnables(reference):
+        with open(reference, "r", encoding="utf-8") as json_file:
+            runnables = json.load(json_file)
+
+        if not (
+            isinstance(runnables, list)
+            and all([isinstance(r, dict) for r in runnables])
+        ):
+            return ReferenceResolution(
+                reference,
+                ReferenceResolutionResult.NOTFOUND,
+                info="File {reference} does not look like a runnables recipe JSON file",
+            )
+
+        return ReferenceResolution(
+            reference,
+            ReferenceResolutionResult.SUCCESS,
+            [Runnable.from_dict(r) for r in runnables],
+        )
+
+    def resolve(self, reference):
+        criteria_check = check_file(
+            reference, reference, suffix=".json", type_name="JSON file"
+        )
+        if criteria_check is not True:
+            return criteria_check
+
+        return self._validate_and_load_runnables(reference)

docs/source/guides/reference/chapters/runners.rst

@@ -477,15 +477,15 @@ Runnables from recipes
 
 You can run a "noop" recipe with::
 
-  avocado-runner-noop runnable-run-recipe examples/nrunner/recipes/runnables/noop.json
+  avocado-runner-noop runnable-run-recipe examples/nrunner/recipes/runnable/noop.json
 
 You can run an "exec-test" runner with::
 
-  avocado-runner-exec-test runnable-run-recipe examples/nrunner/recipes/runnables/exec_test_sleep_3.json
+  avocado-runner-exec-test runnable-run-recipe examples/nrunner/recipes/runnable/exec_test_sleep_3.json
 
 You can run a "python-unittest" runner with::
 
-  avocado-runner-python-unittest runnable-run-recipe examples/nrunner/recipes/runnables/python_unittest.json
+  avocado-runner-python-unittest runnable-run-recipe examples/nrunner/recipes/runnable/python_unittest.json
 
 Writing new runner scripts
 --------------------------

docs/source/guides/writer/chapters/recipes.rst

@@ -16,7 +16,7 @@ pure Python code, such as in the following Job example:
 But, they can also be defined in JSON files, which we call "runnable
 recipes", such as:
 
-.. literalinclude:: ../../../../../examples/nrunner/recipes/runnables/exec_test_sleep_3.json
+.. literalinclude:: ../../../../../examples/nrunner/recipes/runnable/exec_test_sleep_3.json
 
 
 Runnable recipe format
@@ -40,13 +40,13 @@ Avocado ships with a ``runnable-recipe`` resolver plugin, which means
 that you can use runnable recipe file as a reference, and get
 something that Avocado can run (that is, a ``Runnable``).  Example::
 
-   avocado list examples/nrunner/recipes/runnables/python_unittest.json
+   avocado list examples/nrunner/recipes/runnable/python_unittest.json
    python-unittest selftests/unit/test.py:TestClassTestUnit.test_long_name
 
 And just as runnable recipe's resolution can be listed, they can also
 be executed::
 
-  avocado run examples/nrunner/recipes/runnables/python_unittest.json
+  avocado run examples/nrunner/recipes/runnable/python_unittest.json
   JOB ID     : bca087e0e5f16e62f24430602f87df67ecf093f7
   JOB LOG    : ~/avocado/job-results/job-2024-04-17T11.53-bca087e/job.log
    (1/1) selftests/unit/test.py:TestClassTestUnit.test_long_name: STARTED
@@ -57,3 +57,22 @@ be executed::
 .. tip:: As a possible integration strategy with existing tests, you
          can have one or more runnable recipe files that are passed
          to Avocado to be executed.
+
+Combining multiple recipes in a single file
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Avocado also ships with a slightly difference resolver, called
+``runnables-recipe``.  It reads a recipe file that, instead of
+containing one single runnable, contains (potentially) many.
+It should contain nothing more than an a list of runnables.
+
+For instance, to run both ``/bin/true`` and ``/bin/false``, you can
+define a file like:
+
+.. literalinclude:: ../../../../../examples/nrunner/recipes/runnables/true_false.json
+
+That will be parsed by the ``runnables-recipe`` resolver, like in
+``avocado list examples/nrunner/recipes/runnables/true_false.json``::
+
+  exec-test /bin/true
+  exec-test /bin/false