change to spack test behavior

buildtest/buildsystem/spack.py

@@ -116,24 +116,7 @@ def generate_script(self):
                 lines.append(f"spack install {opts}")
 
         if spack_configuration.get("test"):
-            if spack_configuration["test"].get("remove_testsuites"):
-                lines.append("spack test remove -y")
-
-            opts = spack_configuration["test"]["run"].get("option") or ""
-            for spec in spack_configuration["test"]["run"]["specs"]:
-                lines.append(f"spack test run {opts} --alias {spec} {spec}")
-
-            opts = spack_configuration["test"]["results"].get("option") or ""
-
-            # fetch results using 'spack test results <suite>'
-            if spack_configuration["test"]["results"].get("suite"):
-                for suite in spack_configuration["test"]["results"]["suite"]:
-                    lines.append(f"spack test results {opts} {suite}")
-
-            # fetch results using 'spack test results -- <spec>'
-            if spack_configuration["test"]["results"].get("specs"):
-                for spec in spack_configuration["test"]["results"]["specs"]:
-                    lines.append(f"spack test results {opts} -- {spec}")
+            lines += self._spack_test(spack_configuration)
 
         if self.recipe.get("post_cmds"):
             lines.append("\n")
@@ -144,6 +127,41 @@ def generate_script(self):
 
         return lines
 
