Merge pull request #1642 from buildtesters/container_support

container support in buildspecs for docker, podman and singularity

buildtest/builders/script.py

@@ -195,7 +195,37 @@ def generate_script(self):
             lines += self.compiler_settings["modules"]
 
         lines.append("# Content of run section")
+
+        if "container" in self.recipe:
+            container = self.recipe["container"]
+            container_platform = container["platform"]
+            container_command = []
+            if container_platform in ["docker", "podman"]:
+                container_command.extend(
+                    [container_platform, "run", "-v", f"{self.stage_dir}:/buildtest"]
+                )
+
+            elif container_platform in ["singularity"]:
+                container_command.extend(
+                    [f"{container_platform}", "exec", f"-B {self.stage_dir}:/buildtest"]
+                )
+
+            if container.get("mounts"):
+                if container_platform in ["singularity"]:
+                    container_command.extend(["-B", container["mounts"]])
+                else:
+                    container_command.extend(["-v", container["mounts"]])
+
+            if container.get("options"):
+                container_command.append(container["options"])
+
+            container_command.append(container["image"])
+
+            if container.get("command"):
+                container_command.append(container["command"])
+
+            lines.append(" ".join(container_command))
+
         # Add run section
         lines += [self.recipe["run"]]
-
         return lines

buildtest/schemas/examples/script.schema.json/invalid/invalid_container_platform.yml

@@ -0,0 +1,9 @@
+buildspecs:
+  invalid_container_platform:
+    type: script
+    executor: generic.local.bash
+    description: invalid container platform
+    container:
+      platform: "containerd"
+      image: hello-world
+    run: echo 'Test Complete!'

buildtest/schemas/examples/script.schema.json/valid/bind_mounts.yml

@@ -0,0 +1 @@
+../../../../../tutorials/containers/bind_mounts.yml

buildtest/schemas/examples/script.schema.json/valid/hello_world.yml

@@ -0,0 +1 @@
+../../../../../tutorials/containers/hello_world.yml

buildtest/schemas/examples/script.schema.json/valid/run_commands.yml

@@ -0,0 +1 @@
+../../../../../tutorials/containers/run_commands.yml

buildtest/schemas/script.schema.json

@@ -133,6 +133,40 @@
           }
         }
       }
+    },
+    "container": {
+      "type": "object",
+      "required": [
+          "image",
+          "platform"
+        ],
+      "properties": {
+        "platform": {
+          "type": "string",
+          "description": "Specify a container platform to use when running test. This is used for running commands inside container.",
+          "enum": [
+            "docker",
+            "podman",
+            "singularity"
+          ]
+        },
+        "image": {
+          "type": "string",
+          "description": "Specify a container image to use when running test. This is used for running commands inside container."
+        },
+        "mounts": {
+          "type": "string",
+          "description": "Specify a list of directory paths to bind mount into the container"
+        },
+        "options": {
+          "type": "string",
+          "description": "Specify a list of options to pass to container runtime. "
+        },
+        "command": {
+          "type": "string",
+          "description": "Specify a list of commands to run inside container. This is used for running commands inside container."
+        }
+      }
     }
   },
   "definitions": {

docs/troubleshooting.rst

@@ -102,12 +102,12 @@ Shown below is a sample output where we query 5 records from the buildspec cache
 
 .. command-output:: buildtest buildspec find --format name --terse --no-header --count=5
 
-To get all tests in buildspec cache, consider setting to any negative value `--count=-1` or a really high number.
+To get all tests in buildspec cache, consider setting to any negative value ``--count=-1`` or a really high number.
 
 Unable to query test details
 ------------------------------
 
-Let's say you are trying to query a test name `hello_world`, and you get an error message such as following
+Let's say you are trying to query a test name ``hello_world``, and you get an error message such as following
 
 .. code-block:: console
 
@@ -128,7 +128,7 @@ Unable to query all test results
 ---------------------------------
 
 If you run into situation where you are unable to query all test results,
-you should check the buildtest configuration file see :ref:`configuring_buildtest_report`_. In this section, check if
+you should check the buildtest configuration file see :ref:`configuring_buildtest_report`. In this section, check if
 ``count`` property is set in configuration file. For instance if you have ``count: 25``, everytime you run ``buildtest report`` it
 will query 25 records
 
@@ -148,6 +148,8 @@ You can work around this issue by passing ``--count`` on command line and it wil
 To retrieve all content you can specify a negative value and buildtest will fetch all records or alternatively you
 can specify a really high number
 
+.. code-block:: console
+
       buildtest report --terse --no-header --count=-1 | wc -l
     30
 

docs/writing_buildspecs.rst

@@ -12,4 +12,5 @@ Writing Buildspecs
    writing_buildspecs/performance_checks
    writing_buildspecs/test_dependency
    writing_buildspecs/multi_executor
-   writing_buildspecs/customize_shell
+   writing_buildspecs/customize_shell
+   writing_buildspecs/containers