8000 Merge pull request #457 from sigmavirus24/pr/379 · pythonthings/github3.py@5ae9167 · GitHub
[go: up one dir, main page]
Skip to content

Commit 5ae9167

Browse files
sigmavirus24sigmavirus24
committed
Merge pull request sigmavirus24#457 from sigmavirus24/pr/379
Finish up sigmavirus24#379
2 parents d132237 + 3ad381f commit 5ae9167

File tree

4 files changed

+104
-3
lines changed

4 files changed

+104
-3
lines changed

‎github3/repos/repo.py

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -902,7 +902,7 @@ def create_ref(self, ref, sha):
902902
else None
903903
"""
904904
json = None
905-
if ref and ref.count('/') >= 2 and sha:
905+
if ref and ref.startswith('refs') and ref.count('/') >= 2 and sha:
906906
data = {'ref': ref, 'sha': sha}
907907
url = self._build_url('git', 'refs', base_url=self._api)
908908
json = self._json(self._post(url, data=data), 201)
@@ -953,7 +953,7 @@ def create_status(self, sha, state, target_url=None, description=None,
953953
:returns: the status created if successful
954954
:rtype: :class:`~github3.repos.status.Status`
955955
"""
956-
json = {}
956+
json = None
957957
if sha and state:
958958
data = {'state': state, 'target_url': target_url,
959959
'description': description, 'context': context}
@@ -967,6 +967,17 @@ def create_tag(self, tag, message, sha, obj_type, tagger,
967967
lightweight=False):
968968
"""Create a tag in this repository.
969969
970+
By default, this method creates an annotated tag. If you wish to
971+
create a lightweight tag instead, pass ``lightweight=True``.
972+
973+
If you are creating an annotated tag, this method makes **2 calls** to
974+
the API:
975+
976+
1. Creates the tag object
977+
2. Creates the reference for the tag
978+
979+
This behaviour is required by the GitHub API.
980+
970981
:param str tag: (required), name of the tag
971982
:param str message: (required), tag message
972983
:param str sha: (required), SHA of the git object this is tagging
@@ -990,7 +1001,7 @@ def create_tag(self, tag, message, sha, obj_type, tagger,
9901001
url = self._build_url('git', 'tags', base_url=self._api)
9911002
json = self._json(self._post(url, data=data), 201)
9921003
if json:
993-
self.create_ref('refs/tags/' + tag, sha)
1004+
self.create_ref('refs/tags/' + tag, json.get('sha'))
9941005
return self._instance_or_null(Tag, json)
9951006

9961007
@requires_auth

‎tests/cassettes/Repository_create_tag.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"http_interactions": [{"response": {"url": "https://api.github.com/repos/github3py/fork_this", "body": {"encoding": "utf-8", "base64_string": "H4sIAAAAAAAAA+1Y0W7qOBD9lSqvSzEBereNtLq7X7Av92lfkAmGWE3iyHZANOq/7xk7IQm6UDCvfalS43N8PJ6xZ6aJ5CZKXl7jH2+vy0lU8kJESbRV+n1lM2miSbSt83zVju+kzer1ojqy4Qx1KIWOkibK1U6WgJ+mAU708Z+v8/jlxyTie265XtU6x6zM2sokjPlBM/Wo2gidqtKK0k5TVbCateif+78W4NvploSIIwyckVWyJfJosBk21JPZIj8T4H9284cztyrP1QH4c71Xl4BlWhjZzn3LchdCAVjDlM0EDIZtfNLmpbF3ynGQBhszdiU3RGJwBFps7pPUgiCIDvuzYVpUyrHVa5NqWVmpyjuljaCgUnrHS/nBA6gAJV8lUXeKcBBAxR4edyfWYxpWabnn6ZHMoUUq5B7WDeE7A4POHiuKx38HliGbSytWfFNQsG15bsTnJHIaLCa7gQmi6yY/HwXyRpyOEov+8+RsI63Sxyernqww9oniHo75pLbQQf+cFrwah46pj67RqsTyheEvwh0RHd+7OAZzELZh+NsGSIqo5WulOXYeTDoiadjwX/ITK3gRzO3AIMmUCrecA4NEGlOLm9z18ik4DsO6eCjrYu0vrFui4DKtR0MjN0buSiGCLXYiaFh3l641L9MsnLLDN8x/uVPlu2CJhAXFOlfrYA48X8wRNMxk3L8YdvWIKmIk/IhQi+1DEgl/IrT6gXN18ojgRIeHyuKIg/V1eNa0Fsx5uav5LpzxRIDTpWd0xz++TCoux0TPADpKlLRc149dVD0HKfTvOeI33IQ9RU/oEoTrOceVTQ+SDLftopBfPdaX2Vr4yKUfpCQ/PKel/7/OKa7LJHzD+vvUX9Ytc6g129u60zfkbzPv4KPv8Kz5o+I2oxsIy1Rci1CxLZw1a448ZzqdNpngLo8thH4gKj0aNFynGTK2UH1Nh0cmUnDrMuMtydsgU84V3wTb8kQAMn9koRo9enjOFYq6YGEOPGQrZI7cUJXhd2TPMOQtlZVbmd5SEFwOoxFJ89PIMhUTnucTeKWVqYSfIqGlE0PSJ8Kt4tGQjxLaVwK5gMsGW1kLj2+YL9tSLZDfb1bcIjefz+L58+ztOX75NZsny1myWPyHHdTVZjRn+RzHz/Plr9kiid+SlyXNqWqTDWj8FNAsk2WczNwU3Gatq+ELFfrvCuQ+had6GyBjsh70dw9J/OeoadBC0hw+c+bUt621P39KrsMgL1OFqPCMR0kJ96Ua6gPf8WIxepRTVZew72wSHbhFdohHsB/qHvKOIuNm5UMrSqyuqejCSB+2g8GDfJfDSaTEnEonXwH1CxVSa9W2SbxaVYmyXasThG6NL35I7eD3KMEvnXq3lY3Y8jq3K5+nwnsKbiw6NvAFoQvsgEp36t8MS0rvKJ1mCnn/jVJzWKd/t31ODbHvtk/X0LveIPtu+4ybkkgYRj0jxOXtbZ9S2AM1a/vLY5jAd6Of/wPl/R0M5xUAAA==", "string": ""}, "headers": {"Date": "Sun, 01 Nov 2015 20:17:00 GMT", "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload", "X-Frame-Options": "deny", "Content-Encoding": "gzip", "ETag": "W/\"e5a943acacd44e45d880dd08b55ca473\"", "Content-Security-Policy": "default-src 'none'", "Transfer-Encoding": "chunked", "X-XSS-Protection": "1; mode=block", "Status": "200 OK", "X-RateLimit-Limit": "5000", "Access-Control-Expose-Headers": "ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval", "X-Content-Type-Options": "nosniff", "Cache-Control": "private, max-age=60, s-maxage=60", "X-GitHub-Media-Type": "github.v3; param=full; format=json", "X-RateLimit-Remaining": "4995", "Server": "GitHub.com", "Access-Control-Allow-Origin": "*", "X-RateLimit-Reset": "1446412366", "Last-Modified": "Mon, 24 Nov 2014 03:19:54 GMT", "Access-Control-Allow-Credentials": "true", "Content-Type": "application/json; charset=utf-8", "X-GitHub-Request-Id": "48A0C96B:94AC:6E3E766:5636733C", "X-Served-By": "dc1ce2bfb41810a06c705e83b388572d", "Vary": "Accept, Authorization, Cookie, X-GitHub-OTP"}, "status": {"message": "OK", "code": 200}}, "recorded_at": "2015-11-01T20:17:00", "request": {"body": {"encoding": "utf-8", "string": ""}, "method": "GET", "uri": "https://api.github.com/repos/github3py/fork_this", "headers": {"Accept-Charset": "utf-8", "User-Agent": "github3.py/1.0.0a2", "Content-Type": "application/json", "Accept-Encoding": "gzip, deflate", "Authorization": "Basic <BASIC_AUTH>", "Connection": "keep-alive", "Accept": "application/vnd.github.v3.full+json"}}}, {"response": {"url": "https://api.github.com/repos/github3py/fork_this/git/tags", "body": {"encoding": "utf-8", "string": "{\"sha\":\"759200c81cb96160f9d6381ed0a3d7bfb584440e\",\"url\":\"https://api.github.com/repos/github3py/fork_this/git/tags/759200c81cb96160f9d6381ed0a3d7bfb584440e\",\"tagger\":{\"name\":\"Ian Cordasco\",\"email\":\"graffatcolmingov@gmail.com\",\"date\":\"2015-11-01T14:09:00Z\"},\"object\":{\"sha\":\"5145c9682d46d714c31ae0b5fbe30a83039a96e5\",\"type\":\"commit\",\"url\":\"https://api.github.com/repos/github3py/fork_this/git/commits/5145c9682d46d714c31ae0b5fbe30a83039a96e5\"},\"tag\":\"tag-name\",\"message\":\"Test annotated tag creation\"}"}, "headers": {"Date": "Sun, 01 Nov 2015 20:17:02 GMT", "X-Frame-Options": "deny", "Location": "https://api.github.com/repos/github3py/fork_this/git/tags/759200c81cb96160f9d6381ed0a3d7bfb584440e", "ETag": "\"ad366652b3466f26a61226fa535dcd56\"", "Content-Security-Policy": "default-src 'none'", "X-XSS-Protection": "1; mode=block", "Status": "201 Created", "X-Content-Type-Options": "nosniff", "Access-Control-Expose-Headers": "ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval", "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload", "Cache-Control": "private, max-age=60, s-maxage=60", "X-GitHub-Media-Type": "github.v3; param=full; format=json", "X-RateLimit-Remaining": "4994", "Server": "GitHub.com", "X-RateLimit-Limit": "5000", "Access-Control-Allow-Origin": "*", "X-RateLimit-Reset": "1446412366", "Vary": "Accept, Authorization, Cookie, X-GitHub-OTP", "Access-Control-Allow-Credentials": "true", "Content-Type": "application/json; charset=utf-8", "Content-Length": "500", "X-GitHub-Request-Id": "48A0C96B:94AC:6E3E77F:563 EDBE 6733C", "X-Served-By": "c6c65e5196703428e7641f7d1e9bc353"}, "status": {"message": "Created", "code": 201}}, "recorded_at": "2015-11-01T20:17:02", "request": {"body": {"encoding": "utf-8", "string": "{\"message\": \"Test annotated tag creation\", \"object\": \"5145c9682d46d714c31ae0b5fbe30a83039a96e5\", \"tag\": \"tag-name\", \"tagger\": {\"email\": \"graffatcolmingov@gmail.com\", \"name\": \"Ian Cordasco\", \"date\": \"2015-11-01T14:09:00Z\"}, \"type\": \"commit\"}"}, "method": "POST", "uri": "https://api.github.com/repos/github3py/fork_this/git/tags", "headers": {"Content-Length": "240", "Accept-Charset": "utf-8", "User-Agent": "github3.py/1.0.0a2", "Content-Type": "application/json", "Accept-Encoding": "gzip, deflate", "Authorization": "Basic <BASIC_AUTH>", "Connection": "keep-alive", "Accept": "application/vnd.github.v3.full+json"}}}, {"response": {"url": "https://api.github.com/repos/github3py/fork_this/git/refs", "body": {"encoding": "utf-8", "string": "{\"ref\":\"refs/tags/tag-name\",\"url\":\"https://api.github.com/repos/github3py/fork_this/git/refs/tags/tag-name\",\"object\":{\"sha\":\"759200c81cb96160f9d6381ed0a3d7bfb584440e\",\"type\":\"tag\",\"url\":\"https://api.github.com/repos/github3py/fork_this/git/tags/759200c81cb96160f9d6381ed0a3d7bfb584440e\"}}"}, "headers": {"Date": "Sun, 01 Nov 2015 20:17:02 GMT", "X-Frame-Options": "deny", "Location": "https://api.github.com/repos/github3py/fork_this/git/refs/tags/tag-name", "ETag": "\"8e77a4c4f0319cf6cadd829930bccdb0\"", "Content-Security-Policy": "default-src 'none'", "X-XSS-Protection": "1; mode=block", "Status": "201 Created", "X-Content-Type-Options": "nosniff", "Access-Control-Expose-Headers": "ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval", "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload", "Cache-Control": "private, max-age=60, s-maxage=60", "X-GitHub-Media-Type": "github.v3; param=full; format=json", "X-RateLimit-Remaining": "4993", "Server": "GitHub.com", "X-RateLimit-Limit": "5000", "Access-Control-Allow-Origin": "*", "X-RateLimit-Reset": "1446412366", "Vary": "Accept, Authorization, Cookie, X-GitHub-OTP", "Access-Control-Allow-Credentials": "true", "Content-Type": "application/json; charset=utf-8", "Content-Length": "288", "X-GitHub-Request-Id": "48A0C96B:94AC:6E3E908:5636733E", "X-Served-By": "5aeb3f30c9e3ef6ef7bcbcddfd9a68f7"}, "status": {"message": "Created", "code": 201}}, "recorded_at": "2015-11-01T20:17:02", "request": {"body": {"encoding": "utf-8", "string": "{\"ref\": \"refs/tags/tag-name\", \"sha\": \"759200c81cb96160f9d6381ed0a3d7bfb584440e\"}"}, "method": "POST", "uri": "https://api.github.com/repos/github3py/fork_this/git/refs", "headers": {"Content-Length": "80", "Accept-Charset": "utf-8", "User-Agent": "github3.py/1.0.0a2", "Content-Type": "application/json", "Accept-Encoding": "gzip, deflate", "Authorization": "Basic <BASIC_AUTH>", "Connection": "keep-alive", "Accept": "application/vnd.github.v3.full+json"}}}], "recorded_with": "betamax/0.5.1"}

‎tests/integration/test_repos_repo.py

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,27 @@ def test_create_release(self):
140140

141141
assert isinstance(release, github3.repos.release.Release)
142142

143+
def test_create_tag(self):
144+
"""Test the ability to create an annotated tag on a repository."""
145+
self.basic_login()
146+
cassette_name = self.cassette_name('create_tag')
147+
with self.recorder.use_cassette(cassette_name):
148+
repository = self.gh.repository('github3py', 'fork_this')
149+
assert repository is not None
150+
tag = repository.create_tag(
151+
tag='tag-name',
152+
message='Test annotated tag creation',
153+
sha='5145c9682d46d714c31ae0b5fbe30a83039a96e5',
154+
obj_type='commit',
155+
tagger={
156+
'name': 'Ian Cordasco',
157+
'email': 'graffatcolmingov@gmail.com',
158+
'date': '2015-11-01T14:09:00Z'
159+
}
160+
)
161+
162+
assert isinstance(tag, github3.git.Tag)
163+
143164
def test_delete(self):
144165
"""Test that a repository can be deleted."""
145166
self.basic_login()

‎tests/unit/test_repos_repo.py

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,69 @@ def test_asset_requires_a_positive_id(self):
171171

172172
assert self.session.get.called is False
173173

174+
def test_create_ref(self):
175+
"""Verify the request to create a reference."""
176+
self.instance.create_ref('refs/heads/foo', 'my-fake-sha')
177+
178+
self.post_called_with(
179+
url_for('git/refs'),
180+
data={
181+
'ref': 'refs/heads/foo',
182+
'sha': 'my-fake-sha',
183+
},
184+
)
185+
186+
def test_create_ref_requires_a_reference_with_two_slashes(self):
187+
"""Test that we check the validity of a reference."""
188+
self.instance.create_ref('refs/heads', 'my-fake-sha')
189+
190+
assert self.session.post.called is False
191+
192+
def test_create_ref_requires_a_reference_start_with_refs(self):
193+
"""Test that we check the validity of a reference."""
194+
self.instance.create_ref('my-silly-ref/foo/bar', 'my-fake-sha')
195+
196+
assert self.session.post.called is False
197+
198+
def test_create_ref_requires_a_non_None_sha(self):
199+
"""Test that we don't send an empty SHA."""
200+
self.instance.create_ref('refs/heads/valid', None)
201+
202+
assert self.session.post.called is False
203+
204+
def test_create_ref_requires_a_truthy_sha(self):
205+
"""Test that we don't send an empty SHA."""
206+
self.instance.create_ref('refs/heads/valid', '')
207+
208+
assert self.session.post.called is False
209+
210+
def test_create_tag_that_is_not_lightweight(self):
211+
"""Verify we can create an annotated tag."""
212+
self.instance.create_tag(
213+
tag='tag-name',
214+
message='message',
215+
sha='my-sha',
216+
obj_type='commit',
217+
tagger={'name': 'Ian Cordasco',
218+
'email': 'example@example.com',
219+
'date': '2015-11-01T12:16:00Z'},
220+
)
221+
222+
self.post_called_with(
223+
url_for('git/tags'),
224+
data={
225+
'tag': 'tag-name',
226+
'message': 'message',
227+
'object': 'my-sha',
228+
'type': 'commit',
229+
'tagger': {
230+
'name': 'Ian Cordasco',
231+
'email': 'example@example.com',
232+
'date': '2015-11-01T12:16:00Z',
233+
},
234+
},
235+
)
236+
174237
def test_create_tree(self):
175238
"""Verify the request to create a tree."""
176239
self.instance.create_tree([{'foo': 'bar'}])
@@ -697,6 +760,11 @@ def test_add_collaborator(self):
697760
with pytest.raises(GitHubError):
698761
self.instance.add_collaborator('foo')
699762

763+
def test_create_ref(self):
764+
"""Verify that creating a tag requires authentication."""
765+
with pytest.raises(GitHubError):
766+
self.instance.create_ref('some ref', 'some sha')
767+
700768
def test_hooks(self):
701769
"""Show that a user must be authenticated to list hooks."""
702770
with pytest.raises(GitHubError):

0 commit comments

Comments
 (0)
0