Skip to content

Commit

Permalink
Simplify the Raw devfile filename check (#548)
Browse files Browse the repository at this point in the history
Do not check the Raw devfile file name but check if the url ends with .yaml before using the Raw devfile url resolver.
  • Loading branch information
vinokurig authored Sep 6, 2023
1 parent ea67092 commit 9d43803
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@
import org.eclipse.che.api.core.ApiException;
import org.eclipse.che.api.core.BadRequestException;
import org.eclipse.che.api.factory.server.urlfactory.DefaultFactoryUrl;
import org.eclipse.che.api.factory.server.urlfactory.DevfileFilenamesProvider;
import org.eclipse.che.api.factory.server.urlfactory.RemoteFactoryUrl;
import org.eclipse.che.api.factory.server.urlfactory.URLFactoryBuilder;
import org.eclipse.che.api.factory.shared.dto.FactoryMetaDto;
Expand All @@ -52,7 +51,6 @@ public class RawDevfileUrlFactoryParameterResolver implements FactoryParametersR

protected final URLFactoryBuilder urlFactoryBuilder;
protected final URLFetcher urlFetcher;
@Inject private DevfileFilenamesProvider devfileFilenamesProvider;

@Inject
public RawDevfileUrlFactoryParameterResolver(
Expand All @@ -71,9 +69,7 @@ public RawDevfileUrlFactoryParameterResolver(
@Override
public boolean accept(Map<String, String> factoryParameters) {
String url = factoryParameters.get(URL_PARAMETER_NAME);
return !isNullOrEmpty(url)
&& devfileFilenamesProvider.getConfiguredDevfileFilenames().stream()
.anyMatch(url::endsWith);
return !isNullOrEmpty(url) && (url.endsWith(".yaml") || url.endsWith(".yml"));
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,10 @@
import static org.testng.AssertJUnit.assertEquals;
import static org.testng.AssertJUnit.assertTrue;

import java.lang.reflect.Field;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.eclipse.che.api.core.BadRequestException;
import org.eclipse.che.api.factory.server.urlfactory.DevfileFilenamesProvider;
import org.eclipse.che.api.factory.server.urlfactory.RemoteFactoryUrl;
import org.eclipse.che.api.factory.server.urlfactory.URLFactoryBuilder;
import org.eclipse.che.api.workspace.server.devfile.DevfileParser;
Expand Down Expand Up @@ -67,8 +65,6 @@ public class RawDevfileUrlFactoryParameterResolverTest {
+ " reference: ../localfile\n";

@Mock private URLFetcher urlFetcher;
private final DevfileFilenamesProvider devfileFilenamesProvider =
new DevfileFilenamesProvider("devfile.yaml, .devfile.yaml");

@InjectMocks private RawDevfileUrlFactoryParameterResolver rawDevfileUrlFactoryParameterResolver;

Expand Down Expand Up @@ -167,16 +163,7 @@ public void shouldThrowExceptionOnInvalidURL(String url, String message) throws
}

@Test(dataProvider = "devfileNames")
public void shouldAcceptRawDevfileUrl(String devfileName)
throws NoSuchFieldException, IllegalAccessException {
// given
Field field =
rawDevfileUrlFactoryParameterResolver
.getClass()
.getDeclaredField("devfileFilenamesProvider");
field.setAccessible(true);
field.set(rawDevfileUrlFactoryParameterResolver, devfileFilenamesProvider);

public void shouldAcceptRawDevfileUrl(String devfileName) {
// when
boolean result =
rawDevfileUrlFactoryParameterResolver.accept(
Expand All @@ -186,6 +173,17 @@ public void shouldAcceptRawDevfileUrl(String devfileName)
assertTrue(result);
}

@Test
public void shouldNotAcceptRawDevfileUrl() {
// when
boolean result =
rawDevfileUrlFactoryParameterResolver.accept(
Collections.singletonMap(URL_PARAMETER_NAME, "https://host/user/repo.git"));

// then
assertFalse(result);
}

@DataProvider(name = "invalidURLsProvider")
private Object[][] invalidUrlsProvider() {
return new Object[][] {
Expand All @@ -200,6 +198,6 @@ private Object[][] invalidUrlsProvider() {

@DataProvider(name = "devfileNames")
private Object[] devfileNames() {
return new String[] {"devfile.yaml", ".devfile.yaml"};
return new String[] {"devfile.yaml", ".devfile.yaml", "any-name.yaml", "any-name.yml"};
}
}

0 comments on commit 9d43803

Please sign in to comment.