let Jira cloud assign a default permissionScheme if none is specified #1483

codectl · 2022-08-31T17:44:11Z

issue: when a permissionScheme is specified , Jira cloud raises a 500 error

codectl · 2022-08-31T17:58:17Z

this closes #1483

adehad · 2022-09-04T10:27:26Z

hmm this doesn't seem right, the Jira Cloud docs do say this is a correct parameter:
https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-projects/#api-rest-api-2-project-post

adehad · 2022-09-04T10:28:30Z

we should add a test for this in our cloud tests

codectl · 2022-09-04T10:33:15Z

I found this issue mentioned as well by some user:

https://community.atlassian.com/t5/Jira-questions/Using-Default-Permission-Scheme-with-Create-Project-API-causes/qaq-p/1862489

It has almost a year and the issue still persists.

codectl · 2022-09-04T10:40:37Z

The documentation says it's a valid field but it still throws a 500. We either embrace the error or we remove the field if not specified, which is what I am proposing.

The current test manager is suppressing that and other errors so the test suite does not cover that scenario:

...
            create_attempts = 6
            for _ in range(create_attempts):
                try:
                    if self.jira_admin.create_project(project_key, project_name):
                        break
                except JIRAError as e:
                    if "A project with that name already exists" not in str(e):
                        raise e

adehad · 2022-09-04T10:52:25Z

I don't think the test manager is suppressing this error, it only ignores if the error message is relating to the project already existing

adehad · 2022-09-04T10:53:32Z

Are you able to confirm the integer value the original code returns for your instance?

jira/client.py

codectl · 2022-09-04T19:10:38Z

My simplest test is the following:

>>> j = JIRA(...)
>>> j._session.post(j._get_url("project"), data={"key": "X", "name": "XYZ", "leadAccountId": "xxx", "projectTypeKey": "software"})
<Response [201]>
>>> j._session.post(j._get_url("project"), data={"key": "X", "name": "XYZ", "leadAccountId": "xxx", "projectTypeKey": "software", "permissionScheme": 0}})
jira.exceptions.JIRAError: JiraError HTTP 500 url: https://xxx.atlassian.net/rest/api/2/project
        text: Internal server error
        
        response headers = {...}
        response text = {"errorMessages":["Internal server error"],"errors":{}}

Having the field permissionScheme on raises a 500.

codectl · 2022-09-04T19:13:51Z

Are you able to confirm the integer value the original code returns for your instance?

I am running it against Jira Cloud Platform and the permissionScheme is forced to 0 if I don't specify it - if that was the question asked.

codectl · 2022-09-04T19:14:57Z

I don't think the test manager is suppressing this error, it only ignores if the error message is relating to the project already existing

You're right , it doesn't look like it. I need more time to understand what is suppressing the 500.

Co-authored-by: Adel Haddad <26027314+adehad@users.noreply.github.com>

codectl · 2022-09-04T21:20:49Z

Ok so I ran the Jira Cloud CI on my local env and it fails:

...
  File "/tmp/jira/tests/conftest.py", line 255, in _create_project
    if self.jira_admin.create_project(project_key, project_name):

which is the following line:

...
if self.jira_admin.create_project(project_key, project_name):

It begs the question of how is this not failing in this project?

I ran the test suite against API v2:

https://xxx.atlassian.net/rest/api/2

adehad · 2022-09-05T07:48:19Z

Do you have more details in the traceback? I also find it strange that if you are also a Jira admin that you are not able to reproduce the same behaviour

codectl · 2022-09-05T07:57:33Z

Yes full stack trace below:

ERROR    tests.conftest:conftest.py:63 JiraError HTTP 500 url: https://xxx.atlassian.net/rest/api/2/project
        text: Internal server error
        
        response headers = {...}
        response text = {"errorMessages":["Internal server error"],"errors":{}}
