summaryrefslogtreecommitdiff
path: root/scripts/organize-morphologies.py
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/organize-morphologies.py')
-rwxr-xr-xscripts/organize-morphologies.py244
1 files changed, 244 insertions, 0 deletions
diff --git a/scripts/organize-morphologies.py b/scripts/organize-morphologies.py
new file mode 100755
index 00000000..566a28e9
--- /dev/null
+++ b/scripts/organize-morphologies.py
@@ -0,0 +1,244 @@
+# Copyright (C) 2014 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 json
+import morphlib
+import os
+import subprocess
+import sys
+import urllib
+import urllib2
+import urlparse
+import yaml
+import re
+
+''' organize-morphologies.py:
+Tool for organizing morphologies in definitions.
+This script will move:
+ - cluster morphologies into clusters directory
+ - system morphologies into systems directory
+ - stratum morphologies into strata directory
+This script will download the chunk morphologies for every stratum
+and placed into strata/stratum_which_the_chunk_belongs_to directory
+'''
+
+
+# NOTE: The following reimplements part of morphlib's remote repo cache stuff
+def parse_repo_alias(repo):
+ domain, path = repo.split(':')
+ if domain == 'baserock':
+ repo = 'ssh://git@git.baserock.org/baserock/%s' % path
+ elif domain == 'upstream':
+ repo = 'ssh://git@git.baserock.org/delta/%s' % path
+ else:
+ raise Exception("I don't know how to parse the repo-alias \"%s\"" % repo)
+ return repo
+
+def make_request(path):
+ server_url = 'http://git.baserock.org:8080/'
+ url = urlparse.urljoin(server_url, '/1.0/%s' % path)
+ handle = urllib2.urlopen(url)
+ return handle.read()
+
+def quote(*args):
+ return tuple(urllib.quote(string) for string in args)
+
+def cat_file(repo, ref, filename):
+ return make_request('files?repo=%s&ref=%s&filename=%s' %
+ quote(repo, ref, filename))
+
+# NOTE: This function reimplement part of morphlib's loader
+def sanitise_morphology_path(morph_field, morph_kind, belongs_to='None'):
+ '''This function receives the name or the morph field of one morphology
+ and returns the path of the morphology depending on the name, kind and
+ if it belongs to other morphologies.
+ '''
+ # Dictionary which match morphology's kind and morphology's
+ # directory in definitions.git
+ morph_dir = { 'chunk': 'chunks', 'stratum': 'strata',
+ 'system':'systems', 'cluster': 'clusters'}
+ # For chunks morphologies we need to know to which stratums
+ # belongs this chunk.
+ if morph_kind == 'chunk':
+ if belongs_to == 'None':
+ raise morphlib.Error('Chunk morphologies need the stratum name'
+ 'to create the path. Please add the stratum'
+ 'which belongs this morphology')
+ # Get the name of the chunk which we assume is at the end
+ # of the morph file
+ if '/' in morph_field:
+ morph_field = morph_field.split('/')[-1]
+
+ # Add the stratum name to the chunk name
+ morph_field = belongs_to + '/' + morph_field
+
+ # Reset the kind to stratum because chunk contains stratum
+ # name in its path.
+ morph_kind = 'stratum'
+
+ # Add the morphology path to the morph field.
+ if morph_dir[morph_kind] not in morph_field:
+ morph_field = morph_dir[morph_kind] + '/' + morph_field
+
+ # Add the morphology suffix if the morphology.
+ if not morph_field.endswith('.morph'):
+ morph_field = morph_field + '.morph'
+
+ return morph_field
+
+def create_directory(name, path):
+ directory = os.path.join(path, name)
+ subprocess.call(['mkdir','-p', directory])
+ return directory
+
+def move_file(morph, directory, path):
+ if not morph.filename.startswith(directory):
+ filename = morph.filename.split('/')[-1]
+ new_location = os.path.join(path, filename)
+ print 'Moving %s into %s\n' % (filename, new_location)
+ subprocess.call(['git', 'mv', morph.filename, new_location])
+ morph.filename = new_location
+ loader.save_to_file(morph.filename, morph)
+
+def move_morphologies(morphs, kind, directory, path):
+ # Dictionary which match morphology's kind and morphology's
+ # directory in definitions.git
+ morph_dir = { 'chunk': 'chunks', 'stratum': 'strata',
+ 'system':'systems', 'cluster': 'clusters'}
+ # Create the morphology's directory and move the morphologies to it
+ full_path = create_directory(directory, path)
+ for morph in morphs:
+ # Add the correct path to the morph fields in the morphology.
+ for submorph in morph[morph_dir[kind]]:
+ submorph['morph'] = sanitise_morphology_path(submorph['morph'], kind)
+ move_file(morph, directory, full_path)
+
+def move_clusters(morphs):
+ kind = 'system'
+ directory = 'clusters'
+ path = definitions_repo
+ # Move cluster morphologies to clusters folder fixing their dependent
+ # morphologies which are systems.
+ move_morphologies(morphs, kind, directory, path)
+
+def move_systems(morphs):
+ kind = 'stratum'
+ directory = 'systems'
+ path = definitions_repo
+ # Move system morphologies to systems folder fixing their dependent
+ # morphologies which are strata.
+ move_morphologies(morphs, kind, directory, path)
+
+def move_chunks(morphs):
+ # There are not spec for this yet
+ print "No spec defined\n"
+
+def download_chunks(morph):
+ # Download chunks morphologies defined on the stratum and
+ # add them to the directory tree.
+ for chunk in morph['chunks']:
+ name = chunk['name'] + '.morph'
+ chunk['morph'] = sanitise_morphology_path(chunk['morph'], 'chunk', morph['name'])
+ ref = chunk['ref']
+ repo = parse_repo_alias(chunk['repo'])
+ try:
+ print "\nDownloading %s from %s into %s" %(name, repo, chunk['morph'])
+ chunk_morph = cat_file(repo, ref, name)
+ new_chunk = loader.load_from_string(chunk_morph)
+ loader.save_to_file(chunk['morph'], new_chunk)
+ except urllib2.HTTPError as err:
+ # If there is no morphology in the repository we assume that the morphology
+ # system will be autodetected, so we don't have to create a new one
+ # unless we shut down the autodetecting system (fallback system).
+ if err.code == 404:
+ print 'WARNING: %s not found in %s.' \
+ 'Expected autodetection at build time' %(name, repo)
+ # Remove morph field from autodetected chunks
+ del chunk['morph']
+ except morphlib.morphloader.InvalidFieldError as err:
+ print "ERROR: %s in chunk %s." % (err, chunk_morph)
+ if "comments" in str(err):
+ # This error is caused because there are old morphologies which
+ # contain the field "comments" instead of "description".
+ # Replacing "comments" field by "description" will allow the morphology
+ # to pass parse_morphology_text check and ready to be written to a file.
+ fixed_chunk = loader.parse_morphology_text(chunk_morph, name)
+ fixed_chunk['description'] = fixed_chunk.pop('comments')
+ loader.save_to_file(chunk['morph'], fixed_chunk)
+ print "Fixing error in %s and moving into %s." %(name, chunk['morph'])
+ if "buildsystem" in str(err):
+ # This error is caused because a typo in a morphology which
+ # has a field "buildsystem" instead of "build-system".
+ fixed_chunk = loader.parse_morphology_text(chunk_morph, name)
+ fixed_chunk['build-system'] = fixed_chunk.pop('buildsystem')
+ loader.save_to_file(chunk['morph'], fixed_chunk)
+ print "Fixing error in %s and moving into %s" %(name, chunk['morph'])
+ except morphlib.morphloader.MorphologyNotYamlError as err:
+ print "ERROR: %s in chunk %s." % (err, chunk_morph)
+ # This error is caused because there are old morphologies written
+ # in JSON which contain '\t' characters. When try to load this
+ # kind of morphologies load_from_string fails when parse_morphology_text.
+ # Removing this characters will make load_from_string to load the morphology
+ # and translate it into a correct yaml format.
+ fix_chunk = chunk_morph.replace('\t','')
+ new_chunk = loader.load_from_string(fix_chunk)
+ loader.save_to_file(chunk['morph'], new_chunk)
+ print "Fixing error in %s and moving into %s." %(name, chunk['morph'])
+
+def move_strata(morphs):
+ # Create strata directory
+ strata_dir = 'strata/'
+ strata_path = create_directory(strata_dir, definitions_repo)
+ for morph in morphs:
+ # Create stratum directory where downloading its chunks.
+ stratum_path = strata_path + morph['name']
+ stratum_dir = create_directory(stratum_path, definitions_repo)
+
+ # Download chunks which belongs to the stratum
+ download_chunks(morph)
+
+ # Add to build-depends the correct path to the dependent stratum morphologies.
+ for build_depends in morph['build-depends']:
+ build_depends['morph'] = sanitise_morphology_path(build_depends['morph'], 'stratum')
+ # Move stratum morphologies to strata
+ move_file(morph, strata_dir, strata_path)
+
+def main():
+ # Load all morphologies in the definitions repo
+ sb = morphlib.sysbranchdir.open_from_within('.')
+ loader = morphlib.morphloader.MorphologyLoader()
+ morphs = [m for m in sb.load_all_morphologies(loader)]
+
+ # Clasify the morphologies regarding of their kind field
+ morphologies = { 'chunk': '', 'stratum': '', 'system' : '', 'cluster': '' }
+
+ for key in morphologies.iterkeys():
+ morphologies[key] = [m for m in morphs if m['kind'] == key]
+ print 'There are: %d %s.\n' %(len(morphologies[key]), key)
+
+ # Get the path from definitions repo
+ definitions_repo = sb.get_git_directory_name(sb.root_repository_url)
+
+ # Move the morphologies to its directories
+ for key in morphologies.iterkeys():
+ print "Moving %s....\n" %key
+ if key == 'cluster': move_clusters(morphologies[key])
+ elif key == 'system': move_systems(morphologies[key])
+ elif key == 'stratum': move_strata(morphologies[key])
+ elif key == 'chunk': move_chunks(morphologies[key])
+ else: print 'ERROR: Morphology unknown: %s.\n' % key
+
+main()