@eclipse-che/che-devworkspace-generator 0.0.1-d7aefd7 → 7.69.0-8717dbc

package/src/main.ts

@@ -11,67 +11,54 @@
 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';
+import { GitUrlResolver } from './resolve/git-url-resolver';
 
 export class Main {
-  protected async doStart(): Promise<DevfileContext> {
-    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 }[] = [];
+  /**
+   * 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 }[];
+      injectDefaultComponent?: string;
+      defaultComponentImage?: 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');
+    }
 
-    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 }}');
+    let pluginRegistryUrl: string;
 
-        projects.push({ name, location });
-      }
-    });
-    if (!editorPath && !editorEntry) {
-      throw new Error('missing --editor-path: or --editor-entry: parameter');
-    }
-    if (editorEntry && !pluginRegistryUrl) {
+    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}`);
     }
-    if (!devfilePath && !devfileUrl) {
-      throw new Error('missing --devfile-path: or --devfile-url: parameter');
-    }
-    if (!outputFile) {
-      throw new Error('missing --output-file: parameter');
-    }
 
-    const axiosInstance = axios.default;
     const inversifyBinbding = new InversifyBinding();
     const container = await inversifyBinbding.initBindings({
       pluginRegistryUrl,
@@ -82,12 +69,12 @@ export class Main {
     let devfileContent;
     let editorContent;
 
-    // gets the github URL
-    if (devfileUrl) {
-      const githubResolver = container.get(GithubResolver);
-      const githubUrl = githubResolver.resolve(devfileUrl);
+    // gets the repo URL
+    if (params.devfileUrl) {
+      const resolver = container.get(GitUrlResolver);
+      const url = resolver.resolve(params.devfileUrl);
       // user devfile
-      devfileContent = await container.get(UrlFetcher).fetchText(githubUrl.getContentUrl('devfile.yaml'));
+      devfileContent = await container.get(UrlFetcher).fetchText(url.getContentUrl('devfile.yaml'));
 
       // load content
       const devfileParsed = jsYaml.load(devfileContent);
@@ -97,33 +84,43 @@ export class Main {
         // no, so add the current project being cloned
         devfileParsed.projects = [
           {
-            name: githubUrl.getRepoName(),
+            name: url.getRepoName(),
             git: {
-              remotes: { origin: githubUrl.getCloneUrl() },
-              checkoutFrom: { revision: githubUrl.getBranchName() },
+              remotes: { origin: url.getCloneUrl() },
+              checkoutFrom: { revision: url.getBranchName() },
             },
           },
         ];
       }
       // get back the content
       devfileContent = jsYaml.dump(devfileParsed);
+    } else if (params.devfilePath) {
+      devfileContent = await fs.readFile(params.devfilePath);
     } else {
-      devfileContent = await fs.readFile(devfilePath);
+      devfileContent = params.devfileContent;
     }
 
     // enhance projects
-    devfileContent = this.replaceIfExistingProjects(devfileContent, projects);
+    devfileContent = this.replaceIfExistingProjects(devfileContent, params.projects);
 
-    if (editorEntry) {
+    if (params.editorContent) {
+      editorContent = params.editorContent;
+    } else if (params.editorEntry) {
       // devfile of the editor
-      const editorDevfile = await container.get(PluginRegistryResolver).loadDevfilePlugin(editorEntry);
+      const editorDevfile = await container.get(PluginRegistryResolver).loadDevfilePlugin(params.editorEntry);
       editorContent = jsYaml.dump(editorDevfile);
     } else {
-      editorContent = await fs.readFile(editorPath);
+      editorContent = await fs.readFile(params.editorPath);
     }
 
     const generate = container.get(Generate);
-    return generate.generate(devfileContent, editorContent, outputFile);
+    return generate.generate(
+      devfileContent,
+      editorContent,
+      params.outputFile,
+      params.injectDefaultComponent,
+      params.defaultComponentImage
+    );
   }
 
   // Update project entry based on the projects passed as parameter
@@ -154,8 +151,75 @@ export class Main {
   }
 
   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;
+    let injectDefaultComponent: string | undefined;
+    let defaultComponentImage: 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 });
+      }
+      if (arg.startsWith('--injectDefaultComponent:')) {
+        injectDefaultComponent = arg.substring('--injectDefaultComponent:'.length);
+      }
+      if (arg.startsWith('--defaultComponentImage:')) {
+        defaultComponentImage = arg.substring('--defaultComponentImage:'.length);
+      }
+    });
+
     try {
-      await this.doStart();
+      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,
+          injectDefaultComponent,
+          defaultComponentImage,
+        },
+        axios.default
+      );
       return true;
     } catch (error) {
       console.error('stack=' + error.stack);

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

@@ -26,7 +26,7 @@ export class PluginRegistryResolver {
   @inject(UrlFetcher)
   private urlFetcher: UrlFetcher;
 
-  // FQN id (like eclipse/che-theia/next)
+  // 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`;

package/src/resolve/git-url-resolver.ts

@@ -0,0 +1,30 @@
+/**********************************************************************
+ * Copyright (c) 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
+ ***********************************************************************/
+import { injectable, multiInject } from 'inversify';
+import { Url } from './url';
+import { TYPES } from '../types';
+import { Resolver } from './resolver';
+
+const { Resolver } = TYPES;
+
+@injectable()
+export class GitUrlResolver {
+  @multiInject(Resolver)
+  private resolvers: Resolver[];
+
+  resolve(link: string): Url {
+    const resolver = this.resolvers.find(r => r.isValid(link));
+    if (resolver) {
+      return resolver.resolve(link);
+    } else {
+      throw new Error('Can not resolver the URL');
+    }
+  }
+}

package/src/resolve/resolve-module.ts

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

package/src/resolve/resolver.ts

@@ -0,0 +1,25 @@
+/**********************************************************************
+ * Copyright (c) 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
+ ***********************************************************************/
+
+import { Url } from './url';
+
+export interface Resolver {
+  /**
+   * Validates the string url for belonging to a specific Git provider.
+   * @param url string representation of Url.
+   */
+  isValid(url: string): boolean;
+
+  /**
+   * Resolves repository string URL to a {@class Url} object.
+   * @param url string representation of Url.
+   */
+  resolve(url: string): Url;
+}

package/src/resolve/url.ts

@@ -0,0 +1,40 @@
+/**********************************************************************
+ * Copyright (c) 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
+ ***********************************************************************/
+
+/**
+ * Url object
+ */
+export interface Url {
+  /**
+   * Provides RAW file content url
+   * @param path file path
+   */
+  getContentUrl(path: string);
+
+  /**
+   * Provides repositories Url
+   */
+  getUrl(): string;
+
+  /**
+   * Provides Git clone url
+   */
+  getCloneUrl(): string;
+
+  /**
+   * Provides repository name
+   */
+  getRepoName(): string;
+
+  /**
+   * Provides branch name if initialised.
+   */
+  getBranchName(): string;
+}

package/src/types.ts

@@ -0,0 +1,14 @@
+/**********************************************************************
+ * Copyright (c) 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
+ ***********************************************************************/
+const TYPES = {
+  Resolver: Symbol.for('Resolver'),
+};
+
+export { TYPES };