shijl0925 / python-sonarqube-api Goto Github PK

After update to the latest version(1.3.2) getting an error when calling command:
sonar.alm_settings.get_binding(project_key)
Stack trace:

Traceback (most recent call last):
  File "main.py", line 19, in <module>
    alm = sonar.alm_settings.get_binding(project_key)
  File "~/.local/lib/python3.10/site-packages/sonarqube/utils/common.py", line 132, in inner_func
    response = self._get(url_pattern, params=params)
  File "~/.local/lib/python3.10/site-packages/sonarqube/utils/rest_client.py", line 141, in _get
    return self.request("GET", path=path, params=params, data=data, headers=headers)
  File "~/.local/lib/python3.10/site-packages/sonarqube/utils/rest_client.py", line 79, in request
    raise ValidationError(msg)
sonarqube.utils.exceptions.ValidationError: Error in request. Possibly validation error [400]: The 'project' parameter is missing

Downgrading package to 1.3.1 and running works as expected. Believe the problem is with added payload: sonarqube/utils/common.py

Hello @shijl-0925 👋

Thank you for the great work! It is a handy python library to deal with Sonar's api.

I would like to raise an issue I noticed: for some api, there the field organisation is required, and there is no way to pass it.
For example:
https://sonarcloud.io/web_api/api/rules/tags?query=rules

GET api/rules/tags

>>> list(sonar.rules.get_rule(rule_key=rule))
sonarqube.exceptions.ValidationError: Error in request. Possibly validation error [400]: The 'organization' parameter is missing

and some, even though documentation says "optional" it is still needed, like in GET api/rules/search:

>>> list(sonar.rules.search_rules(q=rule))
sonarqube.exceptions.ValidationError: Error in request. Possibly validation error [400]: The 'organization' parameter is missing

Besides adding the missing parameters, maybe it's possible to allow extra ones? or add organization as part of session?

Thank you very much!

我想统计不同严重程度 Issue 的个数，但是您的代码里好像只读取了issue列表，没有将其它返回值拿出来，能否增加一下该功能呢？

This snippet:

from sonarqube import SonarCloudClient

token = "..."
sonar = SonarCloudClient(sonarcloud_url="https://sonarcloud.io", token=token)
issues = sonar.issues.search_issues(componentKeys="...")
for issue in issues:
    print(f"key: {issue['key']}")
    print(f"rule: {sonar.rules.get_rule(issue['rule'])}")

Generate:

key: AXxbH--R-dDKUnsQv6k7
Traceback (most recent call last):
  File "/home/damien/python-sonarqube-api/test_cloud.py", line 8, in <module>
    print(f"rule: {sonar.rules.get_rule(issue['rule'])}")
  File "/home/damien/python-sonarqube-api/sonarqube/utils/common.py", line 132, in inner_func
    response = self._get(url_pattern, params=params)
  File "/home/damien/python-sonarqube-api/sonarqube/utils/rest_client.py", line 144, in _get
    return self.request("GET", path=path, params=params, data=data, headers=headers)
  File "/home/damien/python-sonarqube-api/sonarqube/utils/rest_client.py", line 82, in request
    raise ValidationError(msg)
sonarqube.utils.exceptions.ValidationError: Error in request. Possibly validation error [400]: The 'organization' parameter is missing

It's written in the documentation that create_project() method exist in projects.create_project() but it's not there in the code

I'm trying to connect to a SQ server 9.6 via SSL and I'm receiving an error:

HTTPSConnectionPool(host='company.name.com', port=443): Max retries exceeded with url: /sonar/api/server/version (Caused by SSLError(SSLError(9, '[SSL] PEM lib (_ssl.c:4065)')))

The code I'm using is:

`URL = 'https://company.name.com/sonar'
USERNAME = 'admin'
PASSWORD = 'admin'
CERT = 'company.name.com.pem'

cert_path = Path(CERT)

if cert_path.is_file():
sonar = SonarQubeClient(sonarqube_url=URL, username=USERNAME, password=PASSWORD, cert=CERT)
version = sonar.server.get_server_version()
print(version)`

If I try the same api request using a curl command, it works. Is there any chance getting SSL working with this API

Hi, after using the answer to my first issue I successfully collected instant data, but when I tried to return the historical data it returned me nothing, except for the dates.

