Introduce create ticket script

[oshoval]

The script automates github issue to Jita ticket mirroring.

[EdDev]

I am unclear which tests are written to cover all the code. Are these the main functions?
I suggest you create a tests folder` and create there test modules using pytest that import the production code.

[EdDev]

Please note that for deployment, it is recommended to use a setup file: https://docs.python.org/3/distutils/setupscript.html

If this is for internal use only, then you do not need it.
If you want to maintain it for others to use, you need it.

[oshoval]

Please note that for deployment, it is recommended to use a setup file: https://docs.python.org/3/distutils/setupscript.html

If this is for internal use only, then you do not need it. If you want to maintain it for others to use, you need it.

Thanks
For now we start with internal use.

[oshoval]

Thanks

addressed comments,
didn't add yet tests, most of them are pretty tricky because the github status changes (unless we look always on all the history),
and we can't create issues on Jira in tests (we can just check for example a known issue exists).

new files
config.py
ticket.py
main.py
removed the common.py

maybe worth to remove github from Ticket class, and just send repo to it, since its the only thing it uses

[oshoval]

https://github.com/oshoval/github2jira/compare/25d5236..b717bdf
I think this should include all the pushes (some of them hidden in others, and some are small)

[oshoval]

Refactor the issue class

[oshoval]

Added unit tests for Issue class

[oshoval]

addressed rest of the comments

[oshoval]

addressed comment

[oshoval]

added some more tests, and tests/common lib

[EdDev]

The production code seems good, I only had small comments about it, nothing major.

The unit tests require more work.
Although I will not insist on it, please note that the unit tests are still suppose to check scenarios and not individual methods. I mean:

• checking that you can filter the relevant github issues.
• Opening a Jira ticket, based on some data.
• Failing to open a Jira ticket or contacting github.
• Not finding any relevant issues on github to process.

Etc...

[oshoval]

The production code seems good, I only had small comments about it, nothing major.

The unit tests require more work. Although I will not insist on it, please note that the unit tests are still suppose to check scenarios and not individual methods. I mean:

• checking that you can filter the relevant github issues.
• Opening a Jira ticket, based on some data.
• Failing to open a Jira ticket or contacting github.
• Not finding any relevant issues on github to process.

Etc...

Thanks,
some of those sound as e2e,
I prefer to not develop this project any deeper right now in aspect of tests, and provide as is.
In case we decide we can improve it later.

[oshoval]

addressed most of the comments

[oshoval]

Thanks, addressed rest of the comments (unless unresolved)

[oshoval]

since some Jira servers will deprecate basic auth and move to PAT, support it

[EdDev]

some of those sound as e2e,

I do not think they are, as the intention is to unit test scenarios that have meaning (if possible).

I prefer to not develop this project any deeper right now in aspect of tests, and provide as is.
In case we decide we can improve it later.

Not investing in tests is raising the risk you still have bugs or worse, that you may introduce bugs in the future.
As you are the one who needs to maintain this, it is your burden to carry so I will not push you to do anything beyond what you want.

[oshoval]

I do not think they are, as the intention is to unit test scenarios that have meaning (if possible).

Some aren't possible.

For example jira.create_issue, i already checked the jira create data but
beside this, the only thing the function does is call the real Jira lib, which we can't do in unit test.
the real jira function even doesn't return a value (just assert in case of error, and i don't try to catch it anyhow even on main)

Anyhow as we said, I prefer to first publish an initial version, and upon needs to develop it,
maintaining of it is very easy, and i don't see we need to invest it any deeper right now.

[oshoval]

thanks, addressed comments

[EdDev]

Nice work!

[oshoval]

Thanks for the great review Edy