utils.py 6.34 KB
Newer Older
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
# Copyright (C) 2013 GRNET S.A. All rights reserved.
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
#   1. Redistributions of source code must retain the above
#      copyright notice, this list of conditions and the following
#      disclaimer.
#
#   2. Redistributions in binary form must reproduce the above
#      copyright notice, this list of conditions and the following
#      disclaimer in the documentation and/or other materials
#      provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# The views and conclusions contained in the software and
# documentation are those of the authors and should not be
# interpreted as representing official policies, either expressed
# or implied, of GRNET S.A.

import os
import git
36
import sh
37
from collections import namedtuple
38
39
from configobj import ConfigObj

40
from devflow import BRANCH_TYPES
41
42


43
def get_repository(path=None):
44
    """Load the repository from the current working dir."""
45
46
    if path is None:
        path = os.getcwd()
47
    try:
48
        return git.Repo(path)
49
50
    except git.InvalidGitRepositoryError:
        msg = "Cound not retrivie git information. Directory '%s'"\
51
              " is not a git repository!" % path
52
53
54
        raise RuntimeError(msg)


55
56
57
58
59
60
61
62
63
64
def get_config(path=None):
    """Load configuration file."""
    if path is None:
        toplevel = get_vcs_info().toplevel
        path = os.path.join(toplevel, "devflow.conf")

    config = ConfigObj(path)
    return config


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
def get_vcs_info():
    """Return current git HEAD commit information.

    Returns a tuple containing
        - branch name
        - commit id
        - commit count
        - git describe output
        - path of git toplevel directory

    """

    repo = get_repository()
    branch = repo.head.reference
    revid = get_commit_id(branch.commit, branch)
    revno = len(list(repo.iter_commits()))
    toplevel = repo.working_dir

    info = namedtuple("vcs_info", ["branch", "revid", "revno",
                                   "toplevel"])

    return info(branch=branch.name, revid=revid, revno=revno,
                toplevel=toplevel)


def get_commit_id(commit, current_branch):
    """Return the commit ID

    If the commit is a 'merge' commit, and one of the parents is a
    debian branch we return a compination of the parents commits.

    """
    def short_id(commit):
        return commit.hexsha[0:7]

    parents = commit.parents
    cur_br_name = current_branch.name
    if len(parents) == 1:
        return short_id(commit)
    elif len(parents) == 2:
        if cur_br_name.startswith("debian-") or cur_br_name == "debian":
            pr1, pr2 = parents
            return short_id(pr1) + "_" + short_id(pr2)
        else:
            return short_id(commit)
    else:
        raise RuntimeError("Commit %s has more than 2 parents!" % commit)
112
113
114
115
116
117
118


def get_debian_branch(branch):
    """Find the corresponding debian- branch"""
    if branch == "master":
        return "debian"
    deb_branch = "debian-" + branch
119
120
    # Check if debian-branch exists (local or origin)
    if _get_branch(deb_branch):
121
122
        return deb_branch
    branch_type = BRANCH_TYPES[get_branch_type(branch)]
123
124
125
126
127
128
    # If not try the default debian branch
    default_branch = branch_type.debian_branch
    if _get_branch(default_branch):
        repo = get_repository()
        repo.git.branch(deb_branch, default_branch)
        print "Created branch '%s' from '%s'" % (deb_branch, default_branch)
129
        return deb_branch
130
131
132
    # If not try the debian branch
    repo.git.branch(deb_branch, default_branch)
    print "Created branch '%s' from 'debian'" % deb_branch
133
134
135
136
137
138
139
140
141
    return "debian"


def _get_branch(branch):
    repo = get_repository()
    if branch in repo.branches:
        return branch
    origin_branch = "origin/" + branch
    if origin_branch in repo.refs:
Christos Stavrakakis's avatar
Christos Stavrakakis committed
142
        print "Creating branch '%s' to track '%s'" % (branch, origin_branch)
143
144
145
146
        repo.git.branch(branch, origin_branch)
        return branch
    else:
        return None
147
148
149
150
151
152
153


def get_build_mode():
    """Determine the build mode"""
    # Get it from environment if exists
    mode = os.environ.get("DEVFLOW_BUILD_MODE", None)
    if mode is None:
Christos Stavrakakis's avatar
Fix bug    
Christos Stavrakakis committed
154
        branch = get_branch_type(get_vcs_info().branch)
155
        try:
Christos Stavrakakis's avatar
Fix bug    
Christos Stavrakakis committed
156
            br_type = BRANCH_TYPES[get_branch_type(branch)]
157
158
159
160
161
162
        except KeyError:
            allowed_branches = ", ".join(x for x in BRANCH_TYPES.keys())
            raise ValueError("Malformed branch name '%s', cannot classify as"
                             " one of %s" % (branch, allowed_branches))
        mode = "snapshot" if br_type.builds_snapshot else "release"
    return mode
Christos Stavrakakis's avatar
Fix bug    
Christos Stavrakakis committed
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183


def normalize_branch_name(branch_name):
    """Normalize branch name by removing debian- if exists"""
    brnorm = branch_name
    if brnorm == "debian":
        brnorm = "debian-master"
    # If it's a debian branch, ignore starting "debian-"
    if brnorm.startswith("debian-"):
        brnorm = brnorm.replace("debian-", "", 1)
    return brnorm


def get_branch_type(branch_name):
    """Extract the type from a branch name"""
    branch_name = normalize_branch_name(branch_name)
    if "-" in branch_name:
        btypestr = branch_name.split("-")[0]
    else:
        btypestr = branch_name
    return btypestr
184
185
186
187


def version_to_tag(version):
    return version.replace("~", "")
188

189

190
191
192
193
194
195
196
def undebianize(branch):
    if branch == "debian":
        return "master"
    elif branch.startswith("debian-"):
        return branch.replace("debian-", "")
    else:
        return branch
197
198
199
200
201
202
203


def get_distribution_codename():
    output = sh.lsb_release("-c")
    _, codename = output.split("\t")
    codename = codename.strip()
    return codename