From 070d053e5cc47e572e9f9e647315082bd7a15c63 Mon Sep 17 00:00:00 2001 From: Chandan Singh Date: Wed, 24 Apr 2019 22:53:19 +0100 Subject: Move source from 'buildstream' to 'src/buildstream' This was discussed in #1008. Fixes #1009. --- src/buildstream/plugins/sources/remote.py | 93 +++++++++++++++++++++++++++++++ 1 file changed, 93 insertions(+) create mode 100644 src/buildstream/plugins/sources/remote.py (limited to 'src/buildstream/plugins/sources/remote.py') diff --git a/src/buildstream/plugins/sources/remote.py b/src/buildstream/plugins/sources/remote.py new file mode 100644 index 000000000..562a8f226 --- /dev/null +++ b/src/buildstream/plugins/sources/remote.py @@ -0,0 +1,93 @@ +# +# 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 . +# +# Authors: +# Ed Baunton + +""" +remote - stage files from remote urls +===================================== + +**Usage:** + +.. code:: yaml + + # Specify the remote source kind + kind: remote + + # Optionally specify a relative staging filename. + # If not specified, the basename of the url will be used. + # filename: customfilename + + # Optionally specify whether the downloaded file should be + # marked executable. + # executable: true + + # Specify the url. Using an alias defined in your project + # configuration is encouraged. 'bst source 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 + +See :ref:`built-in functionality doumentation ` for +details on common configuration options for sources. + +.. note:: + + The ``remote`` plugin is available since :ref:`format version 10 ` +""" +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)) + self.executable = self.node_get_member(node, bool, 'executable', False) + + if os.sep in self.filename: + raise SourceError('{}: filename parameter cannot contain directories'.format(self), + reason="filename-contains-directory") + self.node_validate(node, DownloadableFileSource.COMMON_CONFIG_KEYS + ['filename', 'executable']) + + def get_unique_key(self): + return super().get_unique_key() + [self.filename, self.executable] + + 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) + + # To prevent user's umask introducing variability here, explicitly set + # file modes. + if self.executable: + os.chmod(dest, 0o755) + else: + os.chmod(dest, 0o644) + + +def setup(): + return RemoteSource -- cgit v1.2.1