+    def _spack_test(self, spack_configuration):
+        """This method will return lines for generating ``spack test run`` and ``spack test results`` command for running tests via
+        spack and getting results.
+        """
+        lines = []
+        if spack_configuration["test"].get("remove_tests"):
+            lines.append("spack test remove -y")
+
+        spack_test_cmd = ["spack test run"]
+
+        if spack_configuration["test"]["run"].get("option"):
+            spack_test_cmd.append(spack_configuration["test"]["run"]["option"])
+
+        run_specs = spack_configuration["test"]["run"]["specs"]
+
+        spack_test_cmd.append(f"--alias {self.name}")
+
+        for spec in run_specs:
+            spack_test_cmd.append(spec)
+
+        lines.append(" ".join(spack_test_cmd))
+
+        opts = spack_configuration["test"]["results"].get("option") or ""
+        # fetch results using 'spack test results <suite>'
+        if spack_configuration["test"]["results"].get("suite"):
+            for suite in spack_configuration["test"]["results"]["suite"]:
+                lines.append(f"spack test results {opts} {suite}")
+
+        # fetch results using 'spack test results -- <spec>'
+        if spack_configuration["test"]["results"].get("specs"):
+            for spec in spack_configuration["test"]["results"]["specs"]:
+                lines.append(f"spack test results {opts} -- {spec}")
+
+        return lines
+
     def _resolve_spack_root(self, path, verify_spack=True):
         """Given a path find the startup spack setup script to source.
 

buildtest/schemas/spack-v1.0.schema.json

@@ -179,7 +179,8 @@
       "type": "object",
       "additionalProperties": false,
       "required": [
-        "run"
+        "run",
+        "results"
       ],
       "properties": {
         "remove_tests": {

docs/buildspecs/spack.rst

@@ -436,14 +436,16 @@ property. The **results** property expects one to specify the ``specs`` or ``sui
 The ``suite`` property is used to retrieve test results based on suite name, whereas ``specs`` property can be used to retrieve based
 on spec format. Both properties are a list of string types.
 
-In example below we install `bzip2` and run the test using ``spack test run bzip2``.
+In example below we install `m4` and run the test using ``spack test run m4``.
 
 .. literalinclude:: ../tutorials/spack/spack_test.yml
     :language: yaml
 
-If we look at the generated test, buildtest will automatically set ``--alias`` option to define name
-of suite, otherwise spack will generate a random text for suitename which you won't know at time
-of writing test that is required by ``spack test results`` to fetch the results.
+If we look at the generated test, buildtest will install m4 followed by running the test. The **spack test run --alias**
+option is used to reference name of suitename which can be used to reference suitename when using ``spack test results``
+to search for test results. **buildtest will create the suite name based on name of test.** If `--alias` is not specified,
+spack will generate a random text for suitename which you won't know at time of writing test that is required by
+``spack test results`` to fetch the results.
 
 .. code-block:: shell
     :emphasize-lines: 13-14
@@ -453,62 +455,62 @@ of writing test that is required by ``spack test results`` to fetch the results.
 
     ######## START OF PRE COMMANDS ########
     cd /tmp
-    git clone https://github.com/spack/spack spack
+    git clone --depth=5 https://github.com/spack/spack
 
     ######## END OF PRE COMMANDS   ########
 
 
-    source /private/tmp/spack-test-no-env/share/spack/setup-env.sh
-    spack install  bzip2
-    spack test run  --alias bzip2 bzip2
-    spack test results  bzip2
+    source /private/tmp/spack/share/spack/setup-env.sh
+    spack install  m4
+    spack test run --alias spack_test_m4 m4
+    spack test results  spack_test_m4
 
 
     ######## START OF POST COMMANDS ########
     spack find
     rm -rf $SPACK_ROOT
-    ######## END OF POST COMMANDS   ########
 
+    ######## END OF POST COMMANDS   ########
 
-Shown below is the example output of this test.
+Shown below is the example output of this test, we can see spack has installed m4 and run the test after completion.
 
 
 .. code-block:: shell
-    :emphasize-lines: 26-29
-
-    ==> libiconv: Executing phase: 'configure'
-    ==> libiconv: Executing phase: 'build'
-    ==> libiconv: Executing phase: 'install'
-    ==> libiconv: Successfully installed libiconv-1.16-xgemfyqy3gsdz3lk7wy3ejudfaksja4x
-      Fetch: 1.54s.  Build: 33.03s.  Total: 34.57s.
-    [+] /private/tmp/spack/opt/spack/darwin-bigsur-skylake/apple-clang-11.0.3/libiconv-1.16-xgemfyqy3gsdz3lk7wy3ejudfaksja4x
-    ==> Installing diffutils-3.7-3dfrh6li733xxcenwyjhwyta7xkh3udq
-    ==> No binary for diffutils-3.7-3dfrh6li733xxcenwyjhwyta7xkh3udq found: installing from source
-    ==> Fetching https://mirror.spack.io/_source-cache/archive/b3/b3a7a6221c3dc916085f0d205abf6b8e1ba443d4dd965118da364a1dc1cb3a26.tar.xz
-    ==> No patches needed for diffutils
-    ==> diffutils: Executing phase: 'autoreconf'
-    ==> diffutils: Executing phase: 'configure'
-    ==> diffutils: Executing phase: 'build'
-    ==> diffutils: Executing phase: 'install'
-    ==> diffutils: Successfully installed diffutils-3.7-3dfrh6li733xxcenwyjhwyta7xkh3udq
-      Fetch: 1.32s.  Build: 52.35s.  Total: 53.67s.
-    [+] /private/tmp/spack/opt/spack/darwin-bigsur-skylake/apple-clang-11.0.3/diffutils-3.7-3dfrh6li733xxcenwyjhwyta7xkh3udq
-    ==> Installing bzip2-1.0.8-avjwvsoaivuflugopwk4ap7rffhejxzu
-    ==> No binary for bzip2-1.0.8-avjwvsoaivuflugopwk4ap7rffhejxzu found: installing from source
-    ==> Fetching https://mirror.spack.io/_source-cache/archive/ab/ab5a03176ee106d3f0fa90e381da478ddae405918153cca248e682cd0c4a2269.tar.gz
-    ==> Ran patch() for bzip2
-    ==> bzip2: Executing phase: 'install'
-    ==> bzip2: Successfully installed bzip2-1.0.8-avjwvsoaivuflugopwk4ap7rffhejxzu
-      Fetch: 1.42s.  Build: 1.84s.  Total: 3.26s.
-    [+] /private/tmp/spack/opt/spack/darwin-bigsur-skylake/apple-clang-11.0.3/bzip2-1.0.8-avjwvsoaivuflugopwk4ap7rffhejxzu
-    ==> Spack test bzip2
-    ==> Testing package bzip2-1.0.8-avjwvso
-    ==> Results for test suite 'bzip2':
-    ==>   bzip2-1.0.8-avjwvso PASSED
+    :emphasize-lines: 27-30
+
+    ==> Installing libsigsegv-2.13-r7lvpzzhczpr2bgtadetobprkgramtli
+    ==> No binary for libsigsegv-2.13-r7lvpzzhczpr2bgtadetobprkgramtli found: installing from source
+    ==> Fetching https://mirror.spack.io/_source-cache/archive/be/be78ee4176b05f7c75ff03298d84874db90f4b6c9d5503f0da1226b3a3c48119.tar.gz
+    ==> No patches needed for libsigsegv
+    ==> libsigsegv: Executing phase: 'autoreconf'
+    ==> libsigsegv: Executing phase: 'configure'
+    ==> libsigsegv: Executing phase: 'build'
+    ==> libsigsegv: Executing phase: 'install'
+    ==> libsigsegv: Successfully installed libsigsegv-2.13-r7lvpzzhczpr2bgtadetobprkgramtli
+      Fetch: 2.59s.  Build: 10.37s.  Total: 12.97s.
+    [+] /private/tmp/spack/opt/spack/darwin-bigsur-skylake/apple-clang-11.0.3/libsigsegv-2.13-r7lvpzzhczpr2bgtadetobprkgramtli
+    ==> Installing m4-1.4.19-pibdj557bvkhtlyjhm5giq4p2vt5plsw
+    ==> No binary for m4-1.4.19-pibdj557bvkhtlyjhm5giq4p2vt5plsw found: installing from source
+    ==> Fetching https://mirror.spack.io/_source-cache/archive/3b/3be4a26d825ffdfda52a56fc43246456989a3630093cced3fbddf4771ee58a70.tar.gz
+    ==> Fetching https://mirror.spack.io/_source-cache/archive/bf/bfdffa7c2eb01021d5849b36972c069693654ad826c1a20b53534009a4ec7a89
+    ==> Fetching https://mirror.spack.io/_source-cache/archive/9d/9dc5fbd0d5cb1037ab1e6d0ecc74a30df218d0a94bdd5a02759a97f62daca573
+    ==> Applied patch http://git.savannah.gnu.org/cgit/m4.git/patch/?id=a1354086
+    ==> Applied patch http://git.savannah.gnu.org/cgit/m4.git/patch/?id=cd7f4d15
+    ==> Ran patch() for m4
+    ==> m4: Executing phase: 'autoreconf'
+    ==> m4: Executing phase: 'configure'
+    ==> m4: Executing phase: 'build'
+    ==> m4: Executing phase: 'install'
+    ==> m4: Successfully installed m4-1.4.19-pibdj557bvkhtlyjhm5giq4p2vt5plsw
+      Fetch: 3.23s.  Build: 1m 50.63s.  Total: 1m 53.86s.
+    [+] /private/tmp/spack/opt/spack/darwin-bigsur-skylake/apple-clang-11.0.3/m4-1.4.19-pibdj557bvkhtlyjhm5giq4p2vt5plsw
+    ==> Spack test spack_test_m4
+    ==> Testing package m4-1.4.19-pibdj55
+    ==> Results for test suite 'spack_test_m4':
+    ==>   m4-1.4.19-pibdj55 PASSED
     -- darwin-bigsur-skylake / apple-clang@11.0.3 -------------------
-    bzip2@1.0.8
-    diffutils@3.7
-    libiconv@1.16
+    libsigsegv@2.13
+    m4@1.4.19
 
 
 We can search for test results using the spec format instead of suite name. In the ``results`` property we can
@@ -536,15 +538,15 @@ the ``option`` field specified under the ``results`` section.
 
     ######## START OF PRE COMMANDS ########
     cd /tmp
-    git clone https://github.com/spack/spack
+    git clone --depth=1 https://github.com/spack/spack
 
     ######## END OF PRE COMMANDS   ########
 
 
     source /private/tmp/spack/share/spack/setup-env.sh
     spack install  bzip2
     spack test remove -y
-    spack test run  --alias bzip2 bzip2
+    spack test run --alias spack_test_results_specs_format bzip2
     spack test results -l -- bzip2
 
 

docs/conf.py

@@ -138,6 +138,7 @@
 #
 html_theme_options = {
     "prev_next_buttons_location": "both",
+    "sticky_navigation": True,
     # 'vcs_pageview_mode': ''
 }
 

tutorials/spack/spack_test.yml

@@ -1,24 +1,24 @@
 version: "1.0"
 buildspecs:
-  spack_test:
+  spack_test_m4:
     type: spack
     executor: generic.local.sh
-    description: "Install bzip2 and run spack test and report results"
+    description: "Install m4 and run spack test and report results"
     tags: [spack]
     pre_cmds: |
       cd /tmp
-      git clone https://github.com/spack/spack
+      git clone --depth=5 https://github.com/spack/spack
     spack:
       root: /tmp/spack
       verify_spack: false
       install:
-        specs: ['bzip2']
+        specs: ['m4']
       test:
         run:
-          specs: ['bzip2']
+          specs: ['m4']
         results:
-          suite: ['bzip2']
+          suite: ['spack_test_m4']
 
     post_cmds: |
       spack find
-      rm -rf $SPACK_ROOT
+      rm -rf $SPACK_ROOT

tutorials/spack/spack_test_specs.yml

@@ -7,7 +7,7 @@ buildspecs:
     tags: [spack]
     pre_cmds: |
       cd /tmp
-      git clone https://github.com/spack/spack
+      git clone --depth=1 https://github.com/spack/spack
     spack:
       root: /tmp/spack
       verify_spack: false