tests/sources/remote.py

@@ -89,7 +89,7 @@ def test_simple_file_build(cli, tmpdir, datafiles):
     result.assert_success()
 
     result = cli.run(project=project, args=[
-        'checkout', 'target.bst', checkoutdir
+        'artifact', 'checkout', 'target.bst', '--directory', checkoutdir
     ])
     result.assert_success()
     # Note that the url of the file in target.bst is actually /dir/file
@@ -122,7 +122,7 @@ def test_simple_file_custom_name_build(cli, tmpdir, datafiles):
     result.assert_success()
 
     result = cli.run(project=project, args=[
-        'checkout', 'target.bst', checkoutdir
+        'artifact', 'checkout', 'target.bst', '--directory', checkoutdir
     ])
     result.assert_success()
     assert(not os.path.exists(os.path.join(checkoutdir, 'file')))
@@ -136,18 +136,25 @@ def test_unique_key(cli, tmpdir, datafiles):
     '''
     project = os.path.join(datafiles.dirname, datafiles.basename)
     generate_project(project, tmpdir)
-    assert cli.get_element_state(project, 'target.bst') == "fetch needed"
-    assert cli.get_element_state(project, 'target-custom.bst') == "fetch needed"
-    assert cli.get_element_state(project, 'target-custom-executable.bst') == "fetch needed"
+    states = cli.get_element_states(project, [
+        'target.bst', 'target-custom.bst', 'target-custom-executable.bst'
+    ])
+    assert states['target.bst'] == "fetch needed"
+    assert states['target-custom.bst'] == "fetch needed"
+    assert states['target-custom-executable.bst'] == "fetch needed"
+
     # Try to fetch it
     result = cli.run(project=project, args=[
         'source', 'fetch', 'target.bst'
     ])
 
     # We should download the file only once
-    assert cli.get_element_state(project, 'target.bst') == 'buildable'
-    assert cli.get_element_state(project, 'target-custom.bst') == 'buildable'
-    assert cli.get_element_state(project, 'target-custom-executable.bst') == 'buildable'
+    states = cli.get_element_states(project, [
+        'target.bst', 'target-custom.bst', 'target-custom-executable.bst'
+    ])
+    assert states['target.bst'] == 'buildable'
+    assert states['target-custom.bst'] == 'buildable'
+    assert states['target-custom-executable.bst'] == 'buildable'
 
     # But the cache key is different because the 'filename' is different.
     assert cli.get_element_key(project, 'target.bst') != \
@@ -169,7 +176,7 @@ def test_executable(cli, tmpdir, datafiles):
     ])
 
     result = cli.run(project=project, args=[
-        'checkout', 'target-custom-executable.bst', checkoutdir
+        'artifact', 'checkout', 'target-custom-executable.bst', '--directory', checkoutdir
     ])
     mode = os.stat(os.path.join(checkoutdir, 'some-custom-file')).st_mode
     assert (mode & stat.S_IEXEC)
@@ -202,7 +209,7 @@ def test_use_netrc(cli, datafiles, server_type, tmpdir):
         result.assert_success()
         result = cli.run(project=project, args=['build', 'target.bst'])
         result.assert_success()
-        result = cli.run(project=project, args=['checkout', 'target.bst', checkoutdir])
+        result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkoutdir])
         result.assert_success()
 
         checkout_file = os.path.join(checkoutdir, 'file')

tests/sources/tar.py

@@ -139,7 +139,7 @@ def test_stage_default_basedir(cli, tmpdir, datafiles, srcdir):
     result.assert_success()
     result = cli.run(project=project, args=['build', 'target.bst'])
     result.assert_success()
-    result = cli.run(project=project, args=['checkout', 'target.bst', checkoutdir])
+    result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkoutdir])
     result.assert_success()
 
     # Check that the content of the first directory is checked out (base-dir: '*')
@@ -168,7 +168,7 @@ def test_stage_no_basedir(cli, tmpdir, datafiles, srcdir):
     result.assert_success()
     result = cli.run(project=project, args=['build', 'target.bst'])
     result.assert_success()
-    result = cli.run(project=project, args=['checkout', 'target.bst', checkoutdir])
+    result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkoutdir])
     result.assert_success()
 
     # Check that the full content of the tarball is checked out (base-dir: '')
@@ -197,7 +197,7 @@ def test_stage_explicit_basedir(cli, tmpdir, datafiles, srcdir):
     result.assert_success()
     result = cli.run(project=project, args=['build', 'target.bst'])
     result.assert_success()
-    result = cli.run(project=project, args=['checkout', 'target.bst', checkoutdir])
+    result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkoutdir])
     result.assert_success()
 
     # Check that the content of the first directory is checked out (base-dir: '*')
@@ -233,7 +233,7 @@ def test_stage_contains_links(cli, tmpdir, datafiles):
     result.assert_success()
     result = cli.run(project=project, args=['build', 'target.bst'])
     result.assert_success()
-    result = cli.run(project=project, args=['checkout', 'target.bst', checkoutdir])
+    result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkoutdir])
     result.assert_success()
 
     # Check that the content of the first directory is checked out (base-dir: '*')
@@ -262,7 +262,7 @@ def test_stage_default_basedir_lzip(cli, tmpdir, datafiles, srcdir):
     result.assert_success()
     result = cli.run(project=project, args=['build', 'target-lz.bst'])
     result.assert_success()
-    result = cli.run(project=project, args=['checkout', 'target-lz.bst', checkoutdir])
+    result = cli.run(project=project, args=['artifact', 'checkout', 'target-lz.bst', '--directory', checkoutdir])
     result.assert_success()
 
     # Check that the content of the first directory is checked out (base-dir: '*')
@@ -348,7 +348,7 @@ def test_use_netrc(cli, datafiles, server_type, tmpdir):
         result.assert_success()
         result = cli.run(project=project, args=['build', 'target.bst'])
         result.assert_success()
-        result = cli.run(project=project, args=['checkout', 'target.bst', checkoutdir])
+        result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkoutdir])
         result.assert_success()
 
         original_dir = os.path.join(str(datafiles), 'content', 'a')

tests/sources/zip.py

@@ -123,7 +123,7 @@ def test_stage_default_basedir(cli, tmpdir, datafiles):
     result.assert_success()
     result = cli.run(project=project, args=['build', 'target.bst'])
     result.assert_success()
-    result = cli.run(project=project, args=['checkout', 'target.bst', checkoutdir])
+    result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkoutdir])
     result.assert_success()
 
     # Check that the content of the first directory is checked out (base-dir: '*')
@@ -151,7 +151,7 @@ def test_stage_no_basedir(cli, tmpdir, datafiles):
     result.assert_success()
     result = cli.run(project=project, args=['build', 'target.bst'])
     result.assert_success()
-    result = cli.run(project=project, args=['checkout', 'target.bst', checkoutdir])
+    result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkoutdir])
     result.assert_success()
 
     # Check that the full content of the tarball is checked out (base-dir: '')
@@ -179,7 +179,7 @@ def test_stage_explicit_basedir(cli, tmpdir, datafiles):
     result.assert_success()
     result = cli.run(project=project, args=['build', 'target.bst'])
     result.assert_success()
-    result = cli.run(project=project, args=['checkout', 'target.bst', checkoutdir])
+    result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkoutdir])
     result.assert_success()
 
     # Check that the content of the first directory is checked out (base-dir: '*')
@@ -221,7 +221,7 @@ def test_use_netrc(cli, datafiles, server_type, tmpdir):
         result.assert_success()
         result = cli.run(project=project, args=['build', 'target.bst'])
         result.assert_success()
-        result = cli.run(project=project, args=['checkout', 'target.bst', checkoutdir])
+        result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkoutdir])
         result.assert_success()
 
         original_dir = os.path.join(str(datafiles), 'content', 'a')

tests/testutils/python_repo.py

-from setuptools.sandbox import run_setup
 import os
 import pytest
 import re
 import shutil
+import subprocess
 
 
 SETUP_TEMPLATE = '''\
