Bugfix: github_repo does not apply defaults on existing repos (#2386) (#3769)

* github_repo do not apply defaults on currently existing repos

* Fixed sanity

* Fixed doc defaults

* Added changelog

* Fix "or" statement and some formatting

* Improve description change check

* Added api_url parameter for unit tests and default values for private and description parameters

* Added force_defaults parameter

* Improved docs

* Fixed doc anchors for force_defaults parameter

* Update plugins/modules/source_control/github/github_repo.py

Co-authored-by: Felix Fontein <felix@fontein.de>

Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 17c3708f31)

Co-authored-by: Álvaro Torres Cogollo <atorrescogollo@gmail.com>
This commit is contained in:
patchback[bot] 2021-11-22 13:49:29 +01:00 committed by GitHub
parent c6589a772b
commit 3eab4faf0b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 119 additions and 28 deletions

View file

@ -71,6 +71,28 @@ def get_repo_mock(url, request):
return response(200, content, headers, None, 5, request)
@urlmatch(netloc=r'api\.github\.com(:[0-9]+)?$', path=r'/repos/.*/.*', method="get")
def get_private_repo_mock(url, request):
match = re.search(
r"api\.github\.com(:[0-9]+)?/repos/(?P<org>[^/]+)/(?P<repo>[^/]+)", request.url)
org = match.group("org")
repo = match.group("repo")
# https://docs.github.com/en/rest/reference/repos#get-a-repository
headers = {'content-type': 'application/json'}
content = {
"name": repo,
"full_name": "{0}/{1}".format(org, repo),
"url": "https://api.github.com/repos/{0}/{1}".format(org, repo),
"private": True,
"description": "This your first repo!",
"default_branch": "master",
"allow_rebase_merge": True
}
content = json.dumps(content).encode("utf-8")
return response(200, content, headers, None, 5, request)
@urlmatch(netloc=r'api\.github\.com(:[0-9]+)?$', path=r'/orgs/.*/repos', method="post")
def create_new_org_repo_mock(url, request):
match = re.search(
@ -83,8 +105,8 @@ def create_new_org_repo_mock(url, request):
content = {
"name": repo['name'],
"full_name": "{0}/{1}".format(org, repo['name']),
"private": repo['private'],
"description": repo['description']
"private": repo.get('private', False),
"description": repo.get('description')
}
content = json.dumps(content).encode("utf-8")
return response(201, content, headers, None, 5, request)
@ -99,8 +121,8 @@ def create_new_user_repo_mock(url, request):
content = {
"name": repo['name'],
"full_name": "{0}/{1}".format("octocat", repo['name']),
"private": repo['private'],
"description": repo['description']
"private": repo.get('private', False),
"description": repo.get('description')
}
content = json.dumps(content).encode("utf-8")
return response(201, content, headers, None, 5, request)
@ -120,8 +142,8 @@ def patch_repo_mock(url, request):
"name": repo,
"full_name": "{0}/{1}".format(org, repo),
"url": "https://api.github.com/repos/{0}/{1}".format(org, repo),
"private": body['private'],
"description": body['description'],
"private": body.get('private', False),
"description": body.get('description'),
"default_branch": "master",
"allow_rebase_merge": True
}
@ -160,11 +182,34 @@ class TestGithubRepo(unittest.TestCase):
"description": "Just for fun",
"private": False,
"state": "present",
"api_url": "https://api.github.com"
"api_url": "https://api.github.com",
"force_defaults": False,
})
self.assertEqual(result['changed'], True)
self.assertEqual(result['repo']['private'], False)
self.assertEqual(result['repo']['description'], 'Just for fun')
@with_httmock(get_orgs_mock)
@with_httmock(get_repo_notfound_mock)
@with_httmock(create_new_org_repo_mock)
def test_create_new_org_repo_incomplete(self):
result = github_repo.run_module({
'username': None,
'password': None,
"access_token": "mytoken",
"organization": "MyOrganization",
"name": "myrepo",
"description": None,
"private": None,
"state": "present",
"api_url": "https://api.github.com",
"force_defaults": False,
})
self.assertEqual(result['changed'], True)
self.assertEqual(result['repo']['private'], False)
self.assertEqual(result['repo']['description'], None)
@with_httmock(get_user_mock)
@with_httmock(get_repo_notfound_mock)
@ -179,7 +224,8 @@ class TestGithubRepo(unittest.TestCase):
"description": "Just for fun",
"private": True,
"state": "present",
"api_url": "https://api.github.com"
"api_url": "https://api.github.com",
"force_defaults": False,
})
self.assertEqual(result['changed'], True)
self.assertEqual(result['repo']['private'], True)
@ -197,11 +243,31 @@ class TestGithubRepo(unittest.TestCase):
"description": "Just for fun",
"private": True,
"state": "present",
"api_url": "https://api.github.com"
"api_url": "https://api.github.com",
"force_defaults": False,
})
self.assertEqual(result['changed'], True)
self.assertEqual(result['repo']['private'], True)
@with_httmock(get_orgs_mock)
@with_httmock(get_private_repo_mock)
def test_idempotency_existing_org_private_repo(self):
result = github_repo.run_module({
'username': None,
'password': None,
"access_token": "mytoken",
"organization": "MyOrganization",
"name": "myrepo",
"description": None,
"private": None,
"state": "present",
"api_url": "https://api.github.com",
"force_defaults": False,
})
self.assertEqual(result['changed'], False)
self.assertEqual(result['repo']['private'], True)
self.assertEqual(result['repo']['description'], 'This your first repo!')
@with_httmock(get_orgs_mock)
@with_httmock(get_repo_mock)
@with_httmock(delete_repo_mock)
@ -215,7 +281,8 @@ class TestGithubRepo(unittest.TestCase):
"description": "Just for fun",
"private": False,
"state": "absent",
"api_url": "https://api.github.com"
"api_url": "https://api.github.com",
"force_defaults": False,
})
self.assertEqual(result['changed'], True)
@ -232,7 +299,8 @@ class TestGithubRepo(unittest.TestCase):
"description": "Just for fun",
"private": False,
"state": "absent",
"api_url": "https://api.github.com"
"api_url": "https://api.github.com",
"force_defaults": False,
})
self.assertEqual(result['changed'], True)
@ -249,7 +317,8 @@ class TestGithubRepo(unittest.TestCase):
"description": "Just for fun",
"private": True,
"state": "absent",
"api_url": "https://api.github.com"
"api_url": "https://api.github.com",
"force_defaults": False,
})
self.assertEqual(result['changed'], False)