Illustrating what I did:

sonarqube.measures.search_measures_history('key:path', branch = 'master', fields = "metrics", metrics = 'code_smells')

[{'metric': 'code_smells', 'history': [{'date': '2021-10-06T17:29:17+0000'}, {'date': '2021-11-19T13:25:36+0000'}, {'date': '2021-12-31T21:18:26+0000'}, {'date': '2022-01-04T22:39:37+0000'}, {'date': '2022-01-14T11:32:41+0000'}, {'date': '2022-01-15T11:41:10+0000'}, {'date': '2022-01-16T11:45:23+0000'}, {'date': '2022-01-17T11:43:45+0000'}, {'date': '2022-01-17T22:54:13+0000'}, {'date': '2022-01-18T11:54:03+0000'}, {'date': '2022-01-19T17:04:46+0000'}, {'date': '2022-01-20T05:51:13+0000'}, {'date': '2022-01-21T05:41:53+0000'}, {'date': '2022-01-22T05:44:52+0000'}, {'date': '2022-01-23T05:46:08+0000'}, {'date': '2022-01-24T05:42:13+0000'}, {'date': '2022-01-24T20:50:30+0000'}, {'date': '2022-01-25T05:45:52+0000'}, {'date': '2022-01-26T05:48:10+0000'}, {'date': '2022-01-27T05:44:23+0000'}, {'date': '2022-01-27T19:23:21+0000'}, {'date': '2022-01-28T05:54:39+0000'}, {'date': '2022-01-28T18:17:28+0000'}, {'date': '2022-01-29T05:50:29+0000'}, {'date': '2022-01-30T05:48:26+0000'}, {'date': '2022-01-31T05:51:34+0000'}, {'date': '2022-02-01T05:52:32+0000'}}]
Why is this happening? And how to return properly the value of a folder?

Thank you in advance.

After upgrading from 1.3.5 to 1.3.6, searching for projects in sonarcloud by organization is no longer returning the expected results.

This is an example line of code

sonar.projects.search_projects(organization="org")

The expected return is a list of project objects that you can then iterate through, this is the behavior still seen with version 1.3.5

Instead when using 1.3.6 the returned value ends up being an array of strings: ['paging', 'components']

In order to resolve this in the meantime, I am targeting version 1.3.5 explicitly

Hi, I am trying to increase the default timeout value and I am not able to do it.

Reading the docs I can see:

Timeout in RestClient

But when coding I'm not sure where I should change the value, as when I check the debugging I don't see any effect.

Regards.

I have two inquiries。
Firstly,which verison is the based?
Then,Is there an update release for Sonar 7.9 in the future?
Waiting for your response.

Relevant line of code:

sonar.alm_settings.set_github_binding(almSetting="github", project=project_name, repository=github_repo, summaryContentEnabled=True)

Gives the following exception from 1.2.6 onwards

Traceback (most recent call last):
  File "./scripts/sonarqube-project-setup.py", line 45, in <module>
    sonar.alm_settings.set_github_binding(almSetting="github", project=project_name, repository=github_repo, summaryContentEnabled=True)
  File "/usr/local/lib/python3.7/site-packages/sonarqube/utils/common.py", line 134, in inner_func
    response = self._post(url_pattern, params=params)
  File "/usr/local/lib/python3.7/site-packages/sonarqube/utils/rest_client.py", line 165, in _post
    params=params,
  File "/usr/local/lib/python3.7/site-packages/sonarqube/utils/rest_client.py", line 82, in request
    raise ValidationError(msg)
sonarqube.utils.exceptions.ValidationError: Error in request. Possibly validation error [400]: Property summaryCommentEnabled is not a boolean value: True

I am using SonarQubeClient(..).measuers.get_component_tree_with_specified_measures(metricKeys="code_smells,bugs,vulnerabilities,coverage")
returns proper value for bugs and vulnerabilies but returns 0 for code_smells and coverage most of the times.

This behaviour happens randomly. ( Some days it gives proper values and some days it just returns 0 ) [ No code change ]

Is there going to be a fix here or it this already fixed?

If your are selling the pro edition you should provide it immediately after the purchas. I've no time to wait because of time zone delays etc.

Hi,

I am using measures.get_component_with_specified_measures to connect to the relevant endpoint to get the metrics of a project.

Thing is, I am doing this right after I run a scan, and for bigger projects, this can take some time.

So for those projects, my script then fails and gives an error.

I could implement a time.sleep() method to pause execution of the script for a while, but this is not needed for smaller code scans.

Is there any way I can check from the API itself if the analysis and background tasks have been completed or not?

I spent two days debugging an issue with the sonarqube package. Even after digging into the docs and open issues, I had to write tests against all versions since 1.3.0 to find out that 1.3.6 was breaking results format.

The only explanation is in this closed issue: #70 (comment)

Is it possible:

1. to mention this API breaking change in a more prominent way, in the docs, in the changelogs or on the GitHub page;
2. to bump the minor version number if the API has breaking changes in the future ?

I want to pull just security hotspot information from my projects so I try this:

sonar.issues.search_issues(componentKeys=keys[3], types='SECURITY_HOTSPOT')

And the error thrown is:

sonarqube.utils.exceptions.ValidationError: Error in request. Possibly validation error [400]: Value of parameter 'types' (SECURITY_HOTSPOT) must be one of: [CODE_SMELL, BUG, VULNERABILITY]

I am using version Community 8.6.1. I see the web api has a specific hotspots API but I don't see it's use in this library.

Hi,

I am having weird issue from 2 days that the users list and user groups are not giving proper result.

user_groups = list(sonar.user_groups.search_user_groups())
users = list(sonar.users.search_users())

below is the output for the above api call:

<class 'list'>
['paging', 'groups']
<class 'list'>
['paging', 'users']

Initially it used to give correct result. I am using https://python-sonarqube-api.readthedocs.io/en/latest/examples/user_groups.html page.
Any help would be appreciated.

Before purchasing the professional license, please clarify the following and add the info on the website for other who are interested in buying it:

• no of users allowed per license
• deployable on any machine (developer/CI build)?
• expiration time?
• other limitations?

Thanks!

@shijl0925

hello,

Was following this example: https://python-sonarqube-api.readthedocs.io/en/latest/sonarqube.rest.html#module-sonarqube.rest.components and the components module is no longer supported.

Traceback (most recent call last):
  File "sonar.py", line 4, in <module>
    components_tree = sonar.components.get_components_tree(component="component_key")
AttributeError: 'SonarQubeClient' object has no attribute 'components'

Is this expected?

thanks!

I was experimenting with the Sonarcloud API and the Python-Sonarqube-API project and noticed that while I am able to filter all users in the API request to Sonarcloud:

https://sonarcloud.io/api/organizations/search_members?organization=XXXXXX&ps=100'

The library function search_users returns me all users known within Sonarcloud and does not allow for a org filter:

sonarconn = SonarCloudClient(sonarcloud_url="https://sonarcloud.io", token="XXXXXX")
users = list(sonarconn.users.search_users()

and returns ALL users of sonarcloud (or at least the first paging results).

Where the function search_groups_user_belongs_to does allow an organisation input:

   @PAGES_GET(API_USERS_GROUPS_ENDPOINT, item="groups")
    def search_groups_user_belongs_to(
        self, login, organization, q=None, selected="selected"
    ):
        """
        Lists the groups a user belongs to.

        :param login:
        :param organization: organization key.
        :param q: Limit search to group names that contain the supplied string.
        :param selected: Depending on the value, show only selected items (selected=selected), deselected items
          (selected=deselected), or all items with their selection status (selected=all).Possible values are for:
            * all
            * deselected
            * selected
          default value is selected.
        :return:
        """

I want to get the number of issues/hotspots in a certain project. I only want the total number of these issues, however when i do a search i get the JSON with all the issues f.e :

sonar.hotspots.search_hotspots(projectKey=component)

When i do len on this result i get the total number, but i've requested the whole JSON (which is really heavy).

If i do a curl request i can actually filter with the ps parameter to get a lightweight JSON :

curl -sX GET -u <TOKEN>: "http://<SONAR_URL>:9000/api/hotspots/search?projectKey=<PROJECTKEY>&ps=1"

This also returns the total number of hotspots in the result which is good since it is what i'm aiming for.

But when i try to use the same parameter in the python api i get the same result with or without the ps parameter.

Is this a normal API behavior, also is their any other way to get only the total number of issues / hotspots ?

===========
sonarqube is 9.1
python-sonarqube-api is 1.2.4

this works fine

issues1 = list(sonar.issues.search_issues(componentKeys="my_project", branch="develop"))

but...OK only if the default quality profile is the default one ('sonar way').

If a given rule has been modified (let's say its severity CRITICAL in sonar way -> MAJOR in the new quality profile),
then the command above will provide the same issue (i.e. same default severity CRITICAL -not MAJOR- even if the quality profile set to the new one).

without changing the current code, Is it possible to know all the rules linked with a given quality profile ?

getting SSL Certificate error with https..is it possible to pass ca file parameter while connection?

projects = list(sonar.projects.search_projects())

File "/sonarqube/utils/common.py", line 176, in inner_func
response = self._get(url_pattern, params=params).json()
File "/sonarqube/utils/rest_client.py", line 144, in _get
return self.request("GET", path=path, params=params, data=data, headers=headers)
File "/sonarqube/utils/rest_client.py", line 65, in request
timeout=timeout,
File "/usr/lib/python2.7/site-packages/requests/sessions.py", line 542, in request
resp = self.send(prep, **send_kwargs)
File "/usr/lib/python2.7/site-packages/requests/sessions.py", line 655, in send
r = adapter.send(request, **kwargs)
File "/usr/lib/python2.7/site-packages/requests/adapters.py", line 514, in send
raise SSLError(e, request=request)
requests.exceptions.SSLError: HTTPSConnectionPool(host='XXXXXXXXXXXXXX', port=443): Max retries exceeded with url: /api/projects/search?onProvisionedOnly=false&qualifiers=TRK (Caused by SSLError(SSLError(1, u'[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed (_ssl.c:618)'),))

is there a way to get the git commit hash and date related to a sonarqube issue?

Hello,
I’m trying to extract the severity data reported for the vulnerability but I’m having it extremely difficult. I’m using the python-api and when it returns the blocking and critical severities, it returns the total (the sum of bugs, vulnerabilities and code smells). Is there a way to disaggregate this information.
Can anyone help me to know if it is possible to separate this data?
Thanx

How could i pass list values to sonar.settings.update_setting_value().

Got an ValidationError.

Error in request. Possibly validation error [400]: Parameter 'value' must be used for single value setting. Parameter 'values' must be used for multi value setting.

Could you give an example like https://python-sonarqube-api.readthedocs.io/en/latest/examples/settings.html#examples ?

Hello,

When I try to list the items of generators which are return values of functions such as sonar.users.search_users or sonar.projects.search_projects(), I am getting the following error. I updated the simplejson package to 3.17.6 and still getting the same error.

simplejson.errors.JSONDecodeError: Expecting value: line 1 column 1 (char 0)

While trying to test whether a given SonarQube project already has alm settings, I'm currently doing:

c = sonarqube.SonarEnterpriseClient(sonarqube_url=sonarqube_address, token=sonarqube_api_token)
binding = c.alm_settings.get_binding(sonarqube_project_key)

When there is no alm settings defined at the project, get_binding raises a generic sonarqube.utils.exceptions.ClientError with the message Error in request. Possibly client error [404]: Project 'xxx' is not bound to any ALM.

But there is no straightforward way to deal with this expected error without looking at the exception message for Possibly client error [404].

Can we have a better way of reporting a 404?

For example, maybe with a class named NotFoundClientError?

Also, maybe add a response_code property to the ClientError class too?

Hi, I'm getting the following auth error, when doing list(sonar.projects.search_projects()):

AuthError: Error in request. Possibly authentication failed [403]: 
{"errors":[{"msg":"Insufficient privileges"}]}

However other api requests like list(sonar.issues.search_issues(componentKeys="my_project_key", branch="master")) or
list(sq.hotspots.search_hotspots(projectKey="my_project_key", branch="master")) are working like a charm.

I am using a token to authenticate ... is it possible my user is simply not allowed to access this API endpoint?
I can browse the /projects page of our SQ server, but auth works differently then ... so maybe its a problem on our side.

Hey there:
@shijl0925
I've been trying to figure out if this is something silly that I'm getting wrong on my end, or is a legitimate bug with the projects.search_projects() endpoint.

I've confirmed that my token isn't related to the 403 error I've been getting via a curl to the underlying project search endpoint directly and get a 200 with the expected response. I've used the same token with a few other methods to test and no issues.

Quickly testing out the endpoint here as such:

   output = list(sq_obj.projects.search_projects())
   print(output)

Here's the stack trace I get when I try to call the method:

Traceback (most recent call last):
  File "/Users/apho/Documents/Dev/xwing/automation-pipelines/sonarqube-config-pipeline/permissions.py", line 186, in <module>
    print(sq_obj.projects.get("access-api-dev"))
  File "/usr/local/lib/python3.8/site-packages/sonarqube/community/projects.py", line 33, in get
    result = list(self.search_projects(projects=key))
  File "/usr/local/lib/python3.8/site-packages/sonarqube/utils/common.py", line 160, in inner_func
    response = self._get(url_pattern, params=params).json()
  File "/usr/local/lib/python3.8/site-packages/sonarqube/utils/rest_client.py", line 113, in _get
    return self.request('GET', path=path, params=params, data=data, headers=headers)
  File "/usr/local/lib/python3.8/site-packages/sonarqube/utils/rest_client.py", line 73, in request
    raise AuthError(msg)
sonarqube.utils.exceptions.AuthError: Error in request. Possibly authentication failed [403]: Forbidden
<html>
<head><title>403 Forbidden</title></head>
<body bgcolor="white">
<center><h1>403 Forbidden</h1></center>
</body>
</html>
<!-- a padding to disable MSIE and Chrome friendly error page -->
<!-- a padding to disable MSIE and Chrome friendly error page -->
<!-- a padding to disable MSIE and Chrome friendly error page -->
<!-- a padding to disable MSIE and Chrome friendly error page -->
<!-- a padding to disable MSIE and Chrome friendly error page -->
<!-- a padding to disable MSIE and Chrome friendly error page -->

Any ideas?

sonar.qualityprofiles.get_projects_associate_with_quality_profile(key="") api call is not working with sonarQube version - 7.1 but working with version : 7.9.6

Hi Team,

I am writing python script using “python-sonarqube-api” module to get a list of projects associated with particular qualityProfile
Code Snippet as below:

from sonarqube import SonarQubeClient
sonar = SonarQubeClient(sonarqube_url=url, token=sonar_token)
print(sonar.qualityprofiles.get_projects_associate_with_quality_profile(key=""))
I am refering below document for python scripting:
https://python-sonarqube-api.readthedocs.io/en/latest/

When I try above code with sonarqube version 7.1, It giving below response which is unexpected:

and When I try same code with sonarqube version 7.9.6, It giving below response as expecteted:

and when I try same code with sonarqube version 8.8, it is again giving below response which unexpected:

Any one can help me with this issue for this particular api of python?

I would like to add api/qualitygates/add_group to allow us to set groups as members on quality gates, instead of relying ono global administer permissions for quality gates

#59

We have a need to validate the certificate from the SonarQube host via the chain we have in the environment. We would like to have the 'verify' option from requests exposed as a variable that can be set in the SonarQube Client.

I am using python 2.7 virutlenv and getting below error messages.I cloned repo and done setup.
I am getting same kind of error with any api call.

result = sonar.auth.check_credentials()
Traceback (most recent call last):
File "", line 1, in
File "sonarqube/utils/common.py", line 116, in inner_func
func_params = translate_params(f, *args, **kwargs)
File "sonarqube/utils/common.py", line 59, in translate_params
all_params = dict(get_default_kwargs(f))
File "sonarqube/utils/common.py", line 43, in get_default_kwargs
argspec = inspect.getfullargspec(func)
AttributeError: 'module' object has no attribute 'getfullargspec'

When using qualityprofiles.restore_quality_profile() method and providing proper xml file with backup, the method failes with message:

Error in request. Possibly validation error [400]: A backup file must be provided

Code snippet:
with open('C:\\restore.xml', 'r') as f: sonar.qualityprofiles.restore_quality_profile(backup=f.read())

restore.xml:
<?xml version='1.0' encoding='UTF-8'?><profile><name>BackUp</name><language>java</language><rules/></profile>

I believe it is caused because backup file is passed as query parameter (so - /api/qualityprofiles/restore?backup=<?xml...) not as body:form-data parameter

The password, which is given to debug logs in logger is unmasked. For example (stars are replacements for sensitive information):

  | https://*******:443 "POST /api/users/create?login=*****&name=*******&local=true&email=******&password=unmasked_password HTTP/1.1" 200 150

I consider it as a bug. Can it be fixed please? :)

Thanks.

在macOS環境下python 2.7 / 3.8 會無法執行

Traceback (most recent call last):
File "/Users/xxx/xxx/test.py", line 26, in
getSonarqubeInfo()
File "/Users/xxx/xxx/test.py", line 5, in getSonarqubeInfo
sonar.auth.authenticate_user(login=username, username=username, password=password)
File "/Users/xxx/xxx/venv/lib/python2.7/site-packages/sonarqube/community/init.py", line 229, in auth
return SonarQubeAuth(api=self)
File "/Users/xxx/xxx/venv/lib/python2.7/site-packages/sonarqube/community/auth.py", line 23, in init
super(SonarQubeAuth, self).init(**kwargs)
TypeError: super() argument 1 must be type, not classo

I know this has similarities with this issue but I believe this is a more serious problem.

I do not really understand how it is possible that previous releases has been completely removed from everywhere and all the breaking changes are not mentioned anywhere. These changes broke functionality in a complex tool that we were close to put to production and the team is not confident anymore to use this library.

It's not my intention to blame no one, I just want to note that this is a problem that should be prevented.

In my opinion:

• Previous releases shouldn't be removed, not only from pip repositories but also from the code repo (why even the previous tags has been removed?).
• If there is some kind of security issues with previous versions -which would be understandable to remove- then it should be documented somewhere.
• Breaking changes between versions should be documented, even more when there is a major release. Now it's all trial and error or just look at the latest docs (not sure if they're up-to-date, though).

If I'm just missing something, please, I kindly apologize and I'd appreciate any clarification to understand it.

Again, it's not my intention to blame somebody! I appreciate all the effort from contributors to open-source, I want that to be clear :-)

I´m not able to grant permissions to user for a project. Looks like the request dont recognize the "projectKey" param. When I add it sonar api still ask for "global permissions".
funtion: def add_permission_to_user(self, login, permission, project_key)

I tested the request using other tools (POSTMAN) and it work.
Can anybody check if this feature works on this library on his enviroment?
I dont know how to solve it

I would like to search the security hotspots in sonarqube.
Could the python-sonarqube-api request it?

Hello.

I was looking for a way to get the metrics from the repo, but also from a specific folder inside the repo. The "Code" window present the folders and the files of the project, can we access it like we access the full repo? Returning metrics for a specific folder, for example?

I know your API can look into a file,

duplications = sonar.duplications.get_duplications(key="my_project:/src/foo/Bar.php")

But can we do this?

sonar.measures.get_component_with_specified_measures(component: "my_project:/src/foo/")

Thank you for your attention.

Hello,

I'm facing an issue that the function permissions don't exist anymore. Can anyone help me?

import os
import yaml
import re
from sonarqube import SonarEnterpriseClient
from sonarqube.utils.exceptions import ValidationError, NotFoundError

URL = "https://sonar.example.com"
USERNAME = os.environ.get('USERNAME', 'admin')
PASSWORD = os.environ.get('PASSWORD')
PAGESIZE = 10

sonar = SonarEnterpriseClient(sonarqube_url=URL, username=USERNAME, password=PASSWORD)
sonar.permissions
Traceback (most recent call last):
File "", line 1, in
AttributeError: 'SonarEnterpriseClient' object has no attribute 'permissions'

Version 1.3.6 was working.

I checked the code, and it looks like the permissions class is missing.

I can no longer update the settings although the documentation indicates that it is possible.
This commit breaks the compatibility of my app, is there a workaround to update SonarQube settings?

I am getting this error on my app: 'SonarQubeClient' object has no attribute 'settings'
Below is a part of my code:

def update_settings(args):
    # oidc configuration
    sonar = SonarQubeClient(sonarqube_url=args.Url, username=args.Username, password=args.Password)
    sonar.settings.update_setting_value(key='sonar.core.serverBaseURL', value=args.Url)
    sonar.settings.update_setting_value(key='sonar.auth.oidc.enabled', value='true')
    sonar.settings.update_setting_value(key='sonar.auth.oidc.issuerUri', value=args.IssuerURI)
    sonar.settings.update_setting_value(key='sonar.auth.oidc.clientId.secured', value=args.ClientID)
    sonar.settings.update_setting_value(key='sonar.auth.oidc.clientSecret.secured', value=args.ClientSecret)
    sonar.settings.update_setting_value(key='sonar.auth.oidc.groupsSync', value='true')
    sonar.settings.update_setting_value(key='sonar.auth.oidc.groupsSync.claimName', value=args.GroupsClaimName)

I appreciate if you can help me.

def get_sonarqube_info(self, branch="master", component=None, url=None, username=None, password=None):
try:
sonar = SonarQubeClient(sonarqube_url=url)
sonar.auth.authenticate_user(login=username, password=password)
component_data = sonar.measures.get_component_with_specified_measures(
component=component,
branch=branch,
metricKeys=METRICKEYS
)
........

In this code lien, have a except as:
Error in request. Possibly Not Found error [404]: Component 'XXXX' on branch 'master' not found

but in another project ,this code can run normally. the XXXX project is the first scan. In sonarquebe server, [MEASURES]-->[new code ] show result as:
Measures on New Code will appear after the second analysis of this branch.

So, how can I revole it?

This shows version 1.2.5 but GH shows latest 1.2.4.
What was released/changed in 1.2.5?

Hello, I’m trying to list the alm settings for my sonarcloud project via the python API.

I’ve initialized my sonarqube enterprise client and am able to invoke the alm_settings.list() method, but I’m getting the following error:

sonarqube.utils.exceptions.NotFoundError: Error in request. Possibly Not Found error [404]: Unknown url : /api/alm_settings/list

Here’s the python code I’m using:

from sonarqube.enterprise import SonarEnterpriseClient

sonarqube_ent_client = SonarEnterpriseClient(
    sonarqube_url=SONARCLOUD_URL, token=SONARCLOUD_TOKEN
)

response = sonarqube_ent_client.alm_settings.list()

I've verified that my sonarqube_ent_client has a valid token and url because I'm able to create projects with it just fine and the sonarqube_ent_client.auth.check_credentials() method returns "true".

Any advice about how to proceed would be greatly appreciated!

I’m using Python 3.9.7 and the python-sonarqube-api python package (version 1.3.4)

Steps to reproduce:

1. Install python-sonarqube-api==1.3.4
2. Run the following code, replacing the temporary variables with values for your sonarcloud account:

from sonarqube.enterprise import SonarEnterpriseClient

sonarqube_ent_client = SonarEnterpriseClient(
    sonarqube_url=SONARCLOUD_URL, token=SONARCLOUD_TOKEN
)

response = sonarqube_ent_client.alm_settings.list()

#  sonarqube.utils.exceptions.NotFoundError: Error in request. Possibly Not Found error [404]: Unknown url : /api/alm_settings/list

Hi,
I want to get project name's git lab repository url, but I don't know how to get ALM setting key. Please help me, thanks!
SonarQube Server Version: Community EditionVersion 8.9.3 (build 48735)

from sonarqube.enterprise import SonarEnterpriseClient

def sonar_ent_connector() -> SonarEnterpriseClient:
    sonarqube_ent_client = SonarEnterpriseClient(sonarqube_url=SQ_URL, token=SQ_TOKEN)
    sonar_ent_credential = sonarqube_ent_client.auth.check_credentials()

    if "true" not in sonar_ent_credential.lower():
        raise Exception("Permission authentication failure.")
    return sonarqube_ent_client

prj_key = "ABDevUtils"
sqe_connector.alm_integrations.search_gitlab_repos(almSettings="xxxx", projectName=prj_key)

This library has methods to add/remove user permissions to/from projects/groups, but has no way of getting the existing permissions. Without these, there is no way to fully manage the user permissions.

Can these APIs be exposed here?

In the meantime, I will try to prepare a PR.

For reference, SonarQube has those APIs hidden behind the "internal" flag:

GET api/permissions/users INTERNAL SINCE 5.2
Lists the users with their permissions as individual users rather than through group affiliation.
This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.
This service defaults to all users, but can be limited to users with a specific permission by providing the desired permission.

Getting this error

When I tried to look for object's methods, there was no such method