Skip to content

feat: enable IPv6 support for factory resolver endpoints#951

Open
olexii4 wants to merge 6 commits intomainfrom
CHE-1442
Open

feat: enable IPv6 support for factory resolver endpoints#951
olexii4 wants to merge 6 commits intomainfrom
CHE-1442

Conversation

@olexii4
Copy link
Contributor

@olexii4 olexii4 commented Feb 2, 2026

What does this PR do?

This change adds IPv6 support in Eclipse Che Server to enable operation in IPv6-only network environments. As Kubernetes platforms (particularly OpenShift Container Platform 4.20) migrate to IPv6, the factory resolver must handle IPv6 addresses correctly in URLs and API calls.

The implementation involved minimal, focused changes to URL validation patterns and server URL extraction, enabling full IPv6 support while maintaining complete backward compatibility with IPv4-only and dual-stack environments.

Background:

The Eclipse Che factory resolver previously failed to operate with IPv6 git server URLs due to:

  1. URL Validation Issues: Regular expressions rejected IPv6 bracket notation (e.g., http://[::1]:8080)
  2. Manual String Parsing: getServerUrl() methods used pattern matching that didn't account for IPv6 brackets
  3. Regex Escaping: Host strings from IPv6 URLs were inserted into regex patterns without properly escaping the bracket characters

IPv6 Bracket Notation:

IPv6 addresses in URLs require square brackets to distinguish the address from port numbers:

  • ✅ Correct: http://[2001:db8::1]:8080/repo.git
  • ❌ Incorrect: http://2001:db8::1:8080/repo.git (ambiguous)

Changes:

  1. AbstractGitlabUrlParser:

    • Fixed constructor to use URI.getHost() instead of manual substring extraction
    • Added IPv6 bracket escaping in getPatternMatcherByUrl()
    • Updated getServerUrl() to use URI parsing for IPv6 support
  2. AbstractGithubURLParser:

    • Added IPv6 bracket escaping in getPatternMatcherByUrl()
    • Updated getServerUrl() to use URI parsing for IPv6 support
  3. AzureDevOpsURLParser:

    • Added IPv6 bracket escaping in getPatternMatcherByUrl()
    • Updated getServerUrl() to use URI parsing for IPv6 support

Technical Details:

Java's URI.getHost() returns IPv6 addresses WITH brackets (e.g., "[2001:db8::1]"). When constructing regex patterns, these brackets must be escaped as \[ and \] because they are special regex characters. The fix uses:

  • Pattern.quote() to escape the IPv6 address (without brackets)
  • Manual escaping of the brackets themselves

Screenshot/screencast of this PR

What issues does this PR fix or reference?

fixes: eclipse-che/che#23674

How to test this PR?

PR Checklist

As the author of this Pull Request I made sure that:

Release Notes

Reviewers

Reviewers, please comment how you tested the PR when approving it.

@olexii4 olexii4 removed the request for review from vinokurig February 2, 2026 14:35
@openshift-ci
Copy link

openshift-ci bot commented Feb 2, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: olexii4

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@olexii4
Copy link
Contributor Author

olexii4 commented Feb 5, 2026

/retest

//
// In that case, we treat "/scm" as part of the fixed endpoint prefix, not as part of the
// repository path.
final String endpointWithoutScheme =
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

endpointWithoutScheme => hostname ?

try {
URI uri = URI.create(repositoryUrl);
if (uri.getScheme() != null && uri.getHost() != null) {
String serverUrl = uri.getScheme() + "://" + uri.getAuthority();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what if uri.getAuthority() is null?

if (uri.getScheme() != null && uri.getHost() != null) {
String serverUrl = uri.getScheme() + "://" + uri.getAuthority();
// Remove path and query from the server URL
int pathIndex = repositoryUrl.indexOf(uri.getAuthority()) + uri.getAuthority().length();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please move uri.getAuthority() to a local variable.

@vinokurig
Copy link
Contributor

@olexii4 Please update the related tests with ip v6 examples.

@olexii4 olexii4 force-pushed the CHE-1442 branch 4 times, most recently from 31df750 to 164262d Compare February 9, 2026 11:22
public void verify(VerificationData verificationData) {
List<Invocation> invocations = verificationData.getAllInvocations();
InvocationMatcher invocationMatcher = verificationData.getWanted();
MatchableInvocation invocationMatcher = verificationData.getTarget();
Copy link
Contributor Author

@olexii4 olexii4 Feb 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes were required for Mockito 5 compatibility. The test was using Mockito internal APIs that have breaking changes between Mockito 3.11.2 (old version) and 5.21.0 (new version):

Changes made:
Import change: org.mockito.internal.invocation.InvocationMatcher → org.mockito.invocation.MatchableInvocation

Mockito 5 moved this from internal to public API
API change: verificationData.getWanted() → verificationData.getTarget()
Method was renamed in Mockito 5's VerificationData interface


EnvironmentContext.getCurrent().setSubject(new SubjectImpl("name", "id", "token1234", false));
when(preferenceManager.find(anyObject(), anyObject())).thenReturn(preferences);
when(preferenceManager.find(anyString(), anyString())).thenReturn(preferences);
Copy link
Contributor Author

@olexii4 olexii4 Feb 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change was required for Mockito 5 compatibility. The test was using a deprecated matcher that was removed in Mockito 5:

Change made:
Import: ArgumentMatchers.anyObject() → ArgumentMatchers.anyString()
Usage: preferenceManager.find(anyObject(), anyObject()) → preferenceManager.find(anyString(), anyString())

KubernetesClient client = spy(kubernetesClient);
when(cheServerKubernetesClientFactory.create()).thenReturn(client);
kubernetesClient = kubernetesMockServer.createClient();
when(cheServerKubernetesClientFactory.create()).thenReturn(kubernetesClient);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes were required because Mockito 5 doesn't allow spy() on mock objects. This is a breaking change from Mockito 3.x:

Changes made:

  1. Removed import static org.mockito.Mockito.spy;
  2. Changed setup from:
   kubernetesClient = spy(kubernetesMockServer.createClient()); 
   KubernetesClient client = spy(kubernetesClient);  
   when(cheServerKubernetesClientFactory.create()).thenReturn(client);

To:

   kubernetesClient = kubernetesMockServer.createClient();  
   when(cheServerKubernetesClientFactory.create()).thenReturn(kubernetesClient);

})
.when(subject)
.checkPermission(anyObject(), anyObject(), anyObject());
.checkPermission(any(), any(), any());
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change was required for Mockito 5 compatibility due to the removal of the deprecated anyObject() matcher:

Change made:

  • Import: ArgumentMatchers.anyObject() → ArgumentMatchers.any()
  • Usage: checkPermission(anyObject(), anyObject(), anyObject()) → checkPermission(any(), any(), any())

@olexii4 olexii4 force-pushed the CHE-1442 branch 5 times, most recently from 4639781 to d93322a Compare February 11, 2026 22:47
- Handle edge cases where URI authority parsing fails
- Add defensive null checks for URI.getAuthority()
- Support IPv6 addresses in server URL extraction
- Add IPv6 test coverage for GitLab, GitHub and Azure DevOps parsers

Assisted-by: Cursor AI
Signed-off-by: Oleksii Orel <oorel@redhat.com>
Update Mockito version and adjust affected tests to use Mockito 5 compatible APIs:
- Replace InvocationMatcher with MatchableInvocation
- Replace getWanted() with getTarget()
- Replace anyObject() with any()/anyString()
- Remove spy() on mock objects

Assisted-by: Cursor AI
Signed-off-by: Oleksii Orel <oorel@redhat.com>
Updates the license header to fix the license-maven-plugin check failure.

Assisted-by: Cursor AI
Signed-off-by: Oleksii Orel <oorel@redhat.com>
Updates the license headers in AzureDevOpsURLParser and AzureDevOpsURLParserTest
to fix the license-maven-plugin check failure.

Assisted-by: Cursor AI
Signed-off-by: Oleksii Orel <oorel@redhat.com>
Optimizations:
- Reduce redundant pattern matching in AzureDevOpsURLParser.parse()
  by reusing matcher objects instead of creating new ones
- Replace ArrayList-based array concatenation with System.arraycopy
  in ConcurrentCompositeLineConsumerTest.appendTo() for better performance
- Remove unused ArrayList import

Assisted-by: Cursor AI
Signed-off-by: Oleksii Orel <oorel@redhat.com>
This commit adds complete IPv6 address support across all factory URL parsers for GitHub, GitLab, Azure DevOps, and Bitbucket Server.

Key changes:
- Fix GitLab double-bracketing bug in getPatternMatcherByUrl() where IPv6 addresses were wrapped in additional brackets
- Add complete IPv6 support to BitbucketServerURLParser (previously had no IPv6 support)
- Fix SSH URL parsing to correctly handle IPv6 addresses with bracket notation
- Add SSH-to-URI conversion helper methods to properly handle IPv6 in SSH URLs

Test coverage:
- Add 39 new IPv6 test cases across all parsers (from 4 to 43 total)
- Azure DevOps: 8 new IPv6 tests covering branches, tags, loopback, credentials
- GitHub: 8 new IPv6 tests covering branches, pull requests, dynamic patterns
- GitLab: 11 new IPv6 tests covering subgroups, validation, various URL formats
- Bitbucket Server: 12 new IPv6 tests (from zero coverage)

All 238 tests passing across all parsers.

Documentation:
- Add IPv6 verification verdict document detailing implementation analysis and test coverage

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Signed-off-by: Oleksii Orel <oorel@redhat.com>
.anyMatch(t -> Pattern.compile(format(t, schema, host)).matcher(repositoryUrl).matches())) {
.anyMatch(
t ->
Pattern.compile(format(t, schema, hostForRegex))

Check failure

Code scanning / CodeQL

Regular expression injection High

This regular expression is constructed from a
user-provided value
.
final String finalHostWithPort = hostWithPort;
return bitbucketUrlPatternTemplates.stream()
.map(t -> compile(format(t, scheme, host)).matcher(url))
.map(t -> compile(format(t, scheme, finalHostWithPort)).matcher(url))

Check failure

Code scanning / CodeQL

Regular expression injection High

This regular expression is constructed from a
user-provided value
.
This regular expression is constructed from a
user-provided value
.
This regular expression is constructed from a
user-provided value
.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add IPv6 Support to the User Dashboard

2 participants