aboutsummaryrefslogtreecommitdiffstats
path: root/libbe/upgrade.py
blob: 6f14cd8e2e8272b5b1dc8058a6580602b9190b8d (plain) (blame)
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
# Copyright (C) 2009 W. Trevor King <wking@drexel.edu>
#
# 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; either version 2 of the License, or
# (at your option) any later version.
#
# 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.

"""
Handle conversion between the various on-disk images.
"""

import os, os.path
import sys
import doctest

import encoding
import mapfile
import rcs

# a list of all past versions
BUGDIR_DISK_VERSIONS = ["Bugs Everywhere Tree 1 0",
                        "Bugs Everywhere Directory v1.1"]

# the current version
BUGDIR_DISK_VERSION = BUGDIR_DISK_VERSIONS[-1]

class Upgrader (object):
    "Class for converting "
    initial_version = None
    final_version = None
    def __init__(self, root):
        self.root = root
        # use the "None" RCS to ensure proper encoding/decoding and
        # simplify path construction.
        self.rcs = rcs.rcs_by_name("None")
        self.rcs.root(self.root)
        self.rcs.encoding = encoding.get_encoding()

    def get_path(self, *args):
        """
        Return a path relative to .root.
        """
        dir = os.path.join(self.root, ".be")
        if len(args) == 0:
            return dir
        assert args[0] in ["version", "settings", "bugs"], str(args)
        return os.path.join(dir, *args)

    def check_initial_version(self):
        path = self.get_path("version")
        version = self.rcs.get_file_contents(path).rstrip("\n")
        assert version == self.initial_version, version

    def set_version(self):
        path = self.get_path("version")
        self.rcs.set_file_contents(path, self.final_version+"\n")

    def upgrade(self):
        print >> sys.stderr, "upgrading bugdir from '%s' to '%s'" \
            % (self.initial_version, self.final_version)
        self.check_initial_version()
        self.set_version()
        self._upgrade()

    def _upgrade(self):
        raise NotImplementedError


class Upgrade_1_0_to_2 (Upgrader):
    initial_version = "Bugs Everywhere Tree 1 0"
    final_version = "Bugs Everywhere Directory v2"
    def _upgrade_mapfile(self, path):
        contents = self.rcs.get_file_contents(path)
        old_format = False
        for line in contents.splitlines():
            if len(line.split("=")) == 2:
                old_format = True
                break
        if old_format == True:
            # translate to YAML.
            newlines = []
            for line in contents.splitlines():
                line = line.rstrip('\n')
                if len(line) == 0:
                    continue
                fields = line.split("=")
                if len(fields) == 2:
                    key,value = fields
                    newlines.append('%s: "%s"' % (key, value.replace('"','\\"')))
                else:
                    newlines.append(line)
            contents = '\n'.join(newlines)
            # load the YAML and save
            map = mapfile.parse(contents)
            mapfile.map_save(self.rcs, path, map)

    def _upgrade(self):
        """
        Comment value field "From" -> "Author".
        Homegrown mapfile -> YAML.
        """
        path = self.get_path("settings")
        self._upgrade_mapfile(path)
        for bug_uuid in os.listdir(self.get_path("bugs")):
            path = self.get_path("bugs", bug_uuid, "values")
            self._upgrade_mapfile(path)
            c_path = ["bugs", bug_uuid, "comments"]
            if not os.path.exists(self.get_path(*c_path)):
                continue # no comments for this bug
            for comment_uuid in os.listdir(self.get_path(*c_path)):
                path_list = c_path + [comment_uuid, "values"]
                path = self.get_path(*path_list)
                self._upgrade_mapfile(path)
                settings = mapfile.map_load(self.rcs, path)
                if "From" in settings:
                    settings["Author"] = settings.pop("From")
                    mapfile.map_save(self.rcs, path, settings)


upgraders = [Upgrade_1_0_to_2]
upgrade_classes = {}
for upgrader in upgraders:
    upgrade_classes[(upgrader.initial_version,upgrader.final_version)]=upgrader

def upgrade(path, current_version,
            target_version=BUGDIR_DISK_VERSION):
    """
    Call the appropriate upgrade function to convert current_version
    to target_version.  If a direct conversion function does not exist,
    use consecutive conversion functions.
    """
    if current_version not in BUGDIR_DISK_VERSIONS:
        raise NotImplementedError, \
            "Cannot handle version '%s' yet." % version
    if target_version not in BUGDIR_DISK_VERSIONS:
        raise NotImplementedError, \
            "Cannot handle version '%s' yet." % version

    if (current_version, target_version) in upgrade_classes:
        # direct conversion
        upgrade_class = upgrade_classes[(current_version, target_version)]
        u = upgrade_class(path)
        u.upgrade()
    else:
        # consecutive single-step conversion
        i = BUGDIR_DISK_VERSIONS.index(current_version)
        while True:
            version_a = BUGDIR_DISK_VERSIONS[i]
            version_b = BUGDIR_DISK_VERSIONS[i+1]
            try:
                upgrade_class = upgrade_classes[(version_a, version_b)]
            except KeyError:
                raise NotImplementedError, \
                    "Cannot convert version '%s' to '%s' yet." \
                    % (version_a, version_b)
            u = upgrade_class(path)
            u.upgrade()
            if version_b == target_version:
                break
            i += 1

suite = doctest.DocTestSuite()