Traceback (most recent call last):
  File "/tmp/jira/tests/conftest.py", line 58, in setUp
    self.test_manager = JiraTestManager()
  File "/tmp/jira/tests/conftest.py", line 156, in __init__
    self.create_some_data()
  File "/tmp/jira/tests/conftest.py", line 287, in create_some_data
    self.project_a_id = self._create_project(self.project_a, self.project_a_name)
  File "/tmp/jira/tests/conftest.py", line 259, in _create_project
    raise e
  File "/tmp/jira/tests/conftest.py", line 255, in _create_project
    if self.jira_admin.create_project(project_key, project_name):
  File "/tmp/jira/jira/client.py", line 4449, in create_project
    r = self._session.post(url, data=json.dumps(payload))
  File "/tmp/jira/.tox/py39/lib/python3.9/site-packages/requests/sessions.py", line 635, in post
    return self.request("POST", url, data=data, json=json, **kwargs)
  File "/tmp/jira/jira/resilientsession.py", line 223, in request
    elif raise_on_error(response, **processed_kwargs):
  File "/tmp/jira/jira/resilientsession.py", line 69, in raise_on_error
    raise JIRAError(
jira.exceptions.JIRAError: JiraError HTTP 500 url: https://xxx.atlassian.net/rest/api/2/project
        text: Internal server error
        
        response headers = {...}
        response text = {"errorMessages":["Internal server error"],"errors":{}}

codectl · 2022-09-05T08:07:08Z

It fails with 500 for API 3 as well.

The simplest of tests is this:

jira_admin=JIRA(...)
jira_admin.create_project("X", "XYZ")

adehad · 2022-09-05T09:46:51Z

Very strange, if you are able to get logs from the Jira instance itself that might help us further, but unfortunately I am not sure why we are seeing this behaviour.

codectl · 2022-09-05T10:22:45Z

Very strange, if you are able to get logs from the Jira instance itself that might help us further, but unfortunately I am not sure why we are seeing this behaviour.

Thing is, this is the Cloud . If it was a local server I could check the logs and we could compare server versions . But being a cloud instance, it should all be the same version but possibly isn't . I created my cloud environment less than a month ago. And bcs yours is older it could be linked to a different version. But I'm just guessing here since none of this is documented and I'm assuming your cloud environment does not raise 500.

From here I can create an (extra) Jira ticket to report the situation .

codectl · 2022-09-06T08:07:25Z

Ok as opposed to what I said yesterday, it does seem the cloud has a version linked to it. My cloud instance has the following properties:

{'baseUrl': 'https://xxx.atlassian.net',
 'buildDate': '2022-09-05T12:15:56.000+0000',
 'buildNumber': 100206,
 'defaultLocale': {'locale': 'en_US'},
 'deploymentType': 'Cloud',
 'scmInfo': '40f823cc9831469ea3c6decd06fddaf0ad67f8e2',
 'serverTime': '2022-09-06T08:03:48.153+0000',
 'serverTitle': 'Jira',
 'version': '1001.0.0-SNAPSHOT',
 'versionNumbers': [1001, 0, 0]}

Please confirm that you are using an older version than mine.

adehad · 2022-09-30T15:19:51Z

Sorry @rena2damas , have been swamped with work, just letting you know I haven't forgotten to look into this further

codectl · 2022-10-10T14:54:37Z

@adehad no problem I myself been also busy but thanks nonetheless

studioj

Thank you for your contribution, could you add a test to verify this?

studioj · 2023-02-09T21:23:44Z

jira/client.py

-        if permissionScheme is None:
+        if permissionScheme is None and self._is_cloud:
+            # Let Jira Cloud decide the default field due to issues in handling the
+            # field. See https://bit.ly/3ALVqgo


I don't think many people will open a random bit.ly address in some comments. could you paste the full URL here? It might look slightly uglier but at least people won't open this in a burner VM like I did :-D

fix: let Jira assign a default permissionScheme if none is specified

d76f022

github-actions bot added the bug label Aug 31, 2022

codectl had a problem deploying to cloud August 31, 2022 17:59 Failure

codectl mentioned this pull request Aug 31, 2022

create project with 'permissionScheme' field is causing 500 #1480

Open

4 tasks

adehad linked an issue Sep 4, 2022 that may be closed by this pull request

create project with 'permissionScheme' field is causing 500 #1480

Open

4 tasks

adehad reviewed Sep 4, 2022

View reviewed changes

jira/client.py Outdated Show resolved Hide resolved

codectl and others added 2 commits September 4, 2022 20:15

Update jira/client.py

b14d756

Co-authored-by: Adel Haddad <26027314+adehad@users.noreply.github.com>

fix: add missing pass statement

f5f9657

codectl had a problem deploying to cloud September 4, 2022 19:30 Failure

studioj requested changes Feb 9, 2023

View reviewed changes

Uh oh!

let Jira cloud assign a default permissionScheme if none is specified #1483

Are you sure you want to change the base?

let Jira cloud assign a default permissionScheme if none is specified #1483

Uh oh!

Conversation

codectl commented Aug 31, 2022

Uh oh!

codectl commented Aug 31, 2022

Uh oh!

adehad commented Sep 4, 2022

Uh oh!

adehad commented Sep 4, 2022

Uh oh!

codectl commented Sep 4, 2022

Uh oh!

codectl commented Sep 4, 2022

Uh oh!

adehad commented Sep 4, 2022

Uh oh!

adehad commented Sep 4, 2022

Uh oh!

Uh oh!

codectl commented Sep 4, 2022

Uh oh!

codectl commented Sep 4, 2022

Uh oh!

codectl commented Sep 4, 2022

Uh oh!

codectl commented Sep 4, 2022

Uh oh!

adehad commented Sep 5, 2022

Uh oh!

codectl commented Sep 5, 2022

Uh oh!

codectl commented Sep 5, 2022

Uh oh!

adehad commented Sep 5, 2022

Uh oh!

codectl commented Sep 5, 2022

Uh oh!

codectl commented Sep 6, 2022

Uh oh!

adehad commented Sep 30, 2022

Uh oh!

codectl commented Oct 10, 2022

Uh oh!

studioj left a comment

Choose a reason for hiding this comment

Uh oh!

studioj Feb 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

studioj Feb 9, 2023 •

edited

Loading