@eclipse-che/che-devworkspace-generator 0.0.1-09a1f81

package/src/entrypoint.ts

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+/**********************************************************************
+ * Copyright (c) 2022 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
+ ***********************************************************************/
+
+import 'reflect-metadata';
+
+import { Main } from './main';
+
+(async (): Promise<void> => {
+  const main = new Main();
+  const success = await main.start();
+  if (!success) {
+    process.exit(1);
+  }
+})();

package/src/fetch/fetch-module.ts

@@ -0,0 +1,18 @@
+/**********************************************************************
+ * Copyright (c) 2022 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
+ ***********************************************************************/
+import { ContainerModule, interfaces } from 'inversify';
+
+import { UrlFetcher } from './url-fetcher';
+
+const fetchModule = new ContainerModule((bind: interfaces.Bind) => {
+  bind(UrlFetcher).toSelf().inSingletonScope();
+});
+
+export { fetchModule };

package/src/fetch/url-fetcher.ts

@@ -0,0 +1,49 @@
+/**********************************************************************
+ * Copyright (c) 2022 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
+ ***********************************************************************/
+import { inject, injectable } from 'inversify';
+
+import { AxiosInstance } from 'axios';
+
+/**
+ * Allow to grab external content
+ * if browser support is enabled, it will update URLs to make them work on browser side.
+ */
+@injectable()
+export class UrlFetcher {
+  // Can't use AxiosInstance interface there
+  @inject(Symbol.for('AxiosInstance'))
+  private axiosInstance: AxiosInstance;
+
+  // fetch content optionally, if the URL is not found, we return undefined without throwing errors
+  async fetchTextOptionalContent(url: string): Promise<string | undefined> {
+    try {
+      const response = await this.axiosInstance.get<string>(url, {
+        responseType: 'text',
+      });
+      return response.data;
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    } catch (error: any) {
+      // not found then we return undefined
+      if (error.response && error.response.status === 404) {
+        return undefined;
+      }
+      throw error;
+    }
+  }
+
+  // fetch content
+  async fetchText(url: string): Promise<string> {
+    const response = await this.axiosInstance.get<string>(url, {
+      responseType: 'text',
+    });
+    return response.data;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  }
+}

package/src/generate.ts

