diff options
author | Ed Baunton <ebaunton1@bloomberg.net> | 2018-07-12 18:11:08 -0400 |
---|---|---|
committer | Ed Baunton <ebaunton1@bloomberg.net> | 2018-07-25 20:43:51 +0100 |
commit | c049d021f91ba5b25806dc9066b622a411d78766 (patch) | |
tree | cd7128d54349a6c45bd106c8d9c143a0080c2a8e /buildstream/plugins | |
parent | f62b6cb7420c91c2f87b3ebba4dcfcf16b4d6f0a (diff) | |
download | buildstream-c049d021f91ba5b25806dc9066b622a411d78766.tar.gz |
Add remote source plugin
Add a plugin that supports downloading files verbatim from a source with
an optional overridable filename and destination directory. Bumps bst
format version to 10.
Fixes #163
Diffstat (limited to 'buildstream/plugins')
-rw-r--r-- | buildstream/plugins/sources/remote.py | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/buildstream/plugins/sources/remote.py b/buildstream/plugins/sources/remote.py new file mode 100644 index 000000000..77c4ce17d --- /dev/null +++ b/buildstream/plugins/sources/remote.py @@ -0,0 +1,80 @@ +# +# Copyright Bloomberg Finance LP +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library. If not, see <http://www.gnu.org/licenses/>. +# +# Authors: +# Ed Baunton <ebaunton1@bloomberg.net> + +""" +remote - stage files from remote urls +===================================== + +**Usage:** + +.. code:: yaml + + # Specify the remote source kind + kind: remote + + # Optionally specify a relative staging directory + # directory: path/to/stage + + # Optionally specify a relative staging filename. + # If not specified, the basename of the url will be used. + # filename: customfilename + + # Specify the url. Using an alias defined in your project + # configuration is encouraged. 'bst track' will update the + # sha256sum in 'ref' to the downloaded file's sha256sum. + url: upstream:foo + + # Specify the ref. It's a sha256sum of the file you download. + ref: 6c9f6f68a131ec6381da82f2bff978083ed7f4f7991d931bfa767b7965ebc94b + +.. note:: + + The ``remote`` plugin is available since :ref:`format version 10 <project_format_version>` + +""" +import os +from buildstream import SourceError, utils +from ._downloadablefilesource import DownloadableFileSource + + +class RemoteSource(DownloadableFileSource): + # pylint: disable=attribute-defined-outside-init + + def configure(self, node): + super().configure(node) + + self.filename = self.node_get_member(node, str, 'filename', os.path.basename(self.url)) + + if os.sep in self.filename: + raise SourceError('{}: filename parameter cannot contain directories'.format(self)) + self.node_validate(node, DownloadableFileSource.COMMON_CONFIG_KEYS + ['filename']) + + def get_unique_key(self): + return super().get_unique_key() + [self.filename] + + def stage(self, directory): + # Same as in local plugin, don't use hardlinks to stage sources, they + # are not write protected in the sandbox. + dest = os.path.join(directory, self.filename) + with self.timed_activity("Staging remote file to {}".format(dest)): + utils.safe_copy(self._get_mirror_file(), dest) + + +def setup(): + return RemoteSource |