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
|
# Copyright 2018-2019 Florian Fischer <florian.fl.fischer@fau.de>
#
# This file is part of allocbench.
#
# allocbench is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# allocbench 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with allocbench. If not, see <http://www.gnu.org/licenses/>.
"""Artifact classes
An Artifact is a external ressource downloaded from the internet.
There are two flavours of artifacts available: archives and git repositories.
Both flavours are version controlled archive with a checksum and git repositories
with a specific checkout.
"""
import os
import subprocess
import src.globalvars
from src.util import print_info, print_debug, sha1sum
ARTIFACT_STORE_DIR = os.path.join(src.globalvars.allocbenchdir, "cache")
class Artifact:
"""Base class for external ressources"""
store = {}
def __init__(self, name):
if name in Artifact.store:
raise Exception(f'duplicate artifact "{name}"')
Artifact.store[name] = self
self.name = name
self.basedir = os.path.join(ARTIFACT_STORE_DIR, name)
def retrieve(self, cmd):
"""Run cmd to retrieve the artifact"""
os.makedirs(self.basedir, exist_ok=True)
print_info(f'Retrieving artifact "{self.name}"')
print_debug(f"By running: {cmd} in {self.basedir}")
proc = subprocess.run(cmd, cwd=self.basedir,
# stdout=subprocess.PIPE, stderr=subprocess.PIPE,
universal_newlines=True)
if proc.returncode != 0:
raise Exception(f"Failed to retrieve {self.name}")
class GitArtifact(Artifact):
"""External git repository"""
def __init__(self, name, url):
super().__init__(name)
self.url = url
self.repo = os.path.join(self.basedir, "repo")
def retrieve(self):
"""clone the git repo"""
super().retrieve(["git", "clone", "--recursive", "--bare", self.url, "repo"])
def provide(self, checkout, location=None):
"""checkout new worktree at location"""
if not location:
location = os.path.join(self.basedir, checkout)
# check if we have already provided this checkout
if os.path.exists(location):
return
# check if we have already retrieved the repo
if not os.path.exists(self.repo):
self.retrieve()
print_debug("create new worktree. By running: ",
["git", "worktree", "add", location, checkout], f"in {self.repo}")
proc = subprocess.run(["git", "worktree", "add", location, checkout], cwd=self.repo,
# stdout=subprocess.PIPE, stderr=subprocess.PIPE,
universal_newlines=True)
if proc.returncode != 0:
raise Exception(f"Failed to provide {self.name}")
print_debug("update submodules in worktree. By running: ",
["git", "submodule", "update", "--init", "--recursive"], f"in {self.repo}")
proc = subprocess.run(["git", "submodule", "update", "--init", "--recursive"], cwd=location,
# stdout=subprocess.PIPE, stderr=subprocess.PIPE,
universal_newlines=True)
class ArchiveArtifact(Artifact):
"""External archive"""
supported_formats = ["tar"]
def __init__(self, name, url, format, checksum):
super().__init__(name)
self.url = url
if format not in self.supported_formats:
raise Exception(f'Archive format "{format}" not in supported list {self.supported_formats}')
self.format = format
self.archive = os.path.join(self.basedir, f"{self.name}.{self.format}")
self.checksum = checksum
def retrieve(self):
"""download the archive"""
super().retrieve(["wget", "-O", self.archive, self.url])
def provide(self, location=None):
"""extract the archive"""
# Download archive
if not os.path.exists(self.archive):
self.retrieve()
# compare checksums
if sha1sum(self.archive) != self.checksum:
raise Exception(f"Archive {self.archive} does not match provided checksum")
if not location:
location = os.path.join(self.basedir, "content")
# Check if we already provided the archive at location
if os.path.exists(location):
return
os.makedirs(location, exist_ok=True)
# Extract archive
if self.format == "tar":
cmd = ["tar", "Cxf", location, self.archive]
print_debug(f"extract archive by running: {cmd} in {self.basedir}")
proc = subprocess.run(cmd, cwd=self.basedir,
# stdout=subprocess.PIPE, stderr=subprocess.PIPE,
universal_newlines=True)
if proc.returncode != 0:
raise Exception(f"Failed to extract {self.name}")
|