@@ -0,0 +1,122 @@
+/**********************************************************************
+ * Copyright (c) 2022 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
+ ***********************************************************************/
+
+import {
+  V1alpha2DevWorkspace,
+  V1alpha2DevWorkspaceSpecContributions,
+  V1alpha2DevWorkspaceSpecTemplateComponents,
+  V1alpha2DevWorkspaceTemplate,
+  V1alpha2DevWorkspaceTemplateSpec,
+} from '@devfile/api';
+import { injectable, inject } from 'inversify';
+import * as jsYaml from 'js-yaml';
+import * as fs from 'fs-extra';
+import { DevfileContext } from './api/devfile-context';
+import { DevContainerComponentFinder } from './devfile/dev-container-component-finder';
+
+@injectable()
+export class Generate {
+  static readonly MERGE_CONTRIBUTION = 'controller.devfile.io/merge-contribution';
+
+  @inject(DevContainerComponentFinder)
+  private devContainerComponentFinder: DevContainerComponentFinder;
+
+  async generate(devfileContent: string, editorContent: string, outputFile?: string): Promise<DevfileContext> {
+    const context = await this.generateContent(devfileContent, editorContent);
+
+    // write the result
+    if (outputFile) {
+      // write templates and then DevWorkspace in a single file
+      const allContentArray = context.devWorkspaceTemplates.map(template => jsYaml.dump(template));
+      allContentArray.push(jsYaml.dump(context.devWorkspace));
+
+      const generatedContent = allContentArray.join('---\n');
+
+      await fs.writeFile(outputFile, generatedContent, 'utf-8');
+    }
+
+    console.log(`DevWorkspace ${context.devWorkspaceTemplates[0].metadata.name} was generated.`);
+    return context;
+  }
+
+  async generateContent(devfileContent: string, editorContent: string): Promise<DevfileContext> {
+    const devfile = jsYaml.load(devfileContent);
+
+    // const originalDevfile = Object.assign({}, devfile);
+    // sets the suffix to the devfile name
+    const suffix = devfile.metadata.name || '';
+
+    // devfile of the editor
+    const editorDevfile = jsYaml.load(editorContent);
+
+    // transform it into a devWorkspace template
+    const metadata = editorDevfile.metadata;
+    // add sufix
+    metadata.name = `${metadata.name}-${suffix}`;
+    delete editorDevfile.metadata;
+    delete editorDevfile.schemaVersion;
+    const editorDevWorkspaceTemplate: V1alpha2DevWorkspaceTemplate = {
+      apiVersion: 'workspace.devfile.io/v1alpha2',
+      kind: 'DevWorkspaceTemplate',
+      metadata,
+      spec: editorDevfile as V1alpha2DevWorkspaceTemplateSpec,
+    };
+
+    // transform it into a devWorkspace
+    const devfileMetadata = devfile.metadata;
+    const devfileCopy = Object.assign({}, devfile);
+    delete devfileCopy.schemaVersion;
+    delete devfileCopy.metadata;
+    const editorSpecContribution: V1alpha2DevWorkspaceSpecContributions = {
+      name: 'editor',
+      kubernetes: {
+        name: editorDevWorkspaceTemplate.metadata.name,
+      },
+    };
+    const devWorkspace: V1alpha2DevWorkspace = {
+      apiVersion: 'workspace.devfile.io/v1alpha2',
+      kind: 'DevWorkspace',
+      metadata: devfileMetadata,
+      spec: {
+        started: true,
+        template: devfileCopy,
+        contributions: [editorSpecContribution],
+      },
+    };
+
+    // for now the list of devWorkspace templates is only the editor template
+    const devWorkspaceTemplates = [editorDevWorkspaceTemplate];
+
+    const context = {
+      devfile,
+      devWorkspace,
+      devWorkspaceTemplates,
+      suffix,
+    };
+
+    // grab container where to inject controller.devfile.io/merge-contribution attribute
+    let devContainer: V1alpha2DevWorkspaceSpecTemplateComponents = await this.devContainerComponentFinder.find(context);
+    if (!devContainer) {
+      return context;
+    }
+
+    // add attributes
+    let devContainerAttributes = devContainer.attributes;
+    if (!devContainerAttributes) {
+      devContainerAttributes = {};
+      devContainerAttributes[Generate.MERGE_CONTRIBUTION] = true;
+      devContainer.attributes = devContainerAttributes;
+    } else {
+      devContainerAttributes[Generate.MERGE_CONTRIBUTION] = true;
+    }
+
+    return context;
+  }
+}

package/src/github/github-module.ts

@@ -0,0 +1,18 @@
+/**********************************************************************
+ * Copyright (c) 2022 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
+ ***********************************************************************/
+import { ContainerModule, interfaces } from 'inversify';
+
+import { GithubResolver } from './github-resolver';
+
+const githubModule = new ContainerModule((bind: interfaces.Bind) => {
+  bind(GithubResolver).toSelf().inSingletonScope();
+});
+
+export { githubModule };

package/src/github/github-resolver.ts

@@ -0,0 +1,43 @@
+/**********************************************************************
+ * Copyright (c) 2022 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
+ ***********************************************************************/
+
+import { GithubUrl } from './github-url';
+import { injectable } from 'inversify';
+
+/**
+ * Provides a github URL object allowing to interact
+ */
+@injectable()
+export class GithubResolver {
+  // eslint-disable-next-line max-len
+  static readonly GITHUB_URL_PATTERN =
+    /^(?<scheme>https?):\/\/(?<host>github(\..+)?\.[^\/]+)\/(?<repoUser>[^\/]+)\/(?<repoName>[^\/]+)((\/)|\/(blob|tree)\/(?<branchName>[^\/]+)(?:\/(?<subFolder>.*))?)?$/;
+
+  resolve(link: string): GithubUrl {
+    const match = GithubResolver.GITHUB_URL_PATTERN.exec(link);
+    if (!match) {
+      throw new Error(`Invalid github URL: ${link}`);
+    }
+    const scheme = this.getGroup(match, 'scheme');
+    const hostName = this.getGroup(match, 'host');
+    const repoUser = this.getGroup(match, 'repoUser');
+    const repoName = this.getGroup(match, 'repoName');
+    const branchName = this.getGroup(match, 'branchName', 'HEAD');
+    const subFolder = this.getGroup(match, 'subFolder');
+    return new GithubUrl(scheme, hostName, repoUser, repoName, branchName, subFolder);
+  }
+
+  getGroup(match: RegExpExecArray, groupName: string, defaultValue?: string) {
+    if (match.groups && match.groups[groupName]) {
+      return match.groups[groupName];
+    }
+    return defaultValue || '';
+  }
+}

