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
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
|
%global _empty_manifest_terminate_build 0
Name: python-jenkins-lockable-resources
Version: 1.1.0
Release: 1
Summary: A Python API for accessing lockable resources from Jenkins lockable-resources plugin.
License: MIT
URL: https://gitlab.com/alexandre-perrin1/jenkins-lockable-resources
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/ac/a4/2061714e9566c98cfa225eda1241dc844f6e35ad8f59c7efefc046b7d90d/jenkins-lockable-resources-1.1.0.tar.gz
BuildArch: noarch
%description
# Jenkins Lockable Resources Plugin Library
[](https://gitlab.com/alexandre-perrin1/jenkins-lockable-resources/-/commits/master)
[](https://codecov.io/gl/alexandre-perrin1/jenkins-lockable-resources/branch/master)
## About the library
This library and CLI utility was developped to access and control
[Jenkins Lockable-Resources plugin](https://plugins.jenkins.io/lockable-resources/)
because the current version of the plugin does not provide REST APIs.
## Prerequisite
As versions of python prior 3.6 are on their way to be deprecated, this tool was designed for
python 3.6 and onwards.
The command line interface has been written with [`click`](https://click.palletsprojects.com/).
An optionnal [`click-completion`](https://github.com/click-contrib/click-completion)
package can also be installed in order to give shell completion feature.
## Install
The tool may be installed from sources with pip package manager from PyPi.
```
pip3 install jenkins-lockable-resources
```
## Example
The command line interface provides simple commands to show current status of
resources and to reserve or release resources.
Basic usage will prompt for username and API token.
```
lockable-resources --jenkins-url <your jenkins server url> <command>
Jenkins user: <your jenkins user name>
Jenkins token:
...
```
All CLI options can be configured in a configuration file or by environment variables
named after the option name in uppercase.
> **Warning:**
>
> Be aware that storing credentials in clear is not safe.
**With configuration file:**
Create a `.lockable-resources.yml` local file or `~/.lockable-resources` user file and add the options:
```
jenkins_url: <your jenkins server url>
jenkins_user: <your jenkins user>
jenkins_token: <your jenkins api token>
```
**Environment variables:**
Example with a `.env` file:
```
JENKINS_URL=<your jenkins server url>
JENKINS_USER=<your jenkins user>
JENKINS_TOKEN=<your jenkins api token>
```
Then source the environment before running the command
```
source .env && lockable-resources <COMMAND>
```
### List resources
`list` command list all registered resources on jenkins lockable resources plugin.
### Get current resources info
`info` command list all the known information about the resources.
```
lockable-resources info
Resource1: FREE
Resource2: RESERVED by mr.bean@gmail.com
Resource3: RESERVED by mcgiver@gmail.com
Resource4: LOCKED by Nightly
...
```
### Reserve/Unreserve a resource
`reserve` command reserves a resource for your user name only.
`unreserve` command releases the resource you own.
```
lockable-resources reserve
Reserved Resource1
lockable-resources unreserve
Unreserved Resource1
```
### Listing what resources a user owns
`owned` command finds the current resource(s) reserved by a user (default to your user).
**Find the resource(s) you own**
```
lockable-resources owned
Resource1
```
**Find the resource(s) a user owns**
```
lockable-resources owned --user mcgiver@gmail.com
Resource3
```
## Testing
This package is tested using `pytest` framework. See `requirements-test.txt` for the
list of required packages.
Install requirements for testing:
```
pip3 install -r requirements-test.txt
```
The tests are held in `tests` directory.
Simply execute pytest from command line:
```
pytest tests
```
## Development
For development, install as editable:
```
pip3 install -e .
```
## License
The MIT License (MIT): Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
%package -n python3-jenkins-lockable-resources
Summary: A Python API for accessing lockable resources from Jenkins lockable-resources plugin.
Provides: python-jenkins-lockable-resources
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-jenkins-lockable-resources
# Jenkins Lockable Resources Plugin Library
[](https://gitlab.com/alexandre-perrin1/jenkins-lockable-resources/-/commits/master)
[](https://codecov.io/gl/alexandre-perrin1/jenkins-lockable-resources/branch/master)
## About the library
This library and CLI utility was developped to access and control
[Jenkins Lockable-Resources plugin](https://plugins.jenkins.io/lockable-resources/)
because the current version of the plugin does not provide REST APIs.
## Prerequisite
As versions of python prior 3.6 are on their way to be deprecated, this tool was designed for
python 3.6 and onwards.
The command line interface has been written with [`click`](https://click.palletsprojects.com/).
An optionnal [`click-completion`](https://github.com/click-contrib/click-completion)
package can also be installed in order to give shell completion feature.
## Install
The tool may be installed from sources with pip package manager from PyPi.
```
pip3 install jenkins-lockable-resources
```
## Example
The command line interface provides simple commands to show current status of
resources and to reserve or release resources.
Basic usage will prompt for username and API token.
```
lockable-resources --jenkins-url <your jenkins server url> <command>
Jenkins user: <your jenkins user name>
Jenkins token:
...
```
All CLI options can be configured in a configuration file or by environment variables
named after the option name in uppercase.
> **Warning:**
>
> Be aware that storing credentials in clear is not safe.
**With configuration file:**
Create a `.lockable-resources.yml` local file or `~/.lockable-resources` user file and add the options:
```
jenkins_url: <your jenkins server url>
jenkins_user: <your jenkins user>
jenkins_token: <your jenkins api token>
```
**Environment variables:**
Example with a `.env` file:
```
JENKINS_URL=<your jenkins server url>
JENKINS_USER=<your jenkins user>
JENKINS_TOKEN=<your jenkins api token>
```
Then source the environment before running the command
```
source .env && lockable-resources <COMMAND>
```
### List resources
`list` command list all registered resources on jenkins lockable resources plugin.
### Get current resources info
`info` command list all the known information about the resources.
```
lockable-resources info
Resource1: FREE
Resource2: RESERVED by mr.bean@gmail.com
Resource3: RESERVED by mcgiver@gmail.com
Resource4: LOCKED by Nightly
...
```
### Reserve/Unreserve a resource
`reserve` command reserves a resource for your user name only.
`unreserve` command releases the resource you own.
```
lockable-resources reserve
Reserved Resource1
lockable-resources unreserve
Unreserved Resource1
```
### Listing what resources a user owns
`owned` command finds the current resource(s) reserved by a user (default to your user).
**Find the resource(s) you own**
```
lockable-resources owned
Resource1
```
**Find the resource(s) a user owns**
```
lockable-resources owned --user mcgiver@gmail.com
Resource3
```
## Testing
This package is tested using `pytest` framework. See `requirements-test.txt` for the
list of required packages.
Install requirements for testing:
```
pip3 install -r requirements-test.txt
```
The tests are held in `tests` directory.
Simply execute pytest from command line:
```
pytest tests
```
## Development
For development, install as editable:
```
pip3 install -e .
```
## License
The MIT License (MIT): Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
%package help
Summary: Development documents and examples for jenkins-lockable-resources
Provides: python3-jenkins-lockable-resources-doc
%description help
# Jenkins Lockable Resources Plugin Library
[](https://gitlab.com/alexandre-perrin1/jenkins-lockable-resources/-/commits/master)
[](https://codecov.io/gl/alexandre-perrin1/jenkins-lockable-resources/branch/master)
## About the library
This library and CLI utility was developped to access and control
[Jenkins Lockable-Resources plugin](https://plugins.jenkins.io/lockable-resources/)
because the current version of the plugin does not provide REST APIs.
## Prerequisite
As versions of python prior 3.6 are on their way to be deprecated, this tool was designed for
python 3.6 and onwards.
The command line interface has been written with [`click`](https://click.palletsprojects.com/).
An optionnal [`click-completion`](https://github.com/click-contrib/click-completion)
package can also be installed in order to give shell completion feature.
## Install
The tool may be installed from sources with pip package manager from PyPi.
```
pip3 install jenkins-lockable-resources
```
## Example
The command line interface provides simple commands to show current status of
resources and to reserve or release resources.
Basic usage will prompt for username and API token.
```
lockable-resources --jenkins-url <your jenkins server url> <command>
Jenkins user: <your jenkins user name>
Jenkins token:
...
```
All CLI options can be configured in a configuration file or by environment variables
named after the option name in uppercase.
> **Warning:**
>
> Be aware that storing credentials in clear is not safe.
**With configuration file:**
Create a `.lockable-resources.yml` local file or `~/.lockable-resources` user file and add the options:
```
jenkins_url: <your jenkins server url>
jenkins_user: <your jenkins user>
jenkins_token: <your jenkins api token>
```
**Environment variables:**
Example with a `.env` file:
```
JENKINS_URL=<your jenkins server url>
JENKINS_USER=<your jenkins user>
JENKINS_TOKEN=<your jenkins api token>
```
Then source the environment before running the command
```
source .env && lockable-resources <COMMAND>
```
### List resources
`list` command list all registered resources on jenkins lockable resources plugin.
### Get current resources info
`info` command list all the known information about the resources.
```
lockable-resources info
Resource1: FREE
Resource2: RESERVED by mr.bean@gmail.com
Resource3: RESERVED by mcgiver@gmail.com
Resource4: LOCKED by Nightly
...
```
### Reserve/Unreserve a resource
`reserve` command reserves a resource for your user name only.
`unreserve` command releases the resource you own.
```
lockable-resources reserve
Reserved Resource1
lockable-resources unreserve
Unreserved Resource1
```
### Listing what resources a user owns
`owned` command finds the current resource(s) reserved by a user (default to your user).
**Find the resource(s) you own**
```
lockable-resources owned
Resource1
```
**Find the resource(s) a user owns**
```
lockable-resources owned --user mcgiver@gmail.com
Resource3
```
## Testing
This package is tested using `pytest` framework. See `requirements-test.txt` for the
list of required packages.
Install requirements for testing:
```
pip3 install -r requirements-test.txt
```
The tests are held in `tests` directory.
Simply execute pytest from command line:
```
pytest tests
```
## Development
For development, install as editable:
```
pip3 install -e .
```
## License
The MIT License (MIT): Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
%prep
%autosetup -n jenkins-lockable-resources-1.1.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-jenkins-lockable-resources -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 1.1.0-1
- Package Spec generated
|
