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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
#!/usr/bin/env python3
#
# Copyright (C) 2017 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 Maat <tristan.maat@codethink.co.uk>
import os
from collections import Mapping
from .._exceptions import ImplError
from .. import utils
from .. import _yaml
# An ArtifactCache manages artifacts
#
# Args:
# context (Context): The BuildStream context
# project (Project): The BuildStream project
#
class ArtifactCache():
def __init__(self, context, project):
self.context = context
os.makedirs(context.artifactdir, exist_ok=True)
self.extractdir = os.path.join(context.artifactdir, 'extract')
self._local = False
project_overrides = context._get_overrides(project.name)
artifact_overrides = _yaml.node_get(project_overrides, Mapping, 'artifacts', default_value={})
override_url = _yaml.node_get(artifact_overrides, str, 'url', default_value='') or None
_yaml.node_validate(artifact_overrides, ['url'])
if override_url:
self.url = override_url
elif project.artifact_url:
self.url = project.artifact_url
else:
self.url = context.artifact_url
if self.url:
if self.url.startswith('/') or self.url.startswith('file://'):
self._local = True
self.remote = utils.url_directory_name(self.url)
else:
self.remote = None
self._offline = False
# contains():
#
# Check whether the artifact for the specified Element is already available
# in the local artifact cache.
#
# Args:
# element (Element): The Element to check
# strength (_KeyStrength): Either STRONG or WEAK key strength, or None
#
# Returns: True if the artifact is in the cache, False otherwise
#
def contains(self, element, strength=None):
raise ImplError("Cache '{kind}' does not implement contains()"
.format(kind=type(self).__name__))
# extract():
#
# Extract cached artifact for the specified Element if it hasn't
# already been extracted.
#
# Assumes artifact has previously been fetched or committed.
#
# Args:
# element (Element): The Element to extract
#
# Raises:
# ArtifactError: In cases there was an OSError, or if the artifact
# did not exist.
#
# Returns: path to extracted artifact
#
def extract(self, element):
raise ImplError("Cache '{kind}' does not implement extract()"
.format(kind=type(self).__name__))
# commit():
#
# Commit built artifact to cache.
#
# Args:
# element (Element): The Element commit an artifact for
# content (str): The element's content directory
#
def commit(self, element, content):
raise ImplError("Cache '{kind}' does not implement commit()"
.format(kind=type(self).__name__))
# set_offline()
#
# Do not attempt to pull or push artifacts.
#
def set_offline(self):
self._offline = True
# can_fetch():
#
# Check whether remote repository is available for fetching.
#
# Returns: True if remote repository is available, False otherwise
#
def can_fetch(self):
return (not self._offline or self._local) and \
self.remote is not None
# can_push():
#
# Check whether remote repository is available for pushing.
#
# Returns: True if remote repository is available, False otherwise
#
def can_push(self):
return (not self._offline or self._local) and \
self.url is not None
# remote_contains_key():
#
# Check whether the artifact for the specified Element is already available
# in the remote artifact cache.
#
# Args:
# element (Element): The Element to check
# strength (_KeyStrength): Either STRONG or WEAK key strength, or None
#
# Returns: True if the artifact is in the cache, False otherwise
#
def remote_contains(self, element, strength=None):
return False
def fetch_remote_refs(self):
pass
|
