ods-validator 0.1.0__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.
- ods_validator-0.1.0/LICENSE +21 -0
- ods_validator-0.1.0/PKG-INFO +109 -0
- ods_validator-0.1.0/README.md +91 -0
- ods_validator-0.1.0/ods_validator.egg-info/PKG-INFO +109 -0
- ods_validator-0.1.0/ods_validator.egg-info/SOURCES.txt +73 -0
- ods_validator-0.1.0/ods_validator.egg-info/dependency_links.txt +1 -0
- ods_validator-0.1.0/ods_validator.egg-info/entry_points.txt +2 -0
- ods_validator-0.1.0/ods_validator.egg-info/requires.txt +4 -0
- ods_validator-0.1.0/ods_validator.egg-info/top_level.txt +1 -0
- ods_validator-0.1.0/pyproject.toml +39 -0
- ods_validator-0.1.0/setup.cfg +4 -0
- ods_validator-0.1.0/setup.py +65 -0
- ods_validator-0.1.0/src/__init__.py +3 -0
- ods_validator-0.1.0/src/__main__.py +48 -0
- ods_validator-0.1.0/src/_schemas/SessionStartedEvent.schema.json +61 -0
- ods_validator-0.1.0/src/_schemas/VERSION.json +5 -0
- ods_validator-0.1.0/src/_schemas/__init__.py +0 -0
- ods_validator-0.1.0/src/_schemas/actuatorStateEvent.schema.json +84 -0
- ods_validator-0.1.0/src/_schemas/alertActionCommand.schema.json +62 -0
- ods_validator-0.1.0/src/_schemas/alertActionReply.schema.json +88 -0
- ods_validator-0.1.0/src/_schemas/alertCommand.schema.json +60 -0
- ods_validator-0.1.0/src/_schemas/alertEvent.schema.json +105 -0
- ods_validator-0.1.0/src/_schemas/alertReply.schema.json +84 -0
- ods_validator-0.1.0/src/_schemas/alertsQuery.schema.json +49 -0
- ods_validator-0.1.0/src/_schemas/alertsReply.schema.json +164 -0
- ods_validator-0.1.0/src/_schemas/artifactPublishedEvent.schema.json +70 -0
- ods_validator-0.1.0/src/_schemas/audioChunkEvent.schema.json +64 -0
- ods_validator-0.1.0/src/_schemas/calibrationEvent.schema.json +122 -0
- ods_validator-0.1.0/src/_schemas/cameraQualityQuery.schema.json +31 -0
- ods_validator-0.1.0/src/_schemas/cameraQualityReply.schema.json +105 -0
- ods_validator-0.1.0/src/_schemas/captureCommand.schema.json +82 -0
- ods_validator-0.1.0/src/_schemas/captureReply.schema.json +84 -0
- ods_validator-0.1.0/src/_schemas/clipEvent.schema.json +88 -0
- ods_validator-0.1.0/src/_schemas/clipQuery.schema.json +44 -0
- ods_validator-0.1.0/src/_schemas/clipReply.schema.json +143 -0
- ods_validator-0.1.0/src/_schemas/codeReadEvent.schema.json +57 -0
- ods_validator-0.1.0/src/_schemas/detectionsEvent.schema.json +75 -0
- ods_validator-0.1.0/src/_schemas/entityEvent.schema.json +122 -0
- ods_validator-0.1.0/src/_schemas/eventMetricsEvent.schema.json +65 -0
- ods_validator-0.1.0/src/_schemas/facialMarkerEvent.schema.json +50 -0
- ods_validator-0.1.0/src/_schemas/frameEvent.schema.json +68 -0
- ods_validator-0.1.0/src/_schemas/heatmapQuery.schema.json +61 -0
- ods_validator-0.1.0/src/_schemas/heatmapReply.schema.json +140 -0
- ods_validator-0.1.0/src/_schemas/keypointsEvent.schema.json +115 -0
- ods_validator-0.1.0/src/_schemas/lexiconCaptureCommand.schema.json +45 -0
- ods_validator-0.1.0/src/_schemas/lexiconCaptureReply.schema.json +110 -0
- ods_validator-0.1.0/src/_schemas/metricsQuery.schema.json +58 -0
- ods_validator-0.1.0/src/_schemas/metricsReply.schema.json +186 -0
- ods_validator-0.1.0/src/_schemas/moveCommand.schema.json +45 -0
- ods_validator-0.1.0/src/_schemas/moveReply.schema.json +101 -0
- ods_validator-0.1.0/src/_schemas/pieceAnalysisEvent.schema.json +97 -0
- ods_validator-0.1.0/src/_schemas/plateReadEvent.schema.json +128 -0
- ods_validator-0.1.0/src/_schemas/positionEvent.schema.json +82 -0
- ods_validator-0.1.0/src/_schemas/ppeComplianceEvent.schema.json +100 -0
- ods_validator-0.1.0/src/_schemas/qualifiedEvent.schema.json +100 -0
- ods_validator-0.1.0/src/_schemas/recordCommand.schema.json +72 -0
- ods_validator-0.1.0/src/_schemas/recordReply.schema.json +96 -0
- ods_validator-0.1.0/src/_schemas/recordingsQuery.schema.json +39 -0
- ods_validator-0.1.0/src/_schemas/recordingsReply.schema.json +119 -0
- ods_validator-0.1.0/src/_schemas/replayCommand.schema.json +96 -0
- ods_validator-0.1.0/src/_schemas/replayReply.schema.json +109 -0
- ods_validator-0.1.0/src/_schemas/replayStateEvent.schema.json +54 -0
- ods_validator-0.1.0/src/_schemas/rulesCommand.schema.json +83 -0
- ods_validator-0.1.0/src/_schemas/rulesReply.schema.json +86 -0
- ods_validator-0.1.0/src/_schemas/signEvent.schema.json +71 -0
- ods_validator-0.1.0/src/_schemas/synthesisCommand.schema.json +61 -0
- ods_validator-0.1.0/src/_schemas/synthesisReply.schema.json +153 -0
- ods_validator-0.1.0/src/_schemas/tracksEvent.schema.json +93 -0
- ods_validator-0.1.0/src/_schemas/transcriptEvent.schema.json +96 -0
- ods_validator-0.1.0/src/_schemas/zoneMetricsEvent.schema.json +71 -0
- ods_validator-0.1.0/src/_schemas/zoneOccupancyEvent.schema.json +62 -0
- ods_validator-0.1.0/src/_schemas/zoneTransitionEvent.schema.json +74 -0
- ods_validator-0.1.0/src/validator.py +112 -0
- ods_validator-0.1.0/tests/test_contract.py +147 -0
- ods_validator-0.1.0/tests/test_shared_examples.py +35 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 ods-26-2
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ods-validator
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Validador de mensagens do barramento ODS 2026/2 (JSON Schemas da Especificação 1.0)
|
|
5
|
+
License-Expression: MIT
|
|
6
|
+
Project-URL: Homepage, https://github.com/ods-26-2/b1
|
|
7
|
+
Project-URL: Issues, https://github.com/ods-26-2/b1/issues
|
|
8
|
+
Keywords: json-schema,validation,kafka,ods
|
|
9
|
+
Classifier: Programming Language :: Python :: 3
|
|
10
|
+
Classifier: Intended Audience :: Developers
|
|
11
|
+
Requires-Python: >=3.10
|
|
12
|
+
Description-Content-Type: text/markdown
|
|
13
|
+
License-File: LICENSE
|
|
14
|
+
Requires-Dist: jsonschema[format-nongpl]>=4.20
|
|
15
|
+
Provides-Extra: dev
|
|
16
|
+
Requires-Dist: pytest; extra == "dev"
|
|
17
|
+
Dynamic: license-file
|
|
18
|
+
|
|
19
|
+
# ods-validator
|
|
20
|
+
|
|
21
|
+
Valida mensagens do barramento contra os JSON Schemas da Especificação 1.0
|
|
22
|
+
(repositório [ods-26-2/b1](https://github.com/ods-26-2/b1)). Entregável B1 da TRA-1: a mensagem fora do contrato
|
|
23
|
+
é barrada **antes** de chegar ao Kafka.
|
|
24
|
+
|
|
25
|
+
Os schemas vão **dentro do pacote**: quem instala não precisa clonar nada
|
|
26
|
+
nem definir variável de ambiente.
|
|
27
|
+
|
|
28
|
+
## Instalar
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
pip install ods-validator
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Os schemas vêm dentro do pacote. Fixe a versão nos componentes
|
|
35
|
+
(`ods-validator==0.1.0`): a versão do pacote é a versão do contrato.
|
|
36
|
+
|
|
37
|
+
Para desenvolver a biblioteca, a partir do clone do `b1`:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
pip install -e "./jsonValidatorPy[dev]"
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Usar
|
|
44
|
+
|
|
45
|
+
```python
|
|
46
|
+
from ods_validator import Validator, publish, ContractError
|
|
47
|
+
|
|
48
|
+
val = Validator() # usa os schemas do pacote
|
|
49
|
+
val.find_errors("ods.p7.move.command", msg) # [] se válida, senão lista de erros
|
|
50
|
+
val.find_message_errors(msg) # descobre o tópico pelo campo "schema"
|
|
51
|
+
val.validate(msg) # levanta ContractError se inválida
|
|
52
|
+
val.schemas_version # origin, commit do b1, count
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Sem mudar o jeito de publicar
|
|
56
|
+
|
|
57
|
+
Quem já publica direto no Kafka só acrescenta uma linha antes do envio:
|
|
58
|
+
|
|
59
|
+
```python
|
|
60
|
+
val.validate(msg) # barra a mensagem fora do contrato
|
|
61
|
+
producer.send("ods.p7.move.command", payload_bytes) # como já era
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Ou publicar já com validação
|
|
65
|
+
|
|
66
|
+
`publish` aceita qualquer função `send(topic, bytes)`.
|
|
67
|
+
|
|
68
|
+
```python
|
|
69
|
+
publish(lambda t, b: producer.send(t, b), val, msg) # kafka-python
|
|
70
|
+
publish(lambda t, b: producer.produce(t, b), val, msg) # confluent-kafka
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Mensagem inválida levanta `ContractError` (com `.errors`) e nada é enviado.
|
|
74
|
+
|
|
75
|
+
### Linha de comando
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
ods-validate mensagem.json # exit 0 = válida, 1 = inválida
|
|
79
|
+
ods-validate --topic ods.p4.frame - # lê da entrada padrão
|
|
80
|
+
ods-validate --info # de onde vêm os schemas
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## Onde os schemas são procurados
|
|
84
|
+
|
|
85
|
+
Nesta ordem: argumento `Validator("caminho/dos/schemas")`; variável `ODS_SCHEMAS_DIR`;
|
|
86
|
+
a pasta `schemas/` do clone do `b1` (quando o código roda de dentro dele, como
|
|
87
|
+
na instalação editável); cópia embutida no pacote (quem instalou o wheel). Os
|
|
88
|
+
dois primeiros servem para testar um schema ainda não publicado. O tópico é o
|
|
89
|
+
`properties.schema.const` de cada schema; nome de arquivo e pasta não entram
|
|
90
|
+
na busca, mas só `*.schema.json` é lido.
|
|
91
|
+
|
|
92
|
+
## Desenvolvimento e testes
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
cd jsonValidatorPy
|
|
96
|
+
pip install -e ".[dev]"
|
|
97
|
+
pytest
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Para cada schema o teste gera um exemplo válido, confere que passa, remove
|
|
101
|
+
cada campo obrigatório (envelope e payload), troca o tipo e o tópico, e
|
|
102
|
+
verifica que falha. Também confere que `uuid` e `date-time` são checados de
|
|
103
|
+
verdade (o `jsonschema` ignora `format` por padrão).
|
|
104
|
+
|
|
105
|
+
## Limites conhecidos
|
|
106
|
+
|
|
107
|
+
- Valida **uma** mensagem. Regras entre mensagens (`correlation_id` da reply,
|
|
108
|
+
lacuna em `sequence`) ficam para a TRA-2.
|
|
109
|
+
- Schemas sem `additionalProperties: false` aceitam campos desconhecidos.
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# ods-validator
|
|
2
|
+
|
|
3
|
+
Valida mensagens do barramento contra os JSON Schemas da Especificação 1.0
|
|
4
|
+
(repositório [ods-26-2/b1](https://github.com/ods-26-2/b1)). Entregável B1 da TRA-1: a mensagem fora do contrato
|
|
5
|
+
é barrada **antes** de chegar ao Kafka.
|
|
6
|
+
|
|
7
|
+
Os schemas vão **dentro do pacote**: quem instala não precisa clonar nada
|
|
8
|
+
nem definir variável de ambiente.
|
|
9
|
+
|
|
10
|
+
## Instalar
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
pip install ods-validator
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Os schemas vêm dentro do pacote. Fixe a versão nos componentes
|
|
17
|
+
(`ods-validator==0.1.0`): a versão do pacote é a versão do contrato.
|
|
18
|
+
|
|
19
|
+
Para desenvolver a biblioteca, a partir do clone do `b1`:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
pip install -e "./jsonValidatorPy[dev]"
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Usar
|
|
26
|
+
|
|
27
|
+
```python
|
|
28
|
+
from ods_validator import Validator, publish, ContractError
|
|
29
|
+
|
|
30
|
+
val = Validator() # usa os schemas do pacote
|
|
31
|
+
val.find_errors("ods.p7.move.command", msg) # [] se válida, senão lista de erros
|
|
32
|
+
val.find_message_errors(msg) # descobre o tópico pelo campo "schema"
|
|
33
|
+
val.validate(msg) # levanta ContractError se inválida
|
|
34
|
+
val.schemas_version # origin, commit do b1, count
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Sem mudar o jeito de publicar
|
|
38
|
+
|
|
39
|
+
Quem já publica direto no Kafka só acrescenta uma linha antes do envio:
|
|
40
|
+
|
|
41
|
+
```python
|
|
42
|
+
val.validate(msg) # barra a mensagem fora do contrato
|
|
43
|
+
producer.send("ods.p7.move.command", payload_bytes) # como já era
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Ou publicar já com validação
|
|
47
|
+
|
|
48
|
+
`publish` aceita qualquer função `send(topic, bytes)`.
|
|
49
|
+
|
|
50
|
+
```python
|
|
51
|
+
publish(lambda t, b: producer.send(t, b), val, msg) # kafka-python
|
|
52
|
+
publish(lambda t, b: producer.produce(t, b), val, msg) # confluent-kafka
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Mensagem inválida levanta `ContractError` (com `.errors`) e nada é enviado.
|
|
56
|
+
|
|
57
|
+
### Linha de comando
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
ods-validate mensagem.json # exit 0 = válida, 1 = inválida
|
|
61
|
+
ods-validate --topic ods.p4.frame - # lê da entrada padrão
|
|
62
|
+
ods-validate --info # de onde vêm os schemas
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Onde os schemas são procurados
|
|
66
|
+
|
|
67
|
+
Nesta ordem: argumento `Validator("caminho/dos/schemas")`; variável `ODS_SCHEMAS_DIR`;
|
|
68
|
+
a pasta `schemas/` do clone do `b1` (quando o código roda de dentro dele, como
|
|
69
|
+
na instalação editável); cópia embutida no pacote (quem instalou o wheel). Os
|
|
70
|
+
dois primeiros servem para testar um schema ainda não publicado. O tópico é o
|
|
71
|
+
`properties.schema.const` de cada schema; nome de arquivo e pasta não entram
|
|
72
|
+
na busca, mas só `*.schema.json` é lido.
|
|
73
|
+
|
|
74
|
+
## Desenvolvimento e testes
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
cd jsonValidatorPy
|
|
78
|
+
pip install -e ".[dev]"
|
|
79
|
+
pytest
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Para cada schema o teste gera um exemplo válido, confere que passa, remove
|
|
83
|
+
cada campo obrigatório (envelope e payload), troca o tipo e o tópico, e
|
|
84
|
+
verifica que falha. Também confere que `uuid` e `date-time` são checados de
|
|
85
|
+
verdade (o `jsonschema` ignora `format` por padrão).
|
|
86
|
+
|
|
87
|
+
## Limites conhecidos
|
|
88
|
+
|
|
89
|
+
- Valida **uma** mensagem. Regras entre mensagens (`correlation_id` da reply,
|
|
90
|
+
lacuna em `sequence`) ficam para a TRA-2.
|
|
91
|
+
- Schemas sem `additionalProperties: false` aceitam campos desconhecidos.
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ods-validator
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Validador de mensagens do barramento ODS 2026/2 (JSON Schemas da Especificação 1.0)
|
|
5
|
+
License-Expression: MIT
|
|
6
|
+
Project-URL: Homepage, https://github.com/ods-26-2/b1
|
|
7
|
+
Project-URL: Issues, https://github.com/ods-26-2/b1/issues
|
|
8
|
+
Keywords: json-schema,validation,kafka,ods
|
|
9
|
+
Classifier: Programming Language :: Python :: 3
|
|
10
|
+
Classifier: Intended Audience :: Developers
|
|
11
|
+
Requires-Python: >=3.10
|
|
12
|
+
Description-Content-Type: text/markdown
|
|
13
|
+
License-File: LICENSE
|
|
14
|
+
Requires-Dist: jsonschema[format-nongpl]>=4.20
|
|
15
|
+
Provides-Extra: dev
|
|
16
|
+
Requires-Dist: pytest; extra == "dev"
|
|
17
|
+
Dynamic: license-file
|
|
18
|
+
|
|
19
|
+
# ods-validator
|
|
20
|
+
|
|
21
|
+
Valida mensagens do barramento contra os JSON Schemas da Especificação 1.0
|
|
22
|
+
(repositório [ods-26-2/b1](https://github.com/ods-26-2/b1)). Entregável B1 da TRA-1: a mensagem fora do contrato
|
|
23
|
+
é barrada **antes** de chegar ao Kafka.
|
|
24
|
+
|
|
25
|
+
Os schemas vão **dentro do pacote**: quem instala não precisa clonar nada
|
|
26
|
+
nem definir variável de ambiente.
|
|
27
|
+
|
|
28
|
+
## Instalar
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
pip install ods-validator
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Os schemas vêm dentro do pacote. Fixe a versão nos componentes
|
|
35
|
+
(`ods-validator==0.1.0`): a versão do pacote é a versão do contrato.
|
|
36
|
+
|
|
37
|
+
Para desenvolver a biblioteca, a partir do clone do `b1`:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
pip install -e "./jsonValidatorPy[dev]"
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Usar
|
|
44
|
+
|
|
45
|
+
```python
|
|
46
|
+
from ods_validator import Validator, publish, ContractError
|
|
47
|
+
|
|
48
|
+
val = Validator() # usa os schemas do pacote
|
|
49
|
+
val.find_errors("ods.p7.move.command", msg) # [] se válida, senão lista de erros
|
|
50
|
+
val.find_message_errors(msg) # descobre o tópico pelo campo "schema"
|
|
51
|
+
val.validate(msg) # levanta ContractError se inválida
|
|
52
|
+
val.schemas_version # origin, commit do b1, count
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Sem mudar o jeito de publicar
|
|
56
|
+
|
|
57
|
+
Quem já publica direto no Kafka só acrescenta uma linha antes do envio:
|
|
58
|
+
|
|
59
|
+
```python
|
|
60
|
+
val.validate(msg) # barra a mensagem fora do contrato
|
|
61
|
+
producer.send("ods.p7.move.command", payload_bytes) # como já era
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Ou publicar já com validação
|
|
65
|
+
|
|
66
|
+
`publish` aceita qualquer função `send(topic, bytes)`.
|
|
67
|
+
|
|
68
|
+
```python
|
|
69
|
+
publish(lambda t, b: producer.send(t, b), val, msg) # kafka-python
|
|
70
|
+
publish(lambda t, b: producer.produce(t, b), val, msg) # confluent-kafka
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Mensagem inválida levanta `ContractError` (com `.errors`) e nada é enviado.
|
|
74
|
+
|
|
75
|
+
### Linha de comando
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
ods-validate mensagem.json # exit 0 = válida, 1 = inválida
|
|
79
|
+
ods-validate --topic ods.p4.frame - # lê da entrada padrão
|
|
80
|
+
ods-validate --info # de onde vêm os schemas
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## Onde os schemas são procurados
|
|
84
|
+
|
|
85
|
+
Nesta ordem: argumento `Validator("caminho/dos/schemas")`; variável `ODS_SCHEMAS_DIR`;
|
|
86
|
+
a pasta `schemas/` do clone do `b1` (quando o código roda de dentro dele, como
|
|
87
|
+
na instalação editável); cópia embutida no pacote (quem instalou o wheel). Os
|
|
88
|
+
dois primeiros servem para testar um schema ainda não publicado. O tópico é o
|
|
89
|
+
`properties.schema.const` de cada schema; nome de arquivo e pasta não entram
|
|
90
|
+
na busca, mas só `*.schema.json` é lido.
|
|
91
|
+
|
|
92
|
+
## Desenvolvimento e testes
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
cd jsonValidatorPy
|
|
96
|
+
pip install -e ".[dev]"
|
|
97
|
+
pytest
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Para cada schema o teste gera um exemplo válido, confere que passa, remove
|
|
101
|
+
cada campo obrigatório (envelope e payload), troca o tipo e o tópico, e
|
|
102
|
+
verifica que falha. Também confere que `uuid` e `date-time` são checados de
|
|
103
|
+
verdade (o `jsonschema` ignora `format` por padrão).
|
|
104
|
+
|
|
105
|
+
## Limites conhecidos
|
|
106
|
+
|
|
107
|
+
- Valida **uma** mensagem. Regras entre mensagens (`correlation_id` da reply,
|
|
108
|
+
lacuna em `sequence`) ficam para a TRA-2.
|
|
109
|
+
- Schemas sem `additionalProperties: false` aceitam campos desconhecidos.
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
LICENSE
|
|
2
|
+
README.md
|
|
3
|
+
pyproject.toml
|
|
4
|
+
setup.py
|
|
5
|
+
ods_validator.egg-info/PKG-INFO
|
|
6
|
+
ods_validator.egg-info/SOURCES.txt
|
|
7
|
+
ods_validator.egg-info/dependency_links.txt
|
|
8
|
+
ods_validator.egg-info/entry_points.txt
|
|
9
|
+
ods_validator.egg-info/requires.txt
|
|
10
|
+
ods_validator.egg-info/top_level.txt
|
|
11
|
+
src/__init__.py
|
|
12
|
+
src/__main__.py
|
|
13
|
+
src/validator.py
|
|
14
|
+
src/_schemas/SessionStartedEvent.schema.json
|
|
15
|
+
src/_schemas/VERSION.json
|
|
16
|
+
src/_schemas/__init__.py
|
|
17
|
+
src/_schemas/actuatorStateEvent.schema.json
|
|
18
|
+
src/_schemas/alertActionCommand.schema.json
|
|
19
|
+
src/_schemas/alertActionReply.schema.json
|
|
20
|
+
src/_schemas/alertCommand.schema.json
|
|
21
|
+
src/_schemas/alertEvent.schema.json
|
|
22
|
+
src/_schemas/alertReply.schema.json
|
|
23
|
+
src/_schemas/alertsQuery.schema.json
|
|
24
|
+
src/_schemas/alertsReply.schema.json
|
|
25
|
+
src/_schemas/artifactPublishedEvent.schema.json
|
|
26
|
+
src/_schemas/audioChunkEvent.schema.json
|
|
27
|
+
src/_schemas/calibrationEvent.schema.json
|
|
28
|
+
src/_schemas/cameraQualityQuery.schema.json
|
|
29
|
+
src/_schemas/cameraQualityReply.schema.json
|
|
30
|
+
src/_schemas/captureCommand.schema.json
|
|
31
|
+
src/_schemas/captureReply.schema.json
|
|
32
|
+
src/_schemas/clipEvent.schema.json
|
|
33
|
+
src/_schemas/clipQuery.schema.json
|
|
34
|
+
src/_schemas/clipReply.schema.json
|
|
35
|
+
src/_schemas/codeReadEvent.schema.json
|
|
36
|
+
src/_schemas/detectionsEvent.schema.json
|
|
37
|
+
src/_schemas/entityEvent.schema.json
|
|
38
|
+
src/_schemas/eventMetricsEvent.schema.json
|
|
39
|
+
src/_schemas/facialMarkerEvent.schema.json
|
|
40
|
+
src/_schemas/frameEvent.schema.json
|
|
41
|
+
src/_schemas/heatmapQuery.schema.json
|
|
42
|
+
src/_schemas/heatmapReply.schema.json
|
|
43
|
+
src/_schemas/keypointsEvent.schema.json
|
|
44
|
+
src/_schemas/lexiconCaptureCommand.schema.json
|
|
45
|
+
src/_schemas/lexiconCaptureReply.schema.json
|
|
46
|
+
src/_schemas/metricsQuery.schema.json
|
|
47
|
+
src/_schemas/metricsReply.schema.json
|
|
48
|
+
src/_schemas/moveCommand.schema.json
|
|
49
|
+
src/_schemas/moveReply.schema.json
|
|
50
|
+
src/_schemas/pieceAnalysisEvent.schema.json
|
|
51
|
+
src/_schemas/plateReadEvent.schema.json
|
|
52
|
+
src/_schemas/positionEvent.schema.json
|
|
53
|
+
src/_schemas/ppeComplianceEvent.schema.json
|
|
54
|
+
src/_schemas/qualifiedEvent.schema.json
|
|
55
|
+
src/_schemas/recordCommand.schema.json
|
|
56
|
+
src/_schemas/recordReply.schema.json
|
|
57
|
+
src/_schemas/recordingsQuery.schema.json
|
|
58
|
+
src/_schemas/recordingsReply.schema.json
|
|
59
|
+
src/_schemas/replayCommand.schema.json
|
|
60
|
+
src/_schemas/replayReply.schema.json
|
|
61
|
+
src/_schemas/replayStateEvent.schema.json
|
|
62
|
+
src/_schemas/rulesCommand.schema.json
|
|
63
|
+
src/_schemas/rulesReply.schema.json
|
|
64
|
+
src/_schemas/signEvent.schema.json
|
|
65
|
+
src/_schemas/synthesisCommand.schema.json
|
|
66
|
+
src/_schemas/synthesisReply.schema.json
|
|
67
|
+
src/_schemas/tracksEvent.schema.json
|
|
68
|
+
src/_schemas/transcriptEvent.schema.json
|
|
69
|
+
src/_schemas/zoneMetricsEvent.schema.json
|
|
70
|
+
src/_schemas/zoneOccupancyEvent.schema.json
|
|
71
|
+
src/_schemas/zoneTransitionEvent.schema.json
|
|
72
|
+
tests/test_contract.py
|
|
73
|
+
tests/test_shared_examples.py
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
ods_validator
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=77"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "ods-validator"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "Validador de mensagens do barramento ODS 2026/2 (JSON Schemas da Especificação 1.0)"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.10"
|
|
11
|
+
license = "MIT"
|
|
12
|
+
license-files = ["LICENSE"]
|
|
13
|
+
keywords = ["json-schema", "validation", "kafka", "ods"]
|
|
14
|
+
classifiers = [
|
|
15
|
+
"Programming Language :: Python :: 3",
|
|
16
|
+
"Intended Audience :: Developers",
|
|
17
|
+
]
|
|
18
|
+
dependencies = ["jsonschema[format-nongpl]>=4.20"]
|
|
19
|
+
|
|
20
|
+
[project.urls]
|
|
21
|
+
Homepage = "https://github.com/ods-26-2/b1"
|
|
22
|
+
Issues = "https://github.com/ods-26-2/b1/issues"
|
|
23
|
+
|
|
24
|
+
[project.optional-dependencies]
|
|
25
|
+
dev = ["pytest"]
|
|
26
|
+
|
|
27
|
+
[project.scripts]
|
|
28
|
+
ods-validate = "ods_validator.__main__:main"
|
|
29
|
+
|
|
30
|
+
# src/ instala como o pacote "ods_validator"
|
|
31
|
+
[tool.setuptools]
|
|
32
|
+
packages = ["ods_validator", "ods_validator._schemas"]
|
|
33
|
+
|
|
34
|
+
[tool.setuptools.package-dir]
|
|
35
|
+
ods_validator = "src"
|
|
36
|
+
|
|
37
|
+
# _schemas/ é gerada pelo setup.py (não vai ao git)
|
|
38
|
+
[tool.setuptools.package-data]
|
|
39
|
+
"ods_validator._schemas" = ["*.json"]
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import datetime
|
|
2
|
+
import json
|
|
3
|
+
import shutil
|
|
4
|
+
import subprocess
|
|
5
|
+
from pathlib import Path
|
|
6
|
+
|
|
7
|
+
from setuptools import setup
|
|
8
|
+
from setuptools.command.build_py import build_py
|
|
9
|
+
|
|
10
|
+
HERE = Path(__file__).resolve().parent
|
|
11
|
+
REPO = HERE.parent
|
|
12
|
+
SCHEMAS = REPO / "schemas"
|
|
13
|
+
DESTINATION = HERE / "src" / "_schemas"
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
def _git(*args):
|
|
17
|
+
if not (REPO / ".git").exists():
|
|
18
|
+
return None
|
|
19
|
+
try:
|
|
20
|
+
result = subprocess.run(
|
|
21
|
+
["git", *args], cwd=REPO, capture_output=True, text=True, check=True
|
|
22
|
+
)
|
|
23
|
+
return result.stdout.strip() or None
|
|
24
|
+
except (OSError, subprocess.CalledProcessError):
|
|
25
|
+
return None
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
def sync_schemas():
|
|
29
|
+
sources = sorted(SCHEMAS.glob("*/*.schema.json"))
|
|
30
|
+
if not sources:
|
|
31
|
+
if any(DESTINATION.rglob("*.schema.json")):
|
|
32
|
+
return # build a partir de um sdist: a cópia já veio nele
|
|
33
|
+
raise SystemExit(
|
|
34
|
+
"setup.py: nenhum *.schema.json em ../schemas nem em src/_schemas. "
|
|
35
|
+
"Rode o build de dentro do clone do repositório b1."
|
|
36
|
+
)
|
|
37
|
+
names = [source.name for source in sources]
|
|
38
|
+
duplicates = sorted({n for n in names if names.count(n) > 1})
|
|
39
|
+
if duplicates:
|
|
40
|
+
raise SystemExit(f"setup.py: nomes de schema repetidos em pastas diferentes: {duplicates}")
|
|
41
|
+
shutil.rmtree(DESTINATION, ignore_errors=True)
|
|
42
|
+
DESTINATION.mkdir(parents=True)
|
|
43
|
+
(DESTINATION / "__init__.py").write_text("")
|
|
44
|
+
for source in sources:
|
|
45
|
+
shutil.copy2(source, DESTINATION / source.name)
|
|
46
|
+
meta = {
|
|
47
|
+
"commit": _git("rev-parse", "HEAD"),
|
|
48
|
+
"description": _git("describe", "--tags", "--always", "--dirty"),
|
|
49
|
+
"generated_at": datetime.datetime.now(datetime.timezone.utc).isoformat(
|
|
50
|
+
timespec="seconds"
|
|
51
|
+
),
|
|
52
|
+
}
|
|
53
|
+
(DESTINATION / "VERSION.json").write_text(
|
|
54
|
+
json.dumps(meta, indent=2) + "\n", encoding="utf-8"
|
|
55
|
+
)
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
class build_py_with_schemas(build_py):
|
|
59
|
+
# os arquivos precisam existir antes de finalize_options, que lista o package_data
|
|
60
|
+
def finalize_options(self):
|
|
61
|
+
sync_schemas()
|
|
62
|
+
super().finalize_options()
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
setup(cmdclass={"build_py": build_py_with_schemas})
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import argparse
|
|
2
|
+
import json
|
|
3
|
+
import sys
|
|
4
|
+
|
|
5
|
+
from . import Validator
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
def main(argv=None) -> int:
|
|
9
|
+
parser = argparse.ArgumentParser(prog="ods-validate")
|
|
10
|
+
parser.add_argument("--schemas", help="pasta dos schemas (ou ODS_SCHEMAS_DIR)")
|
|
11
|
+
parser.add_argument("--topic", help="força o tópico (padrão: campo 'schema')")
|
|
12
|
+
parser.add_argument("--info", action="store_true", help="mostra de onde vêm os schemas")
|
|
13
|
+
parser.add_argument("files", nargs="*", help="arquivos JSON (- para stdin)")
|
|
14
|
+
args = parser.parse_args(argv)
|
|
15
|
+
validator = Validator(args.schemas)
|
|
16
|
+
if args.info:
|
|
17
|
+
for key, value in validator.schemas_version.items():
|
|
18
|
+
print(f"{key}: {value}")
|
|
19
|
+
if not args.files:
|
|
20
|
+
return 0
|
|
21
|
+
if not args.files:
|
|
22
|
+
parser.error("informe ao menos um arquivo (ou use --info)")
|
|
23
|
+
status = 0
|
|
24
|
+
for name in args.files:
|
|
25
|
+
text = sys.stdin.read() if name == "-" else open(name, encoding="utf-8").read()
|
|
26
|
+
try:
|
|
27
|
+
message = json.loads(text)
|
|
28
|
+
except json.JSONDecodeError as e:
|
|
29
|
+
print(f"{name}: JSON inválido ({e})")
|
|
30
|
+
status = 1
|
|
31
|
+
continue
|
|
32
|
+
errors = (
|
|
33
|
+
validator.find_errors(args.topic, message)
|
|
34
|
+
if args.topic
|
|
35
|
+
else validator.find_message_errors(message)
|
|
36
|
+
)
|
|
37
|
+
if errors:
|
|
38
|
+
status = 1
|
|
39
|
+
print(f"{name}: INVÁLIDA")
|
|
40
|
+
for e in errors:
|
|
41
|
+
print(" -", e)
|
|
42
|
+
else:
|
|
43
|
+
print(f"{name}: ok")
|
|
44
|
+
return status
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
if __name__ == "__main__":
|
|
48
|
+
sys.exit(main())
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"title": "SessionStartedEvent",
|
|
4
|
+
"type": "object",
|
|
5
|
+
"properties": {
|
|
6
|
+
"schema": {
|
|
7
|
+
"type": "string",
|
|
8
|
+
"const": "ods.session.started"
|
|
9
|
+
},
|
|
10
|
+
"message_type": {
|
|
11
|
+
"type": "string",
|
|
12
|
+
"const": "event"
|
|
13
|
+
},
|
|
14
|
+
"producer": {
|
|
15
|
+
"type": "string"
|
|
16
|
+
},
|
|
17
|
+
"payload": {
|
|
18
|
+
"type": "object",
|
|
19
|
+
"properties": {
|
|
20
|
+
"mode": {
|
|
21
|
+
"type": "string",
|
|
22
|
+
"enum": ["REPLAY", "LIVE"]
|
|
23
|
+
},
|
|
24
|
+
"started_at": {
|
|
25
|
+
"type": "string",
|
|
26
|
+
"format": "date-time"
|
|
27
|
+
},
|
|
28
|
+
"sources": {
|
|
29
|
+
"type": "array",
|
|
30
|
+
"items": {
|
|
31
|
+
"type": "string"
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
"recording_id": {
|
|
35
|
+
"type": "string"
|
|
36
|
+
},
|
|
37
|
+
"previous_session_id": {
|
|
38
|
+
"type": "string",
|
|
39
|
+
"format": "uuid"
|
|
40
|
+
},
|
|
41
|
+
"reason": {
|
|
42
|
+
"type": "string",
|
|
43
|
+
"enum": ["SEEK", "START", "RESTART", "LOOP", "RECONNECT"]
|
|
44
|
+
}
|
|
45
|
+
},
|
|
46
|
+
"required": [
|
|
47
|
+
"mode",
|
|
48
|
+
"started_at",
|
|
49
|
+
"sources"
|
|
50
|
+
],
|
|
51
|
+
"additionalProperties": false
|
|
52
|
+
}
|
|
53
|
+
},
|
|
54
|
+
"required": [
|
|
55
|
+
"schema",
|
|
56
|
+
"message_type",
|
|
57
|
+
"producer",
|
|
58
|
+
"payload"
|
|
59
|
+
],
|
|
60
|
+
"additionalProperties": false
|
|
61
|
+
}
|
|
File without changes
|