git-ar 1.1.12

Git all remotes. Git cli tool that targets both Github and Gitlab. Brings common development operations such as opening a pull request down to the shell. This is an alternative to both Github https://github.com/cli/cli and Gitlab https://gitlab.com/gitlab-org/cli cli tools.
Documentation 
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

import requests
import json
import os
import argparse

from validation import validate_responses
from validation import persist_contract
from validation import get_contract_json

PRIVATE_TOKEN = os.environ["GITLAB_TOKEN"]
REMOTE = "gitlab"

parser = argparse.ArgumentParser()
parser.add_argument("--persist", action="store_true")
args = parser.parse_args()


def get_project_api_json():
    url = "https://gitlab.com/api/v4/projects/jordilin%2Fgitlapi"
    headers = {"PRIVATE-TOKEN": PRIVATE_TOKEN}
    response = requests.get(url, headers=headers)
    data = response.json()

    data["runners_token"] = "REDACTED"
    data["namespace"]["avatar_url"] = "https://any_url_test.test"
    data["owner"]["avatar_url"] = "https://any_url_test.test"
    data["service_desk_address"] = "https://any_url_test.test"
    data["owner"]["id"] = 123456
    # change to a long time ago to avoid flaky tests
    data["container_expiration_policy"]["next_run_at"] = "2060-03-20T06:26:02.725Z"
    if args.persist:
        persist_contract("project.json", REMOTE, data)
    return data


def get_project_members_api_json():
    url = "https://gitlab.com/api/v4/projects/gitlab-org%2Fgitlab/members"
    headers = {"PRIVATE-TOKEN": PRIVATE_TOKEN}
    # members API is paginated, gather headers to test pagination
    response = requests.get(url, headers=headers)
    # take first two members and fake data
    data = response.json()[:2]
    for i, member in enumerate(data):
        member["avatar_url"] = "https://any_url_test.test" + str(i)
        member["web_url"] = "https://any_url_test.test" + str(i)
        member["id"] = i + 123456
        member["username"] = "test_user_" + str(i)
        member["name"] = "Test User " + str(i)
        member["created_by"]["avatar_url"] = "https://any_url_test.test" + str(i)
        member["created_by"]["web_url"] = "https://any_url_test.test" + str(i)
        member["created_by"]["id"] = i + 123456
        member["created_by"]["username"] = "test_user_" + str(i)
        member["created_by"]["name"] = "Test User " + str(i)
    if args.persist:
        persist_contract("project_members.json", REMOTE, data)
        persist_contract(
            "project_members_response_headers.json", REMOTE, dict(response.headers)
        )
    return response.json()


def merge_request_api():
    mr_base_url = "https://gitlab.com/api/v4/projects/jordilin%2Fgitlapi/merge_requests"
    existing_mr_url = f"{mr_base_url}/33"
    headers = {"PRIVATE-TOKEN": PRIVATE_TOKEN}
    response = requests.get(existing_mr_url, headers=headers)
    assert response.status_code == 200
    data = response.json()
    author = data["author"]
    author["id"] = 123456
    author["avatar_url"] = "https://any_url_test.test"
    user = data["head_pipeline"]["user"]
    user["id"] = 123456
    user["avatar_url"] = "https://any_url_test.test"
    if args.persist:
        persist_contract("merge_request.json", REMOTE, data)
    # re-create - response with a 409
    body = {
        "source_branch": "feature",
        "target_branch": "main",
        "title": "New Feature",
    }
    response = requests.post(mr_base_url, headers=headers, data=body)
    assert response.status_code == 409
    data_conflict = response.json()
    if args.persist:
        persist_contract("merge_request_conflict.json", REMOTE, data_conflict)
    return data, data_conflict


def list_pipelines_api():
    # https://docs.gitlab.com/ee/api/pipelines.html
    url = "https://gitlab.com/api/v4/projects/jordilin%2Fgitlapi/pipelines"
    headers = {"PRIVATE-TOKEN": PRIVATE_TOKEN}
    response = requests.get(url, headers=headers)
    data = response.json()
    if args.persist:
        persist_contract("list_pipelines.json", REMOTE, data)
    return data[0]


def list_registry_repositories_api():
    url = "https://gitlab.com/api/v4/projects/jordilin%2Fgitlapi/registry/repositories?tags_count=true"
    headers = {"PRIVATE-TOKEN": PRIVATE_TOKEN}
    response = requests.get(url, headers=headers)
    data = response.json()
    if args.persist:
        persist_contract("list_registry_repositories.json", REMOTE, data)
    return data[0]


