Clean up artifact serialisation

We no longer serialise whole artifacts, so it doesn't make sense
for things to still refer to serialise-artifact and similar.

Change-Id: Id4d563a07041bbce77f13ac71dc3f7de39df5e23

6 files changed, 99 insertions, 85 deletions

diff --git a/distbuild/__init__.py b/distbuild/__init__.py
index bb9ddc6e..dc5ff153 100644
--- a/distbuild/__init__.py
+++ b/distbuild/__init__.py
@@ -27,7 +27,9 @@ from mainloop import MainLoop
 from sockserv import ListenServer
 from jm import JsonMachine, JsonNewMessage, JsonEof
 
-from serialise import serialise_artifact, deserialise_artifact
+from artifact_reference import (encode_artifact,
+                                encode_artifact_reference,
+                                decode_artifact_reference)
 from idgen import IdentifierGenerator
 from route_map import RouteMap
 from timer_event_source import TimerEventSource, Timer
diff --git a/distbuild/serialise.py b/distbuild/artifact_reference.py
index 5e83ffc2..bdcfbf23 100644
--- a/distbuild/serialise.py
+++ b/distbuild/artifact_reference.py
@@ -1,7 +1,7 @@
-# distbuild/serialise.py -- (de)serialise Artifact object graphs
+# distbuild/artifact_reference.py -- Decode/encode ArtifactReference objects
 #
 # Copyright (C) 2012, 2014-2015  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.
@@ -59,27 +59,27 @@ class ArtifactReference(object): # pragma: no cover
         return list(depth_first(self))
 
 
-def serialise_artifact(artifact, repo, ref):
-    '''Serialise an Artifact object and its dependencies into string form.'''
+def encode_artifact(artifact, repo, ref):
+    '''Encode part of an Artifact object and dependencies into string form.'''
 
-    def encode_source(source):
-        s_dict = {
+    def get_source_dict(source):
+        source_dict = {
             'filename': source.filename,
             'kind': source.morphology['kind'],
             'source_name': source.name,
             'source_repo': source.repo_name,
             'source_ref': source.original_ref,
             'source_sha1': source.sha1,
-            'source_artifacts': [],
+            'source_artifact_names': [],
             'dependencies': []
         }
-        for dep in source.dependencies:
-            s_dict['dependencies'].append(dep.basename())
-        for sa in source.artifacts:
-            s_dict['source_artifacts'].append(sa)
-        return s_dict
+        for dependency in source.dependencies:
+            source_dict['dependencies'].append(dependency.basename())
+        for source_artifact_name in source.artifacts:
+            source_dict['source_artifact_names'].append(source_artifact_name)
+        return source_dict
 
-    def encode_artifact(a):
+    def get_artifact_dict(a):
         if artifact.source.morphology['kind'] == 'system': # pragma: no cover
             arch = artifact.source.morphology['arch']
         else:
@@ -94,44 +94,14 @@ def serialise_artifact(artifact, repo, ref):
         }
         return a_dict
 
-    def encode_artifact_reference(a): # pragma: no cover
-        a_dict = {
-            'arch': a.arch,
-            'cache_key': a.cache_key,
-            'name': a.name,
-            'repo': a.repo,
-            'ref': a.ref
-        }
-        s_dict = {
-            'filename': a.filename,
-            'kind': a.kind,
-            'source_name': a.source_name,
-            'source_repo': a.source_repo,
-            'source_ref': a.source_ref,
-            'source_sha1': a.source_sha1,
-            'source_artifacts': [],
-            'dependencies': []
-        }
-        for dep in a.dependencies:
-            s_dict['dependencies'].append(dep.basename())
-        for sa in a.source_artifacts:
-            s_dict['source_artifacts'].append(sa)
-        return a_dict, s_dict
-
     encoded_artifacts = {}
     encoded_sources = {}
 