@@ -88,7 +88,9 @@ def generate_pip_package(tmpdir, pypi, name, version='0.1'):
         f.write(INIT_TEMPLATE.format(name=name))
     os.chmod(main_file, 0o644)
 
-    run_setup(setup_file, ['sdist'])
+    # Run sdist with a fresh process
+    p = subprocess.run(['python3', 'setup.py', 'sdist'], cwd=tmpdir)
+    assert p.returncode == 0
 
     # create directory for this package in pypi resulting in a directory
     # tree resembling the following structure:

tests/testutils/runcli.py

@@ -245,8 +245,14 @@ class Cli():
 
     def remove_artifact_from_cache(self, project, element_name,
                                    *, cache_dir=None):
+        # Read configuration to figure out where artifacts are stored
         if not cache_dir:
-            cache_dir = os.path.join(project, 'cache', 'artifacts')
+            default = os.path.join(project, 'cache', 'artifacts')
+
+            if self.config is not None:
+                cache_dir = self.config.get('artifactdir', default)
+            else:
+                cache_dir = default
 
         cache_dir = os.path.join(cache_dir, 'cas', 'refs', 'heads')
 
@@ -375,6 +381,9 @@ class Cli():
     # Fetch an element state by name by
     # invoking bst show on the project with the CLI
     #
