Skip to content

Commit 0b381c7

Browse files
LujeniLujeni
committed
refactor: use pydandic settings to handle configuration
see #21
1 parent 8c6f770 commit 0b381c7

File tree

13 files changed

+166
-385
lines changed

13 files changed

+166
-385
lines changed

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ push: build
1212
docker push $(IMG):$(TAG)
1313

1414
test:
15-
ENV="test" pytest
15+
pytest
1616

1717
qa:
1818
isort --profile black . && black . && flake8

‎dev-requirements.txt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,5 @@ pytest
99
pytest-mock
1010
types-python-slugify
1111
types-PyYAML
12-
types-requests
12+
types-requests
13+
pytest-env==1.1.5

‎gitlab2sentry/__init__.py‎

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,7 @@
66
from slugify import slugify
77

88
from gitlab2sentry.exceptions import SentryProjectCreationFailed
9-
from gitlab2sentry.resources import (
10-
DSN_MR_TITLE,
11-
G2S_STATS,
12-
GITLAB_GRAPHQL_SUFFIX,
13-
GITLAB_GROUP_IDENTIFIER,
14-
GITLAB_TOKEN,
15-
GITLAB_URL,
16-
GRAPHQL_FETCH_PROJECT_QUERY,
17-
GRAPHQL_LIST_PROJECTS_QUERY,
18-
SENTRY_ORG_SLUG,
19-
SENTRY_TOKEN,
20-
SENTRY_URL,
21-
SENTRYCLIRC_FILEPATH,
22-
SENTRYCLIRC_MR_TITLE,
23-
G2SProject,
24-
)
9+
from gitlab2sentry.resources import settings, G2SProject, G2S_STATS, GRAPHQL_LIST_PROJECTS_QUERY, GRAPHQL_FETCH_PROJECT_QUERY
2510
from gitlab2sentry.utils import GitlabProvider, SentryProvider
2611

