csctracker-py-core 26.37.4__tar.gz → 26.47.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/PKG-INFO +19 -3
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/README.md +17 -2
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/models/emuns/config.py +2 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/starter.py +41 -7
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/utils/graceful_shutdown.py +16 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core.egg-info/PKG-INFO +19 -3
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core.egg-info/SOURCES.txt +2 -1
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core.egg-info/requires.txt +1 -0
- csctracker_py_core-26.47.1/tests/test_starter_wsgi.py +143 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/LICENSE +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/__init__.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/models/__init__.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/models/emuns/__init__.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/repository/__init__.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/repository/http_repository.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/repository/remote_repository.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/utils/__init__.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/utils/configs.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/utils/interceptor.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/utils/request_info.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/utils/utils.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/utils/version.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core.egg-info/dependency_links.txt +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core.egg-info/top_level.txt +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/setup.cfg +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/setup.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/tests/test_graceful_shutdown.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: csctracker-py-core
|
|
3
|
-
Version: 26.
|
|
3
|
+
Version: 26.47.1
|
|
4
4
|
Summary: A base library for microservices with Flask, JSON logging, and Prometheus telemetry.
|
|
5
5
|
Home-page: https://github.com/krlsedu/CscTrackerPyCore
|
|
6
6
|
Author: Carlos Eduardo
|
|
@@ -35,6 +35,7 @@ Requires-Dist: flask-cors~=3.0.7
|
|
|
35
35
|
Requires-Dist: prometheus-flask-exporter==0.22.4
|
|
36
36
|
Requires-Dist: flask-swagger-init==23.52.4
|
|
37
37
|
Requires-Dist: pytz~=2023.3.post1
|
|
38
|
+
Requires-Dist: waitress>=3.0.0
|
|
38
39
|
Dynamic: author
|
|
39
40
|
Dynamic: classifier
|
|
40
41
|
Dynamic: description
|
|
@@ -59,7 +60,7 @@ CscTrackerPyCore é uma biblioteca Python base desenvolvida para padronizar e ac
|
|
|
59
60
|
|
|
60
61
|
## Principais Funcionalidades
|
|
61
62
|
|
|
62
|
-
- **Starter Facilitado**: Inicialização rápida de aplicações Flask com suporte a CORS
|
|
63
|
+
- **Starter Facilitado (WSGI Nativo)**: Inicialização rápida de aplicações Flask com suporte a CORS, servidor WSGI de produção (**Waitress**, multi-thread e sem `fork()`) por padrão no `starter.start()` e fallback automático para Werkzeug em desenvolvimento local via `DEBUG=1`.
|
|
63
64
|
- **Logging Estruturado**: Formatação automática de logs em JSON com inclusão de `requestId`, `appName` e `appVersion` para melhor rastreabilidade.
|
|
64
65
|
- **Observabilidade**:
|
|
65
66
|
- Integração nativa com **Prometheus** para coleta de métricas de endpoints.
|
|
@@ -74,6 +75,7 @@ CscTrackerPyCore é uma biblioteca Python base desenvolvida para padronizar e ac
|
|
|
74
75
|
- Python 3.9+
|
|
75
76
|
- Flask
|
|
76
77
|
- Flask-CORS
|
|
78
|
+
- Waitress (WSGI de produção)
|
|
77
79
|
- Prometheus Flask Exporter
|
|
78
80
|
- Flask Swagger Generator
|
|
79
81
|
- Python JSON Logger
|
|
@@ -109,7 +111,9 @@ A biblioteca é configurada principalmente via variáveis de ambiente, suportand
|
|
|
109
111
|
| `URL_BFF` | URL base para persistência de logs de requisição | `http://api-gateway/` |
|
|
110
112
|
| `API_TOKEN` | Token de autorização para chamadas externas | `seu_token_aqui` |
|
|
111
113
|
| `SHUTDOWN_TIMEOUT` | Tempo limite (segundos) para conclusão de requisições e tarefas em background durante o shutdown | `30` |
|
|
112
|
-
| `
|
|
114
|
+
| `WSGI_THREADS` | Número de threads do pool WSGI do Waitress em produção | `32` |
|
|
115
|
+
| `WSGI_CHANNEL_TIMEOUT` | Timeout de ociosidade de canal HTTP (segundos) no Waitress | `600` |
|
|
116
|
+
| `DEBUG` | Quando `1`, utiliza o servidor de desenvolvimento Werkzeug (`app.run()`) no `starter.start()`; caso contrário, sobe via Waitress | `0` |
|
|
113
117
|
|
|
114
118
|
## Uso Didático
|
|
115
119
|
|
|
@@ -132,6 +136,7 @@ def hello():
|
|
|
132
136
|
return {"message": "CscTrackerPyCore is running!"}
|
|
133
137
|
|
|
134
138
|
if __name__ == '__main__':
|
|
139
|
+
# Produção (padrão): sobe Waitress WSGI. Local dev (DEBUG=1): sobe Werkzeug.
|
|
135
140
|
starter.start()
|
|
136
141
|
```
|
|
137
142
|
|
|
@@ -163,6 +168,17 @@ starter.register_shutdown_hook(cleanup_resources)
|
|
|
163
168
|
|
|
164
169
|
## Implantação no Docker Swarm
|
|
165
170
|
|
|
171
|
+
Nos serviços que consomem `csctracker-py-core`, recomenda-se manter `CMD ["python", "-u", "app.py"]` (que inicia o Waitress automaticamente via `starter.start()` quando `DEBUG` não é `1`) e copiar `requirements.txt` antes do código-fonte no `Dockerfile` para aproveitar o cache de layers:
|
|
172
|
+
|
|
173
|
+
```dockerfile
|
|
174
|
+
FROM python:3.11-slim
|
|
175
|
+
WORKDIR /app
|
|
176
|
+
COPY requirements.txt .
|
|
177
|
+
RUN pip install --no-cache-dir -r requirements.txt
|
|
178
|
+
COPY . /app
|
|
179
|
+
CMD ["python", "-u", "app.py"]
|
|
180
|
+
```
|
|
181
|
+
|
|
166
182
|
Para garantir atualizações contínuas (*rolling updates zero-downtime*), configure o `docker-compose.yml` da stack no Swarm utilizando `order: start-first` e defina `stop_grace_period` com um valor superior ao `SHUTDOWN_TIMEOUT`:
|
|
167
183
|
|
|
168
184
|
```yaml
|
|
@@ -9,7 +9,7 @@ CscTrackerPyCore é uma biblioteca Python base desenvolvida para padronizar e ac
|
|
|
9
9
|
|
|
10
10
|
## Principais Funcionalidades
|
|
11
11
|
|
|
12
|
-
- **Starter Facilitado**: Inicialização rápida de aplicações Flask com suporte a CORS
|
|
12
|
+
- **Starter Facilitado (WSGI Nativo)**: Inicialização rápida de aplicações Flask com suporte a CORS, servidor WSGI de produção (**Waitress**, multi-thread e sem `fork()`) por padrão no `starter.start()` e fallback automático para Werkzeug em desenvolvimento local via `DEBUG=1`.
|
|
13
13
|
- **Logging Estruturado**: Formatação automática de logs em JSON com inclusão de `requestId`, `appName` e `appVersion` para melhor rastreabilidade.
|
|
14
14
|
- **Observabilidade**:
|
|
15
15
|
- Integração nativa com **Prometheus** para coleta de métricas de endpoints.
|
|
@@ -24,6 +24,7 @@ CscTrackerPyCore é uma biblioteca Python base desenvolvida para padronizar e ac
|
|
|
24
24
|
- Python 3.9+
|
|
25
25
|
- Flask
|
|
26
26
|
- Flask-CORS
|
|
27
|
+
- Waitress (WSGI de produção)
|
|
27
28
|
- Prometheus Flask Exporter
|
|
28
29
|
- Flask Swagger Generator
|
|
29
30
|
- Python JSON Logger
|
|
@@ -59,7 +60,9 @@ A biblioteca é configurada principalmente via variáveis de ambiente, suportand
|
|
|
59
60
|
| `URL_BFF` | URL base para persistência de logs de requisição | `http://api-gateway/` |
|
|
60
61
|
| `API_TOKEN` | Token de autorização para chamadas externas | `seu_token_aqui` |
|
|
61
62
|
| `SHUTDOWN_TIMEOUT` | Tempo limite (segundos) para conclusão de requisições e tarefas em background durante o shutdown | `30` |
|
|
62
|
-
| `
|
|
63
|
+
| `WSGI_THREADS` | Número de threads do pool WSGI do Waitress em produção | `32` |
|
|
64
|
+
| `WSGI_CHANNEL_TIMEOUT` | Timeout de ociosidade de canal HTTP (segundos) no Waitress | `600` |
|
|
65
|
+
| `DEBUG` | Quando `1`, utiliza o servidor de desenvolvimento Werkzeug (`app.run()`) no `starter.start()`; caso contrário, sobe via Waitress | `0` |
|
|
63
66
|
|
|
64
67
|
## Uso Didático
|
|
65
68
|
|
|
@@ -82,6 +85,7 @@ def hello():
|
|
|
82
85
|
return {"message": "CscTrackerPyCore is running!"}
|
|
83
86
|
|
|
84
87
|
if __name__ == '__main__':
|
|
88
|
+
# Produção (padrão): sobe Waitress WSGI. Local dev (DEBUG=1): sobe Werkzeug.
|
|
85
89
|
starter.start()
|
|
86
90
|
```
|
|
87
91
|
|
|
@@ -113,6 +117,17 @@ starter.register_shutdown_hook(cleanup_resources)
|
|
|
113
117
|
|
|
114
118
|
## Implantação no Docker Swarm
|
|
115
119
|
|
|
120
|
+
Nos serviços que consomem `csctracker-py-core`, recomenda-se manter `CMD ["python", "-u", "app.py"]` (que inicia o Waitress automaticamente via `starter.start()` quando `DEBUG` não é `1`) e copiar `requirements.txt` antes do código-fonte no `Dockerfile` para aproveitar o cache de layers:
|
|
121
|
+
|
|
122
|
+
```dockerfile
|
|
123
|
+
FROM python:3.11-slim
|
|
124
|
+
WORKDIR /app
|
|
125
|
+
COPY requirements.txt .
|
|
126
|
+
RUN pip install --no-cache-dir -r requirements.txt
|
|
127
|
+
COPY . /app
|
|
128
|
+
CMD ["python", "-u", "app.py"]
|
|
129
|
+
```
|
|
130
|
+
|
|
116
131
|
Para garantir atualizações contínuas (*rolling updates zero-downtime*), configure o `docker-compose.yml` da stack no Swarm utilizando `order: start-first` e defina `stop_grace_period` com um valor superior ao `SHUTDOWN_TIMEOUT`:
|
|
117
132
|
|
|
118
133
|
```yaml
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import logging
|
|
2
2
|
import os
|
|
3
3
|
|
|
4
|
+
import waitress
|
|
4
5
|
from csctracker_queue_scheduler.services.scheduler_service import SchedulerService
|
|
5
6
|
from flask import Flask
|
|
6
7
|
from flask_cors import CORS
|
|
@@ -45,6 +46,15 @@ class Starter:
|
|
|
45
46
|
group_by="endpoint",
|
|
46
47
|
default_labels={"application": Version.get_app_name()},
|
|
47
48
|
)
|
|
49
|
+
self._swagger_initialized = False
|
|
50
|
+
|
|
51
|
+
@staticmethod
|
|
52
|
+
def _get_int_env(key: Config, default: int) -> int:
|
|
53
|
+
value = Configs.get_env_variable(key, default=default)
|
|
54
|
+
try:
|
|
55
|
+
return int(value)
|
|
56
|
+
except (TypeError, ValueError):
|
|
57
|
+
return default
|
|
48
58
|
|
|
49
59
|
def register_shutdown_hook(self, callback):
|
|
50
60
|
self.graceful_shutdown.register_shutdown_hook(callback)
|
|
@@ -62,12 +72,36 @@ class Starter:
|
|
|
62
72
|
return self.app
|
|
63
73
|
|
|
64
74
|
def start(self):
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
75
|
+
if not self._swagger_initialized:
|
|
76
|
+
SwaggerView.init(
|
|
77
|
+
self.app,
|
|
78
|
+
application_name=Version.get_app_name(),
|
|
79
|
+
application_version=Version.get_version(),
|
|
80
|
+
swagger_destination_path="swagger.yaml",
|
|
81
|
+
)
|
|
82
|
+
self._swagger_initialized = True
|
|
83
|
+
|
|
84
|
+
port = self._get_int_env(Config.PORT, default=5000)
|
|
85
|
+
|
|
86
|
+
if Configs.is_debug():
|
|
87
|
+
self.logger.info(
|
|
88
|
+
f"Starting Flask development server (DEBUG=1) on 0.0.0.0:{port}"
|
|
89
|
+
)
|
|
90
|
+
self.app.run(host="0.0.0.0", port=port)
|
|
91
|
+
return
|
|
92
|
+
|
|
93
|
+
threads = self._get_int_env(Config.WSGI_THREADS, default=32)
|
|
94
|
+
channel_timeout = self._get_int_env(Config.WSGI_CHANNEL_TIMEOUT, default=600)
|
|
95
|
+
self.logger.info(
|
|
96
|
+
f"Starting Waitress WSGI server on 0.0.0.0:{port} "
|
|
97
|
+
f"(threads={threads}, channel_timeout={channel_timeout}s)"
|
|
70
98
|
)
|
|
71
|
-
|
|
72
|
-
|
|
99
|
+
server = waitress.create_server(
|
|
100
|
+
self.app,
|
|
101
|
+
host="0.0.0.0",
|
|
102
|
+
port=port,
|
|
103
|
+
threads=threads,
|
|
104
|
+
channel_timeout=channel_timeout,
|
|
73
105
|
)
|
|
106
|
+
self.graceful_shutdown.set_server_close_hook(server.close)
|
|
107
|
+
server.run()
|
|
@@ -18,6 +18,7 @@ class GracefulShutdown:
|
|
|
18
18
|
self.active_requests = 0
|
|
19
19
|
self._condition = threading.Condition(self._lock)
|
|
20
20
|
self._shutdown_hooks: List[Callable] = []
|
|
21
|
+
self._server_close_hook: Optional[Callable] = None
|
|
21
22
|
self.logger = logging.getLogger()
|
|
22
23
|
|
|
23
24
|
@classmethod
|
|
@@ -59,6 +60,10 @@ class GracefulShutdown:
|
|
|
59
60
|
with self._lock:
|
|
60
61
|
self._shutdown_hooks.append(callback)
|
|
61
62
|
|
|
63
|
+
def set_server_close_hook(self, callback: Optional[Callable]):
|
|
64
|
+
with self._lock:
|
|
65
|
+
self._server_close_hook = callback
|
|
66
|
+
|
|
62
67
|
def _handle_signal(self, signum, frame):
|
|
63
68
|
signal_name = "SIGTERM" if signum == signal.SIGTERM else ("SIGINT" if signum == signal.SIGINT else str(signum))
|
|
64
69
|
self.logger.info(f"Signal {signal_name} received. Starting graceful shutdown...")
|
|
@@ -76,6 +81,17 @@ class GracefulShutdown:
|
|
|
76
81
|
timeout = override_timeout if override_timeout is not None else self.timeout
|
|
77
82
|
start_time = time.time()
|
|
78
83
|
|
|
84
|
+
# 0. Stop accepting new HTTP connections if a WSGI server close hook is registered
|
|
85
|
+
with self._lock:
|
|
86
|
+
server_close_hook = self._server_close_hook
|
|
87
|
+
self._server_close_hook = None
|
|
88
|
+
|
|
89
|
+
if server_close_hook is not None:
|
|
90
|
+
try:
|
|
91
|
+
server_close_hook()
|
|
92
|
+
except Exception as e:
|
|
93
|
+
self.logger.error(f"Error closing WSGI server listener: {e}")
|
|
94
|
+
|
|
79
95
|
# 1. Wait for active HTTP requests to reach 0
|
|
80
96
|
with self._condition:
|
|
81
97
|
while self.active_requests > 0:
|
{csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core.egg-info/PKG-INFO
RENAMED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: csctracker-py-core
|
|
3
|
-
Version: 26.
|
|
3
|
+
Version: 26.47.1
|
|
4
4
|
Summary: A base library for microservices with Flask, JSON logging, and Prometheus telemetry.
|
|
5
5
|
Home-page: https://github.com/krlsedu/CscTrackerPyCore
|
|
6
6
|
Author: Carlos Eduardo
|
|
@@ -35,6 +35,7 @@ Requires-Dist: flask-cors~=3.0.7
|
|
|
35
35
|
Requires-Dist: prometheus-flask-exporter==0.22.4
|
|
36
36
|
Requires-Dist: flask-swagger-init==23.52.4
|
|
37
37
|
Requires-Dist: pytz~=2023.3.post1
|
|
38
|
+
Requires-Dist: waitress>=3.0.0
|
|
38
39
|
Dynamic: author
|
|
39
40
|
Dynamic: classifier
|
|
40
41
|
Dynamic: description
|
|
@@ -59,7 +60,7 @@ CscTrackerPyCore é uma biblioteca Python base desenvolvida para padronizar e ac
|
|
|
59
60
|
|
|
60
61
|
## Principais Funcionalidades
|
|
61
62
|
|
|
62
|
-
- **Starter Facilitado**: Inicialização rápida de aplicações Flask com suporte a CORS
|
|
63
|
+
- **Starter Facilitado (WSGI Nativo)**: Inicialização rápida de aplicações Flask com suporte a CORS, servidor WSGI de produção (**Waitress**, multi-thread e sem `fork()`) por padrão no `starter.start()` e fallback automático para Werkzeug em desenvolvimento local via `DEBUG=1`.
|
|
63
64
|
- **Logging Estruturado**: Formatação automática de logs em JSON com inclusão de `requestId`, `appName` e `appVersion` para melhor rastreabilidade.
|
|
64
65
|
- **Observabilidade**:
|
|
65
66
|
- Integração nativa com **Prometheus** para coleta de métricas de endpoints.
|
|
@@ -74,6 +75,7 @@ CscTrackerPyCore é uma biblioteca Python base desenvolvida para padronizar e ac
|
|
|
74
75
|
- Python 3.9+
|
|
75
76
|
- Flask
|
|
76
77
|
- Flask-CORS
|
|
78
|
+
- Waitress (WSGI de produção)
|
|
77
79
|
- Prometheus Flask Exporter
|
|
78
80
|
- Flask Swagger Generator
|
|
79
81
|
- Python JSON Logger
|
|
@@ -109,7 +111,9 @@ A biblioteca é configurada principalmente via variáveis de ambiente, suportand
|
|
|
109
111
|
| `URL_BFF` | URL base para persistência de logs de requisição | `http://api-gateway/` |
|
|
110
112
|
| `API_TOKEN` | Token de autorização para chamadas externas | `seu_token_aqui` |
|
|
111
113
|
| `SHUTDOWN_TIMEOUT` | Tempo limite (segundos) para conclusão de requisições e tarefas em background durante o shutdown | `30` |
|
|
112
|
-
| `
|
|
114
|
+
| `WSGI_THREADS` | Número de threads do pool WSGI do Waitress em produção | `32` |
|
|
115
|
+
| `WSGI_CHANNEL_TIMEOUT` | Timeout de ociosidade de canal HTTP (segundos) no Waitress | `600` |
|
|
116
|
+
| `DEBUG` | Quando `1`, utiliza o servidor de desenvolvimento Werkzeug (`app.run()`) no `starter.start()`; caso contrário, sobe via Waitress | `0` |
|
|
113
117
|
|
|
114
118
|
## Uso Didático
|
|
115
119
|
|
|
@@ -132,6 +136,7 @@ def hello():
|
|
|
132
136
|
return {"message": "CscTrackerPyCore is running!"}
|
|
133
137
|
|
|
134
138
|
if __name__ == '__main__':
|
|
139
|
+
# Produção (padrão): sobe Waitress WSGI. Local dev (DEBUG=1): sobe Werkzeug.
|
|
135
140
|
starter.start()
|
|
136
141
|
```
|
|
137
142
|
|
|
@@ -163,6 +168,17 @@ starter.register_shutdown_hook(cleanup_resources)
|
|
|
163
168
|
|
|
164
169
|
## Implantação no Docker Swarm
|
|
165
170
|
|
|
171
|
+
Nos serviços que consomem `csctracker-py-core`, recomenda-se manter `CMD ["python", "-u", "app.py"]` (que inicia o Waitress automaticamente via `starter.start()` quando `DEBUG` não é `1`) e copiar `requirements.txt` antes do código-fonte no `Dockerfile` para aproveitar o cache de layers:
|
|
172
|
+
|
|
173
|
+
```dockerfile
|
|
174
|
+
FROM python:3.11-slim
|
|
175
|
+
WORKDIR /app
|
|
176
|
+
COPY requirements.txt .
|
|
177
|
+
RUN pip install --no-cache-dir -r requirements.txt
|
|
178
|
+
COPY . /app
|
|
179
|
+
CMD ["python", "-u", "app.py"]
|
|
180
|
+
```
|
|
181
|
+
|
|
166
182
|
Para garantir atualizações contínuas (*rolling updates zero-downtime*), configure o `docker-compose.yml` da stack no Swarm utilizando `order: start-first` e defina `stop_grace_period` com um valor superior ao `SHUTDOWN_TIMEOUT`:
|
|
167
183
|
|
|
168
184
|
```yaml
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
import os
|
|
2
|
+
import unittest
|
|
3
|
+
from unittest.mock import MagicMock, patch
|
|
4
|
+
|
|
5
|
+
from csctracker_py_core.starter import Starter
|
|
6
|
+
from csctracker_py_core.utils.graceful_shutdown import GracefulShutdown
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class TestStarterWsgi(unittest.TestCase):
|
|
10
|
+
def setUp(self):
|
|
11
|
+
GracefulShutdown.reset_instance()
|
|
12
|
+
self._env_backup = os.environ.copy()
|
|
13
|
+
for key in ("DEBUG", "PORT", "WSGI_THREADS", "WSGI_CHANNEL_TIMEOUT"):
|
|
14
|
+
os.environ.pop(key, None)
|
|
15
|
+
|
|
16
|
+
def tearDown(self):
|
|
17
|
+
os.environ.clear()
|
|
18
|
+
os.environ.update(self._env_backup)
|
|
19
|
+
GracefulShutdown.reset_instance()
|
|
20
|
+
|
|
21
|
+
@patch("csctracker_py_core.starter.SwaggerView.init")
|
|
22
|
+
@patch("csctracker_py_core.starter.waitress.create_server")
|
|
23
|
+
def test_start_uses_waitress_by_default(self, mock_create_server, mock_swagger_init):
|
|
24
|
+
mock_server = MagicMock()
|
|
25
|
+
mock_create_server.return_value = mock_server
|
|
26
|
+
|
|
27
|
+
starter = Starter(save_request=False)
|
|
28
|
+
with patch.object(starter.app, "run") as mock_flask_run:
|
|
29
|
+
starter.start()
|
|
30
|
+
|
|
31
|
+
mock_swagger_init.assert_called_once()
|
|
32
|
+
mock_flask_run.assert_not_called()
|
|
33
|
+
mock_create_server.assert_called_once_with(
|
|
34
|
+
starter.app,
|
|
35
|
+
host="0.0.0.0",
|
|
36
|
+
port=5000,
|
|
37
|
+
threads=32,
|
|
38
|
+
channel_timeout=600,
|
|
39
|
+
)
|
|
40
|
+
mock_server.run.assert_called_once()
|
|
41
|
+
self.assertIs(starter.get_graceful_shutdown()._server_close_hook, mock_server.close)
|
|
42
|
+
|
|
43
|
+
@patch("csctracker_py_core.starter.SwaggerView.init")
|
|
44
|
+
@patch("csctracker_py_core.starter.waitress.create_server")
|
|
45
|
+
def test_start_respects_wsgi_env_overrides(self, mock_create_server, mock_swagger_init):
|
|
46
|
+
os.environ["PORT"] = "8085"
|
|
47
|
+
os.environ["WSGI_THREADS"] = "64"
|
|
48
|
+
os.environ["WSGI_CHANNEL_TIMEOUT"] = "900"
|
|
49
|
+
mock_server = MagicMock()
|
|
50
|
+
mock_create_server.return_value = mock_server
|
|
51
|
+
|
|
52
|
+
starter = Starter(save_request=False)
|
|
53
|
+
starter.start()
|
|
54
|
+
|
|
55
|
+
mock_create_server.assert_called_once_with(
|
|
56
|
+
starter.app,
|
|
57
|
+
host="0.0.0.0",
|
|
58
|
+
port=8085,
|
|
59
|
+
threads=64,
|
|
60
|
+
channel_timeout=900,
|
|
61
|
+
)
|
|
62
|
+
mock_server.run.assert_called_once()
|
|
63
|
+
|
|
64
|
+
@patch("csctracker_py_core.starter.SwaggerView.init")
|
|
65
|
+
@patch("csctracker_py_core.starter.waitress.create_server")
|
|
66
|
+
def test_start_falls_back_to_defaults_on_invalid_int_envs(
|
|
67
|
+
self, mock_create_server, mock_swagger_init
|
|
68
|
+
):
|
|
69
|
+
os.environ["PORT"] = ""
|
|
70
|
+
os.environ["WSGI_THREADS"] = "invalid"
|
|
71
|
+
os.environ["WSGI_CHANNEL_TIMEOUT"] = ""
|
|
72
|
+
mock_server = MagicMock()
|
|
73
|
+
mock_create_server.return_value = mock_server
|
|
74
|
+
|
|
75
|
+
starter = Starter(save_request=False)
|
|
76
|
+
starter.start()
|
|
77
|
+
|
|
78
|
+
mock_create_server.assert_called_once_with(
|
|
79
|
+
starter.app,
|
|
80
|
+
host="0.0.0.0",
|
|
81
|
+
port=5000,
|
|
82
|
+
threads=32,
|
|
83
|
+
channel_timeout=600,
|
|
84
|
+
)
|
|
85
|
+
|
|
86
|
+
@patch("csctracker_py_core.starter.SwaggerView.init")
|
|
87
|
+
@patch("csctracker_py_core.starter.waitress.create_server")
|
|
88
|
+
def test_start_uses_werkzeug_when_debug_is_1(
|
|
89
|
+
self, mock_create_server, mock_swagger_init
|
|
90
|
+
):
|
|
91
|
+
os.environ["DEBUG"] = "1"
|
|
92
|
+
os.environ["PORT"] = "5050"
|
|
93
|
+
|
|
94
|
+
starter = Starter(save_request=False)
|
|
95
|
+
with patch.object(starter.app, "run") as mock_flask_run:
|
|
96
|
+
starter.start()
|
|
97
|
+
|
|
98
|
+
mock_swagger_init.assert_called_once()
|
|
99
|
+
mock_create_server.assert_not_called()
|
|
100
|
+
mock_flask_run.assert_called_once_with(host="0.0.0.0", port=5050)
|
|
101
|
+
|
|
102
|
+
@patch("csctracker_py_core.starter.SwaggerView.init")
|
|
103
|
+
@patch("csctracker_py_core.starter.waitress.create_server")
|
|
104
|
+
def test_swagger_init_is_idempotent(self, mock_create_server, mock_swagger_init):
|
|
105
|
+
mock_create_server.return_value = MagicMock()
|
|
106
|
+
|
|
107
|
+
starter = Starter(save_request=False)
|
|
108
|
+
starter.start()
|
|
109
|
+
starter.start()
|
|
110
|
+
|
|
111
|
+
mock_swagger_init.assert_called_once()
|
|
112
|
+
|
|
113
|
+
def test_graceful_shutdown_closes_server_before_hooks(self):
|
|
114
|
+
shutdown = GracefulShutdown.get_instance(timeout=5)
|
|
115
|
+
events = []
|
|
116
|
+
|
|
117
|
+
shutdown.set_server_close_hook(lambda: events.append("server_close"))
|
|
118
|
+
shutdown.register_shutdown_hook(lambda: events.append("shutdown_hook"))
|
|
119
|
+
|
|
120
|
+
shutdown.wait_for_drain(timeout=2, exit_process=False)
|
|
121
|
+
self.assertEqual(events, ["server_close", "shutdown_hook"])
|
|
122
|
+
|
|
123
|
+
# Subsequent drain must not call server_close again
|
|
124
|
+
events.clear()
|
|
125
|
+
shutdown.wait_for_drain(timeout=2, exit_process=False)
|
|
126
|
+
self.assertEqual(events, ["shutdown_hook"])
|
|
127
|
+
|
|
128
|
+
def test_graceful_shutdown_continues_if_server_close_raises(self):
|
|
129
|
+
shutdown = GracefulShutdown.get_instance(timeout=5)
|
|
130
|
+
hook_called = []
|
|
131
|
+
|
|
132
|
+
def broken_close():
|
|
133
|
+
raise RuntimeError("socket already closed")
|
|
134
|
+
|
|
135
|
+
shutdown.set_server_close_hook(broken_close)
|
|
136
|
+
shutdown.register_shutdown_hook(lambda: hook_called.append(True))
|
|
137
|
+
|
|
138
|
+
shutdown.wait_for_drain(timeout=2, exit_process=False)
|
|
139
|
+
self.assertEqual(hook_called, [True])
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
if __name__ == "__main__":
|
|
143
|
+
unittest.main()
|
|
File without changes
|
|
File without changes
|
{csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/models/__init__.py
RENAMED
|
File without changes
|
|
File without changes
|
{csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/repository/__init__.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
{csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/utils/__init__.py
RENAMED
|
File without changes
|
{csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/utils/configs.py
RENAMED
|
File without changes
|
{csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/utils/interceptor.py
RENAMED
|
File without changes
|
{csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/utils/request_info.py
RENAMED
|
File without changes
|
|
File without changes
|
{csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core/utils/version.py
RENAMED
|
File without changes
|
|
File without changes
|
{csctracker_py_core-26.37.4 → csctracker_py_core-26.47.1}/csctracker_py_core.egg-info/top_level.txt
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|