pbelskiy / ujenkins Goto Github PK

The get method only seems to retrieve top layer jobs and does not seem to recurse into the folders.

JenkinsClient class can have retry parameter. But passing it causes errors. I suspect it may be due to urllib3 Retry class renaming method_whitelist to allowed_methods. Renaming it locally seems to fix the problem.

ujenkins==0.10.0
urllib3==2.0.3
python3.10.7

Hi,

like I already mentioned here, when trying to install the package from source on Windows, it gives the following error.

UnicodeDecodeError: 'charmap' codec can't decode byte 0x81 in position 738: character maps to <undefined>

I had to add the encoding in setup.py in line 18 to fix this.

...
with open('README.rst', encoding='utf-8') as readme_file:
...

And use f-strings

When using user\password pair instead of recommended token, something strange happens:

If http://localhost:8080 is using it ok
if http://127.0.0.0:8080 leads 403

Or need to make paths shorter like get_info() instead of Build.get_info()

Some of my console log output is 14mb per job. I want to be able to incrementally load the console output live.
My particular use-case, I am writing the stream to redis via a celery eventlet.

I think the feature would also be useful for running groovy scripts written locally via the api, similar to the VSCode plugin https://marketplace.visualstudio.com/items?itemName=tabeyti.jenkins-jack which I find very useful.

I was successful in replicating the same api calls one would see in the console output.

I had to create a new endpoint get_output_logtext to set a different content type and make it a POST, and I had to create a new callback that exposed the response headers as they are used to determine if there is more data coming, and the next index to ask for.

In the example below I use the branch to do a loop and create an async generator. I don't know how much you want to include so I tried to keep it as simple as possible.

If you are interested in this feature could you please guide me on how I should be refactoring it so that I could make the PR?

39c0f0e

example:

from ujenkins import AsyncJenkinsClient #this is GeneMyslinsky/ujenkins/streaming
from tm_auth.settings import settings
import nest_asyncio, asyncio
nest_asyncio.apply()

async def start_job(job_location, parameters=None):
    jenkins = AsyncJenkinsClient(settings['JENKINS_URL'], settings['JENKINS_USER'], settings['JENKINS_PASS'])
    args = {}
    if parameters: args = parameters

    queue = await jenkins.builds.start(job_location, parameters=args)
    qinfo = await jenkins.queue.get_info(queue)


    if qinfo['executable'] and qinfo['executable']['number']:
        number, url = qinfo['executable']['number'], qinfo['executable']['url']
    else:
        raise Exception("Job did not start")

    tries = 0
    while (tries := tries + 1) < 10:
        job = await jenkins.builds.get_info(job_location, number)
        if job['building']:
            break
        else:
            await asyncio.sleep(1)
    
    async for output in stream_job(job_location, number):
        print(output)
        
async def stream_job(path, number, poll_text=5):

    start = 0
    while True:
        output, headers = await jenkins.builds.get_output_logtext(path, number, start)
        yield output
        if headers.get('X-More-Data') == 'true':
            start = headers['X-Text-Size']
        else:
            break

        await asyncio.sleep(poll_text)

When running the sync Jenkins version example (https://github.com/pbelskiy/ujenkins#usage) I get the following errror. What am i doing wrong?

Traceback (most recent call last):
  File "/root/test.py", line 8, in <module>
    example()
  File "/root/test.py", line 5, in example
    version = client.system.get_version()
  File "/usr/local/lib/python3.9/dist-packages/ujenkins/endpoints/system.py", line 40, in get_version
    return self.jenkins._request('GET', '/', callback=callback)
  File "/usr/local/lib/python3.9/dist-packages/ujenkins/adapters/sync.py", line 173, in _request
    self.crumb = self._get_crumb()
  File "/usr/local/lib/python3.9/dist-packages/ujenkins/adapters/sync.py", line 152, in _get_crumb
    self.crumb = {response['crumbRequestField']: response['crumb']}
TypeError: string indices must be integers

There is no information listed under the "API endpoints" section on Read the Docs.

When I ran a Sphinx build in my local environment, the descriptions were generated as intended.

Could it be that the build on Read the Docs is failing?
Thank you for checking into this matter.

Is it possible somehow download job artifacts besides switching to aiohttp and doing downloads outside of ujenkins module?
If not would it be possible to create new function to download these artifacts, similar to getting console output?

add proxy parameter to client init

https://urllib3.readthedocs.io/en/stable/reference/urllib3.util.html?highlight=method_whitelist

method_whitelist is deprecated

It duplicated for PR and push

Hello, Petr!
Are there any plans to build a new release with build.get() new args support?
Because I really need it :)
I would be very grateful for that.

POST /jenkins/computer/xxx/launchSlaveAgent

Can ujenkins better support return types(mostly for async staff)? When I use AsyncJenkinsClient and call for example hw_jenkins.builds.get_artifact() the return type is Bytes so when I await for that then pyright will return error: "bytes" is not awaitable (reportGeneralTypeIssues). To resolve these issues it is required to do casting on each function call cast(Awaitable[bytes], hw_jenkins.builds.get_artifact()).