def list_registry_repository_tags_api():
    url = "https://gitlab.com/api/v4/projects/jordilin%2Fgitlapi/registry/repositories/6120360/tags"
    headers = {"PRIVATE-TOKEN": PRIVATE_TOKEN}
    response = requests.get(url, headers=headers)
    data = response.json()
    if args.persist:
        persist_contract("list_registry_repository_tags.json", REMOTE, data)
    return data[0]


def get_registry_repository_tag_api():
    url = "https://gitlab.com/api/v4/projects/jordilin%2Fgitlapi/registry/repositories/6120360/tags/v0.0.1"
    headers = {"PRIVATE-TOKEN": PRIVATE_TOKEN}
    response = requests.get(url, headers=headers)
    data = response.json()
    if args.persist:
        persist_contract("get_registry_repository_tag.json", REMOTE, data)
    return data


def list_releases_api():
    url = "https://gitlab.com/api/v4/projects/jordilin%2Fgitlapi/releases"
    headers = {"PRIVATE-TOKEN": PRIVATE_TOKEN}
    response = requests.get(url, headers=headers)
    data = response.json()
    if args.persist:
        persist_contract("list_releases.json", REMOTE, data)
    return data[0]


def list_get_user_info():
    url = "https://gitlab.com/api/v4/user"
    headers = {"PRIVATE-TOKEN": PRIVATE_TOKEN}
    response = requests.get(url, headers=headers)
    data = response.json()
    if args.persist:
        persist_contract("get_user_info.json", REMOTE, data)
    return data


def list_gitlab_project_runners_api():
    url = "https://gitlab.com/api/v4/projects/jordilin%2Fgitlapi/runners"
    headers = {"PRIVATE-TOKEN": PRIVATE_TOKEN}
    response = requests.get(url, headers=headers)
    data = response.json()
    if args.persist:
        persist_contract("list_project_runners.json", REMOTE, data)
    return data[0]


def get_runner_details_api():
    runner = get_contract_json("list_project_runners.json", REMOTE).data
    url = f"https://gitlab.com/api/v4/runners/{runner['id']}"
    headers = {"PRIVATE-TOKEN": PRIVATE_TOKEN}
    response = requests.get(url, headers=headers)
    data = response.json()
    if args.persist:
        persist_contract("get_runner_details.json", REMOTE, data)
    return data


def list_user_starred_projects():
    url = "https://gitlab.com/api/v4/users/jordilin/starred_projects"
    headers = {"PRIVATE-TOKEN": PRIVATE_TOKEN}
    response = requests.get(url, headers=headers)
    data = response.json()
    if args.persist:
        persist_contract("stars.json", REMOTE, data)
    return data[0]


class TestAPI:
    def __init__(self, callback, msg, *expected):
        self.callback = callback
        self.msg = msg
        self.expected = expected


if __name__ == "__main__":
    testcases = [
        TestAPI(
            get_project_api_json,
            "project API contract",
            get_contract_json("project.json", REMOTE),
        ),
        TestAPI(
            merge_request_api,
            "merge request API contract",
            get_contract_json("merge_request.json", REMOTE),
            get_contract_json("merge_request_conflict.json", REMOTE),
        ),
        TestAPI(
            list_pipelines_api,
            "list pipelines API contract",
            get_contract_json("list_pipelines.json", REMOTE),
        ),
        TestAPI(
            list_registry_repositories_api,
            "list registry repositories API contract",
            get_contract_json("list_registry_repositories.json", REMOTE),
        ),
        TestAPI(
            list_registry_repository_tags_api,
            "list registry repository tags API contract",
            get_contract_json("list_registry_repository_tags.json", REMOTE),
        ),
        TestAPI(
            get_registry_repository_tag_api,
            "get registry repository tag API contract",
            get_contract_json("get_registry_repository_tag.json", REMOTE),
        ),
        TestAPI(
            list_releases_api,
            "list releases API contract",
            get_contract_json("list_releases.json", REMOTE),
        ),
        TestAPI(
            list_get_user_info,
            "get user info API contract",
            get_contract_json("get_user_info.json", REMOTE),
        ),
        TestAPI(
            list_gitlab_project_runners_api,
            "list gitlab project runners API contract",
            get_contract_json("list_project_runners.json", REMOTE),
        ),
        TestAPI(
            get_runner_details_api,
            "get runner details API contract",
            get_contract_json("get_runner_details.json", REMOTE),
        ),
        TestAPI(
            list_user_starred_projects,
            "list user starred projects API contract",
            get_contract_json("stars.json", REMOTE),
        ),
    ]
    if not validate_responses(testcases):
        exit(1)
    # TODO
    # # get_project_members_api_json()