2712
logging.basicConfig(
@@ -43,10 +28,10 @@ def __str__(self) -> str:
4328
return "<Gitlab2Sentry>"
4429

4530
def _get_gitlab_provider(self) -> GitlabProvider:
46-
return GitlabProvider(GITLAB_URL, GITLAB_TOKEN)
31+
return GitlabProvider(settings.gitlab_url, settings.gitlab_token)
4732

4833
def _get_sentry_provider(self) -> SentryProvider:
49-
return SentryProvider(SENTRY_URL, SENTRY_TOKEN, SENTRY_ORG_SLUG)
34+
return SentryProvider(settings.sentry_url, settings.sentry_token, settings.sentry_org_slug)
5035

5136
def _ensure_sentry_group(self, name: str) -> None:
5237
if name not in self.sentry_groups:
@@ -118,12 +103,12 @@ def _get_mr_states(
118103
sentryclirc_mr_state, dsn_mr_state = None, None
119104
if mr_list:
120105
for mr in mr_list:
121-
if mr["title"] == SENTRYCLIRC_MR_TITLE.format(
106+
if mr["title"] == settings.sentryclirc_mr_title.format(
122107
project_name=project_name
123108
):
124109
if not (sentryclirc_mr_state and sentryclirc_mr_state == "opened"):
125110
sentryclirc_mr_state = mr["state"]
126-
elif mr["title"] == DSN_MR_TITLE.format(project_name=project_name):
111+
elif mr["title"] == settings.dsn_mr_title.format(project_name=project_name):
127112
if not (dsn_mr_state and dsn_mr_state == "opened"):
128113
dsn_mr_state = mr["state"]
129114
else:
@@ -138,7 +123,7 @@ def _is_group_project(self, group: Optional[Dict[str, Any]]) -> bool:
138123

139124
def _get_sentryclirc_file(self, blob: List[Dict[str, Any]]) -> tuple:
140125
has_sentryclirc_file, has_dsn = False, False
141-
if blob and blob[0]["name"] == SENTRYCLIRC_FILEPATH:
126+
if blob and blob[0]["name"] == settings.sentryclirc_filepath:
142127
has_sentryclirc_file = True
143128
if blob[0].get("rawTextBlob"):
144129
for line in blob[0]["rawTextBlob"].split("\n"):
@@ -191,7 +176,7 @@ def _get_paginated_projects(self) -> List[Dict[str, Any]]:
191176
query_start_time = time.time()
192177
logging.info(
193178
"{}: Starting querying all Gitlab group-projects with Graphql at {}/{}".format( # noqa
194-
self.__str__(), GITLAB_URL, GITLAB_GRAPHQL_SUFFIX
179+
self.__str__(), settings.gitlab_url, settings.gitlab_graphql_suffix
195180
)
196181
)
197182
request_gen = self.gitlab_provider.get_all_projects(GRAPHQL_LIST_PROJECTS_QUERY)
@@ -209,7 +194,7 @@ def _get_gitlab_project(self, full_path: str) -> Optional[G2SProject]:
209194
GRAPHQL_FETCH_PROJECT_QUERY["full_path"] = full_path
210195
logging.info(
211196
"{}: Starting querying for specific Gitlab project with Graphql at {}/{}".format( # noqa
212-
self.__str__(), GITLAB_URL, GITLAB_GRAPHQL_SUFFIX
197+
self.__str__(), settings.gitlab_url, settings.gitlab_graphql_suffix
213198
)
214199
)
215200
result = self.gitlab_provider.get_project(GRAPHQL_FETCH_PROJECT_QUERY)
@@ -227,7 +212,7 @@ def _get_gitlab_groups(self):
227212
result = result_node["node"]
228213
if self._is_group_project(result["group"]):
229214
group_name = result["fullPath"].split("/")[0]
230-
if group_name.startswith(GITLAB_GROUP_IDENTIFIER):
215+
if group_name.startswith(settings.gitlab_group_identifier):
231216
g2s_project = self._get_g2s_project(result)
232217

233218
if g2s_project:

‎gitlab2sentry/resources.py‎

Lines changed: 45 additions & 205 deletions
Original file line numberDiff line numberDiff line change
@@ -1,183 +1,56 @@
1-
import logging
21
import os
32
from collections import namedtuple
43
from typing import List, Tuple
4+
from pydantic import Field
5+
from pydantic_settings import BaseSettings
56

6-
from tests.resources import (
7-
TEST_DSN_BRANCH_NAME,
8-
TEST_DSN_MR_CONTENT,
9-
TEST_DSN_MR_DESCRIPTION,
10-
TEST_DSN_MR_TITLE,
11-
TEST_GITLAB_AUTHOR_EMAIL,
12-
TEST_GITLAB_AUTHOR_NAME,
13-
TEST_GITLAB_GRAPHQL_PAGE_LENGTH,
14-
TEST_GITLAB_GRAPHQL_SUFFIX,
15-
TEST_GITLAB_GRAPHQL_TIMEOUT,
16-
TEST_GITLAB_MR_KEYWORD,
17-
TEST_GITLAB_MR_LABEL_LIST,
18-
TEST_GITLAB_RMV_SRC_BRANCH,
19-
TEST_GITLAB_TOKEN,
20-
TEST_GITLAB_URL,
21-
TEST_SENTRY_DSN,
22-
TEST_SENTRY_ORG_SLUG,
23-
TEST_SENTRY_TOKEN,
24-
TEST_SENTRY_URL,
25-
TEST_SENTRYCLIRC_BRANCH_NAME,
26-
TEST_SENTRYCLIRC_COM_MSG,
27-
TEST_SENTRYCLIRC_FILEPATH,
28-
TEST_SENTRYCLIRC_MR_CONTENT,
29-
TEST_SENTRYCLIRC_MR_DESCRIPTION,
30-
TEST_SENTRYCLIRC_MR_TITLE,
31-
)
32-
7+
ENV = os.getenv("ENV", "production")
338

34-
def is_test_env(env: str) -> bool:
35-
return env == "test"
369

37-
try:
38-
ENV = os.getenv("ENV", "production")
10+
class Settings(BaseSettings):
11+
dsn_branch_name: str = Field("auto_add_sentry_dsn")
12+
dsn_mr_content: str = Field("""
13+
## File generated by gitlab2sentry
14+
[defaults]
15+
url = {sentry_url}
16+
dsn = {dsn}
17+
project = {project_slug}
18+
""")
19+
dsn_mr_description: str = Field("{mentions} Congrats, your Sentry project has been created, merge this to finalize your Sentry integration of {name_with_namespace} :clap: :cookie:")
20+
dsn_mr_title: str = Field("[gitlab2sentry] Merge me to add your Sentry DSN to {project_name}")
21+
env: str = Field("production")
22+
gitlab_author_email: str = Field("[email protected]")
23+
gitlab_author_name: str = Field("Default Author")
24+
gitlab_graphql_page_length: int = Field(0)
25+
gitlab_graphql_suffix: str = Field("default-content")
26+
gitlab_graphql_timeout: int = Field(10)
27+
gitlab_group_identifier: str = Field("")
28+
gitlab_mentions: str = Field("", examples=["@foo,@bar"])
29+
gitlab_mentions_access_level: int = Field(40)
30+
gitlab_mr_keyword: str = Field("sentry")
31+
gitlab_mr_label_list: List[str] = Field(["sentry"])
32+
gitlab_project_creation_limit: int = Field(30)
33+
gitlab_rmv_src_branch: bool = Field(True)
34+
gitlab_token: str = Field("default-token")
35+
gitlab_url: str = Field("http://default-gitlab-url")
36+
sentry_dsn: str = Field("http://default.sentry.com")
37+
sentry_env: str = Field("production")
38+
sentry_org_slug: str = Field("default_org")
39+
sentry_token: str = Field("default-token")
40+
sentry_url: str = Field("http://default-sentry-url")
41+
sentryclirc_branch_name: str = Field("auto_add_sentry")
42+
sentryclirc_com_msg: str = Field("Update .sentryclirc")
43+
sentryclirc_filepath: str = Field(".sentryclirc")
44+
sentryclirc_mr_content: str = Field("""
45+
## File generated by gitlab2sentry
46+
[defaults]
47+
url = {sentry_url}
48+
""")
49+
sentryclirc_mr_description: str = Field("{mentions} Merge this and it will automatically create a Sentry project \n for {name_with_namespace} :cookie:")
50+
sentryclirc_mr_title: str = Field("[gitlab2sentry] Merge me to add Sentry to {project_name} or close me")
3951

40-
# Sentry configuration
41-
SENTRY_URL = (
42-
TEST_SENTRY_URL
43-
if is_test_env(ENV)
44-
else os.environ["SENTRY_URL"]
45-
)
46-
SENTRY_TOKEN = (
47-
TEST_SENTRY_TOKEN
48-
if is_test_env(ENV)
49-
else os.environ["SENTRY_TOKEN"]
50-
)
51-
SENTRY_DSN = (
52-
TEST_SENTRY_DSN
53-
if is_test_env(ENV)
54-
else os.environ["SENTRY_DSN"]
55-
)
56-
SENTRY_ENV = os.getenv("SENTRY_ENV", "production")
57-
SENTRY_ORG_SLUG = (
58-
TEST_SENTRY_ORG_SLUG
59-
if is_test_env(ENV)
60-
else os.environ["SENTRY_ORG_SLUG"]
61-
)
62-
# DSN MR configuration.
63-
DSN_MR_CONTENT = (
64-
TEST_DSN_MR_CONTENT
65-
if is_test_env(ENV)
66-
else os.environ["GITLAB_DSN_MR_CONTENT"]
67-
)
68-
DSN_BRANCH_NAME = (
69-
TEST_DSN_BRANCH_NAME
70-
if is_test_env(ENV)
71-
else os.environ["GITLAB_DSN_MR_BRANCH_NAME"]
72-
)
73-
DSN_MR_TITLE = (
74-
TEST_DSN_MR_TITLE
75-
if is_test_env(ENV)
76-
else os.environ["GITLAB_DSN_MR_TITLE"]
77-
)
78-
DSN_MR_DESCRIPTION = (
79-
TEST_DSN_MR_DESCRIPTION
80-
if is_test_env(ENV)
81-
else os.environ["GITLAB_DSN_MR_DESCRIPTION"]
82-
)
8352

84-
# Sentryclirc MR configuration.
85-
SENTRYCLIRC_MR_CONTENT = (
86-
TEST_SENTRYCLIRC_MR_CONTENT
87-
if is_test_env(ENV)
88-
else os.environ["GITLAB_SENTRYCLIRC_MR_CONTENT"]
89-
)
90-
SENTRYCLIRC_BRANCH_NAME = (
91-
TEST_SENTRYCLIRC_BRANCH_NAME
92-
if is_test_env(ENV)
93-
else os.environ["GITLAB_SENTRYCLIRC_MR_BRANCH_NAME"]
94-
)
95-
SENTRYCLIRC_MR_TITLE = (
96-
TEST_SENTRYCLIRC_MR_TITLE
97-
if is_test_env(ENV)
98-
else os.environ["GITLAB_SENTRYCLIRC_MR_TITLE"]
99-
)
100-
SENTRYCLIRC_FILEPATH = (
101-
TEST_SENTRYCLIRC_FILEPATH
102-
if is_test_env(ENV)
103-
else os.environ["GITLAB_SENTRYCLIRC_MR_FILEPATH"]
104-
)
105-
SENTRYCLIRC_COM_MSG = (
106-
TEST_SENTRYCLIRC_COM_MSG
107-
if is_test_env(ENV)
108-
else os.environ["GITLAB_SENTRYCLIRC_MR_COMMIT_MSG"]
109-
)
110-
SENTRYCLIRC_MR_DESCRIPTION = (
111-
TEST_SENTRYCLIRC_MR_DESCRIPTION
112-
if is_test_env(ENV)
113-
else os.environ["GITLAB_SENTRYCLIRC_MR_DESCRIPTION"]
114-
)
115-
# Gitlab Configuration.
116-
GITLAB_URL = (
117-
TEST_GITLAB_URL
118-
if is_test_env(ENV)
119-
else os.environ["GITLAB_URL"]
120-
)
121-
GITLAB_TOKEN = (
122-
TEST_GITLAB_TOKEN
123-
if is_test_env(ENV)
124-
else os.environ["GITLAB_TOKEN"]
125-
)
126-
GITLAB_GRAPHQL_SUFFIX = (
127-
TEST_GITLAB_GRAPHQL_SUFFIX
128-
if is_test_env(ENV)
129-
else os.environ["GITLAB_GRAPHQL_SUFFIX"]
130-
)
131-
GITLAB_GRAPHQL_TIMEOUT = (
132-
TEST_GITLAB_GRAPHQL_TIMEOUT
133-
if is_test_env(ENV)
134-
else int(os.environ["GITLAB_AIOHTTP_TIMEOUT"])
135-
)
136-
GITLAB_GRAPHQL_PAGE_LENGTH = (
137-
TEST_GITLAB_GRAPHQL_PAGE_LENGTH
138-
if is_test_env(ENV)
139-
else int(os.environ["GITLAB_GRAPHQL_PAGE_LENGTH"])
140-
)
141-
GITLAB_GROUP_IDENTIFIER = os.getenv("GITLAB_GROUP_IDENTIFIER", "")
142-
GITLAB_AUTHOR_EMAIL = (
143-
TEST_GITLAB_AUTHOR_EMAIL
144-
if is_test_env(ENV)
145-
else os.environ["GITLAB_AUTHOR_EMAIL"]
146-
)
147-
GITLAB_AUTHOR_NAME = (
148-
TEST_GITLAB_AUTHOR_NAME
149-
if is_test_env(ENV)
150-
else os.environ["GITLAB_AUTHOR_NAME"]
151-
)
152-
GITLAB_PROJECT_CREATION_LIMIT = int(os.getenv("GITLAB_CREATION_DAYS_LIMIT", 30))
153-
GITLAB_RMV_SRC_BRANCH = (
154-
TEST_GITLAB_RMV_SRC_BRANCH
155-
if is_test_env(ENV)
156-
else bool(int(os.environ["GITLAB_REMOVE_SOURCE"]))
157-
)
158-
GITLAB_MENTIONS_LIST = os.getenv("GITLAB_MENTIONS")
159-
GITLAB_MENTIONS_ACCESS_LEVEL = int(os.getenv("GITLAB_MENTIONS_ACCESS_LEVEL", 40))
160-
GITLAB_MR_KEYWORD = (
161-
TEST_GITLAB_MR_KEYWORD
162-
if is_test_env(ENV)
163-
else os.environ["GITLAB_MR_KEYWORD"]
164-
)
165-
GITLAB_MR_LABEL_LIST = (
166-
TEST_GITLAB_MR_LABEL_LIST
167-
if is_test_env(ENV)
168-
else os.environ.get("GITLAB_MR_LABEL_LIST", "").split(",")
169-
)
170-
171-
except KeyError as key_error:
172-
logging.error(
173-
"<Gitlab2Sentry>: env vars are not configured properly - {}".format(str(key_error))
174-
)
175-
exit(1)
176-
except ValueError as value_error:
177-
logging.error(
178-
"<Gitlab2Sentry>: env vars have wrong value type - {}".format(str(value_error))
179-
)
180-
exit(1)
53+
settings = Settings() # type: ignore
18154

18255
# G2SProject namedtuple configuration
18356
G2SProject = namedtuple(
@@ -285,36 +158,3 @@ def is_test_env(env: str) -> bool:
285158
}
286159
""",
287160
}
288-
GRAPHQL_TEST_QUERY = {
289-
"name": "TEST_QUERY",
290-
"instance": "projects",
291-
"body": """
292-
{
293-
project(fullPath: "none") {
294-
id
295-
fullPath
296-
name
297-
createdAt
298-
mergeRequestsEnabled
299-
group {
300-
name
301-
}
302-
repository {
303-
blobs {
304-
nodes {
305-
name
306-
rawTextBlob
307-
}
308-
}
309-
}
310-
mergeRequests {
311-
nodes {
312-
id
313-
title
314-
state
315-
}
316-
}
317-
}
318-
}
319-
""",
320-
}

0 commit comments

Comments
 (0)