File size: 9,519 Bytes
e00b837
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
#!/usr/bin/python
# -*- coding: utf-8 -*-

# Hive Appier Framework
# Copyright (c) 2008-2024 Hive Solutions Lda.
#
# This file is part of Hive Appier Framework.
#
# Hive Appier Framework is free software: you can redistribute it and/or modify
# it under the terms of the Apache License as published by the Apache
# Foundation, either version 2.0 of the License, or (at your option) any
# later version.
#
# Hive Appier Framework 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
# Apache License for more details.
#
# You should have received a copy of the Apache License along with
# Hive Appier Framework. If not, see <http://www.apache.org/licenses/>.

__author__ = "João Magalhães <joamag@hive.pt>"
""" The author(s) of the module """

__copyright__ = "Copyright (c) 2008-2024 Hive Solutions Lda."
""" The copyright for the module """

__license__ = "Apache License, Version 2.0"
""" The license for the module """

from . import util
from . import common
from . import legacy
from . import exceptions


class Git(object):
    @classmethod
    def is_git(cls, path=None):
        path = path or common.base().get_base_path()
        try:
            result = util.execute(["git", "status"], path=path)
        except OSError:
            return False
        code = result["code"]
        return code == 0

    @classmethod
    def clone(cls, url, path=None, raise_e=True):
        path = path or common.base().get_base_path()
        result = util.execute(["git", "clone", url], path=path)
        if cls._wrap_error(result, raise_e=raise_e):
            return None
        message = result.get("stdout", "")
        return message

    @classmethod
    def fetch(cls, flags=[], path=None, raise_e=True):
        path = path or common.base().get_base_path()
        result = util.execute(["git", "fetch"] + flags, path=path)
        if cls._wrap_error(result, raise_e=raise_e):
            return None
        message = result.get("stdout", "")
        return message

    @classmethod
    def pull(cls, flags=[], path=None, raise_e=True):
        path = path or common.base().get_base_path()
        result = util.execute(["git", "pull"] + flags, path=path)
        if cls._wrap_error(result, raise_e=raise_e):
            return None
        message = result.get("stdout", "")
        return message

    @classmethod
    def push(cls, flags=[], path=None, raise_e=True):
        path = path or common.base().get_base_path()
        result = util.execute(["git", "push"] + flags, path=path)
        if cls._wrap_error(result, raise_e=raise_e):
            return None
        message = result.get("stdout", "")
        return message

    @classmethod
    def commit(cls, message="Update", flags=[], path=None, raise_e=True):
        path = path or common.base().get_base_path()
        result = util.execute(["git", "commit", "-m", message] + flags, path=path)
        if cls._wrap_error(result, raise_e=raise_e):
            return None
        message = result.get("stdout", "")
        return message

    @classmethod
    def checkout(cls, branch="master", flags=[], path=None, raise_e=True):
        path = path or common.base().get_base_path()
        result = util.execute(["git", "checkout", branch] + flags, path=path)
        if cls._wrap_error(result, raise_e=raise_e):
            return None
        message = result.get("stdout", "")
        return message

    @classmethod
    def add(cls, target="*", flags=[], path=None, raise_e=True):
        path = path or common.base().get_base_path()
        result = util.execute(["git", "add", target] + flags, path=path)
        if cls._wrap_error(result, raise_e=raise_e):
            return None
        message = result.get("stdout", "")
        return message

    @classmethod
    def add_upstream(cls, url, name="upstream", path=None, raise_e=True):
        path = path or common.base().get_base_path()
        result = util.execute(["git", "remote", "add", name, url], path=path)
        if cls._wrap_error(result, raise_e=raise_e):
            return None
        message = result.get("stdout", "")
        return message

    @classmethod
    def remove_upstream(cls, name="upstream", path=None, raise_e=True):
        path = path or common.base().get_base_path()
        result = util.execute(["git", "remote", "remove", name], path=path)
        if cls._wrap_error(result, raise_e=raise_e):
            return None
        message = result.get("stdout", "")
        return message

    @classmethod
    def config(cls, key, value, _global=True, path=None, raise_e=True):
        path = path or common.base().get_base_path()
        result = util.execute(
            ["git", "config", "--global" if _global else "", key, value], path=path
        )
        if cls._wrap_error(result, raise_e=raise_e):
            return None
        message = result.get("stdout", "")
        return message

    @classmethod
    def get_config(cls, key, _global=True, path=None, raise_e=False):
        path = path or common.base().get_base_path()
        result = util.execute(
            ["git", "config", "--global" if _global else "", "--get", key], path=path
        )
        if cls._wrap_error(result, raise_e=raise_e):
            return None
        message = result.get("stdout", "")
        value = message.strip()
        return value

    @classmethod
    def get_branches(cls, names=False, path=None, raise_e=False):
        path = path or common.base().get_base_path()
        result = util.execute(["git", "branch"], path=path)
        if cls._wrap_error(result, raise_e=raise_e):
            return None
        message = result.get("stdout", "")
        branches = message.strip()
        branches = branches.split("\n")
        branches = [(value.lstrip("* "), value.startswith("*")) for value in branches]
        if names:
            branches = [branch[0] for branch in branches]
        return branches

    @classmethod
    def get_branch(cls, path=None, raise_e=False):
        path = path or common.base().get_base_path()
        branches = cls.get_branches(path=path, raise_e=raise_e)
        for branch, selected in branches:
            if not selected:
                continue
            return branch
        return None

    @classmethod
    def get_commit(cls, path=None, raise_e=False):
        path = path or common.base().get_base_path()
        result = util.execute(["git", "rev-parse", "HEAD"], path=path)
        if cls._wrap_error(result, raise_e=raise_e):
            return None
        message = result.get("stdout", "")
        commit = message.strip()
        return commit

    @classmethod
    def get_origin(cls, path=None, raise_e=False):
        path = path or common.base().get_base_path()
        result = util.execute(
            ["git", "config", "--get", "remote.origin.url"], path=path
        )
        if cls._wrap_error(result, raise_e=raise_e):
            return None
        message = result.get("stdout", "")
        origin = message.strip()
        origin = cls.safe_origin(origin)
        return origin

    @classmethod
    def get_repo_path(cls, path=None, raise_e=False):
        path = path or common.base().get_base_path()
        result = util.execute(["git", "rev-parse", "--show-toplevel"], path=path)
        if cls._wrap_error(result, raise_e=raise_e):
            return None
        message = result.get("stdout", "")
        repo_path = message.strip()
        return repo_path

    @classmethod
    def safe_origin(cls, origin, display_l=3):
        parse = legacy.urlparse(origin)
        safe_l = []
        if parse.scheme:
            safe_l.append(parse.scheme + "://")
        if parse.username:
            safe_l.append(parse.username)
        if parse.password:
            obfuscated = util.obfuscate(parse.password)
            safe_l.append(":" + obfuscated)
        if parse.username:
            safe_l.append("@")
        if parse.hostname:
            safe_l.append(parse.hostname)
        if parse.path:
            safe_l.append(parse.path)
        return "".join(safe_l)

    @classmethod
    def norm_origin(cls, origin, prefix="https://"):
        if origin.startswith(("http://", "https://")):
            return origin
        if origin.endswith(".git"):
            origin = origin[:-4]
        origin = origin.replace(":", "/")
        origin = prefix + origin
        return origin

    @classmethod
    def parse_origin(cls, origin, safe=True):
        parse = legacy.urlparse(origin)
        if safe and not parse.scheme:
            origin = cls.norm_origin(origin)
            return cls.parse_origin(origin, safe=False)
        scheme = parse.scheme if parse.scheme else "ssh"
        username = parse.username if parse.username else None
        password = parse.password if parse.password else None
        hostname = parse.hostname if parse.hostname else None
        path = parse.path if parse.path else None
        return dict(
            scheme=scheme,
            username=username,
            password=password,
            hostname=hostname,
            path=path,
        )

    @classmethod
    def _wrap_error(cls, result, raise_e=False):
        code = result["code"]
        if code == 0:
            return False
        if raise_e:
            raise exceptions.OperationalError(
                message=result.get("stderr", "") or result.get("stdout", "")
            )
        return True