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) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
import requests
from knack.log import get_logger
from knack.util import CLIError
from azext_devops.dev.common.prompting import prompt_not_empty
from azext_devops.dev.common.git import resolve_git_ref_heads, get_branch_name_from_ref
logger = get_logger(__name__)
_HTTP_NOT_FOUND_STATUS = 404
_HTTP_SUCCESS_STATUS = 200
_HTTP_CREATED_STATUS = 201
class Files: # pylint: disable=too-few-public-methods
def __init__(self, path, content):
self.path = path
self.content = content
def get_github_pat_token():
from azext_devops.dev.common.github_credential_manager import GithubCredentialManager
github_manager = GithubCredentialManager()
return github_manager.get_token()
def get_github_repos_api_url(repo_id):
return 'https://api.github.com/repos/' + repo_id
def push_files_github(files, repo_name, branch, commit_to_branch, message="Set up CI with Azure Pipelines"):
if commit_to_branch:
commit_files_to_github_branch(files, repo_name, branch, message)
return branch
# Pull request flow
# Create Branch
new_branch = create_github_branch(repo=repo_name, source=branch)
# Commit files to branch
commit_files_to_github_branch(files, repo_name, new_branch, message)
# Create PR from new branch
pr = create_pr_github(branch, new_branch, repo_name, message)
print('Created a Pull Request - {url}'.format(url=pr['url']))
return new_branch
def create_pr_github(branch, new_branch, repo_name, message):
"""
API Documentation - https://developer.github.com/v3/pulls/#create-a-pull-request
"""
token = get_github_pat_token()
create_pr_url = 'https://api.github.com/repos/{repo_id}/pulls'.format(repo_id=repo_name)
create_pr_request_body = {
"title": message,
"head": new_branch,
"base": branch
}
create_response = requests.post(url=create_pr_url, auth=('', token),
json=create_pr_request_body, headers=get_application_json_header())
if not create_response.status_code == _HTTP_CREATED_STATUS:
raise CLIError('Pull request creation failed. Error: ({err})'.format(err=create_response.reason))
import json
return json.loads(create_response.text)
def create_github_branch(repo, source):
"""
API Documentation - https://developer.github.com/v3/git/refs/#create-a-reference
"""
token = get_github_pat_token()
# Validate new branch name is valid
branch_is_valid = False
while not branch_is_valid:
new_branch = prompt_not_empty(msg='Enter new branch name to create: ')
ref, is_folder = get_github_branch(repo, new_branch)
if not ref and not is_folder:
branch_is_valid = True
else:
logger.warning('Not a valid branch name.')
# Get source branch ref
ref_item, is_folder = get_github_branch(repo, source)
if not ref_item or is_folder:
raise CLIError('Branch ({branch}) does not exist.'.format(branch=source))
source_ref = ref_item['object']['sha']
create_github_ref_url = 'https://api.github.com/repos/{repo_id}/git/refs'.format(repo_id=repo)
create_github_ref_request_body = {
"ref": resolve_git_ref_heads(new_branch),
"sha": source_ref
}
create_response = requests.post(url=create_github_ref_url, auth=('', token),
json=create_github_ref_request_body, headers=get_application_json_header())
if not create_response.status_code == _HTTP_CREATED_STATUS:
raise CLIError('Branch creation failed. Error: ({err})'.format(err=create_response.reason))
return get_branch_name_from_ref(new_branch)
def get_github_branch(repo, branch):
"""
API Documentation - https://developer.github.com/v3/repos/branches/#get-branch
Returns branch, is_folder
branch : None if the branch with this name does not exist else branch ref
is_folder : True or False
"""
token = get_github_pat_token()
head_ref_name = resolve_git_ref_heads(branch).lower()
get_branch_url = 'https://api.github.com/repos/{repo_id}/git/{refs_heads_branch}'.format(
repo_id=repo, refs_heads_branch=head_ref_name)
get_response = requests.get(get_branch_url, auth=('', token))
if get_response.status_code == _HTTP_NOT_FOUND_STATUS:
return None, False
if get_response.status_code == _HTTP_SUCCESS_STATUS:
import json
refs = json.loads(get_response.text)
if isinstance(refs, list):
if refs[0]['ref'].startswith(head_ref_name + '/'):
logger.debug('Branch name is a folder hence invalid branch name.')
return None, True
# Parse and find correct branch
for ref in refs:
if ref['ref'] == head_ref_name:
return ref, False
return None, False
if refs['ref'] == head_ref_name:
return refs, False
raise CLIError('Cannot get branch ({branch})'.format(branch=branch))
def commit_files_to_github_branch(files, repo_name, branch, message):
if files:
for file in files:
commit_file_to_github_branch(file.path, file.content, repo_name, branch, message)
else:
raise CLIError("No files to checkin.")
def get_application_json_header():
return {'Content-Type': 'application/json' + '; charset=utf-8',
'Accept': 'application/json'}
def commit_file_to_github_branch(path_to_commit, content, repo_name, branch, message, skip_ci=True):
"""
API Documentation - https://developer.github.com/v3/repos/contents/#create-a-file
"""
import base64
if not skip_ci:
message = message + ' [skip ci]'
headers = get_application_json_header()
url_for_github_file_api = 'https://api.github.com/repos/{repo_name}/contents/{path_to_commit}'.format(
repo_name=repo_name, path_to_commit=path_to_commit)
if path_to_commit and content:
path_to_commit = path_to_commit.strip('.')
path_to_commit = path_to_commit.strip('/')
encoded_content = base64.b64encode(content.encode('utf-8')).decode("utf-8")
request_body = {
"message": message,
"branch": branch,
"content": encoded_content
}
token = get_github_pat_token()
logger.warning('Checking in file %s in the Github repository %s', path_to_commit, repo_name)
response = requests.put(url_for_github_file_api, auth=('', token),
json=request_body, headers=headers)
logger.debug(response)
if not response.status_code == _HTTP_CREATED_STATUS:
raise CLIError('GitHub file checkin failed for file ({file}). Status Code ({code}).'.format(
file=path_to_commit, code=response.status_code))
else:
raise CLIError('GitHub file checkin failed. File path or content is empty.')
|
