1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
#!/usr/bin/env python3
#
# Copyright (C) 2016 Codethink Limited
#
# 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:
# Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
"""A Source implementation for staging local project files
**Usage:**
.. code:: yaml
# Specify the local source kind
kind: local
# Optionally specify a relative staging directory
# directory: path/to/stage
# Specify the project relative path to a file or directory
path: files/somefile.txt
"""
import os
import sys
from buildstream import Source, SourceError, Consistency
from buildstream import utils
class LocalSource(Source):
def __init__(self, context, project, meta):
super().__init__(context, project, meta)
# Cached unique key to avoid multiple file system traversal if the unique key is requested multiple times.
self.__unique_key = None
def configure(self, node):
self.node_validate(node, ['path'] + Source.COMMON_CONFIG_KEYS)
self.path = self.node_get_member(node, str, 'path')
self.fullpath = os.path.join(self.get_project_directory(), self.path)
def preflight(self):
# Check if the configured file or directory really exists
if not os.path.exists(self.fullpath):
raise SourceError("Specified path '{}' does not exist".format(self.path))
def get_unique_key(self):
if self.__unique_key is None:
# Get a list of tuples of the the project relative paths and fullpaths
if os.path.isdir(self.fullpath):
filelist = utils.list_relative_paths(self.fullpath)
filelist = [(relpath, os.path.join(self.fullpath, relpath)) for relpath in filelist]
else:
filelist = [(self.path, self.fullpath)]
print("{}: Local file list for unique key: {}".format(self, filelist), file=sys.stderr)
# Return a list of (relative filename, sha256 digest) tuples, a sorted list
# has already been returned by list_relative_paths()
self.__unique_key = [(relpath, unique_key(fullpath)) for relpath, fullpath in filelist]
print("{}: Local unique key: {}".format(self, self.__unique_key), file=sys.stderr)
return self.__unique_key
def get_consistency(self):
return Consistency.CACHED
# We dont have a ref, we're a local file...
def get_ref(self):
return None # pragma: nocover
def set_ref(self, ref, node):
pass # pragma: nocover
def fetch(self):
# Nothing to do here for a local source
pass # pragma: nocover
def stage(self, directory):
# Dont use hardlinks to stage sources, they are not write protected
# in the sandbox.
with self.timed_activity("Staging local files at {}".format(self.path)):
if os.path.isdir(self.fullpath):
utils.copy_files(self.fullpath, directory)
else:
destfile = os.path.join(directory, os.path.basename(self.path))
utils.safe_copy(self.fullpath, destfile)
# Create a unique key for a file
def unique_key(filename):
# Return some hard coded things for files which
# have no content to calculate a key for
if os.path.isdir(filename):
return "0"
elif os.path.islink(filename):
return "1"
return utils.sha256sum(filename)
# Plugin entry point
def setup():
return LocalSource
|
