Skip to content

Commit de6b972

Browse files
ZPascalZPascal
authored
Fix the integrationstests (#94)
* fix: Adjust the integrationtests * fix: Disable the Integrationtests * docs: Add coverage badge * fix: Adjust the lint issues
1 parent f2a47b3 commit de6b972

File tree

11 files changed

+75
-66
lines changed

11 files changed

+75
-66
lines changed

‎docs/coverage.svg‎

Lines changed: 2 additions & 2 deletions
Loading

‎grafana_api/api.py‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ def _check_the_api_call_response(
243243
api_call (any): Returns the value of the api call
244244
"""
245245

246-
if Api._check_if_valid_json(response.text) and response.text != "null":
246+
if Api._check_if_valid_json(response.text):
247247
if (
248248
len(json.loads(response.text)) != 0
249249
and type(json.loads(response.text)) == dict
@@ -269,21 +269,26 @@ def _check_the_api_call_response(
269269
return response
270270

271271
@staticmethod
272-
def _check_if_valid_json(response: any) -> bool:
272+
def _check_if_valid_json(response: str) -> bool:
273273
"""The method includes a functionality to check if the response json is valid
274274
275275
Args:
276-
response (any): Specify the inserted response json
276+
response (str): Specify the inserted response json as string
277277
278278
Returns:
279279
result (bool): Returns if the json is valid or not
280280
"""
281281

282-
try:
283-
json.loads(response)
284-
except (TypeError, ValueError):
285-
return False
286-
return True
282+
valid_json: bool = False
283+
284+
if response.encode() not in [b'""\n', b"null"]:
285+
try:
286+
json.loads(response)
287+
valid_json = True
288+
except (TypeError, ValueError):
289+
valid_json = False
290+
291+
return valid_json
287292

288293
@staticmethod
289294
def prepare_api_string(query_string: str) -> str:

‎grafana_api/model.py‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@
1010
ERROR_MESSAGES: list = ["invalid API key", "Invalid API key", "Expired API key"]
1111

1212

13+
# TODO SSO Integrationtests
14+
# TODO Check the Alerting case https://github.com/grafana/grafana/blob/main/pkg/services/ngalert/api/tooling/post.json
15+
16+
1317
class APIEndpoints(Enum):
1418
"""The class includes all necessary API endpoint strings to connect the Grafana API"""
1519

@@ -26,6 +30,7 @@ class APIEndpoints(Enum):
2630
ALERTS_RULER: str = f"{api_prefix}/ruler"
2731
ALERTS_TESTING: str = f"{api_prefix}/{version_1}"
2832
ALERTS_NGALERT: str = f"{api_prefix}/{version_1}/ngalert"
33+
ALERTING_PROVISIONING: str = f"{api_prefix}/{version_1}/provisioning"
2934
DATASOURCES: str = f"{api_prefix}/datasources"
3035
DATASOURCE_QUERY: str = f"{api_prefix}/tsdb/query"
3136
DATASOURCE_PERMISSIONS: str = f"{api_prefix}/access-control/datasources"
@@ -52,7 +57,6 @@ class APIEndpoints(Enum):
5257
SERVICE_ACCOUNTS: str = f"{api_prefix}/serviceaccounts"
5358
RBAC: str = f"{api_prefix}/access-control"
5459
LIBRARY: str = f"{api_prefix}/library-elements"
55-
ALERTING_PROVISIONING: str = f"{api_prefix}/{version_1}/provisioning"
5660
SSO_SETTINGS: str = f"{api_prefix}/{version_1}/sso-settings"
5761

5862

‎grafana_api/playlist.py‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -258,13 +258,14 @@ def delete_playlist(self, playlist_uid: str):
258258
"""
259259

260260
if len(playlist_uid) != 0:
261-
api_call = Api(self.grafana_api_model).call_the_api(
261+
api_call: dict = Api(self.grafana_api_model).call_the_api(
262262
f"{APIEndpoints.PLAYLISTS.value}/{playlist_uid}",
263263
RequestsMethods.DELETE,
264+
response_status_code=True,
264265
)
265266

266-
if api_call.status_code != 200:
267-
logging.error(f"Check the error: {api_call.text}.")
267+
if api_call.get("status") != 200:
268+
logging.error(f"Check the error: {api_call}.")
268269
raise Exception
269270
else:
270271
logging.info("You successfully deleted the corresponding playlist.")

‎tests/integrationtest/test_alerting.py‎

Lines changed: 34 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,6 @@ def test_c_delete_alertmanager_config(self):
7777
"grafana-default-email"]],
7878
"receiver": "grafana-default-email"}]}]
7979
},
80-
"templates": None,
8180
"receivers": [
8281
{
8382
"name": "grafana-default-email",
@@ -98,40 +97,40 @@ def test_c_delete_alertmanager_config(self):
9897

9998
self.assertEqual(result, self.alerting.get_alertmanager_config())
10099

101-
def test_test_alertmanager_receivers(self):
102-
grafana_managed_receiver_configs: list = [
103-
{
104-
"uid": None,
105-
"name": "email receiver",
106-
"type": "email",
107-
"disableResolveMessage": False,
108-
"settings": {"addresses": "[email protected]"},
109-
"secureFields": {},
110-
}
111-
]
112-
113-
alertmangager_receivers: AlertmanagerReceivers = AlertmanagerReceivers(
114-
name="Test",
115-
email_configs=None,
116-
grafana_managed_receiver_configs=grafana_managed_receiver_configs,
117-
opsgenie_configs=None,
118-
pagerduty_configs=None,
119-
pushover_configs=None,
120-
slack_configs=None,
121-
sns_configs=None,
122-
victorops_configs=None,
123-
webhook_configs=None,
124-
wechat_configs=None,
125-
)
126-
self.assertEqual(
127-
None,
128-
self.alerting.test_alertmanager_receivers(
129-
alert=dict(
130-
{"annotations": {"test": "test"}, "labels": {"test": "test"}}
131-
),
132-
receivers=list([alertmangager_receivers]),
133-
),
134-
)
100+
# def test_test_alertmanager_receivers(self):
101+
# grafana_managed_receiver_configs: list = [
102+
# {
103+
# "uid": None,
104+
# "name": "email receiver",
105+
# "type": "email",
106+
# "disableResolveMessage": False,
107+
# "settings": {"addresses": "[email protected]"},
108+
# "secureFields": {},
109+
# }
110+
# ]
111+
#
112+
# alertmangager_receivers: AlertmanagerReceivers = AlertmanagerReceivers(
113+
# name="Test",
114+
# email_configs=None,
115+
# grafana_managed_receiver_configs=grafana_managed_receiver_configs,
116+
# opsgenie_configs=None,
117+
# pagerduty_configs=None,
118+
# pushover_configs=None,
119+
# slack_configs=None,
120+
# sns_configs=None,
121+
# victorops_configs=None,
122+
# webhook_configs=None,
123+
# wechat_configs=None,
124+
# )
125+
# self.assertEqual(
126+
# None,
127+
# self.alerting.test_alertmanager_receivers(
128+
# alert=dict(
129+
# {"annotations": {"test": "test"}, "labels": {"test": "test"}}
130+
# ),
131+
# receivers=list([alertmangager_receivers]),
132+
# ),
133+
# )
135134

136135
def test_get_prometheus_alerts(self):
137136
MAX_TRIES: int = 3

‎tests/integrationtest/test_folder.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ def test_get_folder_permissions(self):
8585
self.assertEqual(
8686
[
8787
{
88-
"created": "2022-06-14T21:32:34+02:00",
88+
"created": "2024-06-25T19:52:40+02:00",
8989
"folderId": 72,
9090
"inherited": False,
9191
"isFolder": True,
@@ -99,7 +99,7 @@ def test_get_folder_permissions(self):
9999
"teamId": 0,
100100
"title": "Github Integrationtest",
101101
"uid": "6U_QdWJnz",
102-
"updated": "2024-01-24T19:33:26.34204+01:00",
102+
"updated": "2024-06-25T19:52:40+02:00",
103103
"url": "/dashboards/f/6U_QdWJnz/github-integrationtest",
104104
"userAvatarUrl": "",
105105
"userEmail": "",

‎tests/integrationtest/test_playlist.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@ def test_search_playlist(self):
1818
self.assertEqual("Test1", self.playlist.search_playlist()[0].get("name"))
1919

2020
def test_get_playlist(self):
21-
self.assertEqual("Test1", self.playlist.get_playlist("ce7b96dd-480a-4d8f-9950-e5082993574b").get("name"))
21+
self.assertEqual("Test1", self.playlist.get_playlist("edq1prp6dfy80c").get("name"))
2222

2323
def test_get_playlist_items(self):
2424
self.assertEqual(
25-
"dashboard_by_id", self.playlist.get_playlist_items("ce7b96dd-480a-4d8f-9950-e5082993574b")[0].get("type")
25+
"dashboard_by_uid", self.playlist.get_playlist_items("edq1prp6dfy80c")[0].get("type")
2626
)
2727

2828
def test_a_create_playlist(self):
2929
playlist_item: PlaylistItemObject = PlaylistItemObject(
30-
type="dashboard_by_id",
31-
value="653",
30+
type="dashboard_by_uid",
31+
value="tests",
3232
order=1,
3333
title="Github Integrationtest/Test 1",
3434
)
@@ -41,8 +41,8 @@ def test_a_create_playlist(self):
4141

4242
def test_b_update_playlist(self):
4343
playlist_item: PlaylistItemObject = PlaylistItemObject(
44-
type="dashboard_by_id",
45-
value="653",
44+
type="dashboard_by_uid",
45+
value="tests",
4646
order=1,
4747
title="Github Integrationtest/Test 1",
4848
)

‎tests/integrationtest/test_team.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ class TeamTest(TestCase):
1717

1818
def test_search_team(self):
1919
self.assertEqual(
20-
4, self.team.search_team(query="Test").get("teams")[0].get("id")
20+
2583, self.team.search_team(query="Test").get("teams")[0].get("id")
2121
)
2222

2323
def test_get_team_by_id(self):
24-
self.assertEqual(4, self.team.get_team_by_id(4).get("id"))
24+
self.assertEqual(2583, self.team.get_team_by_id(2583).get("id"))
2525

2626
def test_a_add_team(self):
2727
team_object: TeamObject = TeamObject(
@@ -61,7 +61,7 @@ def test_c_delete_team_by_id(self):
6161
)
6262

6363
def test_get_team_members(self):
64-
self.assertEqual(1, len(self.team.get_team_members(4)))
64+
self.assertEqual(1, len(self.team.get_team_members(2583)))
6565

6666
def test_d_add_team_member(self):
6767
team_id: int = self._team_creation_util()
@@ -82,17 +82,17 @@ def test_e_delete_team_member(self):
8282

8383
def test_get_team_preferences(self):
8484
self.assertEqual(
85-
"tests", self.team.get_team_preferences(4).get("homeDashboardUID")
85+
"tests", self.team.get_team_preferences(2583).get("homeDashboardUID")
8686
)
8787

8888
def test_update_team_preferences(self):
8989
self.assertIsNone(
9090
self.team.update_team_preferences(
91-
4, timezone="utc", home_dashboard_uid="tests"
91+
2583, timezone="utc", home_dashboard_uid="tests"
9292
)
9393
)
9494

95-
self.assertEqual("utc", self.team.get_team_preferences(4).get("timezone"))
95+
self.assertEqual("utc", self.team.get_team_preferences(2583).get("timezone"))
9696

9797
def _team_creation_util(self) -> int:
9898
self.test_a_add_team()

‎tests/integrationtest/test_user.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ def test_get_user_organizations(self):
2323
self.assertEqual(1, len(self.current_user.get_user_organizations()))
2424

2525
def test_get_user_teams(self):
26-
self.assertEqual(4, self.current_user.get_user_teams()[0].get("id"))
26+
self.assertEqual(2583, self.current_user.get_user_teams()[0].get("id"))
2727

2828
def test_star_a_dashboard(self):
2929
self.current_user.star_a_dashboard(

‎tests/unittests/test_api.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ def test_check_the_api_call_response_return_status_code_dict(self):
237237

238238
def test_check_the_api_call_response_return_status_code_list(self):
239239
mock: Mock = Mock()
240-
mock.text = b'[{"test": "test"}, {"test": "test"}]'
240+
mock.text = '[{"test": "test"}, {"test": "test"}]'
241241
mock.status_code = 200
242242

243243
self.assertEqual(

0 commit comments

Comments
 (0)