Adding teams API #1794
Adding teams API #1794
Conversation
Started adding the tests for those org routes
…y of gssapi python package
… calling service desk do it from the same root api endpoint
Started adding the tests for those org routes
… calling service desk do it from the same root api endpoint
for more information, see https://pre-commit.ci
|
Label error. Requires exactly 1 of: bug, enhancement, major, minor, patch, skip-changelog. Found: feature |
|
Hi @Maxim-Durand, we do have a Jira Cloud instance. However, the credentials for this are not shared with pull requests due to a limitation within GitHub so the process would likely involve the maintainers running in separately to confirm functionality. |
tests/tests.py
Outdated
| if self._should_skip_for_pycontribs_instance(): | ||
| self._skip_pycontribs_instance() |
There was a problem hiding this comment.
We use a test decorator to enable the tests running on the Jira Cloud instance, this is denoted by @allow_on_cloud, an example is in test_group
| list[str] | ||
| """ | ||
| url = f"/gateway/api/public/teams/v1/org/{org_id}/teams/{team_id}/members" | ||
| payload = {"first": 50} |
There was a problem hiding this comment.
this pagination implementation should be moved into a helper method, if is is specific to the Teams API I would make it a static method of the Teams Resource
Then you would call it like:
Teams._fetch_pages(session=session, url=url, ...)
I would aim to match as many of the parameters to the function JIRA._fetch_pages() if possible
There was a problem hiding this comment.
In theory it's not specific to Teams API, but isn't exactly like JIRA._fetch_pages() neither as it's using different identifiers for Jira's latest API (why they didn't stick to the same variable names between API idk 🙄 )
For now I simply created it as a helper function but if it it's used outside of Teams it's bound to change.
| JiraTestCase.setUp(self) | ||
| self.test_team_name = f"testTeamFor_{self.test_manager.project_a}" | ||
| self.test_team_type = "OPEN" | ||
| self.org_id = os.environ["CI_JIRA_ORG_ID"] |
There was a problem hiding this comment.
I'm not sure how to get the org_id of the testing organisation 🤔
I guess the only real solution is to implement the organisation API and to create a new one before running the tests.
I'll get to work 😉
There was a problem hiding this comment.
I created a new PR (#1803) based on this one but also adding Organisations API so that I'm able to test the Team API.
Although I understand the reasoning this seems like a very slow and inefficient process. |
|
I think I'll close this PR in favor of #1803 |
I agree the process is not ideal, but this is a limitation from GitHub. Furthermore, it is impossible to share a limited permission token, as the nature of the API calls of the test suite involve Admin permissions. We reduce the friction by having the Server tests, that once green give an indication to us maintainers whether we should run the Cloud tests. Typically I would expect contributors to have tried their API with their own instances (or other public instances, as shown in https://github.com/pycontribs/jira/blob/main/examples/basic_use.py). At very least the "get" based methods. |
Fair enough, I'll do that. |
#1761
Important
This PR isn't finished as I'm currently stuck not being able to test my changes.
Indeed the jira server container used to test is too old and doesn't support newest API like the Jira Team API or the Jira Org API
Hence, I'm asking the maintainer of this project what is the strategy to keep this project up-to-date with Jira newest APIs ? Do we have a cloud server we could use to test ?