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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
|
# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
#
# Copyright (C) 2015 Canonical Ltd
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3 as
# published by the Free Software Foundation.
#
# This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
import filecmp
import glob
import logging
import os
import shlex
import shutil
import subprocess
import sys
import tempfile
import time
import snapcraft.plugin
import snapcraft.yaml
from snapcraft import common
from snapcraft import meta
logger = logging.getLogger(__name__)
_TEMPLATE_YAML = r'''name: # the name of the snap
version: # the version of the snap
# The vendor for the snap (replace 'Vendor <email@example.com>')
vendor: Vendor <email@example.com>
summary: # 79 char long summary
description: # A longer description for the snap
icon: # A path to an icon for the package
'''
_config = None
def init(args):
if os.path.exists("snapcraft.yaml"):
logger.error('snapcraft.yaml already exists!')
sys.exit(1)
yaml = _TEMPLATE_YAML
if args.part:
yaml += 'parts:\n'
for part_name in args.part:
part = snapcraft.plugin.load_plugin(part_name, part_name, load_code=False)
yaml += ' ' + part.names()[0] + ':\n'
for opt in part.config.get('options', []):
if part.config['options'][opt].get('required', False):
yaml += ' ' + opt + ':\n'
yaml = yaml.strip()
with open('snapcraft.yaml', mode='w+') as f:
f.write(yaml)
logger.info('Wrote the following as snapcraft.yaml.')
print()
print(yaml)
sys.exit(0)
def shell(args):
config = _load_config()
common.env = config.stage_env()
userCommand = args.userCommand
if not userCommand:
userCommand = ['/usr/bin/env', 'PS1=\[\e[1;32m\]snapcraft:\w\$\[\e[0m\] ', '/bin/bash', '--norc']
common.run(userCommand)
def snap(args):
cmd(args)
# This check is to support manual assembly.
if not os.path.exists(os.path.join(common.get_snapdir(), "meta")):
arches = [snapcraft.common.get_arch(), ]
config = _load_config()
# FIXME this should be done in a more contained manner
common.env = config.snap_env()
meta.create(config.data, arches)
def assemble(args):
args.cmd = 'snap'
# With all the data in snapcraft.yaml, maybe it's not a good idea to call
# snap(args) and just do a snappy build if assemble was explicitly called.
snap(args)
common.run(['snappy', 'build', common.get_snapdir()])
def _find_latest_private_key():
"""
Find the latest private key in ~/.ssh.
:returns:
Path of the most-recently-modified private SSH key
:raises LookupError:
If no such key was found.
This function tries to mimic the logic found in ``ubuntu-device-flash``. It
will look for the most recently modified private key in the users' SSH
configuration directory.
"""
candidates = []
ssh_dir = os.path.expanduser('~/.ssh/')
for filename in os.listdir(ssh_dir):
# Skip public keys, we want the private key
if filename.endswith('.pub'):
continue
ssh_key = os.path.join(ssh_dir, filename)
# Skip non-files
if not os.path.isfile(ssh_key):
continue
# Ensure that it is a real ssh key
with open(ssh_key, 'rb') as stream:
if stream.readline() != b'-----BEGIN RSA PRIVATE KEY-----\n':
continue
candidates.append(ssh_key)
# Sort the keys by modification time, pick the most recent key
candidates.sort(key=lambda f: os.stat(f).st_mtime, reverse=True)
logger.debug("Available ssh public keys: %r", candidates)
if not candidates:
raise LookupError("Unable to find any private ssh key")
return candidates[0]
def run(args):
# Find the ssh key that ubuntu-device-flash would use so that we can use it
# ourselves as well. This may not be the default key that the user has
# configured.
# See: https://bugs.launchpad.net/snapcraft/+bug/1486659
try:
ssh_key = _find_latest_private_key()
except LookupError:
logger.error("You need to have an SSH key to use this command")
logger.error("Please generate one with ssh-keygen(1)")
return 1
else:
logger.info("Using the following ssh key: %s", ssh_key)
# Find available *.snap files to copy into the test VM
snap_dir = os.path.join(os.getcwd())
# copy the snap with the largest version number into the test VM
snaps = glob.glob(snap_dir + "/*.snap")
snaps.sort()
if not snaps:
logger.error("There are no .snap files ready")
logger.error("Perhaps you forgot to run 'snapcraft assemble'")
return 1
qemudir = os.path.join(os.getcwd(), "image")
qemu_img = os.path.join(qemudir, "15.04.img")
if not os.path.exists(qemu_img):
os.makedirs(qemudir, exist_ok=True)
logger.info('Setting up virtual snappy environment, root access required')
common.run([
'sudo', 'ubuntu-device-flash', 'core', '15.04', '--developer-mode',
'--enable-ssh', '-o', os.path.relpath(qemu_img, qemudir)],
cwd=qemudir)
qemu = None
try:
# Allow the developer to provide additional arguments to qemu. This
# can be used, for example, to pass through USB devices from the host.
# This can enable a lot of hardware-specific use cases directly inside
# the snapcraft run workflow.
#
# For example:
# $ export SNAPCRAFT_RUN_QEMU_ARGS="-usb -device usb-host,hostbus=1,hostaddr=10"
# $ snapcraft run
qemu_args = os.getenv("SNAPCRAFT_RUN_QEMU_ARGS")
if qemu_args is not None:
qemu_args = shlex.split(qemu_args)
else:
qemu_args = []
qemu = subprocess.Popen(
["kvm", "-m", "768", "-nographic", "-snapshot", "-redir",
"tcp:8022::22", qemu_img] + qemu_args, stdin=subprocess.PIPE)
n = tempfile.NamedTemporaryFile()
ssh_opts = [
# We want to login with the specified ssh identity (key)
'-i', ssh_key,
# We don't want strict host checking because it's a new VM with a
# random key each time.
"-oStrictHostKeyChecking=no",
# We don't want to pollute the known_hosts file with new entries
# all the time so let's use a temporary file for that
"-oUserKnownHostsFile=%s" % n.name,
# Don't try keyboard interactive authentication, we're expecting to
# login via the key and if that doesn't work then everything else
# will fail anyway.
"-oKbdInteractiveAuthentication=no",
]
while True:
ret_code = _call(
["ssh"] + ssh_opts +
["ubuntu@localhost", "-p", "8022", "true"])
if ret_code == 0:
break
print("Waiting for device")
time.sleep(1)
# copy the most recent snap into the test VM
_check_call(
["scp"] + ssh_opts + [
"-P", "8022", snaps[-1], "ubuntu@localhost:~/"])
# install the snap
_check_call(
["ssh"] + ssh_opts +
["ubuntu@localhost", "-p", "8022", "sudo snappy install *.snap"])
# "login"
_check_call(
["ssh"] + ssh_opts + ["-p", "8022", "ubuntu@localhost"],
preexec_fn=os.setsid)
finally:
if qemu:
qemu.kill()
def clean(args):
config = _load_config()
for part in config.all_parts:
logger.info('Cleaning up for part %r', part.names()[0])
if os.path.exists(part.partdir):
shutil.rmtree(part.partdir)
# parts dir does not contain only generated code.
if (os.path.exists(common.get_partsdir()) and
not os.listdir(common.get_partsdir())):
os.rmdir(common.get_partsdir())
logger.info('Cleaning up staging area')
if os.path.exists(common.get_stagedir()):
shutil.rmtree(common.get_stagedir())
logger.info('Cleaning up snapping area')
if os.path.exists(common.get_snapdir()):
shutil.rmtree(common.get_snapdir())
def _check_for_collisions(parts):
parts_files = {}
for part in parts:
# Gather our own files up
fileset = getattr(part.code.options, 'stage', ['*']) or ['*']
part_files, _ = snapcraft.plugin.migratable_filesets(fileset, part.installdir)
# Scan previous parts for collisions
for other_part_name in parts_files:
common = part_files & parts_files[other_part_name]['files']
conflict_files = []
for f in common:
this = os.path.join(part.installdir, f)
other = os.path.join(parts_files[other_part_name]['installdir'], f)
if not filecmp.cmp(this, other, shallow=False):
conflict_files.append(f)
if conflict_files:
logger.error('Error: parts %s and %s have the following file paths in common which have different contents:\n %s', other_part_name, part.names()[0], '\n '.join(sorted(conflict_files)))
return False
# And add our files to the list
parts_files[part.names()[0]] = {'files': part_files, 'installdir': part.installdir}
return True
def cmd(args):
forceAll = args.force
forceCommand = None
cmds = [args.cmd]
if cmds[0] in common.COMMAND_ORDER:
forceCommand = cmds[0]
cmds = common.COMMAND_ORDER[0:common.COMMAND_ORDER.index(cmds[0]) + 1]
config = _load_config()
# Install local packages that we need
if config.build_tools:
newPackages = []
for checkpkg in config.build_tools:
if subprocess.call(['dpkg-query', '-s', checkpkg], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL) != 0:
newPackages.append(checkpkg)
if newPackages:
print("Installing required packages on the host system: " + ", ".join(newPackages))
subprocess.call(['sudo', 'apt-get', '-y', 'install'] + newPackages, stdout=subprocess.DEVNULL)
# clean the snap dir before Snapping
snap_clean = False
for part in config.all_parts:
for cmd in cmds:
if cmd is 'stage':
# This ends up running multiple times, as each part gets to its
# staging cmd. That's inefficient, but largely OK.
# FIXME: fix the above by iterating over cmds before iterating
# all_parts. But then we need to make sure we continue to handle
# cases like go, where you want go built before trying to pull
# a go project.
if not _check_for_collisions(config.all_parts):
sys.exit(1)
# We want to make sure we have a clean snap dir
if cmd is 'snap' and not snap_clean:
shutil.rmtree(common.get_snapdir())
snap_clean = True
common.env = config.build_env_for_part(part)
force = forceAll or cmd == forceCommand
if not getattr(part, cmd)(force=force):
logger.error('Failed doing %s for %s!', cmd, part.names()[0])
sys.exit(1)
def _call(args, **kwargs):
logger.info('Running: %s', ' '.join(shlex.quote(arg) for arg in args))
return subprocess.call(args, **kwargs)
def _check_call(args, **kwargs):
logger.info('Running: %s', ' '.join(shlex.quote(arg) for arg in args))
return subprocess.check_call(args, **kwargs)
def _load_config():
global _config
if _config:
return _config
try:
_config = snapcraft.yaml.Config()
return _config
except snapcraft.yaml.SnapcraftYamlFileError as e:
logger.error(
'Could not find {}. Are you sure you are in the right directory?\n'
'To start a new project, use \'snapcraft init\''.format(e.file))
sys.exit(1)
except snapcraft.yaml.SnapcraftSchemaError as e:
msg = "Issues while validating snapcraft.yaml: {}".format(e.message)
logger.error(msg)
sys.exit(1)
except snapcraft.yaml.SnapcraftLogicError as e:
logger.error('Issue detected while analyzing snapcraft.yaml: {}'.format(e.message))
sys.exit(1)
|