Respect branch parameter when resolving a devfile (#828)

* Respect branch parameter when resolving a devfile

* fixup! Respect branch parameter when resolving a devfile

* fixup! Respect branch parameter when resolving a devfile

Author: vinokurig

build/build.sh

@@ -200,7 +200,7 @@ build_image() {
       fi
 
       printf "${BOLD}Building image ${IMAGE_NAME}${NC}\n"
-      "${BUILDER}" build --platform ${BUILD_PLATFORMS} -f ${DIR}/.Dockerfile --manifest ${IMAGE_MANIFEST} .
+      "${BUILDER}" build --platform ${BUILD_PLATFORMS} -t ${IMAGE_NAME} -f ${DIR}/.Dockerfile --manifest ${IMAGE_MANIFEST} .
       DOCKER_STATUS=$?
       if [ ! $DOCKER_STATUS -eq 0 ]; then
         printf "${RED}Failure when building docker image ${IMAGE_NAME}${NC}\n"

wsmaster/che-core-api-factory-azure-devops/pom.xml

@@ -82,6 +82,10 @@
             <groupId>org.eclipse.che.core</groupId>
             <artifactId>che-core-api-workspace-shared</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.eclipse.che.core</groupId>
+            <artifactId>che-core-commons-annotations</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.eclipse.che.core</groupId>
             <artifactId>che-core-commons-lang</artifactId>

wsmaster/che-core-api-factory-azure-devops/src/main/java/org/eclipse/che/api/factory/server/azure/devops/AzureDevOpsFactoryParametersResolver.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012-2024 Red Hat, Inc.
+ * Copyright (c) 2012-2025 Red Hat, Inc.
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
  * which is available at https://www.eclipse.org/legal/epl-2.0/
@@ -11,6 +11,7 @@
  */
 package org.eclipse.che.api.factory.server.azure.devops;
 
+import static org.eclipse.che.api.factory.shared.Constants.REVISION_PARAMETER_NAME;
 import static org.eclipse.che.api.factory.shared.Constants.URL_PARAMETER_NAME;
 import static org.eclipse.che.dto.server.DtoFactory.newDto;
 
@@ -82,7 +83,9 @@ public FactoryMetaDto createFactory(@NotNull final Map<String, String> factoryPa
       throws ApiException {
     // no need to check null value of url parameter as accept() method has performed the check
     final AzureDevOpsUrl azureDevOpsUrl =
-        azureDevOpsURLParser.parse(factoryParameters.get(URL_PARAMETER_NAME));
+        azureDevOpsURLParser.parse(
+            factoryParameters.get(URL_PARAMETER_NAME),
+            factoryParameters.get(REVISION_PARAMETER_NAME));
 
     // create factory from the following location if location exists, else create default factory
     return createFactory(
@@ -118,7 +121,7 @@ public FactoryDevfileV2Dto visit(FactoryDevfileV2Dto factoryDto) {
 
   @Override
   public RemoteFactoryUrl parseFactoryUrl(String factoryUrl) throws ApiException {
-    return azureDevOpsURLParser.parse(factoryUrl);
+    return azureDevOpsURLParser.parse(factoryUrl, null);
   }
 
   private SourceStorageDto buildWorkspaceConfigSource(AzureDevOpsUrl azureDevOpsUrl) {

wsmaster/che-core-api-factory-azure-devops/src/main/java/org/eclipse/che/api/factory/server/azure/devops/AzureDevOpsScmFileResolver.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012-2023 Red Hat, Inc.
+ * Copyright (c) 2012-2025 Red Hat, Inc.
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
  * which is available at https://www.eclipse.org/legal/epl-2.0/
@@ -52,7 +52,7 @@ public boolean accept(@NotNull String repository) {
   @Override
   public String fileContent(@NotNull String repository, @NotNull String filePath)
       throws ApiException {
-    final AzureDevOpsUrl azureDevOpsUrl = azureDevOpsURLParser.parse(repository);
+    final AzureDevOpsUrl azureDevOpsUrl = azureDevOpsURLParser.parse(repository, null);
     try {
       return fetchContent(azureDevOpsUrl, filePath, false);
     } catch (DevfileException exception) {

wsmaster/che-core-api-factory-azure-devops/src/main/java/org/eclipse/che/api/factory/server/azure/devops/AzureDevOpsURLParser.java

@@ -32,6 +32,7 @@
 import org.eclipse.che.api.factory.server.scm.exception.UnknownScmProviderException;
 import org.eclipse.che.api.factory.server.scm.exception.UnsatisfiedScmPreconditionException;
 import org.eclipse.che.api.factory.server.urlfactory.DevfileFilenamesProvider;
+import org.eclipse.che.commons.annotation.Nullable;
 
 /**
  * Parser of String Azure DevOps URLs and provide {@link AzureDevOpsUrl} objects.
@@ -155,7 +156,7 @@ private IllegalArgumentException buildIllegalArgumentException(String url) {
         format("The given url %s is not a valid Azure DevOps URL. ", url));
   }
 
-  public AzureDevOpsUrl parse(String url) {
+  public AzureDevOpsUrl parse(String url, @Nullable String revision) {
     Matcher matcher;
     boolean isHTTPSUrl = azureDevOpsPattern.matcher(url).matches();
     if (isHTTPSUrl) {
@@ -179,13 +180,13 @@ public AzureDevOpsUrl parse(String url) {
       project = repoName;
     }
 
-    String branch = null;
+    String branchFromUrl = null;
     String tag = null;
 
     String organization = matcher.group("organization");
     String urlToReturn = url;
     if (isHTTPSUrl) {
-      branch = matcher.group("branch");
+      branchFromUrl = matcher.group("branch");
       tag = matcher.group("tag");
       // The url might have the following formats:
       // - https://<organization>@<host>/<organization>/<project>/_git/<repoName>
@@ -207,7 +208,7 @@ public AzureDevOpsUrl parse(String url) {
         .withProject(project)
         .withRepository(repoName)
         .withOrganization(organization)
-        .withBranch(branch)
+        .withBranch(isNullOrEmpty(branchFromUrl) ? revision : branchFromUrl)
         .withTag(tag)
         .withDevfileFilenames(devfileFilenamesProvider.getConfiguredDevfileFilenames())
         .withServerUrl(serverUrl)

wsmaster/che-core-api-factory-azure-devops/src/test/java/org/eclipse/che/api/factory/server/azure/devops/AzureDevOpsURLParserTest.java

@@ -40,7 +40,22 @@ protected void start() {
 
   @Test(expectedExceptions = IllegalArgumentException.class)
   public void testParseInvalidUrl() {
-    azureDevOpsURLParser.parse("http://www.eclipse.org");
+    azureDevOpsURLParser.parse("http://www.eclipse.org", null);
+  }
+
+  @Test
+  public void shouldParseWithBranch() {
+    AzureDevOpsUrl azureDevOpsUrl =
+        azureDevOpsURLParser.parse("https://dev.azure.com/MyOrg/MyProject/_git/MyRepo", "branch");
+    assertEquals(azureDevOpsUrl.getBranch(), "branch");
+  }
+
+  @Test
+  public void shouldParseWithUrlBranch() {
+    AzureDevOpsUrl azureDevOpsUrl =
+        azureDevOpsURLParser.parse(
+            "https://dev.azure-server.com/MyOrg/MyProject/_git/MyRepo?version=GBmain", "branch");
+    assertEquals(azureDevOpsUrl.getBranch(), "main");
   }
 
   @Test(dataProvider = "parsing")
@@ -51,7 +66,7 @@ public void testParse(
       String repository,
       String branch,
       String tag) {
-    AzureDevOpsUrl azureDevOpsUrl = azureDevOpsURLParser.parse(url);
+    AzureDevOpsUrl azureDevOpsUrl = azureDevOpsURLParser.parse(url, null);
 
     assertEquals(azureDevOpsUrl.getOrganization(), organization);
     assertEquals(azureDevOpsUrl.getProject(), project);
@@ -68,7 +83,7 @@ public void testParseServer(
       String repository,
       String branch,
       String tag) {
-    AzureDevOpsUrl azureDevOpsUrl = azureDevOpsURLParser.parse(url);
+    AzureDevOpsUrl azureDevOpsUrl = azureDevOpsURLParser.parse(url, null);
 
     assertEquals(azureDevOpsUrl.getOrganization(), organization);
     assertEquals(azureDevOpsUrl.getProject(), project);
@@ -362,7 +377,7 @@ public Object[][] expectedServerParsing() {
 
   @Test(dataProvider = "url")
   public void testCredentials(String url, String organization, Optional<String> credentials) {
-    AzureDevOpsUrl azureDevOpsUrl = azureDevOpsURLParser.parse(url);
+    AzureDevOpsUrl azureDevOpsUrl = azureDevOpsURLParser.parse(url, null);
 
     assertEquals(azureDevOpsUrl.getOrganization(), organization);
     assertEquals(azureDevOpsUrl.getCredentials(), credentials);

wsmaster/che-core-api-factory-azure-devops/src/test/java/org/eclipse/che/api/factory/server/azure/devops/AzureDevOpsURLTest.java

@@ -44,7 +44,7 @@ public void checkDevfileLocation(String repoUrl, String fileUrl) {
 
     AzureDevOpsUrl azureDevOpsUrl =
         azureDevOpsURLParser
-            .parse(repoUrl)
+            .parse(repoUrl, null)
             .withDevfileFilenames(Arrays.asList("devfile.yaml", "foo.bar"));
     assertEquals(azureDevOpsUrl.devfileFileLocations().size(), 2);
     Iterator<RemoteFactoryUrl.DevfileLocation> iterator =
@@ -59,7 +59,7 @@ public void checkDevfileLocationServer(String repoUrl, String fileUrl) {
 
     AzureDevOpsUrl azureDevOpsUrl =
         azureDevOpsURLParser
-            .parse(repoUrl)
+            .parse(repoUrl, null)
             .withDevfileFilenames(Arrays.asList("devfile.yaml", "foo.bar"));
     assertEquals(azureDevOpsUrl.devfileFileLocations().size(), 2);
     Iterator<RemoteFactoryUrl.DevfileLocation> iterator =
@@ -223,13 +223,13 @@ public static Object[][] urlsProviderServer() {
 
   @Test(dataProvider = "repoProvider")
   public void checkRepositoryLocation(String rawUrl, String repoUrl) {
-    AzureDevOpsUrl azureDevOpsUrl = azureDevOpsURLParser.parse(rawUrl);
+    AzureDevOpsUrl azureDevOpsUrl = azureDevOpsURLParser.parse(rawUrl, null);
     assertEquals(azureDevOpsUrl.getRepositoryLocation(), repoUrl);
   }
 
   @Test(dataProvider = "repoProviderServer")
   public void checkRepositoryLocationServer(String rawUrl, String repoUrl) {
-    AzureDevOpsUrl azureDevOpsUrl = azureDevOpsURLParser.parse(rawUrl);
+    AzureDevOpsUrl azureDevOpsUrl = azureDevOpsURLParser.parse(rawUrl, null);
     assertEquals(azureDevOpsUrl.getRepositoryLocation(), repoUrl);
   }
 

wsmaster/che-core-api-factory-bitbucket-server/src/main/java/org/eclipse/che/api/factory/server/bitbucket/BitbucketServerAuthorizingFactoryParametersResolver.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012-2024 Red Hat, Inc.
+ * Copyright (c) 2012-2025 Red Hat, Inc.
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
  * which is available at https://www.eclipse.org/legal/epl-2.0/
@@ -11,6 +11,7 @@
  */
 package org.eclipse.che.api.factory.server.bitbucket;
 
+import static org.eclipse.che.api.factory.shared.Constants.REVISION_PARAMETER_NAME;
 import static org.eclipse.che.api.factory.shared.Constants.URL_PARAMETER_NAME;
 import static org.eclipse.che.dto.server.DtoFactory.newDto;
 
@@ -94,7 +95,9 @@ public FactoryMetaDto createFactory(@NotNull final Map<String, String> factoryPa
 
     // no need to check null value of url parameter as accept() method has performed the check
     final BitbucketServerUrl bitbucketServerUrl =
-        bitbucketURLParser.parse(factoryParameters.get(URL_PARAMETER_NAME));
+        bitbucketURLParser.parse(
+            factoryParameters.get(URL_PARAMETER_NAME),
+            factoryParameters.get(REVISION_PARAMETER_NAME));
     // create factory from the following location if location exists, else create default factory
     return createFactory(
         factoryParameters,
@@ -135,6 +138,6 @@ public FactoryDevfileV2Dto visit(FactoryDevfileV2Dto factoryDto) {
 
   @Override
   public RemoteFactoryUrl parseFactoryUrl(String factoryUrl) throws ApiException {
-    return bitbucketURLParser.parse(factoryUrl);
+    return bitbucketURLParser.parse(factoryUrl, null);
   }
 }

wsmaster/che-core-api-factory-bitbucket-server/src/main/java/org/eclipse/che/api/factory/server/bitbucket/BitbucketServerScmFileResolver.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012-2023 Red Hat, Inc.
+ * Copyright (c) 2012-2025 Red Hat, Inc.
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
  * which is available at https://www.eclipse.org/legal/epl-2.0/
@@ -47,7 +47,7 @@ public boolean accept(String repository) {
   @Override
   public String fileContent(String repository, String filePath) throws ApiException {
 
-    BitbucketServerUrl bitbucketServerUrl = bitbucketURLParser.parse(repository);
+    BitbucketServerUrl bitbucketServerUrl = bitbucketURLParser.parse(repository, null);
 
     try {
       return fetchContent(bitbucketServerUrl, filePath, false);

wsmaster/che-core-api-factory-bitbucket-server/src/main/java/org/eclipse/che/api/factory/server/bitbucket/BitbucketServerURLParser.java

@@ -182,12 +182,12 @@ private Optional<Matcher> getPatternMatcherByUrl(String url) {
    * https://bitbucket.apps.cluster-cb82.cb82.example.opentlc.com/scm/test/test1.git into
    * BitbucketUrl objects.
    */
-  public BitbucketServerUrl parse(String url) {
+  public BitbucketServerUrl parse(String url, @Nullable String revision) {
 
     if (bitbucketUrlPatterns.isEmpty()) {
       Optional<Matcher> matcherOptional = getPatternMatcherByUrl(url);
       if (matcherOptional.isPresent()) {
-        return parse(matcherOptional.get());
+        return parse(matcherOptional.get(), revision);
       }
       throw new UnsupportedOperationException(
           "The Bitbucket integration is not configured properly and cannot be used at this moment."
@@ -205,10 +205,10 @@ public BitbucketServerUrl parse(String url) {
                         format(
                             "The given url %s is not a valid Bitbucket server URL. Check either URL or server configuration.",
                             url)));
-    return parse(matcher).withUrl(url);
+    return parse(matcher, revision).withUrl(url);
   }
 
-  private BitbucketServerUrl parse(Matcher matcher) {
+  private BitbucketServerUrl parse(Matcher matcher, @Nullable String revision) {
     String scheme = matcher.group("scheme");
     String host = matcher.group("host");
     String port = null;
@@ -225,9 +225,9 @@ private BitbucketServerUrl parse(Matcher matcher) {
       project = matcher.group("project");
     }
     String repoName = matcher.group("repo");
-    String branch = null;
+    String branchFromUrl = null;
     try {
-      branch = matcher.group("branch");
+      branchFromUrl = matcher.group("branch");
     } catch (IllegalArgumentException e) {
       // keep branch with null, as the pattern doesn't have the branch group
     }
@@ -239,7 +239,7 @@ private BitbucketServerUrl parse(Matcher matcher) {
         .withProject(project)
         .withUser(user)
         .withRepository(repoName)
-        .withBranch(branch)
+        .withBranch(isNullOrEmpty(branchFromUrl) ? revision : branchFromUrl)
         .withDevfileFilenames(devfileFilenamesProvider.getConfiguredDevfileFilenames());
   }
 }