From 9dd3b80e98705c341b0d702b8fbcd17506803b81 Mon Sep 17 00:00:00 2001 From: Jannis Pohlmann Date: Mon, 17 Dec 2012 14:52:40 +0000 Subject: Add image inspection plugin This adds a `run-in-artifact` command which allows another command to be run in a system. There is also a `content-manifest` command which gives a manifest of the artifacts, which commits they were built from, and if possible, a version. This adds a morphlib.bins.call_in_artifact_directory() method to run a command inside an artifact and to generate a manifest. --- morphlib/plugins/artifact_inspection_plugin.py | 156 +++++++++++++++++++++ .../run-in-artifact-propagates-exit-code.exit | 1 + .../run-in-artifact-propagates-exit-code.script | 33 +++++ .../run-in-artifact-propagates-exit-code.stderr | 3 + ...run-in-artifact-with-different-artifacts.script | 47 +++++++ ...run-in-artifact-with-different-artifacts.stderr | 1 + ...run-in-artifact-with-different-artifacts.stdout | 14 ++ without-test-modules | 1 + 8 files changed, 256 insertions(+) create mode 100644 morphlib/plugins/artifact_inspection_plugin.py create mode 100644 tests.as-root/run-in-artifact-propagates-exit-code.exit create mode 100755 tests.as-root/run-in-artifact-propagates-exit-code.script create mode 100644 tests.as-root/run-in-artifact-propagates-exit-code.stderr create mode 100755 tests.as-root/run-in-artifact-with-different-artifacts.script create mode 100644 tests.as-root/run-in-artifact-with-different-artifacts.stderr create mode 100644 tests.as-root/run-in-artifact-with-different-artifacts.stdout diff --git a/morphlib/plugins/artifact_inspection_plugin.py b/morphlib/plugins/artifact_inspection_plugin.py new file mode 100644 index 00000000..0ff04bef --- /dev/null +++ b/morphlib/plugins/artifact_inspection_plugin.py @@ -0,0 +1,156 @@ +# Copyright (C) 2012-2013 Codethink Limited +# +# This program 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; version 2 of the License. +# +# 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, write to the Free Software Foundation, Inc., +# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + + +import cliapp +import glob +import json +import os + +import morphlib + +from morphlib.bins import call_in_artifact_directory +from morphlib.extractedtarball import ExtractedTarball +from morphlib.mountableimage import MountableImage + + +class NotASystemArtifactError(cliapp.AppException): + + def __init__(self, artifact): + cliapp.AppException.__init__( + self, '%s is not a system artifact' % artifact) + + +class ManifestGenerator(object): + + def __init__(self, app): + self.app = app + + def generate(self, artifact, dirname): + # Try to find a directory with baserock metadata files. + metadirs = [ + os.path.join(dirname, 'factory', 'baserock'), + os.path.join(dirname, 'baserock') + ] + existing_metadirs = [x for x in metadirs if os.path.isdir(x)] + if not existing_metadirs: + raise NotASystemArtifactError(artifact) + metadir = existing_metadirs[0] + + # Collect all meta information about the system, its strata + # and its chunks that we are interested in. + artifacts = [] + for basename in glob.glob(os.path.join(metadir, '*.meta')): + metafile = os.path.join(metadir, basename) + metadata = json.load(open(metafile)) + + artifacts.append({ + 'cache-key': metadata['cache-key'], + 'name': metadata['artifact-name'], + 'kind': metadata['kind'], + 'sha1': metadata['sha1'], + 'original_ref': metadata['original_ref'], + 'repo': metadata['repo'], + 'morphology': metadata['morphology'] + }) + + # Generate a format string for dumping the information. + fmt = self._generate_output_format(artifacts) + + # Print information about system, strata and chunks. + self._print_artifacts(fmt, artifacts, 'system') + self._print_artifacts(fmt, artifacts, 'stratum') + self._print_artifacts(fmt, artifacts, 'chunk') + + def _generate_output_format(self, artifacts): + colwidths = {} + for artifact in artifacts: + for key, value in artifact.iteritems(): + colwidths[key] = max(colwidths.get(key, 0), len(value)) + + colwidths['first'] = sum([colwidths['cache-key'], + colwidths['kind'], + colwidths['name']]) + 1 + + return 'artifact=%%-%is\t' \ + 'version=%%-%is\t' \ + 'commit=%%-%is\t' \ + 'repository=%%-%is\t' \ + 'ref=%%-%is\t' \ + 'morphology=%%-%is\n' % ( + len('artifact=') + colwidths['first'], + len('version=') + colwidths['version'], + len('commit=') + colwidths['sha1'], + len('repository=') + colwidths['repo'], + len('ref=') + colwidths['original_ref'], + len('morphology=') + colwidths['morphology']) + + def _print_artifacts(self, fmt, artifacts, kind): + for artifact in sorted(artifacts, key=lambda x: x['name']): + if artifact['kind'] == kind: + self.app.output.write(fmt % ( + '%s.%s.%s' % (artifact['cache-key'], + artifact['kind'], + artifact['name']), + artifact['version'], + artifact['sha1'], + artifact['repo'], + artifact['original_ref'], + artifact['morphology'])) + + +class ArtifactInspectionPlugin(cliapp.Plugin): + + def enable(self): + self.app.add_subcommand('run-in-artifact', + self.run_in_artifact, + arg_synopsis='ARTIFACT CMD') + self.app.add_subcommand('generate-manifest', + self.generate_manifest, + arg_synopsis='ROOTFS_ARTIFACT') + + def disable(self): + pass + + def run_in_artifact(self, args): + '''Run a command inside an extracted/mounted chunk or system.''' + + if len(args) < 2: + raise cliapp.AppException( + 'run-in-artifact requires arguments: a chunk or ' + 'system artifact and a a shell command') + + artifact, cmd = args[0], args[1:] + + def run_command_in_dir(dirname): + output = self.app.runcmd(cmd, cwd=dirname) + self.app.output.write(output) + + call_in_artifact_directory(self.app, artifact, run_command_in_dir) + + def generate_manifest(self, args): + '''Generate a content manifest for a system image.''' + + if len(args) != 1: + raise cliapp.AppException('morph generate-manifest expects ' + 'a system image as its input') + + artifact = args[0] + + def generate_manifest(dirname): + generator = ManifestGenerator(self.app) + generator.generate(artifact, dirname) + + call_in_artifact_directory(self.app, artifact, generate_manifest) diff --git a/tests.as-root/run-in-artifact-propagates-exit-code.exit b/tests.as-root/run-in-artifact-propagates-exit-code.exit new file mode 100644 index 00000000..d00491fd --- /dev/null +++ b/tests.as-root/run-in-artifact-propagates-exit-code.exit @@ -0,0 +1 @@ +1 diff --git a/tests.as-root/run-in-artifact-propagates-exit-code.script b/tests.as-root/run-in-artifact-propagates-exit-code.script new file mode 100755 index 00000000..d815c73d --- /dev/null +++ b/tests.as-root/run-in-artifact-propagates-exit-code.script @@ -0,0 +1,33 @@ +#!/bin/bash +# +# Copyright (C) 2012-2013 Codethink Limited +# +# This program 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; version 2 of the License. +# +# 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, write to the Free Software Foundation, Inc., +# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + + +## Test that 'run-in-artifact' propagates the exit code of its command. + +set -eu + +. "$SRCDIR/tests.as-root/lib" + +# Build first image. Remember the stratum. +"$SRCDIR/scripts/test-morph" build-morphology \ + test:morphs master linux-system + +system=$(find "$DATADIR/cache/artifacts" -maxdepth 1 -name '*.system.*-rootfs') + +# Run 'run-in-artifact' with the system artifact. The command will fail +# and this should result in an exit code of 1 in the test. +"$SRCDIR/scripts/test-morph" run-in-artifact "$system" -- ls i-do-not-exist diff --git a/tests.as-root/run-in-artifact-propagates-exit-code.stderr b/tests.as-root/run-in-artifact-propagates-exit-code.stderr new file mode 100644 index 00000000..98aa5450 --- /dev/null +++ b/tests.as-root/run-in-artifact-propagates-exit-code.stderr @@ -0,0 +1,3 @@ +ERROR: Command failed: ls i-do-not-exist +ls: i-do-not-exist: No such file or directory + diff --git a/tests.as-root/run-in-artifact-with-different-artifacts.script b/tests.as-root/run-in-artifact-with-different-artifacts.script new file mode 100755 index 00000000..0b14f527 --- /dev/null +++ b/tests.as-root/run-in-artifact-with-different-artifacts.script @@ -0,0 +1,47 @@ +#!/bin/bash +# +# Copyright (C) 2012-2013 Codethink Limited +# +# This program 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; version 2 of the License. +# +# 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, write to the Free Software Foundation, Inc., +# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + + +## Test the 'run-in-artifact' command with different types of artifacts. + +set -eu + +. "$SRCDIR/tests.as-root/lib" + +# Build first image. Remember the stratum. +"$SRCDIR/scripts/test-morph" build-morphology \ + test:morphs master linux-system + +system=$(find "$DATADIR/cache/artifacts" -maxdepth 1 -name '*.system.*-rootfs') +chunk=$(find "$DATADIR/cache/artifacts" -maxdepth 1 -name '*.chunk.linux') +stratum=$(find "$DATADIR/cache/artifacts" -maxdepth 1 \ + -name '*.stratum.linux-stratum') + +# Run 'run-in-artifact' with the system artifact. +echo "System:" +"$SRCDIR/scripts/test-morph" run-in-artifact "$system" -- ls factory/baserock/ +echo + +# Run 'run-in-artifact' with the chunk artifact. +echo "Chunk:" +"$SRCDIR/scripts/test-morph" run-in-artifact "$chunk" -- ls baserock/ +echo + +# Run 'run-in-artifact' with the statum artifact. +echo "Stratum:" +"$SRCDIR/scripts/test-morph" run-in-artifact "$stratum" -- ls baserock/ \ + || echo "Failed" diff --git a/tests.as-root/run-in-artifact-with-different-artifacts.stderr b/tests.as-root/run-in-artifact-with-different-artifacts.stderr new file mode 100644 index 00000000..44e70c38 --- /dev/null +++ b/tests.as-root/run-in-artifact-with-different-artifacts.stderr @@ -0,0 +1 @@ +ERROR: Artifact TMP/cache/artifacts/293fc1b78dd2af221ae7de246ff5a59df476165704b7e366230ac8ed4c16d1b7.stratum.linux-stratum cannot be extracted or mounted diff --git a/tests.as-root/run-in-artifact-with-different-artifacts.stdout b/tests.as-root/run-in-artifact-with-different-artifacts.stdout new file mode 100644 index 00000000..281ab109 --- /dev/null +++ b/tests.as-root/run-in-artifact-with-different-artifacts.stdout @@ -0,0 +1,14 @@ +System: +hello-stratum.meta +hello.meta +linux-stratum.meta +linux-system-rootfs.meta +linux.meta +tools-stratum.meta +tools.meta + +Chunk: +linux.meta + +Stratum: +Failed diff --git a/without-test-modules b/without-test-modules index 7ba80129..cc901f32 100644 --- a/without-test-modules +++ b/without-test-modules @@ -7,6 +7,7 @@ morphlib/fsutils.py morphlib/app.py morphlib/mountableimage.py morphlib/extractedtarball.py +morphlib/plugins/artifact_inspection_plugin.py morphlib/plugins/hello_plugin.py morphlib/plugins/graphing_plugin.py morphlib/plugins/syslinux-disk-systembuilder_plugin.py -- cgit v1.2.1