Skip to content

Commit 75f2272

Browse files
committed
feat: Adjust the version and fix lint issues
1 parent 838d15f commit 75f2272

File tree

9 files changed

+94
-45
lines changed

9 files changed

+94
-45
lines changed

grafana_api/alerting.py

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -151,11 +151,7 @@ def delete_alertmanager_silence_by_id(
151151
RequestsMethods.DELETE,
152152
)
153153

154-
if (
155-
api_call == dict()
156-
or api_call.get("message")
157-
!= "silence deleted"
158-
):
154+
if api_call == dict() or api_call.get("message") != "silence deleted":
159155
logging.error(f"Please, check the error: {api_call}.")
160156
raise Exception
161157
else:
@@ -258,7 +254,9 @@ def create_or_update_alertmanager_silence(
258254
json.dumps(silence_json_dict),
259255
)
260256

261-
if api_call == dict() or (api_call.get("id") is None and api_call.get("silenceID") is None):
257+
if api_call == dict() or (
258+
api_call.get("id") is None and api_call.get("silenceID") is None
259+
):
262260
logging.error(f"Check the error: {api_call}.")
263261
raise Exception
264262
else:
@@ -661,7 +659,12 @@ def create_or_update_ruler_group_by_namespace(
661659
None
662660
"""
663661

664-
if len(datasource_uid) != 0 and len(namespace) != 0 and len(group_name) != 0 and rules != list():
662+
if (
663+
len(datasource_uid) != 0
664+
and len(namespace) != 0
665+
and len(group_name) != 0
666+
and rules != list()
667+
):
665668
rules_json_list: list = list()
666669

667670
for rule in rules:
@@ -696,7 +699,9 @@ def create_or_update_ruler_group_by_namespace(
696699
else:
697700
logging.info("You successfully created an ruler group.")
698701
else:
699-
logging.error("There is no datasource_uid, namespace, name or rules defined.")
702+
logging.error(
703+
"There is no datasource_uid, namespace, name or rules defined."
704+
)
700705
raise ValueError
701706

702707
def delete_ruler_group(
@@ -729,7 +734,9 @@ def delete_ruler_group(
729734
else:
730735
logging.info("You successfully deleted a ruler group.")
731736
else:
732-
logging.error("There is no datasource_uid, namespace or group_name defined.")
737+
logging.error(
738+
"There is no datasource_uid, namespace or group_name defined."
739+
)
733740
raise ValueError
734741

735742
def get_ruler_group(
@@ -761,7 +768,9 @@ def get_ruler_group(
761768
else:
762769
return api_call
763770
else:
764-
logging.error("There is no datasource_uid, namespace or group_name defined.")
771+
logging.error(
772+
"There is no datasource_uid, namespace or group_name defined."
773+
)
765774
raise ValueError
766775

767776
def test_rule(self, data_query: list) -> dict:
@@ -823,7 +832,11 @@ def test_rule(self, data_query: list) -> dict:
823832
raise ValueError
824833

825834
def test_datasource_uid_rule(
826-
self, expr: str, condition: str, data_query: list, datasource_uid: str = "grafana"
835+
self,
836+
expr: str,
837+
condition: str,
838+
data_query: list,
839+
datasource_uid: str = "grafana",
827840
) -> dict:
828841
"""The method includes a functionality to test a datasource uid rule specified by the expr, the condition, a list of data queries and the datasource_uid
829842
@@ -841,7 +854,12 @@ def test_datasource_uid_rule(
841854
api_call (dict): Returns the result of the specified datasource_uid rule
842855
"""
843856

844-
if len(datasource_uid) != 0 and len(expr) != 0 and len(condition) != 0 and data_query != list():
857+
if (
858+
len(datasource_uid) != 0
859+
and len(expr) != 0
860+
and len(condition) != 0
861+
and data_query != list()
862+
):
845863
datasource_rule_query_objects_json: list = list()
846864
datasource_rule_query_object_json: dict = dict()
847865

@@ -1045,9 +1063,7 @@ def create_or_update_ngalert_organization_configuration(
10451063
"You successfully created an NGAlert organization configuration."
10461064
)
10471065
else:
1048-
logging.error(
1049-
"There is no alert_managers or alertmanagers_choice defined."
1050-
)
1066+
logging.error("There is no alert_managers or alertmanagers_choice defined.")
10511067
raise ValueError
10521068

10531069
def get_ngalert_alertmanagers_by_organization(self) -> dict:

grafana_api/folder.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,9 @@ def get_folder_by_id(self, id: int) -> dict:
108108
logging.error("There is no folder id defined.")
109109
raise ValueError
110110

111-
def create_folder(self, title: str, uid: str = None, parent_uid: str = None) -> dict:
111+
def create_folder(
112+
self, title: str, uid: str = None, parent_uid: str = None
113+
) -> dict:
112114
"""The method includes a functionality to create a new folder inside the organization specified by the defined title and the optional uid
113115
114116
Args:
@@ -243,7 +245,6 @@ def move_folder(self, uid: str, parent_uid: str = None):
243245
logging.error("There is no folder uid defined.")
244246
raise ValueError
245247

246-
247248
def delete_folder(self, uid: str):
248249
"""The method includes a functionality to delete a folder inside the organization specified by the defined uid
249250

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
setuptools.setup(
1010
name="grafana-api-sdk",
11-
version="0.6.0",
11+
version="0.6.1",
1212
author="Pascal Zimmermann",
1313
author_email="[email protected]",
1414
description="A Grafana API SDK",

tests/integrationtest/test_alerting.py

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
from grafana_api.model import (
77
APIModel,
88
AlertmanagerConfig,
9-
AlertmanagerReceivers,
109
DatasourceRuleQuery,
1110
)
1211
from grafana_api.alerting import Alerting
@@ -66,16 +65,27 @@ def test_c_delete_alertmanager_config(self):
6665
"group_by": ["grafana_folder", "alertname"],
6766
"receiver": "grafana-default-email",
6867
"provenance": "api",
69-
"routes": [{"object_matchers": [["__grafana_autogenerated__",
70-
"=",
71-
"true"]],
72-
"receiver": "grafana-default-email",
73-
"routes": [{"group_by": ["grafana_folder",
74-
"alertname"],
75-
"object_matchers": [["__grafana_receiver__",
76-
"=",
77-
"grafana-default-email"]],
78-
"receiver": "grafana-default-email"}]}]
68+
"routes": [
69+
{
70+
"object_matchers": [
71+
["__grafana_autogenerated__", "=", "true"]
72+
],
73+
"receiver": "grafana-default-email",
74+
"routes": [
75+
{
76+
"group_by": ["grafana_folder", "alertname"],
77+
"object_matchers": [
78+
[
79+
"__grafana_receiver__",
80+
"=",
81+
"grafana-default-email",
82+
]
83+
],
84+
"receiver": "grafana-default-email",
85+
}
86+
],
87+
}
88+
],
7989
},
8090
"receivers": [
8191
{
@@ -92,7 +102,7 @@ def test_c_delete_alertmanager_config(self):
92102
],
93103
}
94104
],
95-
}
105+
},
96106
}
97107

98108
self.assertEqual(result, self.alerting.get_alertmanager_config())
@@ -137,8 +147,8 @@ def test_get_prometheus_alerts(self):
137147

138148
for i in range(0, MAX_TRIES):
139149
if (
140-
len(self.alerting.get_prometheus_alerts().get("data").get("alerts"))
141-
!= 0
150+
len(self.alerting.get_prometheus_alerts().get("data").get("alerts"))
151+
!= 0
142152
):
143153
time.sleep(0.1 + i / 2)
144154
self.assertEqual(

tests/integrationtest/test_folder.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,9 @@ def test_b_subfolder(self):
7474

7575
subfolder: dict = self.folder.create_folder("test2", parent_uid=parent_uid)
7676

77-
self.assertEqual("test2", self.folder.get_folder_by_uid(subfolder["uid"]).get("title"))
77+
self.assertEqual(
78+
"test2", self.folder.get_folder_by_uid(subfolder["uid"]).get("title")
79+
)
7880

7981
def test_c_update_folder(self):
8082
self.folder.update_folder(
@@ -91,12 +93,13 @@ def test_d_move_folder(self):
9193

9294
self.assertEqual("test12", self.folder.get_folder_by_uid(folder_uid_b)["title"])
9395

94-
moved_folder: dict = self.folder.move_folder(folder_uid_a, parent_uid=folder_uid_b)
96+
moved_folder: dict = self.folder.move_folder(
97+
folder_uid_a, parent_uid=folder_uid_b
98+
)
9599

96100
self.assertEqual("test12", moved_folder["parents"][0]["title"])
97101
self.folder.delete_folder(moved_folder["parents"][0]["uid"])
98102

99-
100103
def test_e_delete_folder(self):
101104
self.folder.delete_folder(self.folder.get_folders()[1].get("uid"))
102105

tests/integrationtest/test_playlist.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,14 @@ 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("edq1prp6dfy80c").get("name"))
21+
self.assertEqual(
22+
"Test1", self.playlist.get_playlist("edq1prp6dfy80c").get("name")
23+
)
2224

2325
def test_get_playlist_items(self):
2426
self.assertEqual(
25-
"dashboard_by_uid", self.playlist.get_playlist_items("edq1prp6dfy80c")[0].get("type")
27+
"dashboard_by_uid",
28+
self.playlist.get_playlist_items("edq1prp6dfy80c")[0].get("type"),
2629
)
2730

2831
def test_a_create_playlist(self):

tests/unittests/test_alerting.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,9 @@ def test_create_or_update_alertmanager_silence(self, call_the_api_mock):
203203
)
204204

205205
@patch("grafana_api.api.Api.call_the_api")
206-
def test_create_or_update_alertmanager_silence_return_silence_id(self, call_the_api_mock):
206+
def test_create_or_update_alertmanager_silence_return_silence_id(
207+
self, call_the_api_mock
208+
):
207209
model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
208210
alerting: Alerting = Alerting(grafana_api_model=model)
209211
silence: Silence = Silence(

tests/unittests/test_api.py

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,20 +38,34 @@ def test_call_the_api_basic_auth(self, httpx_client_mock):
3838
@patch("httpx.Client")
3939
def test_call_the_api_with_proxy_headers(self, httpx_client_mock):
4040
model: APIModel = APIModel(
41-
host="https://test.test.de", username="test", password="test",
42-
headers=dict({"X-Custom-Header": "custom_value"})
41+
host="https://test.test.de",
42+
username="test",
43+
password="test",
44+
headers=dict({"X-Custom-Header": "custom_value"}),
4345
)
4446
api: Api = Api(grafana_api_model=model)
4547

46-
httpx_client_mock.return_value.request.return_value.text = '{"status": "success"}'
48+
httpx_client_mock.return_value.request.return_value.text = (
49+
'{"status": "success"}'
50+
)
4751

4852
self.assertEqual(
4953
"success",
5054
api.call_the_api(api_call=MagicMock())["status"],
5155
)
5256

5357
httpx_client_mock.assert_called()
54-
self.assertEqual(dict({"X-Custom-Header": "custom_value", "Authorization": "Basic dGVzdDp0ZXN0", "Content-Type": "application/json", "Accept": "application/json"}), httpx_client_mock.call_args[1]["headers"])
58+
self.assertEqual(
59+
dict(
60+
{
61+
"X-Custom-Header": "custom_value",
62+
"Authorization": "Basic dGVzdDp0ZXN0",
63+
"Content-Type": "application/json",
64+
"Accept": "application/json",
65+
}
66+
),
67+
httpx_client_mock.call_args[1]["headers"],
68+
)
5569

5670
@patch("httpx.Client")
5771
def test_call_the_api_org_id(self, httpx_client_mock):

tests/unittests/test_folder.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,9 @@ def test_create_folder_parent_uid(self, call_the_api_mock):
113113
model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
114114
folder: Folder = Folder(grafana_api_model=model)
115115

116-
call_the_api_mock.return_value = dict({"title": None, "id": 12, "parent_uid": "test"})
116+
call_the_api_mock.return_value = dict(
117+
{"title": None, "id": 12, "parent_uid": "test"}
118+
)
117119

118120
self.assertEqual(
119121
dict({"title": None, "id": 12, "parent_uid": "test"}),
@@ -215,7 +217,6 @@ def test_move_folder_no_uid(self):
215217
with self.assertRaises(ValueError):
216218
folder.move_folder("")
217219

218-
219220
@patch("grafana_api.api.Api.call_the_api")
220221
def test_move_folder_parent_uid(self, call_the_api_mock):
221222
model: APIModel = APIModel(host=MagicMock(), token=MagicMock())
@@ -238,7 +239,6 @@ def test_move_folder_no_id(self, call_the_api_mock):
238239
with self.assertRaises(Exception):
239240
folder.move_folder("test")
240241

241-
242242
@patch("grafana_api.api.Api.call_the_api")
243243
def test_delete_folder(self, call_the_api_mock):
244244
model: APIModel = APIModel(host=MagicMock(), token=MagicMock())

0 commit comments

Comments
 (0)