package/src/github/github-url.ts

@@ -0,0 +1,47 @@
+/**********************************************************************
+ * Copyright (c) 2022 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
+ ***********************************************************************/
+
+/**
+ * Provides helper methods on top of github URL to get for example raw content of get relative links
+ */
+export class GithubUrl {
+  constructor(
+    private readonly scheme: string,
+    private readonly hostName: string,
+    private readonly repoUser: string,
+    private readonly repoName: string,
+    private readonly branchName: string,
+    private readonly subFolder: string
+  ) {}
+
+  /**
+   * Provides the raw link to the given path based on the current repository information
+   */
+  getContentUrl(path: string): string {
+    const hostName = this.hostName === 'github.com' ? 'githubusercontent.com' : this.hostName;
+    return `${this.scheme}://raw.${hostName}/${this.repoUser}/${this.repoName}/${this.branchName}/${path}`;
+  }
+
+  getUrl(): string {
+    return `${this.scheme}://${this.hostName}/${this.repoUser}/${this.repoName}/tree/${this.branchName}/${this.subFolder}`;
+  }
+
+  getCloneUrl(): string {
+    return `${this.scheme}://${this.hostName}/${this.repoUser}/${this.repoName}.git`;
+  }
+
+  getRepoName(): string {
+    return this.repoName;
+  }
+
+  getBranchName(): string {
+    return this.branchName;
+  }
+}

package/src/inversify/inversify-binding.ts

@@ -0,0 +1,46 @@
+/**********************************************************************
+ * Copyright (c) 2022 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
+ ***********************************************************************/
+import 'reflect-metadata';
+
+import { AxiosInstance } from 'axios';
+import { Container } from 'inversify';
+import { devfileModule } from '../devfile/devfile-module';
+import { fetchModule } from '../fetch/fetch-module';
+import { githubModule } from '../github/github-module';
+import { pluginRegistryModule } from '../plugin-registry/plugin-registry-module';
+
+/**
+ * Manage all bindings for inversify
+ */
+export class InversifyBinding {
+  private container: Container;
+
+  public async initBindings(options: InversifyBindingOptions): Promise<Container> {
+    this.container = new Container();
+
+    this.container.load(devfileModule);
+    this.container.load(fetchModule);
+    this.container.load(githubModule);
+    this.container.load(pluginRegistryModule);
+
+    this.container.bind(Symbol.for('AxiosInstance')).toConstantValue(options.axiosInstance);
+    this.container.bind('string').toConstantValue(options.pluginRegistryUrl).whenTargetNamed('PLUGIN_REGISTRY_URL');
+
+    return this.container;
+  }
+}
+
+/**
+ * Options for inversify bindings
+ */
+export interface InversifyBindingOptions {
+  pluginRegistryUrl: string;
+  axiosInstance: AxiosInstance;
+}

package/src/main.ts

