openqa-async 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.
@@ -0,0 +1,339 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Lesser General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
282
+ How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ <one line to give the program's name and a brief idea of what it does.>
294
+ Copyright (C) <year> <name of author>
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License along
307
+ with this program; if not, write to the Free Software Foundation, Inc.,
308
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309
+
310
+ Also add information on how to contact you by electronic and paper mail.
311
+
312
+ If the program is interactive, make it output a short notice like this
313
+ when it starts in an interactive mode:
314
+
315
+ Gnomovision version 69, Copyright (C) year name of author
316
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317
+ This is free software, and you are welcome to redistribute it
318
+ under certain conditions; type `show c' for details.
319
+
320
+ The hypothetical commands `show w' and `show c' should show the appropriate
321
+ parts of the General Public License. Of course, the commands you use may
322
+ be called something other than `show w' and `show c'; they could even be
323
+ mouse-clicks or menu items--whatever suits your program.
324
+
325
+ You should also get your employer (if you work as a programmer) or your
326
+ school, if any, to sign a "copyright disclaimer" for the program, if
327
+ necessary. Here is a sample; alter the names:
328
+
329
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
331
+
332
+ <signature of Ty Coon>, 1 April 1989
333
+ Ty Coon, President of Vice
334
+
335
+ This General Public License does not permit incorporating your program into
336
+ proprietary programs. If your program is a subroutine library, you may
337
+ consider it more useful to permit linking proprietary applications with the
338
+ library. If this is what you want to do, use the GNU Lesser General
339
+ Public License instead of this License.
@@ -0,0 +1,149 @@
1
+ Metadata-Version: 2.4
2
+ Name: openqa-async
3
+ Version: 0.1.0
4
+ Summary: OpenqQA Client Library with Async Support
5
+ Author: Ondřej Súkup
6
+ Author-email: Ondřej Súkup <mimi.vx@gmail.com>
7
+ License-Expression: GPL-2.0-or-later
8
+ License-File: COPYING
9
+ Classifier: Programming Language :: Python :: 3
10
+ Classifier: Programming Language :: Python :: 3.13
11
+ Classifier: Programming Language :: Python :: 3.14
12
+ Requires-Dist: httpx>=0.28.1
13
+ Requires-Dist: pyyaml>=6
14
+ Requires-Python: >=3.13
15
+ Description-Content-Type: text/markdown
16
+
17
+ # openqa-async
18
+
19
+ An [httpx](https://www.python-httpx.org/)-based client for the
20
+ [openQA](https://open.qa/) REST API, exposing both a **synchronous** and an
21
+ **asynchronous** API. It is a port of
22
+ [`openQA-python-client`](https://github.com/os-autoinst/openQA-python-client)
23
+ from `requests` to `httpx`, preserving its HMAC request signing, `client.conf`
24
+ discovery, and YAML-response fallback.
25
+
26
+ ## Installation
27
+
28
+ ```sh
29
+ uv add openqa-async
30
+ # or
31
+ pip install openqa-async
32
+ ```
33
+
34
+ ## Usage
35
+
36
+ ### Synchronous
37
+
38
+ ```python
39
+ from openqa_async import OpenQAClient
40
+
41
+ with OpenQAClient(server="openqa.opensuse.org") as client:
42
+ jobs = client.openqa_request("GET", "/api/v1/jobs", params={"limit": 10})
43
+ print(jobs)
44
+ ```
45
+
46
+ ### Asynchronous
47
+
48
+ ```python
49
+ import asyncio
50
+
51
+ from openqa_async import AsyncOpenQAClient
52
+
53
+
54
+ async def main():
55
+ async with AsyncOpenQAClient(server="openqa.opensuse.org") as client:
56
+ jobs = await client.openqa_request(
57
+ "GET", "/api/v1/jobs", params={"limit": 10}
58
+ )
59
+ print(jobs)
60
+
61
+
62
+ asyncio.run(main())
63
+ ```
64
+
65
+ ### `openqa_request` signature
66
+
67
+ Both clients share the same request method (the async one is awaitable):
68
+
69
+ ```python
70
+ openqa_request(
71
+ method, # "GET", "POST", ...
72
+ path, # e.g. "/api/v1/jobs" (a leading slash is optional)
73
+ params=None, # query-string parameters
74
+ retries=None, # override the client default (5)
75
+ wait=None, # override the initial backoff in seconds (10)
76
+ data=None, # form-encoded body
77
+ json=None, # JSON body
78
+ )
79
+ ```
80
+
81
+ Responses are parsed automatically: a `text/yaml` body is loaded with
82
+ `yaml.safe_load`, a `204 No Content` (or `parse=False`) returns the raw
83
+ `httpx.Response`, and everything else is decoded as JSON. Non-2xx responses
84
+ raise `RequestError`; transport failures raise `ConnectionError`. Retryable
85
+ status codes (e.g. `503`) are retried with exponential backoff.
86
+
87
+ ## Configuration
88
+
89
+ Credentials are read from INI-style `client.conf` files, searched in order:
90
+
91
+ 1. `/etc/openqa/client.conf`
92
+ 2. `~/.config/openqa/client.conf`
93
+
94
+ Each section is keyed by the server host (or full base URL) and provides the
95
+ API `key`/`secret`:
96
+
97
+ ```ini
98
+ [openqa.opensuse.org]
99
+ key = YOUR_API_KEY
100
+ secret = YOUR_API_SECRET
101
+ ```
102
+
103
+ The lookup tries the bare `server` section first, then the full base URL
104
+ section. When a key/secret is present, requests are HMAC-SHA1 signed and the
105
+ `X-API-Key` header is sent. Without credentials only unauthenticated `GET`
106
+ requests are possible.
107
+
108
+ **Scheme defaulting:** the scheme defaults to `https`, except for loopback
109
+ hosts (`localhost`, `127.0.0.1`, `::1`), which default to `http`. You can also
110
+ pass a fully-qualified server such as `http://openqa.example.com`.
111
+
112
+ ## Migration from `openQA-python-client`
113
+
114
+ For code written against the upstream `requests`-based client, a compatibility
115
+ alias keeps most call sites working unchanged:
116
+
117
+ ```python
118
+ from openqa_async import OpenQA_Client # alias for OpenQAClient
119
+
120
+ client = OpenQA_Client(server="openqa.opensuse.org")
121
+ jobs = client.openqa_request("GET", "/api/v1/jobs")
122
+ ```
123
+
124
+ `OpenQA_Client` is the synchronous `OpenQAClient`, and `openqa_request` keeps
125
+ the same method/path semantics. New code should prefer `OpenQAClient` /
126
+ `AsyncOpenQAClient` directly.
127
+
128
+ ## Disabling TLS verification
129
+
130
+ Both clients accept a `verify` parameter (default `True`) that is passed
131
+ straight through to httpx. It accepts a `bool`, a CA-bundle path, or an
132
+ `ssl.SSLContext`:
133
+
134
+ ```python
135
+ # Self-signed or internal-CA openQA instance:
136
+ client = OpenQAClient(server="openqa.internal", verify="/path/to/internal-ca.pem")
137
+
138
+ # Disable verification entirely:
139
+ client = OpenQAClient(server="openqa.internal", verify=False)
140
+ ```
141
+
142
+ > **Security warning:** `verify=False` disables TLS certificate verification
143
+ > and exposes the connection to man-in-the-middle attacks. Use it only against
144
+ > trusted instances on trusted networks; prefer supplying the internal CA
145
+ > bundle instead.
146
+
147
+ ## License
148
+
149
+ GPL-2.0-or-later. See [COPYING](COPYING).
@@ -0,0 +1,133 @@
1
+ # openqa-async
2
+
3
+ An [httpx](https://www.python-httpx.org/)-based client for the
4
+ [openQA](https://open.qa/) REST API, exposing both a **synchronous** and an
5
+ **asynchronous** API. It is a port of
6
+ [`openQA-python-client`](https://github.com/os-autoinst/openQA-python-client)
7
+ from `requests` to `httpx`, preserving its HMAC request signing, `client.conf`
8
+ discovery, and YAML-response fallback.
9
+
10
+ ## Installation
11
+
12
+ ```sh
13
+ uv add openqa-async
14
+ # or
15
+ pip install openqa-async
16
+ ```
17
+
18
+ ## Usage
19
+
20
+ ### Synchronous
21
+
22
+ ```python
23
+ from openqa_async import OpenQAClient
24
+
25
+ with OpenQAClient(server="openqa.opensuse.org") as client:
26
+ jobs = client.openqa_request("GET", "/api/v1/jobs", params={"limit": 10})
27
+ print(jobs)
28
+ ```
29
+
30
+ ### Asynchronous
31
+
32
+ ```python
33
+ import asyncio
34
+
35
+ from openqa_async import AsyncOpenQAClient
36
+
37
+
38
+ async def main():
39
+ async with AsyncOpenQAClient(server="openqa.opensuse.org") as client:
40
+ jobs = await client.openqa_request(
41
+ "GET", "/api/v1/jobs", params={"limit": 10}
42
+ )
43
+ print(jobs)
44
+
45
+
46
+ asyncio.run(main())
47
+ ```
48
+
49
+ ### `openqa_request` signature
50
+
51
+ Both clients share the same request method (the async one is awaitable):
52
+
53
+ ```python
54
+ openqa_request(
55
+ method, # "GET", "POST", ...
56
+ path, # e.g. "/api/v1/jobs" (a leading slash is optional)
57
+ params=None, # query-string parameters
58
+ retries=None, # override the client default (5)
59
+ wait=None, # override the initial backoff in seconds (10)
60
+ data=None, # form-encoded body
61
+ json=None, # JSON body
62
+ )
63
+ ```
64
+
65
+ Responses are parsed automatically: a `text/yaml` body is loaded with
66
+ `yaml.safe_load`, a `204 No Content` (or `parse=False`) returns the raw
67
+ `httpx.Response`, and everything else is decoded as JSON. Non-2xx responses
68
+ raise `RequestError`; transport failures raise `ConnectionError`. Retryable
69
+ status codes (e.g. `503`) are retried with exponential backoff.
70
+
71
+ ## Configuration
72
+
73
+ Credentials are read from INI-style `client.conf` files, searched in order:
74
+
75
+ 1. `/etc/openqa/client.conf`
76
+ 2. `~/.config/openqa/client.conf`
77
+
78
+ Each section is keyed by the server host (or full base URL) and provides the
79
+ API `key`/`secret`:
80
+
81
+ ```ini
82
+ [openqa.opensuse.org]
83
+ key = YOUR_API_KEY
84
+ secret = YOUR_API_SECRET
85
+ ```
86
+
87
+ The lookup tries the bare `server` section first, then the full base URL
88
+ section. When a key/secret is present, requests are HMAC-SHA1 signed and the
89
+ `X-API-Key` header is sent. Without credentials only unauthenticated `GET`
90
+ requests are possible.
91
+
92
+ **Scheme defaulting:** the scheme defaults to `https`, except for loopback
93
+ hosts (`localhost`, `127.0.0.1`, `::1`), which default to `http`. You can also
94
+ pass a fully-qualified server such as `http://openqa.example.com`.
95
+
96
+ ## Migration from `openQA-python-client`
97
+
98
+ For code written against the upstream `requests`-based client, a compatibility
99
+ alias keeps most call sites working unchanged:
100
+
101
+ ```python
102
+ from openqa_async import OpenQA_Client # alias for OpenQAClient
103
+
104
+ client = OpenQA_Client(server="openqa.opensuse.org")
105
+ jobs = client.openqa_request("GET", "/api/v1/jobs")
106
+ ```
107
+
108
+ `OpenQA_Client` is the synchronous `OpenQAClient`, and `openqa_request` keeps
109
+ the same method/path semantics. New code should prefer `OpenQAClient` /
110
+ `AsyncOpenQAClient` directly.
111
+
112
+ ## Disabling TLS verification
113
+
114
+ Both clients accept a `verify` parameter (default `True`) that is passed
115
+ straight through to httpx. It accepts a `bool`, a CA-bundle path, or an
116
+ `ssl.SSLContext`:
117
+
118
+ ```python
119
+ # Self-signed or internal-CA openQA instance:
120
+ client = OpenQAClient(server="openqa.internal", verify="/path/to/internal-ca.pem")
121
+
122
+ # Disable verification entirely:
123
+ client = OpenQAClient(server="openqa.internal", verify=False)
124
+ ```
125
+
126
+ > **Security warning:** `verify=False` disables TLS certificate verification
127
+ > and exposes the connection to man-in-the-middle attacks. Use it only against
128
+ > trusted instances on trusted networks; prefer supplying the internal CA
129
+ > bundle instead.
130
+
131
+ ## License
132
+
133
+ GPL-2.0-or-later. See [COPYING](COPYING).
@@ -0,0 +1,48 @@
1
+ [project]
2
+ name = "openqa-async"
3
+ version = "0.1.0"
4
+ description = "OpenqQA Client Library with Async Support"
5
+ readme = "README.md"
6
+ requires-python = ">=3.13"
7
+ license = "GPL-2.0-or-later"
8
+ license-files = ["COPYING"]
9
+ authors = [{ name = "Ondřej Súkup", email = "mimi.vx@gmail.com" }]
10
+ classifiers = [
11
+ "Programming Language :: Python :: 3",
12
+ "Programming Language :: Python :: 3.13",
13
+ "Programming Language :: Python :: 3.14",
14
+ ]
15
+ dependencies = [
16
+ "httpx>=0.28.1",
17
+ "pyyaml>=6",
18
+ ]
19
+
20
+ [dependency-groups]
21
+ test = [
22
+ "pytest>=9.0.3",
23
+ "pytest-cov>=7.1.0",
24
+ "respx>=0.21",
25
+ "pytest-asyncio>=0.24",
26
+ "types-pyyaml>=6",
27
+ ]
28
+ lint = [
29
+ "ruff>=0.15.15",
30
+ "ty>=0.0.40",
31
+ ]
32
+
33
+ [tool.pytest.ini_options]
34
+ asyncio_mode = "auto"
35
+
36
+ [tool.ruff]
37
+ target-version = "py313"
38
+ line-length = 88
39
+
40
+ [tool.ruff.lint]
41
+ select = ["E", "F", "I", "UP", "B"]
42
+
43
+ [tool.ty.src]
44
+ include = ["src"]
45
+
46
+ [build-system]
47
+ requires = ["uv_build>=0.11.17,<0.12.0"]
48
+ build-backend = "uv_build"
@@ -0,0 +1,38 @@
1
+ # This program is free software; you can redistribute it and/or modify
2
+ # it under the terms of the GNU General Public License as published by
3
+ # the Free Software Foundation, either version 2 of the License, or
4
+ # (at your option) any later version.
5
+ #
6
+ # This program is distributed in the hope that it will be useful,
7
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
8
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9
+ # GNU General Public License for more details.
10
+ #
11
+ # You should have received a copy of the GNU General Public License
12
+ # along with this program. If not, see <http://www.gnu.org/licenses/>.
13
+
14
+ """openqa_async: an httpx-based openQA client with sync and async APIs.
15
+
16
+ The pythonic entry points are :class:`OpenQAClient` (synchronous) and
17
+ :class:`AsyncOpenQAClient` (asynchronous). ``OpenQA_Client`` is a thin
18
+ compatibility alias for the synchronous client so legacy code that calls
19
+ ``OpenQA_Client(...).openqa_request(...)`` mostly keeps working.
20
+ """
21
+
22
+ from . import const
23
+ from .aclient import AsyncOpenQAClient
24
+ from .client import OpenQAClient
25
+ from .exceptions import ConnectionError, OpenQAClientError, RequestError
26
+
27
+ #: Compatibility alias for the upstream ``requests``-based class name.
28
+ OpenQA_Client = OpenQAClient
29
+
30
+ __all__ = [
31
+ "AsyncOpenQAClient",
32
+ "ConnectionError",
33
+ "OpenQAClient",
34
+ "OpenQA_Client",
35
+ "OpenQAClientError",
36
+ "RequestError",
37
+ "const",
38
+ ]
@@ -0,0 +1,62 @@
1
+ # This program is free software; you can redistribute it and/or modify
2
+ # it under the terms of the GNU General Public License as published by
3
+ # the Free Software Foundation, either version 2 of the License, or
4
+ # (at your option) any later version.
5
+ #
6
+ # This program is distributed in the hope that it will be useful,
7
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
8
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9
+ # GNU General Public License for more details.
10
+ #
11
+ # You should have received a copy of the GNU General Public License
12
+ # along with this program. If not, see <http://www.gnu.org/licenses/>.
13
+
14
+ """HMAC authentication for the openqa_async client library.
15
+
16
+ A single ``httpx.Auth`` subclass drives request signing for both the
17
+ synchronous and asynchronous clients.
18
+ """
19
+
20
+ import hmac
21
+ import time
22
+ from collections.abc import Generator
23
+ from hashlib import sha1
24
+
25
+ import httpx
26
+
27
+
28
+ class OpenQAAuth(httpx.Auth):
29
+ """Sign requests with openQA's HMAC-SHA1 scheme.
30
+
31
+ The signed string is the request ``raw_path`` (path plus ``?query``)
32
+ concatenated with the current ``str(time.time())`` timestamp, with the
33
+ ``%20``->``+`` and ``~``->``%7E`` fixups applied to match upstream's
34
+ ``requests``-based ``path_url`` signing byte-for-byte.
35
+
36
+ The ``X-API-Key`` header is a static client header set by the base
37
+ client, not here.
38
+ """
39
+
40
+ def __init__(self, apisecret: str) -> None:
41
+ self.apisecret = apisecret
42
+
43
+ def auth_flow(
44
+ self, request: httpx.Request
45
+ ) -> Generator[httpx.Request, httpx.Response]:
46
+ if not self.apisecret:
47
+ # GET works without auth; nothing to sign.
48
+ yield request
49
+ return
50
+
51
+ path = (
52
+ request.url.raw_path.decode("ascii").replace("%20", "+").replace("~", "%7E")
53
+ )
54
+ ts = str(time.time())
55
+ apihash = hmac.new(
56
+ self.apisecret.encode("utf-8"),
57
+ f"{path}{ts}".encode(),
58
+ sha1,
59
+ ).hexdigest()
60
+ request.headers["X-API-Microtime"] = ts
61
+ request.headers["X-API-Hash"] = apihash
62
+ yield request
@@ -0,0 +1,177 @@
1
+ # This program is free software; you can redistribute it and/or modify
2
+ # it under the terms of the GNU General Public License as published by
3
+ # the Free Software Foundation, either version 2 of the License, or
4
+ # (at your option) any later version.
5
+ #
6
+ # This program is distributed in the hope that it will be useful,
7
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
8
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9
+ # GNU General Public License for more details.
10
+ #
11
+ # You should have received a copy of the GNU General Public License
12
+ # along with this program. If not, see <http://www.gnu.org/licenses/>.
13
+
14
+ """Transport-agnostic base for the openqa_async clients.
15
+
16
+ ``_OpenQAClientBase`` holds everything that does not depend on whether a
17
+ request is dispatched synchronously or asynchronously: configuration
18
+ parsing, URL/scheme defaulting, default headers, auth construction,
19
+ request-argument building, response handling, and retry decision
20
+ helpers. The sync and async clients subclass it and supply only the
21
+ request/retry loop, which is the one part that genuinely differs between
22
+ ``httpx.Client`` and ``httpx.AsyncClient``.
23
+ """
24
+
25
+ import configparser
26
+ import logging
27
+ import os
28
+ import ssl
29
+ from typing import Any
30
+ from urllib.parse import urlparse, urlunparse
31
+
32
+ import httpx
33
+ import yaml
34
+
35
+ from ._auth import OpenQAAuth
36
+ from .exceptions import RequestError
37
+
38
+ logger = logging.getLogger(__name__)
39
+
40
+ #: HTTP status codes that warrant a retry, matching upstream's tuple.
41
+ _RETRY_STATUS = frozenset((408, 413, 429, 444, 500, 502, 503, 504, 509, 521, 522, 599))
42
+
43
+
44
+ class _OpenQAClientBase:
45
+ """Shared, transport-agnostic state and helpers for the openQA clients."""
46
+
47
+ def __init__(
48
+ self,
49
+ server: str = "",
50
+ scheme: str = "",
51
+ retries: int = 5,
52
+ wait: int = 10,
53
+ verify: bool | str | ssl.SSLContext = True,
54
+ ) -> None:
55
+ self.retries = retries
56
+ self.wait = wait
57
+ self.verify = verify
58
+
59
+ # Read in config files.
60
+ config = configparser.ConfigParser()
61
+ paths = ("/etc/openqa", f"{os.path.expanduser('~')}/.config/openqa")
62
+ config.read(f"{path}/client.conf" for path in paths)
63
+
64
+ # If server not specified, default to the first one in the
65
+ # configuration file. If no configuration file, default to
66
+ # localhost. NOTE: this is different from the perl client, it
67
+ # *always* defaults to localhost.
68
+ if not server:
69
+ try:
70
+ server = config.sections()[0]
71
+ except (configparser.MissingSectionHeaderError, IndexError):
72
+ server = "localhost"
73
+
74
+ if server.startswith("http"):
75
+ # Handle entries like [http://foo] or [https://foo]. The
76
+ # perl client does NOT handle these, so you shouldn't use
77
+ # them. This client started out supporting this, though,
78
+ # so it should continue to.
79
+ if not scheme:
80
+ scheme = urlparse(server).scheme
81
+ server = urlparse(server).netloc
82
+
83
+ if not scheme:
84
+ if server in ("localhost", "127.0.0.1", "::1"):
85
+ # Default to non-TLS for localhost; cert is unlikely to
86
+ # be valid for 'localhost' and there's no MITM...
87
+ scheme = "http"
88
+ else:
89
+ scheme = "https"
90
+
91
+ self.baseurl = urlunparse((scheme, server, "", "", "", ""))
92
+
93
+ # Get the API secrets from the config file.
94
+ try:
95
+ apikey = config.get(server, "key")
96
+ self.apisecret = config.get(server, "secret")
97
+ except configparser.Error:
98
+ try:
99
+ apikey = config.get(self.baseurl, "key")
100
+ self.apisecret = config.get(self.baseurl, "secret")
101
+ except configparser.Error:
102
+ logger.debug(
103
+ "No API key for %s: only GET requests will be allowed", server
104
+ )
105
+ apikey = ""
106
+ self.apisecret = ""
107
+
108
+ self._apikey = apikey
109
+
110
+ def _default_headers(self) -> dict[str, str]:
111
+ """Static headers applied to every request through the client."""
112
+ headers = {"Accept": "json"}
113
+ if self._apikey:
114
+ headers["X-API-Key"] = self._apikey
115
+ return headers
116
+
117
+ def _build_auth(self) -> OpenQAAuth:
118
+ """Build the HMAC auth flow used by both clients."""
119
+ return OpenQAAuth(self.apisecret)
120
+
121
+ def _build_request_args(
122
+ self,
123
+ method: str,
124
+ path: str,
125
+ params: Any = None,
126
+ data: Any = None,
127
+ json: Any = None,
128
+ ) -> dict[str, Any]:
129
+ """Return kwargs for ``client.build_request``.
130
+
131
+ The path is normalized to a leading slash so it joins predictably
132
+ against the client's ``base_url`` and the signed ``raw_path`` is
133
+ well-defined.
134
+ """
135
+ if not path.startswith("/"):
136
+ path = "/" + path
137
+ return {
138
+ "method": method.upper(),
139
+ "url": path,
140
+ "params": params,
141
+ "data": data,
142
+ "json": json,
143
+ }
144
+
145
+ def _handle_response(self, resp: httpx.Response, parse: bool = True) -> Any:
146
+ """Turn an ``httpx.Response`` into parsed output or raise.
147
+
148
+ Mirrors upstream branch order: non-2xx raises ``RequestError``;
149
+ ``parse=False`` or a 204 returns the raw response; a ``text/yaml``
150
+ body is loaded with the safe loader; otherwise the JSON body is
151
+ returned.
152
+ """
153
+ if not resp.is_success:
154
+ raise RequestError(
155
+ resp.request.method, str(resp.url), resp.status_code, resp.text
156
+ )
157
+ if not parse or resp.status_code == 204:
158
+ return resp
159
+ # Check if the server sent us YAML when we asked for JSON.
160
+ contype = resp.headers.get("content-type", "")
161
+ if contype.startswith("text/yaml"):
162
+ # SafeLoader is sufficient; we trust the devs not to put
163
+ # anything beyond its capacity in the responses.
164
+ return yaml.safe_load(resp.text)
165
+ return resp.json()
166
+
167
+ def _should_retry(self, status_or_exc: int | BaseException) -> bool:
168
+ """Decide whether a status code or exception warrants a retry."""
169
+ if isinstance(status_or_exc, httpx.TransportError):
170
+ return True
171
+ if isinstance(status_or_exc, int):
172
+ return status_or_exc in _RETRY_STATUS
173
+ return False
174
+
175
+ def _next_wait(self, wait: int | float) -> int | float:
176
+ """Exponential backoff, capped at 60 seconds (matches upstream)."""
177
+ return min(wait + wait, 60)
@@ -0,0 +1,133 @@
1
+ # This program is free software; you can redistribute it and/or modify
2
+ # it under the terms of the GNU General Public License as published by
3
+ # the Free Software Foundation, either version 2 of the License, or
4
+ # (at your option) any later version.
5
+ #
6
+ # This program is distributed in the hope that it will be useful,
7
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
8
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9
+ # GNU General Public License for more details.
10
+ #
11
+ # You should have received a copy of the GNU General Public License
12
+ # along with this program. If not, see <http://www.gnu.org/licenses/>.
13
+
14
+ """Asynchronous openQA client built on ``httpx.AsyncClient``.
15
+
16
+ ``AsyncOpenQAClient`` is the async mirror of
17
+ :class:`~openqa_async.client.OpenQAClient`. It supplies the one part that
18
+ genuinely differs between the sync and async transports: the
19
+ request/retry loop (here awaiting ``send`` and sleeping via
20
+ ``asyncio.sleep``). Everything else (configuration, URL/scheme
21
+ defaulting, headers, auth, response handling, retry decisions) lives in
22
+ :class:`~openqa_async._base._OpenQAClientBase`.
23
+ """
24
+
25
+ import asyncio
26
+ import ssl
27
+ from types import TracebackType
28
+ from typing import Any, Self
29
+
30
+ import httpx
31
+
32
+ from ._base import _OpenQAClientBase
33
+ from .exceptions import ConnectionError
34
+
35
+
36
+ class AsyncOpenQAClient(_OpenQAClientBase):
37
+ """Asynchronous client for an openQA server's REST API."""
38
+
39
+ def __init__(
40
+ self,
41
+ server: str = "",
42
+ scheme: str = "",
43
+ retries: int = 5,
44
+ wait: int = 10,
45
+ verify: bool | str | ssl.SSLContext = True,
46
+ ) -> None:
47
+ super().__init__(
48
+ server=server,
49
+ scheme=scheme,
50
+ retries=retries,
51
+ wait=wait,
52
+ verify=verify,
53
+ )
54
+ self.client = httpx.AsyncClient(
55
+ base_url=self.baseurl,
56
+ headers=self._default_headers(),
57
+ auth=self._build_auth(),
58
+ trust_env=True,
59
+ verify=self.verify,
60
+ )
61
+
62
+ async def do_request(
63
+ self,
64
+ request: httpx.Request,
65
+ retries: int | None = None,
66
+ wait: int | float | None = None,
67
+ parse: bool = True,
68
+ ) -> Any:
69
+ """Send ``request`` with retry/backoff and return parsed output.
70
+
71
+ Retries on the upstream status-code set and on transport errors,
72
+ sleeping with exponential backoff between attempts. A value of
73
+ ``retries`` means up to that many *retries* (so ``retries + 1``
74
+ total attempts). After the attempts are exhausted, a transport
75
+ failure raises :class:`~openqa_async.exceptions.ConnectionError`
76
+ and a non-2xx response raises
77
+ :class:`~openqa_async.exceptions.RequestError` (via
78
+ ``_handle_response``).
79
+ """
80
+ if retries is None:
81
+ retries = self.retries
82
+ if wait is None:
83
+ wait = self.wait
84
+
85
+ for attempt in range(retries + 1):
86
+ last_attempt = attempt == retries
87
+ try:
88
+ resp = await self.client.send(request)
89
+ except httpx.TransportError as exc:
90
+ if last_attempt:
91
+ raise ConnectionError(
92
+ f"Connection to {request.url} failed: {exc}"
93
+ ) from exc
94
+ await asyncio.sleep(wait)
95
+ wait = self._next_wait(wait)
96
+ continue
97
+
98
+ if not last_attempt and self._should_retry(resp.status_code):
99
+ await asyncio.sleep(wait)
100
+ wait = self._next_wait(wait)
101
+ continue
102
+
103
+ return self._handle_response(resp, parse)
104
+
105
+ async def openqa_request(
106
+ self,
107
+ method: str,
108
+ path: str,
109
+ params: Any = None,
110
+ retries: int | None = None,
111
+ wait: int | float | None = None,
112
+ data: Any = None,
113
+ json: Any = None,
114
+ ) -> Any:
115
+ """Build and dispatch a request against the openQA API."""
116
+ args = self._build_request_args(method, path, params, data, json)
117
+ request = self.client.build_request(**args)
118
+ return await self.do_request(request, retries=retries, wait=wait, parse=True)
119
+
120
+ async def aclose(self) -> None:
121
+ """Close the underlying ``httpx.AsyncClient``."""
122
+ await self.client.aclose()
123
+
124
+ async def __aenter__(self) -> Self:
125
+ return self
126
+
127
+ async def __aexit__(
128
+ self,
129
+ exc_type: type[BaseException] | None,
130
+ exc_value: BaseException | None,
131
+ traceback: TracebackType | None,
132
+ ) -> None:
133
+ await self.aclose()
@@ -0,0 +1,132 @@
1
+ # This program is free software; you can redistribute it and/or modify
2
+ # it under the terms of the GNU General Public License as published by
3
+ # the Free Software Foundation, either version 2 of the License, or
4
+ # (at your option) any later version.
5
+ #
6
+ # This program is distributed in the hope that it will be useful,
7
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
8
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9
+ # GNU General Public License for more details.
10
+ #
11
+ # You should have received a copy of the GNU General Public License
12
+ # along with this program. If not, see <http://www.gnu.org/licenses/>.
13
+
14
+ """Synchronous openQA client built on ``httpx.Client``.
15
+
16
+ ``OpenQAClient`` supplies the one part that genuinely differs between the
17
+ sync and async transports: the request/retry loop. Everything else
18
+ (configuration, URL/scheme defaulting, headers, auth, response handling,
19
+ retry decisions) lives in :class:`~openqa_async._base._OpenQAClientBase`.
20
+ """
21
+
22
+ import ssl
23
+ import time
24
+ from types import TracebackType
25
+ from typing import Any, Self
26
+
27
+ import httpx
28
+
29
+ from ._base import _OpenQAClientBase
30
+ from .exceptions import ConnectionError
31
+
32
+
33
+ class OpenQAClient(_OpenQAClientBase):
34
+ """Synchronous client for an openQA server's REST API."""
35
+
36
+ def __init__(
37
+ self,
38
+ server: str = "",
39
+ scheme: str = "",
40
+ retries: int = 5,
41
+ wait: int = 10,
42
+ verify: bool | str | ssl.SSLContext = True,
43
+ ) -> None:
44
+ super().__init__(
45
+ server=server,
46
+ scheme=scheme,
47
+ retries=retries,
48
+ wait=wait,
49
+ verify=verify,
50
+ )
51
+ self.client = httpx.Client(
52
+ base_url=self.baseurl,
53
+ headers=self._default_headers(),
54
+ auth=self._build_auth(),
55
+ trust_env=True,
56
+ verify=self.verify,
57
+ )
58
+ #: Legacy alias for ``self.client`` (upstream exposed ``session``).
59
+ self.session = self.client
60
+
61
+ def do_request(
62
+ self,
63
+ request: httpx.Request,
64
+ retries: int | None = None,
65
+ wait: int | float | None = None,
66
+ parse: bool = True,
67
+ ) -> Any:
68
+ """Send ``request`` with retry/backoff and return parsed output.
69
+
70
+ Retries on the upstream status-code set and on transport errors,
71
+ sleeping with exponential backoff between attempts. A value of
72
+ ``retries`` means up to that many *retries* (so ``retries + 1``
73
+ total attempts). After the attempts are exhausted, a transport
74
+ failure raises :class:`~openqa_async.exceptions.ConnectionError`
75
+ and a non-2xx response raises
76
+ :class:`~openqa_async.exceptions.RequestError` (via
77
+ ``_handle_response``).
78
+ """
79
+ if retries is None:
80
+ retries = self.retries
81
+ if wait is None:
82
+ wait = self.wait
83
+
84
+ for attempt in range(retries + 1):
85
+ last_attempt = attempt == retries
86
+ try:
87
+ resp = self.client.send(request)
88
+ except httpx.TransportError as exc:
89
+ if last_attempt:
90
+ raise ConnectionError(
91
+ f"Connection to {request.url} failed: {exc}"
92
+ ) from exc
93
+ time.sleep(wait)
94
+ wait = self._next_wait(wait)
95
+ continue
96
+
97
+ if not last_attempt and self._should_retry(resp.status_code):
98
+ time.sleep(wait)
99
+ wait = self._next_wait(wait)
100
+ continue
101
+
102
+ return self._handle_response(resp, parse)
103
+
104
+ def openqa_request(
105
+ self,
106
+ method: str,
107
+ path: str,
108
+ params: Any = None,
109
+ retries: int | None = None,
110
+ wait: int | float | None = None,
111
+ data: Any = None,
112
+ json: Any = None,
113
+ ) -> Any:
114
+ """Build and dispatch a request against the openQA API."""
115
+ args = self._build_request_args(method, path, params, data, json)
116
+ request = self.client.build_request(**args)
117
+ return self.do_request(request, retries=retries, wait=wait, parse=True)
118
+
119
+ def close(self) -> None:
120
+ """Close the underlying ``httpx.Client``."""
121
+ self.client.close()
122
+
123
+ def __enter__(self) -> Self:
124
+ return self
125
+
126
+ def __exit__(
127
+ self,
128
+ exc_type: type[BaseException] | None,
129
+ exc_value: BaseException | None,
130
+ traceback: TracebackType | None,
131
+ ) -> None:
132
+ self.close()
@@ -0,0 +1,106 @@
1
+ # This program is free software; you can redistribute it and/or modify
2
+ # it under the terms of the GNU General Public License as published by
3
+ # the Free Software Foundation, either version 2 of the License, or
4
+ # (at your option) any later version.
5
+ #
6
+ # This program is distributed in the hope that it will be useful,
7
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
8
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9
+ # GNU General Public License for more details.
10
+ #
11
+ # You should have received a copy of the GNU General Public License
12
+ # along with this program. If not, see <http://www.gnu.org/licenses/>.
13
+ #
14
+ # Authors: Adam Williamson <awilliam@redhat.com>
15
+
16
+ """Important constants duplicated from openQA. We need to keep this in
17
+ sync with upstream, but it's better to have it done just once here
18
+ rather than every consumer of this library duplicating things like
19
+ 'these are the "running" states' on the fly. It is explicitly allowed
20
+ to use 'from openqa_async.const import *'; this will only import
21
+ sanely named 'constants'. You may prefer to do `from openqa_async
22
+ import const as oqc` or similar. For details on what each of these
23
+ means, please refer to the openQA source, it has comments that explain
24
+ them; it seems unnecessary to duplicate those here.
25
+ """
26
+
27
+ # States
28
+ JOB_STATE_SCHEDULED = "scheduled"
29
+ JOB_STATE_ASSIGNED = "assigned"
30
+ JOB_STATE_SETUP = "setup"
31
+ JOB_STATE_RUNNING = "running"
32
+ JOB_STATE_UPLOADING = "uploading"
33
+ JOB_STATE_CANCELLED = "cancelled"
34
+ JOB_STATE_DONE = "done"
35
+
36
+ JOB_STATES = (
37
+ JOB_STATE_SCHEDULED,
38
+ JOB_STATE_SETUP,
39
+ JOB_STATE_RUNNING,
40
+ JOB_STATE_CANCELLED,
41
+ JOB_STATE_DONE,
42
+ JOB_STATE_UPLOADING,
43
+ JOB_STATE_ASSIGNED,
44
+ )
45
+ JOB_PENDING_STATES = (
46
+ JOB_STATE_SCHEDULED,
47
+ JOB_STATE_ASSIGNED,
48
+ JOB_STATE_SETUP,
49
+ JOB_STATE_RUNNING,
50
+ JOB_STATE_UPLOADING,
51
+ )
52
+ JOB_EXECUTION_STATES = (
53
+ JOB_STATE_ASSIGNED,
54
+ JOB_STATE_SETUP,
55
+ JOB_STATE_RUNNING,
56
+ JOB_STATE_UPLOADING,
57
+ )
58
+ JOB_PRE_EXECUTION_STATES = (JOB_STATE_SCHEDULED,)
59
+ JOB_FINAL_STATES = (JOB_STATE_DONE, JOB_STATE_CANCELLED)
60
+
61
+ # Results
62
+ JOB_RESULT_NONE = "none"
63
+ JOB_RESULT_PASSED = "passed"
64
+ JOB_RESULT_SOFTFAILED = "softfailed"
65
+ JOB_RESULT_FAILED = "failed"
66
+ JOB_RESULT_INCOMPLETE = "incomplete"
67
+ JOB_RESULT_SKIPPED = "skipped"
68
+ JOB_RESULT_OBSOLETED = "obsoleted"
69
+ JOB_RESULT_PARALLEL_FAILED = "parallel_failed"
70
+ JOB_RESULT_PARALLEL_RESTARTED = "parallel_restarted"
71
+ JOB_RESULT_USER_CANCELLED = "user_cancelled"
72
+ JOB_RESULT_USER_RESTARTED = "user_restarted"
73
+ JOB_RESULT_TIMEOUT_EXCEEDED = "timeout_exceeded"
74
+
75
+ JOB_RESULTS = (
76
+ JOB_RESULT_NONE,
77
+ JOB_RESULT_PASSED,
78
+ JOB_RESULT_SOFTFAILED,
79
+ JOB_RESULT_FAILED,
80
+ JOB_RESULT_INCOMPLETE,
81
+ JOB_RESULT_SKIPPED,
82
+ JOB_RESULT_OBSOLETED,
83
+ JOB_RESULT_PARALLEL_FAILED,
84
+ JOB_RESULT_PARALLEL_RESTARTED,
85
+ JOB_RESULT_USER_CANCELLED,
86
+ JOB_RESULT_USER_RESTARTED,
87
+ JOB_RESULT_TIMEOUT_EXCEEDED,
88
+ )
89
+ JOB_COMPLETE_RESULTS = (JOB_RESULT_PASSED, JOB_RESULT_SOFTFAILED, JOB_RESULT_FAILED)
90
+ JOB_NOT_COMPLETE_RESULTS = (JOB_RESULT_INCOMPLETE, JOB_RESULT_TIMEOUT_EXCEEDED)
91
+ JOB_ABORTED_RESULTS = (
92
+ JOB_RESULT_SKIPPED,
93
+ JOB_RESULT_OBSOLETED,
94
+ JOB_RESULT_PARALLEL_FAILED,
95
+ JOB_RESULT_PARALLEL_RESTARTED,
96
+ JOB_RESULT_USER_CANCELLED,
97
+ JOB_RESULT_USER_RESTARTED,
98
+ )
99
+ JOB_NOT_OK_RESULTS = (
100
+ (JOB_RESULT_FAILED,) + JOB_NOT_COMPLETE_RESULTS + JOB_ABORTED_RESULTS
101
+ )
102
+ JOB_OK_RESULTS = (JOB_RESULT_PASSED, JOB_RESULT_SOFTFAILED)
103
+
104
+ # Scenarios
105
+ JOB_SCENARIO_KEYS = ("DISTRI", "VERSION", "FLAVOR", "ARCH", "TEST")
106
+ JOB_SCENARIO_WITH_MACHINE_KEYS = JOB_SCENARIO_KEYS + ("MACHINE",)
@@ -0,0 +1,38 @@
1
+ # This program is free software; you can redistribute it and/or modify
2
+ # it under the terms of the GNU General Public License as published by
3
+ # the Free Software Foundation, either version 2 of the License, or
4
+ # (at your option) any later version.
5
+ #
6
+ # This program is distributed in the hope that it will be useful,
7
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
8
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9
+ # GNU General Public License for more details.
10
+ #
11
+ # You should have received a copy of the GNU General Public License
12
+ # along with this program. If not, see <http://www.gnu.org/licenses/>.
13
+
14
+ """Exceptions for the openqa_async client library."""
15
+
16
+
17
+ class OpenQAClientError(Exception):
18
+ """Base class for all openqa_async client errors."""
19
+
20
+
21
+ class RequestError(OpenQAClientError):
22
+ """Error raised when a request fails (after retries). Stores the
23
+ request method, URL, the final HTTP status code, and the response
24
+ text.
25
+ """
26
+
27
+ def __init__(self, method: str, url: str, status_code: int, text: str) -> None:
28
+ super().__init__(method, url, status_code, text)
29
+ self.method = method
30
+ self.url = url
31
+ self.status_code = status_code
32
+ self.text = text
33
+
34
+
35
+ class ConnectionError(OpenQAClientError):
36
+ """Error raised when the server connection fails. Wraps the
37
+ underlying httpx transport error.
38
+ """
File without changes