@eclipse-che/che-devworkspace-generator 0.0.1-a00c266 → 0.0.1-b3f6c7c

package/src/generate.ts

@@ -9,9 +9,11 @@
  ***********************************************************************/
 
 import {
+  V221Devfile,
+  V221DevfileMetadata,
   V1alpha2DevWorkspace,
+  V1alpha2DevWorkspaceMetadata,
   V1alpha2DevWorkspaceSpecContributions,
-  V1alpha2DevWorkspaceSpecTemplateComponents,
   V1alpha2DevWorkspaceTemplate,
   V1alpha2DevWorkspaceTemplateSpec,
 } from '@devfile/api';
@@ -21,15 +23,30 @@ import * as fs from 'fs-extra';
 import { DevfileContext } from './api/devfile-context';
 import { DevContainerComponentFinder } from './devfile/dev-container-component-finder';
 
+type DevfileLike = V221Devfile & {
+  metadata: V221DevfileMetadata & {
+    generateName?: string;
+  };
+};
+
 @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);
+  async generate(
+    devfileContent: string,
+    editorContent: string,
+    outputFile?: string,
+    injectDefaultComponent?: string,
+    defaultComponentImage?: string
+  ): Promise<DevfileContext> {
+    const context = await this.generateContent(
+      devfileContent,
+      editorContent,
+      injectDefaultComponent,
+      defaultComponentImage
+    );
 
     // write the result
     if (outputFile) {
@@ -46,7 +63,12 @@ export class Generate {
     return context;
   }
 
-  async generateContent(devfileContent: string, editorContent: string): Promise<DevfileContext> {
+  async generateContent(
+    devfileContent: string,
+    editorContent: string,
+    injectDefaultComponent?: string,
+    defaultComponentImage?: string
+  ): Promise<DevfileContext> {
     const devfile = jsYaml.load(devfileContent);
 
     // const originalDevfile = Object.assign({}, devfile);
@@ -57,7 +79,7 @@ export class Generate {
     const editorDevfile = jsYaml.load(editorContent);
 
     // transform it into a devWorkspace template
-    const metadata = editorDevfile.metadata;
+    const metadata = this.createDevWorkspaceMetadata(editorDevfile);
     // add sufix
     metadata.name = `${metadata.name}-${suffix}`;
     delete editorDevfile.metadata;
@@ -70,7 +92,7 @@ export class Generate {
     };
 
     // transform it into a devWorkspace
-    const devfileMetadata = devfile.metadata;
+    const devfileMetadata = this.createDevWorkspaceMetadata(devfile, true);
     const devfileCopy = Object.assign({}, devfile);
     delete devfileCopy.schemaVersion;
     delete devfileCopy.metadata;
@@ -86,6 +108,7 @@ export class Generate {
       metadata: devfileMetadata,
       spec: {
         started: true,
+        routingClass: 'che',
         template: devfileCopy,
         contributions: [editorSpecContribution],
       },
@@ -101,19 +124,28 @@ export class Generate {
       suffix,
     };
 
-    // grab container where to inject controller.devfile.io/merge-contribution attribute
-    let devContainer: V1alpha2DevWorkspaceSpecTemplateComponents = await this.devContainerComponentFinder.find(context);
-
-    // add attributes
-    let devContainerAttributes = devContainer.attributes;
-    if (!devContainerAttributes) {
-      devContainerAttributes = {};
-      devContainerAttributes[Generate.MERGE_CONTRIBUTION] = true;
-      devContainer.attributes = devContainerAttributes;
-    } else {
-      devContainerAttributes[Generate.MERGE_CONTRIBUTION] = true;
-    }
+    // find devContainer component, add a default one if not found
+    await this.devContainerComponentFinder.find(context, injectDefaultComponent, defaultComponentImage);
 
     return context;
   }
+
+  private createDevWorkspaceMetadata(devfile: DevfileLike, addDevfileContent = false): V1alpha2DevWorkspaceMetadata {
+    const devWorkspaceMetadata = {} as V1alpha2DevWorkspaceMetadata;
+    const devfileMetadata = devfile.metadata;
+
+    if (devfileMetadata.name) {
+      devWorkspaceMetadata.name = devfileMetadata.name;
+    }
+    if (devfileMetadata.generateName) {
+      devWorkspaceMetadata.generateName = devfileMetadata.generateName;
+    }
+    if (addDevfileContent) {
+      devWorkspaceMetadata.annotations = {
+        'che.eclipse.org/devfile': jsYaml.dump(devfile),
+      };
+    }
+
+    return devWorkspaceMetadata;
+  }
 }

package/src/github/github-module.ts

@@ -10,9 +10,12 @@
 import { ContainerModule, interfaces } from 'inversify';
 
 import { GithubResolver } from './github-resolver';
+import { TYPES } from '../types';
+
+const { Resolver } = TYPES;
 
 const githubModule = new ContainerModule((bind: interfaces.Bind) => {
-  bind(GithubResolver).toSelf().inSingletonScope();
+  bind(Resolver).to(GithubResolver).inSingletonScope();
 });
 
 export { githubModule };

package/src/github/github-resolver.ts

@@ -10,29 +10,37 @@
 
 import { GithubUrl } from './github-url';
 import { injectable } from 'inversify';
+import { Url } from '../resolve/url';
+import { Resolver } from '../resolve/resolver';
 
-/**
- * Provides a github URL object allowing to interact
- */
 @injectable()
-export class GithubResolver {
+export class GithubResolver implements Resolver {
   // eslint-disable-next-line max-len
   static readonly GITHUB_URL_PATTERN =
-    /^(?:http)(?:s)?(?:\:\/\/)github\.com\/(?<repoUser>[^\/]+)\/(?<repoName>[^\/]+)((\/)|(?:\/(blob|tree)\/(?<branchName>[^\/]+)(?:\/(?<subFolder>.*))?))?$/;
+    /^(?<scheme>https?):\/\/(?<host>github(\..+)?\.[^\/]+)\/(?<repoUser>[^\/]+)\/(?<repoName>[^\/]+)((\/)|\/(blob|tree)\/(?<branchName>[^\/]+)(?:\/(?<subFolder>.*))?)?$/;
 
-  resolve(link: string): GithubUrl {
+  isValid(url: string): boolean {
+    return GithubResolver.GITHUB_URL_PATTERN.test(url);
+  }
+
+  resolve(link: string): Url {
     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');
+    let repoName = this.getGroup(match, 'repoName');
+    if (/^[\w-][\w.-]*?\.git$/.test(repoName)) {
+      repoName = repoName.substring(0, repoName.length - 4);
+    }
     const branchName = this.getGroup(match, 'branchName', 'HEAD');
     const subFolder = this.getGroup(match, 'subFolder');
-    return new GithubUrl(repoUser, repoName, branchName, subFolder);
+    return new GithubUrl(scheme, hostName, repoUser, repoName, branchName, subFolder);
   }
 
-  getGroup(match: RegExpExecArray, groupName: string, defaultValue?: string) {
+  private getGroup(match: RegExpExecArray, groupName: string, defaultValue?: string) {
     if (match.groups && match.groups[groupName]) {
       return match.groups[groupName];
     }

package/src/github/github-url.ts

@@ -8,14 +8,12 @@
  * 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 {
-  // raw link
-  static readonly RAW_LINK = 'https://raw.githubusercontent.com';
+import { Url } from '../resolve/url';
 
+export class GithubUrl implements Url {
   constructor(
+    private readonly scheme: string,
+    private readonly hostName: string,
     private readonly repoUser: string,
     private readonly repoName: string,
     private readonly branchName: string,
@@ -26,15 +24,16 @@ export class GithubUrl {
    * Provides the raw link to the given path based on the current repository information
    */
   getContentUrl(path: string): string {
-    return `${GithubUrl.RAW_LINK}/${this.repoUser}/${this.repoName}/${this.branchName}/${path}`;
+    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 `https://github.com/${this.repoUser}/${this.repoName}/tree/${this.branchName}/${this.subFolder}`;
+    return `${this.scheme}://${this.hostName}/${this.repoUser}/${this.repoName}/tree/${this.branchName}/${this.subFolder}`;
   }
 
   getCloneUrl(): string {
-    return `https://github.com/${this.repoUser}/${this.repoName}.git`;
+    return `${this.scheme}://${this.hostName}/${this.repoUser}/${this.repoName}.git`;
   }
 
   getRepoName(): string {

package/src/inversify/inversify-binding.ts

@@ -14,7 +14,10 @@ import { Container } from 'inversify';
 import { devfileModule } from '../devfile/devfile-module';
 import { fetchModule } from '../fetch/fetch-module';
 import { githubModule } from '../github/github-module';
+import { resolveModule } from '../resolve/resolve-module';
 import { pluginRegistryModule } from '../plugin-registry/plugin-registry-module';
+import { bitbucketModule } from '../bitbucket/bitbucket-module';
+import { bitbucketServerModule } from '../bitbucket-server/bitbucket-server-module';
 
 /**
  * Manage all bindings for inversify
@@ -28,6 +31,9 @@ export class InversifyBinding {
     this.container.load(devfileModule);
     this.container.load(fetchModule);
     this.container.load(githubModule);
+    this.container.load(bitbucketModule);
+    this.container.load(bitbucketServerModule);
+    this.container.load(resolveModule);
     this.container.load(pluginRegistryModule);
 
     this.container.bind(Symbol.for('AxiosInstance')).toConstantValue(options.axiosInstance);

package/src/main.ts

@@ -11,13 +11,13 @@
 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 {
   /**
@@ -34,21 +34,27 @@ export class Main {
       devfileContent?: string;
       outputFile?: string;
       editorPath?: string;
-      pluginRegistryUrl?: string;
+      editorContent?: string;
       editorEntry?: string;
+      pluginRegistryUrl?: string;
       projects: { name: string; location: string }[];
+      injectDefaultComponent?: string;
+      defaultComponentImage?: string;
     },
     axiosInstance: axios.AxiosInstance
   ): Promise<DevfileContext> {
-    let { devfilePath, devfileUrl, outputFile, editorPath, pluginRegistryUrl, editorEntry, projects } = params;
-
-    if (!editorPath && !editorEntry) {
-      throw new Error('missing editorPath or editorEntry');
+    if (!params.editorPath && !params.editorEntry && !params.editorContent) {
+      throw new Error('missing editorPath or editorEntry or editorContent');
     }
-    if (!devfilePath && !devfileUrl && !params.devfileContent) {
+    if (!params.devfilePath && !params.devfileUrl && !params.devfileContent) {
       throw new Error('missing devfilePath or devfileUrl or devfileContent');
     }
-    if (!pluginRegistryUrl) {
+
+    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}`);
     }
@@ -63,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);
@@ -78,35 +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 (devfilePath) {
-      devfileContent = await fs.readFile(devfilePath);
+    } else if (params.devfilePath) {
+      devfileContent = await fs.readFile(params.devfilePath);
     } else {
       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
@@ -143,6 +157,8 @@ export class Main {
     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);
@@ -172,6 +188,12 @@ export class Main {
 
         projects.push({ name, location });
       }
+      if (arg.startsWith('--injectDefaultComponent:')) {
+        injectDefaultComponent = arg.substring('--injectDefaultComponent:'.length);
+      }
+      if (arg.startsWith('--defaultComponentImage:')) {
+        defaultComponentImage = arg.substring('--defaultComponentImage:'.length);
+      }
     });
 
     try {
@@ -193,6 +215,8 @@ export class Main {
           pluginRegistryUrl,
           editorEntry,
           projects,
+          injectDefaultComponent,
+          defaultComponentImage,
         },
         axios.default
       );

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 };