Otherwise you get errors like:
Traceback (most recent call last):
File "path/bin/jenkins-jobs", line 8, in <module>
sys.exit(main())
^^^^^^
File "path/lib64/python3.12/site-packages/jenkins_jobs/cli/entry.py", line 179, in main
jjb.execute()
File "path/lib64/python3.12/site-packages/jenkins_jobs/cli/entry.py", line 158, in execute
ext.obj.execute(self.options, self.jjb_config)
File "path/lib64/python3.12/site-packages/jenkins_jobs/cli/subcommand/update.py", line 154, in execute
n = builder.delete_old_managed_views(keep=keep_views)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "path/lib64/python3.12/site-packages/jenkins_jobs/builder.py", line 402, in delete_old_managed_views
if view["name"] not in keep and self.is_view(view["name"], use_cache=False):
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "path/lib64/python3.12/site-packages/jenkins_jobs/builder.py", line 384, in is_view
return self.jenkins.view_exists(view_name)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "path/lib64/python3.12/site-packages/jenkins/__init__.py", line 1857, in view_exists
if self.get_view_name(name) == name:
^^^^^^^^^^^^^^^^^^^^^^^^
File "path/lib64/python3.12/site-packages/jenkins/__init__.py", line 1834, in get_view_name
raise JenkinsException(
jenkins.JenkinsException: Jenkins returned an unexpected view name All (expected: all)
Fixes: a8f0d8cfda832c700cf4ca744d07acff3afc5f04
Change-Id: I82b5abd8429190e871e432732d502b0640ebc99b
Signed-off-by: Evgeni Golov <evgeni@golov.de>
The Python world, including the `setuptools` package, has migrated to
the versioning scheme defined in PEP 440. Unfortunately, the versioning
of Jenkins plugins is less strict than that. As a consequence,
`pkg_resources.parse_version()` now rejects versions as invalid.
Fix `PluginVersion` by salvaging the implementation of the old
`LegacyVersion` class, which used to be part of the `packaging` library
prior to version 22.0. The code is licensed under a 2-clause BSD
licence.
For compatibility with older Python versions, remove type annotations
from the copied code.
Change-Id: Iaa057dcd81620fed861cb11bed534ff7f9ab3f32
Signed-off-by: Christoph Erhardt <ce+ubuntuone@sicherha.de>
new function get_build_artifact_as_bytes to replace get_build_artifact (incompatible with artifacts not json-formatted)
+ use a stream to download binary artifacts
all artifacts are returned as bytes to avoid encoding issues
and an exception NotFoundException is raised in case of missing artifact
Closes-Bug: #1973243
Change-Id: I24ce4ecd854f8a19ed4d760404adb7d1ac6b5509
Jenkins version 2.387.1 or earlier can return 'all' as view name
when requested is 'All'. Add workaround for that.
Change-Id: I6b5327a5f969607ca4838a13bbac838f44e76ccb
urllib3 1.x used to accept socket._GLOBAL_DEFAULT_TIMEOUT as a sentinal
object to mean "no configured timeout".
In urllib3 2.x, urllib3 uses its own _DEFAULT_TIMEOUT sentinal object,
and it rejects socket._GLOBAL_DEFAULT_TIMEOUT.
Assign our own DEFAULT_TIMEOUT constant to the newer object if it
exists, and fall back to the old behavior on old urllib3 versions.
Co-authored-by: Vsevolod Fedorov <vsevolod.fedorov@gmail.com>
Closes-Bug: #2018567
Change-Id: Ic626ba0e8ed79eec3a63ffab6cc02f91aa545ab1
Use full job name in `get_job_info_regex` instead of just the name, so
that matches will work in folders as well.
Closes-Bug: 1685575
Change-Id: I97ba8ca004387b376a511ba52fc9fdd2aeb98a63
When retreiving data from builds, the build number can have a string portion.
This is for matrix jobs that define a label to retrieve one sub-build of the
matrix job.
The URL structure is:
https://<jenkins_server>/job/>job_name>/<number>/label=<configuration>/
Allowing a string for build number allows for it to be specifed as, e.g.:
1/label=amd64
And whilst being somewhat a workaround, works without introducing complexity
and modifying function calls for extra parameters.
Change-Id: Ic409df6e20e85d6a417c6490472b3729f1f20cd2
Enable calls to retreive artifacts from Jenkins and also to pull
the stages data from the wfapi endpoint.
Change-Id: I59eb403d54416ed45a918d98fc2f43c3c02441d0
Pipeline jobs in in Jenkins 2.x appear as placeholder tasks for their
entire lifetime when queried via the API. The fix for #1659787
introduced completly ignoring placeholder tasks. Thus pipeline jobs are
never included in the list returned by get_running_builds.
This commit will change the behaviour of get_running_builds as follows:
- Placeholder tasks will be included: So running pipeline jobs
will be included.
- Builds which do not have a build number yet will be ignored:
This prevents the exception described in #1659787.
Change-Id: I30351ec78d6186b0674e3c08be00076b0ce2333e
Closes-Bug: #1750372
Related-Bug: #1659787
Previously, reconfig_credential() passed empty `data` with
`Content-Length: 0` to the credentials configuration rather
than the credentials data.
This patch fixes the issue by passing the config_xml data to
the configuration API to properly update the credential.
Change-Id: Idef50f5a31d55991698b6217f55f15a9308b8526
Make sure to use fullName from the API results to correctly
compute the URL for the additional API request.
Change-Id: I7ca1f2e15a6c40883ba376b182c2c991ca76e8b2
Closes-Bug:#1828051
Other specific requests may need a body. Thus remove the general check
for an empty body and add a more specific one where needed.
I noticed this because when updating a Jenkins job with Jenkins Job
Builder I got an EmptyResponseException even though updating worked
correctly.
Change-Id: Ie144e6fb0b922a681e6c65ffbe5120da72a495f0
On our Jenkins instance with almost a hundred folders, JJB update
stalls for quite a while because it calls get_all_jobs. When invoked
locally at the Jenkins master, it's a matter of seconds, on a fast
broadband link and VPN, it's 2 minutes, and on a train it's easily 10
minutes.
But there's trick!
curl \
--show-error --silent --fail \
--user : --negotiate \
--get \
--data-urlencode \
tree=jobs\[url\,name\,jobs\[url\,name\,jobs\[url\,name\,\
jobs\[url\,name\,jobs\[url\,name\,jobs\[url\,name\,\
jobs\[url\,name\,jobs\[url\,name\,jobs\[url\,name\,\
jobs\[url\,name\,jobs\]\]\]\]\]\]\]\]\]\]
https://jenkins.example.com/api/json
This returns almost instantly.
And it gets better: if we fail to correctly guess the nesting level
necessary, Jenkins returns
…, "jobs": [{}, {}, …], …
so we can easily detect that we need to recurse deeper.
Change-Id: I7268259149e4bc8939c512a112c7e6ec1908224f
Avoid repeatedly serializing and splitting the root path component of
jobs being added to the list to be processed and returned.
Attempting to split a string path using 'job' introduces a bug if a job
ever happens to also use the name 'job' as part of its name. This could
be fixed by using root.split('/job/') but it still seems hackish.
Maintain the root path to the folder in the hierarchy as a list of path
components, add to it when descending and store the result of joining
it with '/job/' as a separate variable to avoid needing to re-parse.
Change-Id: I074ad74ad935c50716141a79822ca84999734c3f
In some network setups Jenkins may be hidden behind complex reverse
proxy setups that require additional custom headers to be set on
each request in order to pass them trough
Allow providing such headers using JENKINS_API_EXTRA_HEADERS environment
variable
Change-Id: If071c5c707f916ba5f4f2c371ec600b7476bf723
HTTP specification states clearly that HEAD requests
should have no body, so we should not fail on these.
Change-Id: I9d2418f26c26b2a40f6bafaf86ed6640fbf83b0c
This, I think, would've caused get_all_jobs to loop indefinitely if the
Jenkins instance has folders. Am I really the first to have caught this?
Change-Id: I4158b0d068135de08a3337486d8a4b41d8b7cda6
Detects if API url is redirected and corrects it in order
to avoid doubling number of requests and even failing
POST ones because of having them silently converted by
requests from POST to GET.
Displays a warning to the user when redirection occurs
because almost always this means that they are using an
old endpoint, like a non secured one.
Change-Id: I7387bf150dad307342f9a6a91afbae32859bc82e
Signed-off-by: Sorin Sbarnea <ssbarnea@redhat.com>
Existing code assumes the script sent by the user is terminated with a newline.
Appending magic string without '\n' before print() command results in a syntactically
incorrect Groovy code.
This patch ensures that '\n' is added between user's provided script and appended
magic string.
Change-Id: I39021f1058e7434d487efb4bc7aca18416b2c08e
If the keep_alive is not available because of using reverse
proxy, the header 'Content-Lenght' may not be available,
causing the exception:
Error communicating with server[...]: empty response
However, if 'Location' header is present, the response is valid.
Add unit tests:
- build_job must pass even if no 'content-lenght'
in response header
- build_job must fail if no 'location' in response header
Change-Id: I4da6dd19f9d8302a76652a3686a9377f9a2503a6
Closes-Bug:#1775047
Resolve regression caused by I5369a0d35be4bf8b3b197a51e60aba21b5742cc7
preventing run_scripts() from successfully running against the remote
Jenkins instance.
Switching data to a dictionary and passing the script string without
quote() appears to allow the script to successfully run.
Add a magic string ')]}.' as an indicator of if the groovy script
successfully passed or failed. In theory if the groovy script failed
perhaps due to syntax error or some other reason the magic string
will not be printed and we can assume failure.
Change-Id: Ibaffb768ea82c76b44ec5a6cccde8563afe1783f
Signed-off-by: Thanh Ha <zxiiro@linux.com>
Timeouts are different to auth failures, make sure to re-raise them
while attempting multiple authentications.
Change-Id: I56c9580be9a90f5cda7349a148d467e6ff4e9270
Some API endpoints require the use of a filter or they will respond
with HTTP error code 418 I'm a teapot.
This was seen on CloudBees Jenkins Enterprise 2.107.2.1-rolling.
Adding a depth filter will ensure the API calls will succeed.
Change-Id: Ib4d6a251bf3a024a76081b2fc83baa7839ad4015
If tests results are added to builds, or environment variables are injected
into a job, there are separate API calls to retrieve that data. Add functions
to do so.
Change-Id: Ie0a51839d527db6d440719eeb44cd1cc89644d06
Account for situations where no Content-Length or Transfer-Encoding
headers are present in a response.
The length of the response.content could still indicate a response was
given. The earlier raise_for_status() should catch bad HTTP responses
that return content.
Closes-bug: #1766660
Change-Id: I6739e26a039a898982f5cdc96d19d6992ed37737