-    if isinstance(artifact, ArtifactReference): # pragma: no cover
-        root_filename = artifact.root_filename
-        a_dict, s_dict = encode_artifact_reference(artifact)
-        encoded_artifacts[artifact.basename()] = a_dict
-        encoded_sources[artifact.cache_key] = s_dict
-    else:
-        root_filename = artifact.source.filename
-        for a in artifact.walk():
-            if a.basename() not in encoded_artifacts: # pragma: no cover
-                encoded_artifacts[a.basename()] = encode_artifact(a)
-                encoded_sources[a.source.cache_key] = encode_source(a.source)
+    root_filename = artifact.source.filename
+    for a in artifact.walk():
+        if a.basename() not in encoded_artifacts: # pragma: no cover
+            encoded_artifacts[a.basename()] = get_artifact_dict(a)
+            encoded_sources[a.source.cache_key] = get_source_dict(a.source)
 
     content = {
         'root-artifact': artifact.basename(),
@@ -143,14 +113,57 @@ def serialise_artifact(artifact, repo, ref):
     return json.dumps(yaml.dump(content))
 
 
-def deserialise_artifact(encoded):
-    '''Re-construct the Artifact object (and dependencies).
-    
-    The argument should be a string returned by ``serialise_artifact``.
-    The reconstructed Artifact objects will be sufficiently like the
-    originals that they can be used as a build graph, and other such
-    purposes, by Morph.
-    
+def encode_artifact_reference(artifact): # pragma: no cover
+    '''Encode an ArtifactReference object into string form.
+
+    The ArtifactReference object is encoded such that it can be recreated by
+    ``decode_artifact_reference``.
+
+    '''
+    artifact_dict = {
+        'arch': artifact.arch,
+        'cache_key': artifact.cache_key,
+        'name': artifact.name,
+        'repo': artifact.repo,
+        'ref': artifact.ref
+    }
+    source_dict = {
+        'filename': artifact.filename,
+        'kind': artifact.kind,
+        'source_name': artifact.source_name,
+        'source_repo': artifact.source_repo,
+        'source_ref': artifact.source_ref,
+        'source_sha1': artifact.source_sha1,
+        'source_artifact_names': [],
+        'dependencies': []
+    }
+
+    for dependency in artifact.dependencies:
+        source_dict['dependencies'].append(dependency.basename())
+
+    for source_artifact_name in artifact.source_artifact_names:
+        source_dict['source_artifact_names'].append(source_artifact_name)
+
+    content = {
+        'root-artifact': artifact.basename(),
+        'root-filename': artifact.root_filename,
+        'artifacts': {artifact.basename(): artifact_dict},
+        'sources': {artifact.cache_key: source_dict}
+    }
+
+    return json.dumps(yaml.dump(content))
+
+
+def decode_artifact_reference(encoded):
+    '''Decode an ArtifactReference object from `encoded`.
+
+    The argument should be a string returned by ``encode_artifact``
+    or ``encode_artifact_reference``. The decoded ArtifactReference
+    object will be sufficient to represent a build graph and contain
+    enough information to allow `morph worker-build` to calculate a
+    build graph and find the original Artifact object it needs to
+    build.
+
     '''
     content = yaml.load(json.loads(encoded))
     root = content['root-artifact']
diff --git a/distbuild/serialise_tests.py b/distbuild/artifact_reference_tests.py
index 2de3ab85..e21918a1 100644
--- a/distbuild/serialise_tests.py
+++ b/distbuild/artifact_reference_tests.py
@@ -1,7 +1,7 @@
-# distbuild/serialise_tests.py -- unit tests for Artifact serialisation
+# distbuild/artifact_reference_tests.py -- unit tests for Artifact encoding
 #
 # Copyright (C) 2012, 2014-2015  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.
@@ -59,7 +59,7 @@ class MockArtifact(object):
 
     def walk(self): # pragma: no cover
         done = set()
-        
+
         def depth_first(a):
             if a not in done:
                 done.add(a)
@@ -71,7 +71,7 @@ class MockArtifact(object):
         return list(depth_first(self))
 
 
-class SerialisationTests(unittest.TestCase):
+class ArtifactReferenceTests(unittest.TestCase):
 
     def setUp(self):
         self.art1 = MockArtifact('name1', 'stratum')
@@ -80,12 +80,12 @@ class SerialisationTests(unittest.TestCase):
         self.art4 = MockArtifact('name4', 'chunk')
 
     def verify_round_trip(self, artifact):
-        encoded = distbuild.serialise_artifact(artifact,
-                                               artifact.source.repo_name,
-                                               artifact.source.sha1)
-        decoded = distbuild.deserialise_artifact(encoded)
+        encoded = distbuild.encode_artifact(artifact,
+                                            artifact.source.repo_name,
+                                            artifact.source.sha1)
+        decoded = distbuild.decode_artifact_reference(encoded)
         self.assertEqual(artifact.basename(), decoded.basename())
-        
+
         objs = {}
         queue = [decoded]
         while queue:
@@ -98,9 +98,9 @@ class SerialisationTests(unittest.TestCase):
             queue.extend(obj.dependencies)
 
     def test_returns_string(self):
-        encoded = distbuild.serialise_artifact(self.art1,
-                                               self.art1.source.repo_name,
-                                               self.art1.source.sha1)
+        encoded = distbuild.encode_artifact(self.art1,
+                                            self.art1.source.repo_name,
+                                            self.art1.source.sha1)
         self.assertEqual(type(encoded), str)
 
     def test_works_without_dependencies(self):
diff --git a/distbuild/build_controller.py b/distbuild/build_controller.py
index 5f281682..3a099b82 100644
--- a/distbuild/build_controller.py
+++ b/distbuild/build_controller.py
@@ -335,7 +335,7 @@ class BuildController(distbuild.StateMachine):
         self._artifact_error = distbuild.StringBuffer()
         argv = [
             self._morph_instance,
-            'serialise-artifact',
+            'calculate-build-graph',
             '--quiet',
             self._request['repo'],
             self._request['ref'],
@@ -380,7 +380,7 @@ class BuildController(distbuild.StateMachine):
             
             text = self._artifact_data.peek()
             try:
-                artifact = distbuild.deserialise_artifact(text)
+                artifact = distbuild.decode_artifact_reference(text)
             except ValueError as e:
                 logging.error(traceback.format_exc())
                 self.fail('Failed to compute build graph: %s' % e)
diff --git a/distbuild/worker_build_scheduler.py b/distbuild/worker_build_scheduler.py
index 71e1c3ef..9397d5c9 100644
--- a/distbuild/worker_build_scheduler.py
+++ b/distbuild/worker_build_scheduler.py
@@ -527,9 +527,7 @@ class WorkerConnection(distbuild.StateMachine):
         msg = distbuild.message('exec-request',
             id=job.artifact.basename(),
             argv=argv,
-            stdin_contents=distbuild.serialise_artifact(job.artifact,
-                                                        job.artifact.repo,
-                                                        job.artifact.ref),
+            stdin_contents=distbuild.encode_artifact_reference(job.artifact),
         )
         self._jm.send(msg)
 
@@ -610,9 +608,9 @@ class WorkerConnection(distbuild.StateMachine):
         kind = job.artifact.kind
 
         if kind == 'chunk':
-            source_artifacts = job.artifact.source_artifacts
+            artifact_names = job.artifact.source_artifact_names
 
-            suffixes = ['%s.%s' % (kind, name) for name in source_artifacts]
+            suffixes = ['%s.%s' % (kind, name) for name in artifact_names]
             suffixes.append('build-log')
         else:
             filename = '%s.%s' % (kind, job.artifact.name)
diff --git a/morphlib/plugins/distbuild_plugin.py b/morphlib/plugins/distbuild_plugin.py
index 71d83dfe..c5ea5ed6 100644
--- a/morphlib/plugins/distbuild_plugin.py
+++ b/morphlib/plugins/distbuild_plugin.py
@@ -171,17 +171,18 @@ class DistbuildListJobsPlugin(cliapp.Plugin):
         loop.run()
 
 
-class SerialiseArtifactPlugin(cliapp.Plugin):
+class CalculateBuildGraphPlugin(cliapp.Plugin):
 
     def enable(self):
-        self.app.add_subcommand('serialise-artifact', self.serialise_artifact,
+        self.app.add_subcommand('calculate-build-graph',
+                                self.calculate_build_graph,
                                 arg_synopsis='REPO REF MORPHOLOGY [REF_NAME]')
 
     def disable(self):
         pass
 
-    def serialise_artifact(self, args):
-        '''Internal use only: Serialise Artifact build graph as JSON.'''
+    def calculate_build_graph(self, args):
+        '''Internal use only: Encode Artifact build graph as JSON.'''
         
         distbuild.add_crash_conditions(self.app.settings['crash-condition'])
         
@@ -202,9 +203,9 @@ class SerialiseArtifactPlugin(cliapp.Plugin):
         srcpool = build_command.create_source_pool(
             repo_name, ref, filename, original_ref=original_ref)
         artifact = build_command.resolve_artifacts(srcpool)
-        self.app.output.write(distbuild.serialise_artifact(artifact,
-                                                           repo_name,
-                                                           ref))
+        self.app.output.write(distbuild.encode_artifact(artifact,
+                                                        repo_name,
+                                                        ref))
         self.app.output.write('\n')
 
 
@@ -227,8 +228,8 @@ class WorkerBuild(cliapp.Plugin):
         
         distbuild.add_crash_conditions(self.app.settings['crash-condition'])
 
-        serialized = sys.stdin.readline()
-        artifact_reference = distbuild.deserialise_artifact(serialized)
+        text = sys.stdin.readline()
+        artifact_reference = distbuild.decode_artifact_reference(text)
 
         bc = morphlib.buildcommand.BuildCommand(self.app)
         source_pool = bc.create_source_pool(artifact_reference.repo,