@@ -0,0 +1,212 @@
+/**********************************************************************
+ * Copyright (c) 2022 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
+ ***********************************************************************/
+
+import * as axios from 'axios';
+import * as fs from 'fs-extra';
+import { Generate } from './generate';
+import { GithubResolver } from './github/github-resolver';
+import * as jsYaml from 'js-yaml';
+import { InversifyBinding } from './inversify/inversify-binding';
+import { UrlFetcher } from './fetch/url-fetcher';
+import { PluginRegistryResolver } from './plugin-registry/plugin-registry-resolver';
+import { V1alpha2DevWorkspaceSpecTemplate } from '@devfile/api';
+import { DevfileContext } from './api/devfile-context';
+
+export class Main {
+  /**
+   * Default constructor.
+   */
+  constructor() {
+    // no-op
+  }
+  // Generates a devfile context object based on params
+  public async generateDevfileContext(
+    params: {
+      devfilePath?: string;
+      devfileUrl?: string;
+      devfileContent?: string;
+      outputFile?: string;
+      editorPath?: string;
+      editorContent?: string;
+      editorEntry?: string;
+      pluginRegistryUrl?: string;
+      projects: { name: string; location: string }[];
+    },
+    axiosInstance: axios.AxiosInstance
+  ): Promise<DevfileContext> {
+    if (!params.editorPath && !params.editorEntry && !params.editorContent) {
+      throw new Error('missing editorPath or editorEntry or editorContent');
+    }
+    if (!params.devfilePath && !params.devfileUrl && !params.devfileContent) {
+      throw new Error('missing devfilePath or devfileUrl or devfileContent');
+    }
+
+    let pluginRegistryUrl: string;
+
+    if (params.pluginRegistryUrl) {
+      pluginRegistryUrl = params.pluginRegistryUrl;
+    } else {
+      pluginRegistryUrl = 'https://eclipse-che.github.io/che-plugin-registry/main/v3';
+      console.log(`No plug-in registry url. Setting to ${pluginRegistryUrl}`);
+    }
+
+    const inversifyBinbding = new InversifyBinding();
+    const container = await inversifyBinbding.initBindings({
+      pluginRegistryUrl,
+      axiosInstance,
+    });
+    container.bind(Generate).toSelf().inSingletonScope();
+
+    let devfileContent;
+    let editorContent;
+
+    // gets the github URL
+    if (params.devfileUrl) {
+      const githubResolver = container.get(GithubResolver);
+      const githubUrl = githubResolver.resolve(params.devfileUrl);
+      // user devfile
+      devfileContent = await container.get(UrlFetcher).fetchText(githubUrl.getContentUrl('devfile.yaml'));
+
+      // load content
+      const devfileParsed = jsYaml.load(devfileContent);
+
+      // is there projects in the devfile ?
+      if (devfileParsed && !devfileParsed.projects) {
+        // no, so add the current project being cloned
+        devfileParsed.projects = [
+          {
+            name: githubUrl.getRepoName(),
+            git: {
+              remotes: { origin: githubUrl.getCloneUrl() },
+              checkoutFrom: { revision: githubUrl.getBranchName() },
+            },
+          },
+        ];
+      }
+      // get back the content
+      devfileContent = jsYaml.dump(devfileParsed);
+    } else if (params.devfilePath) {
+      devfileContent = await fs.readFile(params.devfilePath);
+    } else {
+      devfileContent = params.devfileContent;
+    }
+
+    // enhance projects
+    devfileContent = this.replaceIfExistingProjects(devfileContent, params.projects);
+
+    if (params.editorContent) {
+      editorContent = params.editorContent;
+    } else if (params.editorEntry) {
+      // devfile of the editor
+      const editorDevfile = await container.get(PluginRegistryResolver).loadDevfilePlugin(params.editorEntry);
+      editorContent = jsYaml.dump(editorDevfile);
+    } else {
+      editorContent = await fs.readFile(params.editorPath);
+    }
+
+    const generate = container.get(Generate);
+    return generate.generate(devfileContent, editorContent, params.outputFile);
+  }
+
+  // Update project entry based on the projects passed as parameter
+  public replaceIfExistingProjects(devfileContent: string, projects: { name: string; location: string }[]): string {
+    // do nothing if no override
+    if (projects.length === 0) {
+      return devfileContent;
+    }
+    const devfileParsed: V1alpha2DevWorkspaceSpecTemplate = jsYaml.load(devfileContent);
+
+    if (!devfileParsed || !devfileParsed.projects) {
+      return devfileContent;
+    }
+    devfileParsed.projects = devfileParsed.projects.map(project => {
+      const userProjectConfiguration = projects.find(p => p.name === project.name);
+      if (userProjectConfiguration) {
+        if (userProjectConfiguration.location.endsWith('.zip')) {
+          // delete git section and use instead zip
+          delete project.git;
+          project.zip = { location: userProjectConfiguration.location };
+        } else {
+          project.git.remotes.origin = userProjectConfiguration.location;
+        }
+      }
+      return project;
+    });
+    return jsYaml.dump(devfileParsed);
+  }
+
+  async start(): Promise<boolean> {
+    let devfilePath: string | undefined;
+    let devfileUrl: string | undefined;
+    let outputFile: string | undefined;
+    let editorPath: string | undefined;
+    let pluginRegistryUrl: string | undefined;
+    let editorEntry: string | undefined;
+    const projects: { name: string; location: string }[] = [];
+
+    const args = process.argv.slice(2);
+    args.forEach(arg => {
+      if (arg.startsWith('--devfile-path:')) {
+        devfilePath = arg.substring('--devfile-path:'.length);
+      }
+      if (arg.startsWith('--devfile-url:')) {
+        devfileUrl = arg.substring('--devfile-url:'.length);
+      }
+      if (arg.startsWith('--plugin-registry-url:')) {
+        pluginRegistryUrl = arg.substring('--plugin-registry-url:'.length);
+      }
+      if (arg.startsWith('--editor-entry:')) {
+        editorEntry = arg.substring('--editor-entry:'.length);
+      }
+      if (arg.startsWith('--editor-path:')) {
+        editorPath = arg.substring('--editor-path:'.length);
+      }
+      if (arg.startsWith('--output-file:')) {
+        outputFile = arg.substring('--output-file:'.length);
+      }
+      if (arg.startsWith('--project.')) {
+        const name = arg.substring('--project.'.length, arg.indexOf('='));
+        let location = arg.substring(arg.indexOf('=') + 1);
+        location = location.replace('{{_INTERNAL_URL_}}', '{{ INTERNAL_URL }}');
+
+        projects.push({ name, location });
+      }
+    });
+
+    try {
+      if (!editorPath && !editorEntry) {
+        throw new Error('missing --editor-path: or --editor-entry: parameter');
+      }
+      if (!devfilePath && !devfileUrl) {
+        throw new Error('missing --devfile-path: or --devfile-url: parameter');
+      }
+      if (!outputFile) {
+        throw new Error('missing --output-file: parameter');
+      }
+      await this.generateDevfileContext(
+        {
+          devfilePath,
+          devfileUrl,
+          editorPath,
+          outputFile,
+          pluginRegistryUrl,
+          editorEntry,
+          projects,
+        },
+        axios.default
+      );
+      return true;
+    } catch (error) {
+      console.error('stack=' + error.stack);
+      console.error('Unable to start', error);
+      return false;
+    }
+  }
+}

