seg_yinzy
/
che-server
mirror of https://github.com/eclipse-che/che-server.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Check the devfile content before creating a factory (#463) 

When Che creates a workspace from a repository URL, first we iterate and find a related git provider handler, then we gat a devfile location according to the handler rules. If we pass an unsupported git repository url we will have a default handler which will try find a devfile by the same url as the repository. In that case we will have an html content as a devfile.

We need to check the content before parsing the devfile, and throw a specific error in case if the content is not yaml.
pull/466/head
Igor Vinokur 2023-03-14 12:03:39 +02:00 committed by GitHub
parent 54827213f1
commit be757ec5a6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -135,9 +135,15 @@ public class URLFactoryBuilder {
if (isNullOrEmpty(devfileYamlContent)) {
return Optional.empty();
}
try {
JsonNode parsedDevfile = devfileParser.parseYamlRaw(devfileYamlContent);
// We might have an html content in the parsed devfile, in case if the access is restricted,
// or if the URL points to a wrong resource.
try {
devfileVersionDetector.devfileVersion(parsedDevfile);
} catch (DevfileException e) {
throw new ApiException("Failed to fetch devfile");
}
return Optional.of(
createFactory(parsedDevfile, overrideProperties, fileContentProvider, location));
} catch (OverrideParameterException e) {

17
wsmaster/che-core-api-factory/src/test/java/org/eclipse/che/api/factory/server/urlfactory/URLFactoryBuilderTest.java
View File

@ -21,6 +21,7 @@ import static org.eclipse.che.dto.server.DtoFactory.newDto;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyMap;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import static org.testng.Assert.assertEquals;
@ -444,6 +445,22 @@ public class URLFactoryBuilderTest {
}
}
@Test(
expectedExceptions = ApiException.class,
expectedExceptionsMessageRegExp = "Failed to fetch devfile")
public void shouldThrowErrorOnUnsupportedDevfileContent()
throws ApiException, DevfileException, IOException {
JsonNode jsonNode = mock(JsonNode.class);
when(fileContentProvider.fetchContent(eq("location"))).thenReturn("unsupported content");
when(devfileParser.parseYamlRaw(eq("unsupported content"))).thenReturn(jsonNode);
when(devfileVersionDetector.devfileVersion(eq(jsonNode))).thenThrow(new DevfileException(""));
urlFactoryBuilder.createFactoryFromDevfile(
new DefaultFactoryUrl().withDevfileFileLocation("location"),
fileContentProvider,
emptyMap(),
false);
}
@DataProvider
public static Object[][] devfileExceptions() {
return new Object[][] {