Support Basic authentication for devfile factory URL

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

@@ -169,7 +169,7 @@ 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);
+    return parse(matcher).withUrl(url);
   }
 
   private BitbucketServerUrl parse(Matcher matcher) {

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

@@ -19,10 +19,10 @@
 import java.util.Optional;
 import java.util.StringJoiner;
 import java.util.stream.Collectors;
-import org.eclipse.che.api.factory.server.urlfactory.RemoteFactoryUrl;
+import org.eclipse.che.api.factory.server.urlfactory.DefaultFactoryUrl;
 
 /** Representation of a bitbucket Server URL, allowing to get details from it. */
-public class BitbucketServerUrl implements RemoteFactoryUrl {
+public class BitbucketServerUrl extends DefaultFactoryUrl {
 
   private final String NAME = "bitbucket";
 

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

@@ -61,6 +61,7 @@ public BitbucketUrl parse(String url) {
         .withRepository(repoName)
         .withBranch(branchName)
         .withWorkspaceId(workspaceId)
-        .withDevfileFilenames(devfileFilenamesProvider.getConfiguredDevfileFilenames());
+        .withDevfileFilenames(devfileFilenamesProvider.getConfiguredDevfileFilenames())
+        .withUrl(url);
   }
 }

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

@@ -19,14 +19,14 @@
 import java.util.Optional;
 import java.util.StringJoiner;
 import java.util.stream.Collectors;
-import org.eclipse.che.api.factory.server.urlfactory.RemoteFactoryUrl;
+import org.eclipse.che.api.factory.server.urlfactory.DefaultFactoryUrl;
 
 /**
  * Representation of a bitbucket URL, allowing to get details from it.
  *
  * <p>like https://<your_username>@bitbucket.org/<workspace_ID>/<repo_name>.git
  */
-public class BitbucketUrl implements RemoteFactoryUrl {
+public class BitbucketUrl extends DefaultFactoryUrl {
 
   private final String NAME = "bitbucket";
 

wsmaster/che-core-api-factory-github/src/main/java/org/eclipse/che/api/factory/server/github/GithubURLParser.java

@@ -174,7 +174,8 @@ private GithubUrl parse(String url, boolean authenticationRequired) throws ApiEx
         .withBranch(branchName)
         .withLatestCommit(latestCommit)
         .withSubfolder(matcher.group("subFolder"))
-        .withDevfileFilenames(devfileFilenamesProvider.getConfiguredDevfileFilenames());
+        .withDevfileFilenames(devfileFilenamesProvider.getConfiguredDevfileFilenames())
+        .withUrl(url);
   }
 
   private GithubPullRequest getPullRequest(

wsmaster/che-core-api-factory-github/src/main/java/org/eclipse/che/api/factory/server/github/GithubUrl.java

@@ -18,7 +18,7 @@
 import java.util.Optional;
 import java.util.StringJoiner;
 import java.util.stream.Collectors;
-import org.eclipse.che.api.factory.server.urlfactory.RemoteFactoryUrl;
+import org.eclipse.che.api.factory.server.urlfactory.DefaultFactoryUrl;
 
 /**
  * Representation of a github URL, allowing to get details from it.
@@ -28,7 +28,7 @@
  *
  * @author Florent Benoit
  */
-public class GithubUrl implements RemoteFactoryUrl {
+public class GithubUrl extends DefaultFactoryUrl {
 
   private final String NAME = "github";
 

wsmaster/che-core-api-factory-gitlab/src/main/java/org/eclipse/che/api/factory/server/gitlab/GitlabUrl.java

@@ -20,7 +20,7 @@
 import java.util.Optional;
 import java.util.StringJoiner;
 import java.util.stream.Collectors;
-import org.eclipse.che.api.factory.server.urlfactory.RemoteFactoryUrl;
+import org.eclipse.che.api.factory.server.urlfactory.DefaultFactoryUrl;
 
 /**
  * Representation of a gitlab URL, allowing to get details from it.
@@ -30,7 +30,7 @@
  *
  * @author Max Shaposhnyk
  */
-public class GitlabUrl implements RemoteFactoryUrl {
+public class GitlabUrl extends DefaultFactoryUrl {
 
   private final String NAME = "gitlab";
 

wsmaster/che-core-api-factory-gitlab/src/main/java/org/eclipse/che/api/factory/server/gitlab/GitlabUrlParser.java

@@ -153,7 +153,7 @@ public GitlabUrl parse(String url) {
             .findFirst()
             .or(() -> getPatternMatcherByUrl(url));
     if (matcherOptional.isPresent()) {
-      return parse(matcherOptional.get());
+      return parse(matcherOptional.get()).withUrl(url);
     } else {
       throw new UnsupportedOperationException(
           "The gitlab integration is not configured properly and cannot be used at this moment."

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

@@ -88,7 +88,9 @@ public FactoryMetaDto createFactory(@NotNull final Map<String, String> factoryPa
     }
     return urlFactoryBuilder
         .createFactoryFromDevfile(
-            new DefaultFactoryUrl().withDevfileFileLocation(devfileLocation),
+            new DefaultFactoryUrl()
+                .withDevfileFileLocation(devfileLocation)
+                .withUrl(devfileLocation),
             new URLFileContentProvider(devfileURI, urlFetcher),
             extractOverrideParams(factoryParameters),
             false)

wsmaster/che-core-api-factory/src/main/java/org/eclipse/che/api/factory/server/scm/AuthorizingFileContentProvider.java

@@ -11,10 +11,13 @@
  */
 package org.eclipse.che.api.factory.server.scm;
 
+import static com.google.common.base.Strings.isNullOrEmpty;
+
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.net.URI;
 import java.net.URISyntaxException;
+import java.util.Base64;
 import javax.net.ssl.SSLException;
 import org.eclipse.che.api.factory.server.scm.exception.ScmCommunicationException;
 import org.eclipse.che.api.factory.server.scm.exception.ScmConfigurationPersistenceException;
@@ -25,6 +28,7 @@
 import org.eclipse.che.api.workspace.server.devfile.FileContentProvider;
 import org.eclipse.che.api.workspace.server.devfile.URLFetcher;
 import org.eclipse.che.api.workspace.server.devfile.exception.DevfileException;
+import org.eclipse.che.commons.annotation.Nullable;
 
 /**
  * Common implementation of file content provider which is able to access content of private
@@ -48,26 +52,41 @@ public AuthorizingFileContentProvider(
 
   @Override
   public String fetchContent(String fileURL) throws IOException, DevfileException {
-    return fetchContent(fileURL, false);
+    return fetchContent(fileURL, false, null);
+  }
+
+  @Override
+  public String fetchContent(String fileURL, String credentials)
+      throws IOException, DevfileException {
+    return fetchContent(fileURL, false, credentials);
   }
 
   @Override
   public String fetchContentWithoutAuthentication(String fileURL)
       throws IOException, DevfileException {
-    return fetchContent(fileURL, true);
+    return fetchContent(fileURL, true, null);
   }
 
-  protected String fetchContent(String fileURL, boolean skipAuthentication)
+  private String fetchContent(
+      String fileURL, boolean skipAuthentication, @Nullable String credentials)
       throws IOException, DevfileException {
     final String requestURL = formatUrl(fileURL);
     try {
       if (skipAuthentication) {
         return urlFetcher.fetch(requestURL);
       } else {
         // try to authenticate for the given URL
-        PersonalAccessToken token =
-            personalAccessTokenManager.getAndStore(remoteFactoryUrl.getHostName());
-        return urlFetcher.fetch(requestURL, formatAuthorization(token.getToken()));
+        String authorization;
+        if (isNullOrEmpty(credentials)) {
+          authorization =
+              formatAuthorization(
+                  personalAccessTokenManager
+                      .getAndStore(remoteFactoryUrl.getHostName())
+                      .getToken());
+        } else {
+          authorization = getCredentialsAuthorization(credentials);
+        }
+        return urlFetcher.fetch(requestURL, authorization);
       }
     } catch (UnknownScmProviderException e) {
       return fetchContentWithoutToken(requestURL, e);
@@ -143,4 +162,8 @@ protected String formatUrl(String fileURL) throws DevfileException {
   protected String formatAuthorization(String token) {
     return "Bearer " + token;
   }
+
+  private String getCredentialsAuthorization(String credentials) {
+    return "Basic " + new String(Base64.getEncoder().encode(credentials.getBytes()));
+  }
 }

wsmaster/che-core-api-factory/src/main/java/org/eclipse/che/api/factory/server/urlfactory/DefaultFactoryUrl.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012-2021 Red Hat, Inc.
+ * Copyright (c) 2012-2023 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,11 +11,16 @@
  */
 package org.eclipse.che.api.factory.server.urlfactory;
 
+import static com.google.common.base.Strings.isNullOrEmpty;
+import static java.lang.String.format;
 import static java.util.Collections.singletonList;
+import static java.util.regex.Pattern.compile;
 
 import java.net.URI;
 import java.util.List;
 import java.util.Optional;
+import java.util.regex.Matcher;
+import org.eclipse.che.commons.annotation.Nullable;
 
 /**
  * Default implementation of {@link RemoteFactoryUrl} which used with all factory URL's until there
@@ -24,6 +29,7 @@
 public class DefaultFactoryUrl implements RemoteFactoryUrl {
 
   private String devfileFileLocation;
+  private String url;
 
   @Override
   public String getProviderName() {
@@ -61,6 +67,38 @@ public String getBranch() {
     return null;
   }
 
+  @Override
+  public @Nullable String getCredentials() {
+    if (isNullOrEmpty(url)) {
+      return null;
+    }
+    Matcher matcher =
+        compile("https?://((?<username>[^:|@]+)?:?(?<password>[^@]+)?@)?.*").matcher(url);
+    String password = null;
+    String username = null;
+    try {
+      username = matcher.matches() ? matcher.group("username") : null;
+    } catch (IllegalArgumentException e) {
+      // no such group
+    }
+    try {
+      password = matcher.matches() ? matcher.group("password") : null;
+    } catch (IllegalArgumentException e) {
+      // no such group
+    }
+    if (!isNullOrEmpty(username) || !isNullOrEmpty(password)) {
+      return format(
+          "%s:%s",
+          isNullOrEmpty(username) ? "" : username, isNullOrEmpty(password) ? "" : password);
+    }
+    return null;
+  }
+
+  public <T extends DefaultFactoryUrl> T withUrl(String url) {
+    this.url = url;
+    return (T) this;
+  }
+
   public DefaultFactoryUrl withDevfileFileLocation(String devfileFileLocation) {
     this.devfileFileLocation = devfileFileLocation;
     return this;

wsmaster/che-core-api-factory/src/main/java/org/eclipse/che/api/factory/server/urlfactory/RemoteFactoryUrl.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012-2021 Red Hat, Inc.
+ * Copyright (c) 2012-2023 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/
@@ -42,6 +42,9 @@ public interface RemoteFactoryUrl {
   /** Remote branch */
   String getBranch();
 
+  /** Credentials in format <username>:<password> */
+  String getCredentials();
+
   /** Describes devfile location, including filename if any. */
   interface DevfileLocation {
     Optional<String> filename();

wsmaster/che-core-api-factory/src/main/java/org/eclipse/che/api/factory/server/urlfactory/URLFactoryBuilder.java

@@ -115,7 +115,8 @@ public Optional<FactoryMetaDto> createFactoryFromDevfile(
         devfileYamlContent =
             skipAuthentication
                 ? fileContentProvider.fetchContentWithoutAuthentication(location.location())
-                : fileContentProvider.fetchContent(location.location());
+                : fileContentProvider.fetchContent(
+                    location.location(), remoteFactoryUrl.getCredentials());
       } catch (IOException ex) {
         // try next location
         LOG.debug(

wsmaster/che-core-api-factory/src/test/java/org/eclipse/che/api/factory/server/DefaultFactoryParameterResolverTest.java

@@ -91,14 +91,14 @@ public void shouldResolveRelativeFiles() throws Exception {
     // set up our factory with the location of our devfile that is referencing our localfile
     Map<String, String> factoryParameters = new HashMap<>();
     factoryParameters.put(URL_PARAMETER_NAME, "http://myloc.com/aa/bb/devfile");
-    doReturn(DEVFILE).when(urlFetcher).fetch(eq("http://myloc.com/aa/bb/devfile"));
-    doReturn("localfile").when(urlFetcher).fetch("http://myloc.com/aa/localfile");
+    doReturn(DEVFILE).when(urlFetcher).fetch(eq("http://myloc.com/aa/bb/devfile"), eq(null));
+    doReturn("localfile").when(urlFetcher).fetch("http://myloc.com/aa/localfile", null);
 
     // when
     res.createFactory(factoryParameters);
 
     // then
-    verify(urlFetcher).fetch(eq("http://myloc.com/aa/localfile"));
+    verify(urlFetcher).fetch(eq("http://myloc.com/aa/localfile"), eq(null));
   }
 
   @Test

wsmaster/che-core-api-factory/src/test/java/org/eclipse/che/api/factory/server/urlfactory/DefaultFactoryUrlTest.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2012-2023 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/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.che.api.factory.server.urlfactory;
+
+import static org.testng.Assert.assertEquals;
+import static org.testng.Assert.assertNull;
+
+import org.mockito.testng.MockitoTestNGListener;
+import org.testng.annotations.Listeners;
+import org.testng.annotations.Test;
+
+/** Testing {@link DefaultFactoryUrl} */
+@Listeners(MockitoTestNGListener.class)
+public class DefaultFactoryUrlTest {
+  @Test
+  public void shouldCredentials() {
+    // given
+    DefaultFactoryUrl factoryUrl =
+        new DefaultFactoryUrl().withUrl("https://username:password@hostname/path");
+    // when
+    String credentials = factoryUrl.getCredentials();
+    // then
+    assertEquals(credentials, "username:password");
+  }
+
+  @Test
+  public void shouldCredentialsWithoutPassword() {
+    // given
+    DefaultFactoryUrl factoryUrl =
+        new DefaultFactoryUrl().withUrl("https://username@hostname/path");
+    // when
+    String credentials = factoryUrl.getCredentials();
+    // then
+    assertEquals(credentials, "username:");
+  }
+
+  @Test
+  public void shouldGetNullCredentials() {
+    // given
+    DefaultFactoryUrl factoryUrl = new DefaultFactoryUrl().withUrl("https://hostname/path");
+    // when
+    String credentials = factoryUrl.getCredentials();
+    // then
+    assertNull(credentials);
+  }
+}