Devfile local features implenentation with schema validation and automated model build.

assembly/assembly-wsmaster-war/pom.xml

@@ -157,6 +157,10 @@
             <groupId>org.eclipse.che.core</groupId>
             <artifactId>che-core-api-core</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.eclipse.che.core</groupId>
+            <artifactId>che-core-api-devfile</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.eclipse.che.core</groupId>
             <artifactId>che-core-api-factory</artifactId>

assembly/assembly-wsmaster-war/src/main/java/org/eclipse/che/api/deploy/WsMasterModule.java

@@ -152,6 +152,9 @@ protected void configure() {
     bind(org.eclipse.che.api.user.server.PreferencesService.class);
     bind(org.eclipse.che.security.oauth.OAuthAuthenticationService.class);
 
+    bind(org.eclipse.che.api.devfile.server.DevFileSchemaValidator.class);
+    bind(org.eclipse.che.api.devfile.server.DevFileService.class);
+
     MapBinder<String, String> stacks =
         MapBinder.newMapBinder(
             binder(), String.class, String.class, Names.named(StackLoader.CHE_PREDEFINED_STACKS));

pom.xml

@@ -325,6 +325,11 @@
                 <version>${che.version}</version>
                 <classifier>sources</classifier>
             </dependency>
+            <dependency>
+                <groupId>org.eclipse.che.core</groupId>
+                <artifactId>che-core-api-devfile</artifactId>
+                <version>${che.version}</version>
+            </dependency>
             <dependency>
                 <groupId>org.eclipse.che.core</groupId>
                 <artifactId>che-core-api-dto</artifactId>

wsmaster/che-core-api-devfile/pom.xml

@@ -0,0 +1,149 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Copyright (c) 2012-2018 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
+
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <artifactId>che-master-parent</artifactId>
+        <groupId>org.eclipse.che.core</groupId>
+        <version>6.15.0-SNAPSHOT</version>
+    </parent>
+    <artifactId>che-core-api-devfile</artifactId>
+    <packaging>jar</packaging>
+    <name>Che Core :: API :: Devfile</name>
+    <dependencies>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-core</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.dataformat</groupId>
+            <artifactId>jackson-dataformat-yaml</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.github.java-json-tools</groupId>
+            <artifactId>json-schema-validator</artifactId>
+            <version>2.2.10</version>
+        </dependency>
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>javax.inject</groupId>
+            <artifactId>javax.inject</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.eclipse.che.core</groupId>
+            <artifactId>che-core-api-core</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.eclipse.che.core</groupId>
+            <artifactId>che-core-api-model</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.eclipse.che.core</groupId>
+            <artifactId>che-core-api-workspace</artifactId>
+        </dependency>
+        <dependency>
+            <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-json</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.everrest</groupId>
+            <artifactId>everrest-core</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>javax.servlet</groupId>
+            <artifactId>javax.servlet-api</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>javax.ws.rs</groupId>
+            <artifactId>javax.ws.rs-api</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.testng</groupId>
+            <artifactId>testng</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>build-helper-maven-plugin</artifactId>
+                <version>1.4</version>
+                <executions>
+                    <execution>
+                        <id>test</id>
+                        <phase>generate-sources</phase>
+                        <goals>
+                            <goal>add-source</goal>
+                        </goals>
+                        <configuration>
+                            <sources>
+                                <source>${basedir}/target/java-gen</source>
+                            </sources>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.jsonschema2pojo</groupId>
+                <artifactId>jsonschema2pojo-maven-plugin</artifactId>
+                <version>0.5.1</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>generate</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <sourceDirectory>${basedir}/src/main/resources/schema</sourceDirectory>
+                    <targetPackage>org.eclipse.che.api.devfile.model</targetPackage>
+                    <includeAdditionalProperties>false</includeAdditionalProperties>
+                    <includeHashcodeAndEquals>false</includeHashcodeAndEquals>
+                    <includeToString>false</includeToString>
+                    <initializeCollections>true</initializeCollections>
+                    <generateBuilders>true</generateBuilders>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-dependency-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>analyze</id>
+                        <configuration>
+                            <ignoredDependencies>
+                                <ignoredDependency>org.everrest:everrest-core</ignoredDependency>
+                            </ignoredDependencies>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+</project>

wsmaster/che-core-api-devfile/src/main/java/org/eclipse/che/api/devfile/server/Constants.java

@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2012-2018 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.devfile.server;
+
+public class Constants {
+
+  public static final String CURRENT_SPEC_VERSION = "0.0.1";
+}

wsmaster/che-core-api-devfile/src/main/java/org/eclipse/che/api/devfile/server/DevFileConverter.java

@@ -0,0 +1,191 @@
+/*
+ * Copyright (c) 2012-2018 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.devfile.server;
+
+import static com.google.common.base.Strings.isNullOrEmpty;
+import static java.lang.String.format;
+import static java.util.Collections.singletonMap;
+import static org.eclipse.che.api.devfile.server.Constants.CURRENT_SPEC_VERSION;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.StringJoiner;
+import org.eclipse.che.api.devfile.model.Action;
+import org.eclipse.che.api.devfile.model.Command;
+import org.eclipse.che.api.devfile.model.Devfile;
+import org.eclipse.che.api.devfile.model.Project;
+import org.eclipse.che.api.devfile.model.Source;
+import org.eclipse.che.api.devfile.model.Tool;
+import org.eclipse.che.api.workspace.server.model.impl.CommandImpl;
+import org.eclipse.che.api.workspace.server.model.impl.EnvironmentImpl;
+import org.eclipse.che.api.workspace.server.model.impl.MachineConfigImpl;
+import org.eclipse.che.api.workspace.server.model.impl.ProjectConfigImpl;
+import org.eclipse.che.api.workspace.server.model.impl.RecipeImpl;
+import org.eclipse.che.api.workspace.server.model.impl.SourceStorageImpl;
+import org.eclipse.che.api.workspace.server.model.impl.WorkspaceConfigImpl;
+
+public class DevFileConverter {
+
+  static Devfile workspaceToDevFile(WorkspaceConfigImpl wsConfig) {
+
+    Devfile devFile = new Devfile().withVersion(CURRENT_SPEC_VERSION).withName(wsConfig.getName());
+
+    // Manage projects
+    List<Project> projects = new ArrayList<>();
+    for (ProjectConfigImpl project : wsConfig.getProjects()) {
+      Source source =
+          new Source()
+              .withType(project.getSource().getType())
+              .withLocation(project.getSource().getLocation());
+      Project devProject = new Project().withName(project.getName()).withSource(source);
+      projects.add(devProject);
+    }
+    devFile.setProjects(projects);
+
+    // Manage commands
+    List<Command> commands = new ArrayList<>();
+    for (CommandImpl command : wsConfig.getCommands()) {
+      Command devCommand = new Command().withName(command.getName());
+      Action action =
+          new Action().withCommand(command.getCommandLine()).withType(command.getType());
+      if (!isNullOrEmpty(command.getAttributes().get("workingDir"))) {
+        action.setWorkdir(command.getAttributes().get("workingDir"));
+      }
+      // Remove internal attributes
+      command.getAttributes().remove("workingDir");
+      command.getAttributes().remove("pluginId");
+      // Put others
+      if (devCommand.getAttributes() == null) {
+        devCommand.withAttributes(command.getAttributes());
+      } else {
+        devCommand.getAttributes().putAll(command.getAttributes());
+      }
+
+      commands.add(devCommand);
+    }
+    devFile.setCommands(commands);
+
+    // Manage tools
+    List<Tool> tools = new ArrayList<>();
+    for (Map.Entry entry : wsConfig.getAttributes().entrySet()) {
+      if (entry.getKey().equals("editor")) {
+        String editorId = wsConfig.getAttributes().get("editor");
+        Tool editorTool =
+            new Tool()
+                .withType("cheEditor")
+                .withId(editorId)
+                .withName(wsConfig.getAttributes().get(editorId));
+        tools.add(editorTool);
+      } else if (entry.getKey().equals("plugins")) {
+        for (String pluginId : wsConfig.getAttributes().get("plugins").split(",")) {
+          Tool pluginTool =
+              new Tool()
+                  .withId(pluginId)
+                  .withType("chePlugin")
+                  .withName(wsConfig.getAttributes().get(pluginId));
+          tools.add(pluginTool);
+        }
+      }
+    }
+
+    devFile.setTools(tools);
+    return devFile;
+  }
+
+  static WorkspaceConfigImpl devFileToWorkspaceConfig(Devfile devFile)
+      throws DevFileFormatException {
+    validateCurrentVersion(devFile);
+    WorkspaceConfigImpl config = new WorkspaceConfigImpl();
+
+    config.setName(devFile.getName());
+
+    // Manage projects
+    List<ProjectConfigImpl> projects = new ArrayList<>();
+    for (Project devProject : devFile.getProjects()) {
+      ProjectConfigImpl projectConfig = new ProjectConfigImpl();
+      projectConfig.setName(devProject.getName());
+      projectConfig.setPath("/" + projectConfig.getName());
+      SourceStorageImpl sourceStorage = new SourceStorageImpl();
+      sourceStorage.setType(devProject.getSource().getType());
+      sourceStorage.setLocation(devProject.getSource().getLocation());
+      projectConfig.setSource(sourceStorage);
+      projects.add(projectConfig);
+    }
+    config.setProjects(projects);
+
+    // Manage tools
+    Map<String, String> attributes = new HashMap<>();
+    StringJoiner pluginsStringJoiner = new StringJoiner(",");
+    for (Tool tool : devFile.getTools()) {
+      if (tool.getType().equals("cheEditor")) {
+        attributes.put("editor", tool.getId());
+      } else if (tool.getType().equals("chePlugin")) {
+        pluginsStringJoiner.add(tool.getId());
+      }
+      attributes.put(tool.getId(), tool.getName());
+    }
+    attributes.put("plugins", pluginsStringJoiner.toString());
+    config.setAttributes(attributes);
+
+    // Manage commands
+    List<CommandImpl> commands = new ArrayList<>();
+    for (Command devCommand : devFile.getCommands()) {
+      for (Action devAction : devCommand.getActions()) {
+        CommandImpl command = new CommandImpl();
+        command.setName(devCommand.getName() + ":" + devAction.getTool());
+        command.setType(devAction.getType());
+        command.setCommandLine(devAction.getCommand());
+        if (devAction.getWorkdir() != null) {
+          command.getAttributes().put("workingDir", devAction.getWorkdir());
+        }
+        Optional<Tool> toolOfCommand =
+            devFile
+                .getTools()
+                .stream()
+                .filter(tool -> tool.getName().equals(devAction.getTool()))
+                .findFirst();
+        if (toolOfCommand.isPresent() && !isNullOrEmpty(toolOfCommand.get().getId())) {
+          command.getAttributes().put("pluginId", toolOfCommand.get().getId());
+        }
+        if (devCommand.getAttributes() != null) {
+          command.getAttributes().putAll(devCommand.getAttributes());
+        }
+        commands.add(command);
+      }
+    }
+
+    config.setCommands(commands);
+
+    // TODO: Add default environment. Remove when it will be possible
+    config.setDefaultEnv("default");
+    EnvironmentImpl environment = new EnvironmentImpl();
+    RecipeImpl recipe = new RecipeImpl();
+    recipe.setType("dockerimage");
+    recipe.setContent("eclipse/ubuntu_jdk8");
+    environment.setRecipe(recipe);
+    MachineConfigImpl machine = new MachineConfigImpl();
+    machine.setAttributes(singletonMap("memoryLimitBytes", "2147483648"));
+    environment.setMachines(singletonMap("dev-machine", machine));
+    config.setEnvironments(singletonMap("default", environment));
+    return config;
+  }
+
+  private static void validateCurrentVersion(Devfile devFile) throws DevFileFormatException {
+    if (!CURRENT_SPEC_VERSION.equals(devFile.getVersion())) {
+      throw new DevFileFormatException(
+          format("Provided devfile has unsupported version %s", devFile.getVersion()));
+    }
+  }
+}