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
|
%global _empty_manifest_terminate_build 0
Name: python-ntsbuildtools
Version: 4.0.7
Release: 1
Summary: CLI toolset that supports CICD processes.
License: MIT
URL: https://git.uoregon.edu/projects/ISN/repos/buildtools/browse
Source0: https://mirrors.aliyun.com/pypi/web/packages/52/d1/8823ae1b101a3447b988d512c83b866493517d1e93c877b7117b7d060d67/ntsbuildtools-4.0.7.tar.gz
BuildArch: noarch
%description
BuildTools is a collection of scripts that support the University of Oregon's Network and Telecom Services team (NTS)
continuous integration and deployment solutions. E.g. this solution is used in Jenkinsfile pipelines.
[](https://badge.fury.io/py/ntsbuildtools)
# Install BuildTools
BuildTools is packaged as `ntsbuildtools` and provided in the Python Package Index (PyPI).
So, simply use pip to install BuildTools.
pip install ntsbuildtools
# BuildTools Usage
With BuildTools installed, the `buildtools` CLI utility should now be available in your shell.
$ buildtools --version
BuildTools Version: 1.3.5
Below is an example of posting a comment onto an existing BitBucket Pull Request.
$ buildtools post bitbucket pr-comment \
--bitbucket-url https://git.uoregon.edu \
--user rleonar7 \
--password SuperSecretPassword \
--project ISN \
--repo buildtools \
--pull-request-id 2 \
--message "Hello, world! I am BuildTools!"
## BuildTools Capabilities
BuildTools has many capabilities. These capabilities are provided as subcommands.
To discover the subcommands available in your version of BuildTools, use the `--help` argument anywhere in the CLI.
> BuildTools capabilities can discovered much more easily when using tab completion -- **how to enable tab completion via `argcomplete` is discussed below.**
In the example below, we see how the `--help` flag informs us that the `buildtools post bitbucket pr-comment` command is available and how to run it!
$ buildtools --help
usage: buildtools [-h] [--version] [--bitbucket-url BITBUCKET_URL] {post,parse} ...
positional arguments:
{post,parse}
post Make an HTTP POST to a target.
parse Parse some input (typically from a file).
$ buildtools post --help
usage: buildtools post [-h] {bitbucket,teams,github} ...
positional arguments:
{bitbucket,teams,github}
bitbucket Target Bitbucket.
teams Target Microsoft Teams.
github Target GitHub.
$ buildtools post bitbucket --help
usage: buildtools post bitbucket [-h] {build-status,pr-comment} ...
positional arguments:
{build-status,pr-comment}
build-status Set the "Build Status" in Bitbucket for a particular git commit.
pr-comment Posts a comment to a Bitbucket pull request, with optional arguments for 'Jenkins build
annotations', indicating build status, encasing content in 'diff markdown', and more!
$ buildtools post bitbucket pr-comment --help
usage: buildtools post bitbucket pr-comment [-h] [--version] [--bitbucket-url BITBUCKET_URL]
(--message COMMENT_MESSAGE | --file COMMENT_FILE | --json JSON_OUTPUT | --json-file JSON_FILE)
--user USER --password PASSWORD --project PROJECT
--repo REPO --pull-request-id PULL_REQUEST_ID
[--diff-markdown]
[--code-markdown]
[--max-comment-size MAX_COMMENT_SIZE] [--tail TAIL]
[--build-annotation]
[--playbook-limit PLAYBOOK_LIMIT]
[--build-id BUILD_ID] [--build-url BUILD_URL]
[--build-status {SUCCESS,UNSTABLE,FAILURE,NOT_BUILD,ABORTED}]
optional arguments:
-h, --help show this help message and exit
--version show program's version number and exit
--bitbucket-url BITBUCKET_URL
URL for Bitbucket. [env var: BITBUCKET_URL]
--message COMMENT_MESSAGE, -m COMMENT_MESSAGE
Provide the comment as a message on the command line.
--file COMMENT_FILE, -f COMMENT_FILE
Provide the comment in a file.
--json JSON_OUTPUT, -j JSON_OUTPUT
Provide ansible JSON output as a message on the command line (which will
be parsed to extract build-status info). NOTE: Additional 'formatting'
arguments, such as '--code-markdown', are ignored when using json input.
--json-file JSON_FILE
Provide ansible JSON output as a file (which will be parsed to extract
build-status info). NOTE: Additional 'formatting' arguments, such as '--
code-markdown', are ignored when using json input.
--user USER Bitbucket user that will be used to authenticate to Bitbucket. [env var:
BITBUCKET_USER]
--password PASSWORD Bitbucket password (or Personal Access Token) for the Bitbucket user.
[env var: BITBUCKET_PASSWORD]
--project PROJECT The Bitbucket project key for the project where the pull request exists.
[env var: BITBUCKET_PROJECT]
--repo REPO The Bitbucket repository slug for the repository where the pull request
exists. [env var: BITBUCKET_REPO]
--pull-request-id PULL_REQUEST_ID
The ID of the Bitbucket pull request to be commented on. [env var: PR_ID]
formatting:
--diff-markdown Wrap the provided comment in diff markdown. E.g. ```diff \{comment\}) ```
--code-markdown Wrap the provided comment in code markdown. E.g. ``` \{comment\}) ```
--max-comment-size MAX_COMMENT_SIZE
Fragment the comment into based on the maximum comment size.
--trim TRIM Only print the last `TRIM` lines of the provided message/file.
### Tab Completion? Yes, please!
BuildTools works as a CLI by default, and can support tab completion via the [`argcomplete` module](https://kislyuk.github.io/argcomplete/).
$ buildtools (double press 'tab' to see possible commands)
--bitbucket-url --help --version -h parse post
$ buildtools post (double press 'tab')
--help -h bitbucket github teams
$ buildtools post bitbucket (double press 'tab')
--help -h build-status pr-comment
$ buildtools post bitbucket pr-comment
Unfortunately, this does not work 'out of the box' without doing some 'bash configuration.'
So, run the following commands to enable argcomplete in your bash session:
pip install argcomplete
eval "$(register-python-argcomplete buildtools)"
#### Tab Completion for *all* bash sessions
If you want `buildtools` tab completion to work for *all* your bash sessions, we just need to install argcomplete for your user and add a line to your `bashrc` file.
Install argcomplete to your Python user site-package:
deactivate # (if currently in a Python venv)
pip3 install --user argcomplete
Add the following to your `~/.bashrc`:
if [ -x "register-python-argcomplete" ] ; then
eval "$(register-python-argcomplete buildtools)"
fi
%package -n python3-ntsbuildtools
Summary: CLI toolset that supports CICD processes.
Provides: python-ntsbuildtools
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-ntsbuildtools
BuildTools is a collection of scripts that support the University of Oregon's Network and Telecom Services team (NTS)
continuous integration and deployment solutions. E.g. this solution is used in Jenkinsfile pipelines.
[](https://badge.fury.io/py/ntsbuildtools)
# Install BuildTools
BuildTools is packaged as `ntsbuildtools` and provided in the Python Package Index (PyPI).
So, simply use pip to install BuildTools.
pip install ntsbuildtools
# BuildTools Usage
With BuildTools installed, the `buildtools` CLI utility should now be available in your shell.
$ buildtools --version
BuildTools Version: 1.3.5
Below is an example of posting a comment onto an existing BitBucket Pull Request.
$ buildtools post bitbucket pr-comment \
--bitbucket-url https://git.uoregon.edu \
--user rleonar7 \
--password SuperSecretPassword \
--project ISN \
--repo buildtools \
--pull-request-id 2 \
--message "Hello, world! I am BuildTools!"
## BuildTools Capabilities
BuildTools has many capabilities. These capabilities are provided as subcommands.
To discover the subcommands available in your version of BuildTools, use the `--help` argument anywhere in the CLI.
> BuildTools capabilities can discovered much more easily when using tab completion -- **how to enable tab completion via `argcomplete` is discussed below.**
In the example below, we see how the `--help` flag informs us that the `buildtools post bitbucket pr-comment` command is available and how to run it!
$ buildtools --help
usage: buildtools [-h] [--version] [--bitbucket-url BITBUCKET_URL] {post,parse} ...
positional arguments:
{post,parse}
post Make an HTTP POST to a target.
parse Parse some input (typically from a file).
$ buildtools post --help
usage: buildtools post [-h] {bitbucket,teams,github} ...
positional arguments:
{bitbucket,teams,github}
bitbucket Target Bitbucket.
teams Target Microsoft Teams.
github Target GitHub.
$ buildtools post bitbucket --help
usage: buildtools post bitbucket [-h] {build-status,pr-comment} ...
positional arguments:
{build-status,pr-comment}
build-status Set the "Build Status" in Bitbucket for a particular git commit.
pr-comment Posts a comment to a Bitbucket pull request, with optional arguments for 'Jenkins build
annotations', indicating build status, encasing content in 'diff markdown', and more!
$ buildtools post bitbucket pr-comment --help
usage: buildtools post bitbucket pr-comment [-h] [--version] [--bitbucket-url BITBUCKET_URL]
(--message COMMENT_MESSAGE | --file COMMENT_FILE | --json JSON_OUTPUT | --json-file JSON_FILE)
--user USER --password PASSWORD --project PROJECT
--repo REPO --pull-request-id PULL_REQUEST_ID
[--diff-markdown]
[--code-markdown]
[--max-comment-size MAX_COMMENT_SIZE] [--tail TAIL]
[--build-annotation]
[--playbook-limit PLAYBOOK_LIMIT]
[--build-id BUILD_ID] [--build-url BUILD_URL]
[--build-status {SUCCESS,UNSTABLE,FAILURE,NOT_BUILD,ABORTED}]
optional arguments:
-h, --help show this help message and exit
--version show program's version number and exit
--bitbucket-url BITBUCKET_URL
URL for Bitbucket. [env var: BITBUCKET_URL]
--message COMMENT_MESSAGE, -m COMMENT_MESSAGE
Provide the comment as a message on the command line.
--file COMMENT_FILE, -f COMMENT_FILE
Provide the comment in a file.
--json JSON_OUTPUT, -j JSON_OUTPUT
Provide ansible JSON output as a message on the command line (which will
be parsed to extract build-status info). NOTE: Additional 'formatting'
arguments, such as '--code-markdown', are ignored when using json input.
--json-file JSON_FILE
Provide ansible JSON output as a file (which will be parsed to extract
build-status info). NOTE: Additional 'formatting' arguments, such as '--
code-markdown', are ignored when using json input.
--user USER Bitbucket user that will be used to authenticate to Bitbucket. [env var:
BITBUCKET_USER]
--password PASSWORD Bitbucket password (or Personal Access Token) for the Bitbucket user.
[env var: BITBUCKET_PASSWORD]
--project PROJECT The Bitbucket project key for the project where the pull request exists.
[env var: BITBUCKET_PROJECT]
--repo REPO The Bitbucket repository slug for the repository where the pull request
exists. [env var: BITBUCKET_REPO]
--pull-request-id PULL_REQUEST_ID
The ID of the Bitbucket pull request to be commented on. [env var: PR_ID]
formatting:
--diff-markdown Wrap the provided comment in diff markdown. E.g. ```diff \{comment\}) ```
--code-markdown Wrap the provided comment in code markdown. E.g. ``` \{comment\}) ```
--max-comment-size MAX_COMMENT_SIZE
Fragment the comment into based on the maximum comment size.
--trim TRIM Only print the last `TRIM` lines of the provided message/file.
### Tab Completion? Yes, please!
BuildTools works as a CLI by default, and can support tab completion via the [`argcomplete` module](https://kislyuk.github.io/argcomplete/).
$ buildtools (double press 'tab' to see possible commands)
--bitbucket-url --help --version -h parse post
$ buildtools post (double press 'tab')
--help -h bitbucket github teams
$ buildtools post bitbucket (double press 'tab')
--help -h build-status pr-comment
$ buildtools post bitbucket pr-comment
Unfortunately, this does not work 'out of the box' without doing some 'bash configuration.'
So, run the following commands to enable argcomplete in your bash session:
pip install argcomplete
eval "$(register-python-argcomplete buildtools)"
#### Tab Completion for *all* bash sessions
If you want `buildtools` tab completion to work for *all* your bash sessions, we just need to install argcomplete for your user and add a line to your `bashrc` file.
Install argcomplete to your Python user site-package:
deactivate # (if currently in a Python venv)
pip3 install --user argcomplete
Add the following to your `~/.bashrc`:
if [ -x "register-python-argcomplete" ] ; then
eval "$(register-python-argcomplete buildtools)"
fi
%package help
Summary: Development documents and examples for ntsbuildtools
Provides: python3-ntsbuildtools-doc
%description help
BuildTools is a collection of scripts that support the University of Oregon's Network and Telecom Services team (NTS)
continuous integration and deployment solutions. E.g. this solution is used in Jenkinsfile pipelines.
[](https://badge.fury.io/py/ntsbuildtools)
# Install BuildTools
BuildTools is packaged as `ntsbuildtools` and provided in the Python Package Index (PyPI).
So, simply use pip to install BuildTools.
pip install ntsbuildtools
# BuildTools Usage
With BuildTools installed, the `buildtools` CLI utility should now be available in your shell.
$ buildtools --version
BuildTools Version: 1.3.5
Below is an example of posting a comment onto an existing BitBucket Pull Request.
$ buildtools post bitbucket pr-comment \
--bitbucket-url https://git.uoregon.edu \
--user rleonar7 \
--password SuperSecretPassword \
--project ISN \
--repo buildtools \
--pull-request-id 2 \
--message "Hello, world! I am BuildTools!"
## BuildTools Capabilities
BuildTools has many capabilities. These capabilities are provided as subcommands.
To discover the subcommands available in your version of BuildTools, use the `--help` argument anywhere in the CLI.
> BuildTools capabilities can discovered much more easily when using tab completion -- **how to enable tab completion via `argcomplete` is discussed below.**
In the example below, we see how the `--help` flag informs us that the `buildtools post bitbucket pr-comment` command is available and how to run it!
$ buildtools --help
usage: buildtools [-h] [--version] [--bitbucket-url BITBUCKET_URL] {post,parse} ...
positional arguments:
{post,parse}
post Make an HTTP POST to a target.
parse Parse some input (typically from a file).
$ buildtools post --help
usage: buildtools post [-h] {bitbucket,teams,github} ...
positional arguments:
{bitbucket,teams,github}
bitbucket Target Bitbucket.
teams Target Microsoft Teams.
github Target GitHub.
$ buildtools post bitbucket --help
usage: buildtools post bitbucket [-h] {build-status,pr-comment} ...
positional arguments:
{build-status,pr-comment}
build-status Set the "Build Status" in Bitbucket for a particular git commit.
pr-comment Posts a comment to a Bitbucket pull request, with optional arguments for 'Jenkins build
annotations', indicating build status, encasing content in 'diff markdown', and more!
$ buildtools post bitbucket pr-comment --help
usage: buildtools post bitbucket pr-comment [-h] [--version] [--bitbucket-url BITBUCKET_URL]
(--message COMMENT_MESSAGE | --file COMMENT_FILE | --json JSON_OUTPUT | --json-file JSON_FILE)
--user USER --password PASSWORD --project PROJECT
--repo REPO --pull-request-id PULL_REQUEST_ID
[--diff-markdown]
[--code-markdown]
[--max-comment-size MAX_COMMENT_SIZE] [--tail TAIL]
[--build-annotation]
[--playbook-limit PLAYBOOK_LIMIT]
[--build-id BUILD_ID] [--build-url BUILD_URL]
[--build-status {SUCCESS,UNSTABLE,FAILURE,NOT_BUILD,ABORTED}]
optional arguments:
-h, --help show this help message and exit
--version show program's version number and exit
--bitbucket-url BITBUCKET_URL
URL for Bitbucket. [env var: BITBUCKET_URL]
--message COMMENT_MESSAGE, -m COMMENT_MESSAGE
Provide the comment as a message on the command line.
--file COMMENT_FILE, -f COMMENT_FILE
Provide the comment in a file.
--json JSON_OUTPUT, -j JSON_OUTPUT
Provide ansible JSON output as a message on the command line (which will
be parsed to extract build-status info). NOTE: Additional 'formatting'
arguments, such as '--code-markdown', are ignored when using json input.
--json-file JSON_FILE
Provide ansible JSON output as a file (which will be parsed to extract
build-status info). NOTE: Additional 'formatting' arguments, such as '--
code-markdown', are ignored when using json input.
--user USER Bitbucket user that will be used to authenticate to Bitbucket. [env var:
BITBUCKET_USER]
--password PASSWORD Bitbucket password (or Personal Access Token) for the Bitbucket user.
[env var: BITBUCKET_PASSWORD]
--project PROJECT The Bitbucket project key for the project where the pull request exists.
[env var: BITBUCKET_PROJECT]
--repo REPO The Bitbucket repository slug for the repository where the pull request
exists. [env var: BITBUCKET_REPO]
--pull-request-id PULL_REQUEST_ID
The ID of the Bitbucket pull request to be commented on. [env var: PR_ID]
formatting:
--diff-markdown Wrap the provided comment in diff markdown. E.g. ```diff \{comment\}) ```
--code-markdown Wrap the provided comment in code markdown. E.g. ``` \{comment\}) ```
--max-comment-size MAX_COMMENT_SIZE
Fragment the comment into based on the maximum comment size.
--trim TRIM Only print the last `TRIM` lines of the provided message/file.
### Tab Completion? Yes, please!
BuildTools works as a CLI by default, and can support tab completion via the [`argcomplete` module](https://kislyuk.github.io/argcomplete/).
$ buildtools (double press 'tab' to see possible commands)
--bitbucket-url --help --version -h parse post
$ buildtools post (double press 'tab')
--help -h bitbucket github teams
$ buildtools post bitbucket (double press 'tab')
--help -h build-status pr-comment
$ buildtools post bitbucket pr-comment
Unfortunately, this does not work 'out of the box' without doing some 'bash configuration.'
So, run the following commands to enable argcomplete in your bash session:
pip install argcomplete
eval "$(register-python-argcomplete buildtools)"
#### Tab Completion for *all* bash sessions
If you want `buildtools` tab completion to work for *all* your bash sessions, we just need to install argcomplete for your user and add a line to your `bashrc` file.
Install argcomplete to your Python user site-package:
deactivate # (if currently in a Python venv)
pip3 install --user argcomplete
Add the following to your `~/.bashrc`:
if [ -x "register-python-argcomplete" ] ; then
eval "$(register-python-argcomplete buildtools)"
fi
%prep
%autosetup -n ntsbuildtools-4.0.7
%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-ntsbuildtools -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 4.0.7-1
- Package Spec generated
|
