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
|
############################ Copyrights and license ############################
# #
# Copyright 2012 Vincent Jacques <vincent@vincent-jacques.net> #
# Copyright 2012 Zearin <zearin@gonk.net> #
# Copyright 2013 Vincent Jacques <vincent@vincent-jacques.net> #
# Copyright 2014 Vincent Jacques <vincent@vincent-jacques.net> #
# Copyright 2016 Peter Buckley <dx-pbuckley@users.noreply.github.com> #
# Copyright 2018 Shinichi TAMURA <shnch.tmr@gmail.com> #
# Copyright 2018 Wan Liuyang <tsfdye@gmail.com> #
# Copyright 2018 sfdye <tsfdye@gmail.com> #
# Copyright 2019 Steve Kowalik <steven@wedontsleep.org> #
# Copyright 2019 TechnicalPirate <35609336+TechnicalPirate@users.noreply.github.com>#
# Copyright 2019 Wan Liuyang <tsfdye@gmail.com> #
# Copyright 2020 Steve Kowalik <steven@wedontsleep.org> #
# Copyright 2023 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2023 Jirka Borovec <6035284+Borda@users.noreply.github.com> #
# Copyright 2024 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2024 Min RK <benjaminrk@gmail.com> #
# Copyright 2025 Enrico Minack <github@enrico.minack.dev> #
# #
# This file is part of PyGithub. #
# http://pygithub.readthedocs.io/ #
# #
# PyGithub is free software: you can redistribute it and/or modify it under #
# the terms of the GNU Lesser General Public License as published by the Free #
# Software Foundation, either version 3 of the License, or (at your option) #
# any later version. #
# #
# PyGithub 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 GNU Lesser General Public License for more #
# details. #
# #
# You should have received a copy of the GNU Lesser General Public License #
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
# #
################################################################################
from __future__ import annotations
from datetime import datetime, timezone
from urllib3.exceptions import InsecureRequestWarning
import github
from github import Consts
from github.Auth import AppAuth, AppInstallationAuth
from . import Framework, GithubIntegration
class Installation(Framework.BasicTestCase):
def setUp(self):
super().setUp()
app_id = 36541767
private_key = GithubIntegration.PRIVATE_KEY
self.auth = AppAuth(app_id, private_key)
self.integration = github.GithubIntegration(auth=self.auth)
self.installations = list(self.integration.get_installations())
self.installation = self.installations[0]
def testAttributes(self):
self.assertEqual(
self.installation.access_tokens_url, "https://api.github.com/app/installations/36541767/access_tokens"
)
self.assertEqual(self.installation.account.login, "EnricoMi")
self.assertEqual(self.installation.app_id, 319953)
self.assertEqual(self.installation.app_slug, "publish-test-results")
self.assertIsNone(self.installation.contact_email)
self.assertEqual(self.installation.created_at, datetime(2023, 4, 17, 16, 18, 5, tzinfo=timezone.utc))
self.assertEqual(self.installation.events, [])
self.assertEqual(self.installation.has_multiple_single_files, False)
self.assertEqual(self.installation.html_url, "https://github.com/settings/installations/36541767")
self.assertEqual(self.installation.id, 36541767)
self.assertEqual(
self.installation.permissions,
{"checks": "write", "issues": "read", "contents": "read", "metadata": "read", "pull_requests": "write"},
)
self.assertEqual(self.installation.repositories_url, "https://api.github.com/installation/repositories")
self.assertEqual(self.installation.repository_selection, "selected")
self.assertIsNone(self.installation.single_file_name)
self.assertEqual(self.installation.single_file_paths, [])
self.assertIsNone(self.installation.suspended_at)
self.assertIsNone(self.installation.suspended_by)
self.assertEqual(self.installation.target_id, 44700269)
self.assertEqual(self.installation.target_type, "User")
self.assertEqual(self.installation.updated_at, datetime(2023, 6, 8, 7, 38, 12, tzinfo=timezone.utc))
def testGetRepos(self):
repos = list(self.installation.get_repos())
self.assertEqual(len(repos), 2)
self.assertListEqual([repo.full_name for repo in repos], ["EnricoMi/sandbox", "EnricoMi/python"])
def testGetGithubForInstallation(self):
# with verify=False, urllib3.connectionpool rightly may issue an InsecureRequestWarning
# we ignore InsecureRequestWarning from urllib3.connectionpool
with self.ignoreWarning(category=InsecureRequestWarning, module="urllib3.connectionpool"):
kwargs = dict(
auth=AppAuth(319953, GithubIntegration.PRIVATE_KEY),
# http protocol used to deviate from default base url, recording data might require https
base_url="http://api.github.com",
timeout=Consts.DEFAULT_TIMEOUT + 10,
user_agent="PyGithub/Python-Test",
per_page=Consts.DEFAULT_PER_PAGE + 10,
verify=False,
retry=3,
pool_size=10,
seconds_between_requests=100,
seconds_between_writes=1000,
# v3: this should not be the default value, so if this has been changed in v3,
# change it here is well
lazy=True,
)
# assert kwargs consists of ALL requester constructor arguments
self.assertEqual(kwargs.keys(), github.Requester.Requester.__init__.__annotations__.keys())
self.integration = github.GithubIntegration(**kwargs)
installations = list(self.integration.get_installations())
installation = installations[0]
g = installation.get_github_for_installation()
self.assertIsInstance(g._Github__requester.auth, AppInstallationAuth)
actual = g._Github__requester.kwargs
kwargs.update(auth=str(AppInstallationAuth))
actual.update(auth=str(type(actual["auth"])))
self.assertDictEqual(kwargs, actual)
repo = g.get_repo("PyGithub/PyGithub")
self.assertEqual(repo.full_name, "PyGithub/PyGithub")
def testRequester(self):
self.assertEqual(len(self.installations), 1)
installation = self.installations[0]
assert installation.requester is installation._requester
|
