Docs: Add remote execution architecture documentation.

See merge request !923

Avoid hanging artifact cache tests

See merge request !964

This eliminates unneeded copies of the project directory for junctions
with a single local source.

Optimization for local junctions

See merge request !290

This improves readability.

This adds the batch() context manager.

This allows the sandbox to output messages using the plugin id.

This allows batching of all sandbox commands aross prepare() and
assemble().

Execute batched commands in a single shell script.

Command batching

Closes #675

See merge request !915

There is nothing in ArtifactCacheSpec that's actually specific to
artifacts, so I've made it a CAS class so we can use the same
spec for remote execution.

Since the artifact cache and remote execution share the same
local CAS store, they should share the same CASCache object. Moving
this into context allows us to do this.

Uses the new config options introduced earlier to specify remote
exec storage and execution service.

Tests that we get a sensible error message when we specify incomplete
or wrong information in the configuration for remote execution.

The port number must come after the hostname and before the path.
The path is ignored by CASCache anyway, so including it is misleading.

Split remote execution from artifact cache

Closes #750

See merge request !946

setup.py: require ruamel.yaml >= 0.15.41 < 0.15.52

See merge request !975

f_bfree space might not be usable. In practice we see failures in big
disks because f_bfree is over 2GB and f_bavail is 0. We get ENOSPC if
writing on disk then.

We plan to make cache incomplete. That is some blobs are missing.  For
most of cases we will delete references when requested if they are
incomplete. But there will be corner cases where objects are removed
after the reference is requested.

The file is already a temporary file and does not need copy.  ENOSPC
is thrown during that copy in issue #609.

Fixes #678.

This locks the temporary object file so that cleanup does not need to
be done for every write.

This also remove references when some objects are missing. This is in
preparation for the move from reference to object garbage collection.

When there is less than 2GB left, it cleans up have 10GB available.
These values are configurable.

Cleaning up in parallel might slow down the cleaning process

Fix cleanup of cache in server when disk is full

Closes #678

See merge request !830

push_message and push_directory will both raise assertion failures if
they fail to send the digest to the server. Checking the digest
returned by each only tests that the content was hashed locally, which
cannot reasonably fail.

_sandboxremote.py: Remove unnecessary tests.

Closes #786

See merge request !976

Fixes #723.

Add support for .netrc in remote/tar/zip plugins

Closes #723

See merge request !908

Angelos Evripiotis authored Nov 29, 2018 and Jürg Billeter committed Nov 30, 2018

It seems that the regenerated man pages haven't been committed for some
time. Add them all in one lump now.

Had to manually strip the version number from the generated files.

Had to manually fix the NAME field of bst.1 to not be 'bst - None'.

Oddly had to invoke click-man directly in order to get the changes to
be applied, the usual setup.py route mentioned in contributing.rst
didn't work.

Eyeballed the result of invoking man on each of the commands, seems
good.

man/: update with changes since Apr 2018

See merge request !981

Tom Pollard authored Nov 28, 2018 and Jürg Billeter committed Nov 30, 2018

Adds helper function _buildtree_pull_required() to determine if a
pullqueue should be constructed, for commands outside of bst pull
and build where it is determined that an element's buildtree
artifact is to be required given the respective semantics and
config. Utilised in push() to attempt to mitigate skipping the push
of partial elements without the user having to have preceded it with
an explicit pull.

cli.py: Add new behaviour to push command description

element.py: Move _cached_buildtree() to be non local private method,
use _KeyStrength types to reduce duplication.

tests/integration/pullbuildtrees.py also updated to cover this
use-case.

_stream.py: Ability to pull missing buildtrees outside of pull/build

Closes #774

See merge request !978

_loader/loader.py: Added Suffix check and warning for named elements and add helper function

buildcheckout.py: Add mandatory .bst suffix tests
completions.py: Add test for fail on invalid suffix
Added required files for testing
integration/source-determinism.py: renamed test elements to end with .bst
loader/__init__.py: initialised context properly with load and a message handler

Mandatory .bst suffix

See merge request !967

This was previously missing, causing our CI to forget to rebuild the sessions
when updating the documentation.

This fixes issue #778

MANIFEST.in: Include the sources for rebuilding the documentation session HTML

Closes #778

See merge request !984

Chandan Singh authored Sep 26, 2018 and Benjamin Schubert committed Dec 03, 2018

Currently, `bst checkout --deps none` command always produces empty
output. Fix this issue and add regression test for the same.

- element_enums.py: Add Scope.NONE.

- element.py: Ensure Scope.NONE works correctly in addition to
  Scope.RUN/Scope.ALL in Element.dependencies() and Element.search().

- tests/frontend/buildcheckout.py: Fix tests for `--deps none`.

Fixes #670.

Chandan Singh authored Sep 21, 2018 and Benjamin Schubert committed Dec 03, 2018

As discussed in
https://mail.gnome.org/archives/buildstream-list/2018-September/msg00064.html,
add `--deps build` option to `bst checkout`. This will allow users to
checkout the all build dependencies of a given element using a single
command.

- _frontend/cli.py: Add `--deps build` option for `bst checkout`.

- element.py: Support `deps='build'` in Element._prepare_sandbox().

- tests/frontend/buildcheckout.py: Ensure `--deps build` works as
  expected.

Before we would have a intricate logics with multiple arguments
that might get ignored.

This simplifies the design and introduces a bool `shell` instead
of having two different variables concerned about scope

Add `--deps build` option to `bst checkout`

Closes #670

See merge request !819

Javier Jardón authored Dec 02, 2018 and Tristan Van Berkom committed Dec 03, 2018

See #783

git: warn about checkout submodules  by default

See merge request !983

This is required because if there are projects with the same name
loaded, that have elements in the same path, with the same contents,
they are considered the same, despite actually belonging to different
Projects.

This fixes buildstream issue #795

James Ennis authored Nov 30, 2018 and Jonathan Maw committed Dec 03, 2018

Test required to close #795 - We should be able to build a project which refers
to the same junction twice, but with two different filenames.

_yamlcache.py: Use a project's junction name if present

Closes #795

See merge request !980