package/src/plugin-registry/plugin-registry-module.ts

@@ -0,0 +1,18 @@
+/**********************************************************************
+ * Copyright (c) 2022 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
+ ***********************************************************************/
+import { ContainerModule, interfaces } from 'inversify';
+
+import { PluginRegistryResolver } from './plugin-registry-resolver';
+
+const pluginRegistryModule = new ContainerModule((bind: interfaces.Bind) => {
+  bind(PluginRegistryResolver).toSelf().inSingletonScope();
+});
+
+export { pluginRegistryModule };

package/src/plugin-registry/plugin-registry-resolver.ts

@@ -0,0 +1,36 @@
+/**********************************************************************
+ * Copyright (c) 2022 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
+ ***********************************************************************/
+
+import * as jsYaml from 'js-yaml';
+
+import { inject, injectable, named } from 'inversify';
+
+import { UrlFetcher } from '../fetch/url-fetcher';
+
+/**
+ * Resolve plug-ins by grabbing the definition from the plug-in registry.
+ */
+@injectable()
+export class PluginRegistryResolver {
+  @inject('string')
+  @named('PLUGIN_REGISTRY_URL')
+  private pluginRegistryUrl: string;
+
+  @inject(UrlFetcher)
+  private urlFetcher: UrlFetcher;
+
+  // FQN id (like che-incubator/che-code/next)
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  async loadDevfilePlugin(devfileId: string): Promise<any> {
+    const devfileUrl = `${this.pluginRegistryUrl}/plugins/${devfileId}/devfile.yaml`;
+    const devfileContent = await this.urlFetcher.fetchText(devfileUrl);
+    return jsYaml.load(devfileContent);
+  }
+}