1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
|
%global _empty_manifest_terminate_build 0
Name: python-api-watchdog
Version: 0.6.0
Release: 1
Summary: API watchdog
License: MIT
URL: https://pypi.org/project/api-watchdog/
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/36/10/998688ce6ea7b1f8ee50771e831395ed978f47484cb8044d9fdfc0cc15fc/api_watchdog-0.6.0.tar.gz
BuildArch: noarch
Requires: python3-pydantic
Requires: python3-jq
Requires: python3-requests
Requires: python3-reasoner-pydantic
%description
# API Watchdog
## Usage
```
api-watchdog discover path/to/test/files
```
Will output the abbreviated result of the tests to stdout.
```
api-watchdog discover --email path/to/test/files
```
Will email the results of the tests to the relevant addresses
(as determined by the `email_to=` field of the test. Test results
are grouped so that only one email per address is sent per run.
Whjen using the CLI, these environment variables must be set to email results
- MAILGUN_API_URL
- MAILGUN_API_TOKEN
- MAILGUN_FROM
```
api-watchdog discover -o results_file.json path/to/test/files
```
Will serialize the `WatchdogResultGroup` object to the path specified
by the `-o` flag.
## Installation
API watchdog handles validation support through extra requirements.
This means that to install it with TRAPI validation you invoke
```
pip install api-watchdog[TRAPI]
```
If you are using `zsh` you will run affoul of bracket globbing and should use
```
pip install 'api-watchdog[TRAPI]'
```
See this [stackoverflow question](https://stackoverflow.com/questions/30539798/zsh-no-matches-found-requestssecurity) for context.
Available extensions are:
- TRAPI
If you do not want any validation support you can use the bare `pip install api-watchdog` command.
## WatchdogTest format
The main way you'll interface with API Watchdog is through `WatchdogTest`s.
Each `WatchdogTest` has
- name (str): The name of the test
- target (url): The endpoint that the test targets
- expectations (Array[Expectation]): A list of requirements that the response must meet for the test to pass.
- payload (object): The json passed to the endpoint.
## Expectation format
An `Expectation` describes where to find a piece of data in the response and what that piece of data should be in order for the test to pass.
Each `Expectation` has
- selector (jq program): A string describing a jq program that selects the one or more elements to test against
- value (Any): a value to test equality against
- validation_type (ValidationType): An API Watchdog validation type used to validate the value/response. The value/response will be implicitly converted to this type. For example, if you specify 'float' and the value is an integer it will be implicitly converted to a float.
- level (Optional[ExpectationLevel]): How important an expectation is. Defaults to "critical"
## ExpectationLevel
One of the strings:
- critical
- warning
- info
Only "critical" expectations affect the success or failure of a `WatchdogTest`.
The selector format is a string that is a [jq program](https://stedolan.github.io/jq/). This allows for rich selection capabilities.
For example:
```
{
"selector": ".message.knowledge_graph.nodes[\"MONDO:0005148\"].name",
"value": "type 2 diabetes mellitus",
"validation_type": "string"
},
```
Is an `Expectation` that checks if a node is present in the knowledge graph of a TRAPI response.
The possible validation types are
- "string",
- "int",
- "float",
- "object",
- "bool",
- "null",
- "trapi.knowledge_graph",
- "trapi.node",
- "trapi.edge",
- "trapi.query_graph",
- "trapi.q_node",
- "trapi.q_edge",
- "trapi.query_constraint",
- "trapi.result",
- "trapi.node_binding",
- "trapi.edge_binding",
- "trapi.message",
- "trapi.query",
- "trapi.response",
- "trapi.async_query",
- "trapi.operation",
- "trapi.workflow",
- "trapi.attribute",
- "trapi.biolink_entity",
- "trapi.biolink_predicate",
- "trapi.curie",
- "trapi.log_entry",
- "trapi.log_level",
- "trapi.meta_edge",
- "trapi.meta_node",
- "trapi.meta_knowledge_graph",
- "trapi.meta_attribute"
## What it is
An API monitoring utility that aspires to support:
- [ ] Validation
- [ ] Continuous Integration
- [ ] Multiple input and output formats
- [ ] Test discovery / minimal configuration
## What it is not
- A way to regularly schedule tests against an endpoint, eg. [cron](https://en.wikipedia.org/wiki/Cron), [celery](https://docs.celeryproject.org/en/stable/getting-started/introduction.html)
- A way to specify api schemas eg. [marshmallow](https://marshmallow.readthedocs.io/en/stable/), [pydantic](https://pydantic-docs.helpmanual.io/)
%package -n python3-api-watchdog
Summary: API watchdog
Provides: python-api-watchdog
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-api-watchdog
# API Watchdog
## Usage
```
api-watchdog discover path/to/test/files
```
Will output the abbreviated result of the tests to stdout.
```
api-watchdog discover --email path/to/test/files
```
Will email the results of the tests to the relevant addresses
(as determined by the `email_to=` field of the test. Test results
are grouped so that only one email per address is sent per run.
Whjen using the CLI, these environment variables must be set to email results
- MAILGUN_API_URL
- MAILGUN_API_TOKEN
- MAILGUN_FROM
```
api-watchdog discover -o results_file.json path/to/test/files
```
Will serialize the `WatchdogResultGroup` object to the path specified
by the `-o` flag.
## Installation
API watchdog handles validation support through extra requirements.
This means that to install it with TRAPI validation you invoke
```
pip install api-watchdog[TRAPI]
```
If you are using `zsh` you will run affoul of bracket globbing and should use
```
pip install 'api-watchdog[TRAPI]'
```
See this [stackoverflow question](https://stackoverflow.com/questions/30539798/zsh-no-matches-found-requestssecurity) for context.
Available extensions are:
- TRAPI
If you do not want any validation support you can use the bare `pip install api-watchdog` command.
## WatchdogTest format
The main way you'll interface with API Watchdog is through `WatchdogTest`s.
Each `WatchdogTest` has
- name (str): The name of the test
- target (url): The endpoint that the test targets
- expectations (Array[Expectation]): A list of requirements that the response must meet for the test to pass.
- payload (object): The json passed to the endpoint.
## Expectation format
An `Expectation` describes where to find a piece of data in the response and what that piece of data should be in order for the test to pass.
Each `Expectation` has
- selector (jq program): A string describing a jq program that selects the one or more elements to test against
- value (Any): a value to test equality against
- validation_type (ValidationType): An API Watchdog validation type used to validate the value/response. The value/response will be implicitly converted to this type. For example, if you specify 'float' and the value is an integer it will be implicitly converted to a float.
- level (Optional[ExpectationLevel]): How important an expectation is. Defaults to "critical"
## ExpectationLevel
One of the strings:
- critical
- warning
- info
Only "critical" expectations affect the success or failure of a `WatchdogTest`.
The selector format is a string that is a [jq program](https://stedolan.github.io/jq/). This allows for rich selection capabilities.
For example:
```
{
"selector": ".message.knowledge_graph.nodes[\"MONDO:0005148\"].name",
"value": "type 2 diabetes mellitus",
"validation_type": "string"
},
```
Is an `Expectation` that checks if a node is present in the knowledge graph of a TRAPI response.
The possible validation types are
- "string",
- "int",
- "float",
- "object",
- "bool",
- "null",
- "trapi.knowledge_graph",
- "trapi.node",
- "trapi.edge",
- "trapi.query_graph",
- "trapi.q_node",
- "trapi.q_edge",
- "trapi.query_constraint",
- "trapi.result",
- "trapi.node_binding",
- "trapi.edge_binding",
- "trapi.message",
- "trapi.query",
- "trapi.response",
- "trapi.async_query",
- "trapi.operation",
- "trapi.workflow",
- "trapi.attribute",
- "trapi.biolink_entity",
- "trapi.biolink_predicate",
- "trapi.curie",
- "trapi.log_entry",
- "trapi.log_level",
- "trapi.meta_edge",
- "trapi.meta_node",
- "trapi.meta_knowledge_graph",
- "trapi.meta_attribute"
## What it is
An API monitoring utility that aspires to support:
- [ ] Validation
- [ ] Continuous Integration
- [ ] Multiple input and output formats
- [ ] Test discovery / minimal configuration
## What it is not
- A way to regularly schedule tests against an endpoint, eg. [cron](https://en.wikipedia.org/wiki/Cron), [celery](https://docs.celeryproject.org/en/stable/getting-started/introduction.html)
- A way to specify api schemas eg. [marshmallow](https://marshmallow.readthedocs.io/en/stable/), [pydantic](https://pydantic-docs.helpmanual.io/)
%package help
Summary: Development documents and examples for api-watchdog
Provides: python3-api-watchdog-doc
%description help
# API Watchdog
## Usage
```
api-watchdog discover path/to/test/files
```
Will output the abbreviated result of the tests to stdout.
```
api-watchdog discover --email path/to/test/files
```
Will email the results of the tests to the relevant addresses
(as determined by the `email_to=` field of the test. Test results
are grouped so that only one email per address is sent per run.
Whjen using the CLI, these environment variables must be set to email results
- MAILGUN_API_URL
- MAILGUN_API_TOKEN
- MAILGUN_FROM
```
api-watchdog discover -o results_file.json path/to/test/files
```
Will serialize the `WatchdogResultGroup` object to the path specified
by the `-o` flag.
## Installation
API watchdog handles validation support through extra requirements.
This means that to install it with TRAPI validation you invoke
```
pip install api-watchdog[TRAPI]
```
If you are using `zsh` you will run affoul of bracket globbing and should use
```
pip install 'api-watchdog[TRAPI]'
```
See this [stackoverflow question](https://stackoverflow.com/questions/30539798/zsh-no-matches-found-requestssecurity) for context.
Available extensions are:
- TRAPI
If you do not want any validation support you can use the bare `pip install api-watchdog` command.
## WatchdogTest format
The main way you'll interface with API Watchdog is through `WatchdogTest`s.
Each `WatchdogTest` has
- name (str): The name of the test
- target (url): The endpoint that the test targets
- expectations (Array[Expectation]): A list of requirements that the response must meet for the test to pass.
- payload (object): The json passed to the endpoint.
## Expectation format
An `Expectation` describes where to find a piece of data in the response and what that piece of data should be in order for the test to pass.
Each `Expectation` has
- selector (jq program): A string describing a jq program that selects the one or more elements to test against
- value (Any): a value to test equality against
- validation_type (ValidationType): An API Watchdog validation type used to validate the value/response. The value/response will be implicitly converted to this type. For example, if you specify 'float' and the value is an integer it will be implicitly converted to a float.
- level (Optional[ExpectationLevel]): How important an expectation is. Defaults to "critical"
## ExpectationLevel
One of the strings:
- critical
- warning
- info
Only "critical" expectations affect the success or failure of a `WatchdogTest`.
The selector format is a string that is a [jq program](https://stedolan.github.io/jq/). This allows for rich selection capabilities.
For example:
```
{
"selector": ".message.knowledge_graph.nodes[\"MONDO:0005148\"].name",
"value": "type 2 diabetes mellitus",
"validation_type": "string"
},
```
Is an `Expectation` that checks if a node is present in the knowledge graph of a TRAPI response.
The possible validation types are
- "string",
- "int",
- "float",
- "object",
- "bool",
- "null",
- "trapi.knowledge_graph",
- "trapi.node",
- "trapi.edge",
- "trapi.query_graph",
- "trapi.q_node",
- "trapi.q_edge",
- "trapi.query_constraint",
- "trapi.result",
- "trapi.node_binding",
- "trapi.edge_binding",
- "trapi.message",
- "trapi.query",
- "trapi.response",
- "trapi.async_query",
- "trapi.operation",
- "trapi.workflow",
- "trapi.attribute",
- "trapi.biolink_entity",
- "trapi.biolink_predicate",
- "trapi.curie",
- "trapi.log_entry",
- "trapi.log_level",
- "trapi.meta_edge",
- "trapi.meta_node",
- "trapi.meta_knowledge_graph",
- "trapi.meta_attribute"
## What it is
An API monitoring utility that aspires to support:
- [ ] Validation
- [ ] Continuous Integration
- [ ] Multiple input and output formats
- [ ] Test discovery / minimal configuration
## What it is not
- A way to regularly schedule tests against an endpoint, eg. [cron](https://en.wikipedia.org/wiki/Cron), [celery](https://docs.celeryproject.org/en/stable/getting-started/introduction.html)
- A way to specify api schemas eg. [marshmallow](https://marshmallow.readthedocs.io/en/stable/), [pydantic](https://pydantic-docs.helpmanual.io/)
%prep
%autosetup -n api-watchdog-0.6.0
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-api-watchdog -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Thu May 18 2023 Python_Bot <Python_Bot@openeuler.org> - 0.6.0-1
- Package Spec generated
|