+    # If you need to get the states of multiple elements,
+    # then use get_element_states(s) instead.
+    #
     def get_element_state(self, project, element_name):
         result = self.run(project=project, silent=True, args=[
             'show',
@@ -385,6 +394,24 @@ class Cli():
         result.assert_success()
         return result.output.strip()
 
+    # Fetch the states of elements for a given target / deps
+    #
+    # Returns a dictionary with the element names as keys
+    #
+    def get_element_states(self, project, targets, deps='all'):
+        result = self.run(project=project, silent=True, args=[
+            'show',
+            '--deps', deps,
+            '--format', '%{name}||%{state}',
+        ] + targets)
+        result.assert_success()
+        lines = result.output.splitlines()
+        states = {}
+        for line in lines:
+            split = line.split(sep='||')
+            states[split[0]] = split[1]
+        return states
+
     # Fetch an element's cache key by invoking bst show
     # on the project with the CLI
     #

tests/testutils/site.py

@@ -2,6 +2,7 @@
 # so we dont have to repeat this everywhere
 #
 import os
+import subprocess
 import sys
 
 from buildstream import _site, utils, ProgramNotFoundError
@@ -16,8 +17,12 @@ except ProgramNotFoundError:
 try:
     utils.get_host_tool('git')
     HAVE_GIT = True
+    out = str(subprocess.check_output(['git', '--version']), "utf-8")
+    version = tuple(int(x) for x in out.split(' ', 2)[2].split('.'))
+    HAVE_OLD_GIT = version < (1, 8, 5)
 except ProgramNotFoundError:
     HAVE_GIT = False
+    HAVE_OLD_GIT = False
 
 try:
     utils.get_host_tool('ostree')

tox.ini

@@ -65,11 +65,11 @@ deps =
 [testenv:docs]
 commands =
     make -C doc
-# Currently sphinx_rtd_theme does not support Sphinx >1.8, this breaks search functionality
+# sphinx_rtd_theme < 0.4.2 breaks search functionality for Sphinx >= 1.8
 deps =
-    sphinx==1.7.9
+    sphinx
     sphinx-click
-    sphinx_rtd_theme
+    sphinx_rtd_theme >= 0.4.2
     -rrequirements/requirements.txt
     -rrequirements/plugin-requirements.txt
 passenv =
@@ -80,3 +80,13 @@ passenv =
     LC_ALL
 whitelist_externals =
     make
+
+#
+# (re-)Generating man pages
+#
+[testenv:man]
+commands =
+    python3 setup.py --command-packages=click_man.commands man_pages
+deps =
+    click-man
+    -rrequirements/requirements.txt