Allow configuration of unreachable Web URLs for the Jira integration
Problem to solve
Allow configuration of an unreachable Web URL for the Jira integration as long as the API URL is configured and reachable
Intended users
Developers
Further details
This feature can help to customers who use an isolated Jira instance with limited access outside LAN and want to use Gitlab.com cloud service at the same time.
The limited access to the Jira instance should be sufficient for the API access, otherwise the integration does not make sense.
This configuration is reasonable for customers who do not want to make the Jira login page accessible for the wide audience and who are ready to expose a tunnel for the minimal API access at the same time.
Proposal
The following conditions are met during configuration of the Jira integration:
- Valid Web and API URLs are set and they are different.
- The API URL check passes without issues: the URL is valid and it is reachable.
- The Web URL check is valid, but it is currently unreachable.
The validation error should be emitted as it is currently done, but it should be allowed to save the configuration anyway as it is already done in case of wrong credentials.
The current error message is as follows.
The error message for the wrong credentials case when it is allowed to enforce the change is as follows.
Permissions and Security
There are no changes to this area.
Documentation
There are no changes to this area.
Testing
All tests require work with the Jira integration dialog and use of a cloud/non-cloud Jira instance.
Test Case 1
Aim: To check that the key issue is addressed.
Actions:
- Configure valid credentials for access to the Jira instance.
- Configure a correct API URL.
- Configure an unreachable valid Web URL.
- Save the configuration.
- Confirm the save action.
- Validate Jira links from the commit messages.
Expected results:
- Okay.
- Okay.
- Okay.
- An error is displayed about an unreachable URL, but there is a link to force the change anyway.
- The configuration is saved and applied.
- The Jira links are based on the Web URL.
Test Case 2
Aim: To check that an unreachable API URL is still not accepted.
Actions:
- Configure valid credentials for access to the Jira instance.
- Configure a valid unreachable API URL.
- Configure a valid unreachable Web URL.
- Save the configuration.
Expected results:
- Okay.
- Okay.
- Okay.
- An error is displayed about an unreachable URL and there is not a link to force the change.
Test Case 3
Aim: To check that an unreachable Web URL is not accepted if the API URL is not configured.
Actions:
- Configure valid credentials for access to the Jira instance.
- Configure a valid unreachable Web URL, unset the API URL if it is configured.
- Save the configuration.
Expected results:
- Okay.
- Okay.
- An error is displayed about an unreachable URL and there is not a link to force the change.
Test Case 4
Aim: To check that an invalid (malformed) Web URL is not accepted in any case.
Actions:
- Configure valid credentials for access to the Jira instance.
- Configure a correct API URL.
- Configure an invalid Web URL.
- Save the configuration.
Expected results:
- Okay.
- Okay.
- Okay.
- An error is displayed about an unreachable URL and there is not a link to force the change.
What does success look like, and how can we measure that?
The test cases are passed and it is possible to use isolated Jira instances with the Gitlab.com cloud service.
What is the type of buyer?
Core tier
Links / references
None.