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

package/src/bitbucket/bitbucket-resolver.ts

@@ -0,0 +1,46 @@
+/**********************************************************************
+ * 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 { BitbucketUrl } from './bitbucket-url';
+import { injectable } from 'inversify';
+import { Url } from '../resolve/url';
+import { Resolver } from '../resolve/resolver';
+
+@injectable()
+export class BitbucketResolver implements Resolver {
+  // eslint-disable-next-line max-len
+  static readonly BITBUCKET_URL_PATTERN: RegExp =
+    /^https:\/\/.*@?bitbucket\.org\/(?<workspaceId>[^\/]+)\/(?<repoName>[^\/]+)(\/(src|branch)\/(?<branchName>[^\/]+))?\/?$/;
+
+  isValid(url: string): boolean {
+    return BitbucketResolver.BITBUCKET_URL_PATTERN.test(url);
+  }
+
+  resolve(url: string): Url {
+    const match = BitbucketResolver.BITBUCKET_URL_PATTERN.exec(url);
+    if (!match) {
+      throw new Error(`Invalid bitbucket URL: ${url}`);
+    }
+    const workspaceId = this.getGroup(match, 'workspaceId');
+    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');
+    return new BitbucketUrl(workspaceId, repoName, branchName);
+  }
+
+  private getGroup(match: RegExpExecArray, groupName: string, defaultValue?: string) {
+    if (match.groups && match.groups[groupName]) {
+      return match.groups[groupName];
+    }
+    return defaultValue;
+  }
+}

package/src/bitbucket/bitbucket-url.ts

@@ -0,0 +1,41 @@
+/**********************************************************************
+ * 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 '../resolve/url';
+
+export class BitbucketUrl implements Url {
+  private static readonly BITBUCKET_URL = 'https://bitbucket.org';
+
+  constructor(
+    private readonly workspaceId: string,
+    private readonly repoName: string,
+    private readonly branchName: string
+  ) {}
+
+  getContentUrl(path: string): string {
+    return `${BitbucketUrl.BITBUCKET_URL}/${this.workspaceId}/${this.repoName}/raw/${this.branchName}/${path}`;
+  }
+
+  getUrl(): string {
+    return `${BitbucketUrl.BITBUCKET_URL}/${this.workspaceId}/${this.repoName}/src/${this.branchName}`;
+  }
+
+  getCloneUrl(): string {
+    return `${BitbucketUrl.BITBUCKET_URL}/${this.workspaceId}/${this.repoName}.git`;
+  }
+
+  getRepoName(): string {
+    return this.repoName;
+  }
+
+  getBranchName(): string {
+    return this.branchName;
+  }
+}

package/src/bitbucket-server/bitbucket-server-module.ts

@@ -0,0 +1,21 @@
+/**********************************************************************
+ * 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 { BitbucketServerResolver } from './bitbucket-server-resolver';
+import { TYPES } from '../types';
+
+const { Resolver } = TYPES;
+
+const bitbucketServerModule = new ContainerModule((bind: interfaces.Bind) => {
+  bind(Resolver).to(BitbucketServerResolver).inSingletonScope();
+});
+
+export { bitbucketServerModule };

package/src/bitbucket-server/bitbucket-server-resolver.ts

@@ -0,0 +1,53 @@
+/**********************************************************************
+ * 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 { BitbucketServerUrl } from './bitbucket-server-url';
+import { injectable } from 'inversify';
+import { Url } from '../resolve/url';
+import { Resolver } from '../resolve/resolver';
+
+@injectable()
+export class BitbucketServerResolver implements Resolver {
+  // eslint-disable-next-line max-len
+  static readonly BITBUCKET_URL_PATTERNS: RegExp[] = [
+    /^(?<scheme>https?):\/\/(?<host>.*)\/scm\/~(?<user>[^\/]+)\/(?<repo>.*).git$/,
+    /^(?<scheme>https?):\/\/(?<host>.*)\/users\/(?<user>[^\/]+)\/repos\/(?<repo>[^\/]+)\/browse(\?at=(?<branch>.*))?$/,
+    /^(?<scheme>https?):\/\/(?<host>.*)\/scm\/(?<project>[^\/~]+)\/(?<repo>[^\/]+).git$/,
+    /^(?<scheme>https?):\/\/(?<host>.*)\/projects\/(?<project>[^\/]+)\/repos\/(?<repo>[^\/]+)\/browse(\?at=(?<branch>.*))?$/,
+  ];
+
+  isValid(url: string): boolean {
+    return BitbucketServerResolver.BITBUCKET_URL_PATTERNS.some(p => p.test(url));
+  }
+
+  resolve(url: string): Url {
+    const regExp = BitbucketServerResolver.BITBUCKET_URL_PATTERNS.find(p => p.test(url));
+    if (!regExp) {
+      throw new Error(`Invalid bitbucket-server URL: ${url}`);
+    }
+    const match = regExp.exec(url);
+    const scheme = this.getGroup(match, 'scheme');
+    const hostName = this.getGroup(match, 'host');
+    const user = this.getGroup(match, 'user');
+    const project = this.getGroup(match, 'project');
+    const repo = this.getGroup(match, 'repo');
+    let branch = this.getGroup(match, 'branch');
+    if (branch !== undefined && branch.startsWith('refs%2Fheads%2F')) {
+      branch = branch.substring(15);
+    }
+    return new BitbucketServerUrl(scheme, hostName, user, project, repo, branch);
+  }
+
+  private getGroup(match: RegExpExecArray, groupName: string): string | undefined {
+    if (match.groups && match.groups[groupName]) {
+      return match.groups[groupName];
+    }
+  }
+}

package/src/bitbucket-server/bitbucket-server-url.ts

@@ -0,0 +1,51 @@
+/**********************************************************************
+ * 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 '../resolve/url';
+
+export class BitbucketServerUrl implements Url {
+  constructor(
+    private readonly scheme: string,
+    private readonly hostName: string,
+    private readonly user: string | undefined,
+    private readonly project: string | undefined,
+    private readonly repo: string,
+    private readonly branch: string | undefined
+  ) {}
+
+  getContentUrl(path: string): string {
+    const isUser = this.user !== undefined;
+    return `${this.scheme}://${this.hostName}/${isUser ? 'users' : 'projects'}/${
+      isUser ? this.user : this.project
+    }/repos/${this.repo}/raw/${path}${this.branch !== undefined ? '?/at=' + this.branch : ''}`;
+  }
+
+  getUrl(): string {
+    const isUser = this.user !== undefined;
+    return `${this.scheme}://${this.hostName}/${isUser ? 'users' : 'projects'}/${
+      isUser ? this.user : this.project
+    }/repos/${this.repo}${this.branch !== undefined ? '/browse?at=' + this.branch : ''}`;
+  }
+
+  getCloneUrl(): string {
+    const isUser = this.user !== undefined;
+    return `${this.scheme}://${this.hostName}/scm/${isUser ? '~' + this.user : this.project.toLowerCase()}/${
+      this.repo
+    }.git`;
+  }
+
+  getRepoName(): string {
+    return this.repo;
+  }
+
+  getBranchName(): string {
+    return this.branch;
+  }
+}

package/src/devfile/dev-container-component-finder.ts

@@ -10,14 +10,26 @@
 
 import { DevfileContext } from '../api/devfile-context';
 import { V1alpha2DevWorkspaceSpecTemplateComponents } from '@devfile/api';
-import { injectable } from 'inversify';
+import { inject, injectable } from 'inversify';
+import { DevContainerComponentInserter } from './dev-container-component-inserter';
 
 /**
  * Need to find dev container from main dev workspace
  */
 @injectable()
 export class DevContainerComponentFinder {
-  async find(devfileContext: DevfileContext): Promise<V1alpha2DevWorkspaceSpecTemplateComponents | undefined> {
+  @inject(DevContainerComponentInserter)
+  private devContainerComponentInserter: DevContainerComponentInserter;
+
+  async find(
+    devfileContext: DevfileContext,
+    injectDefaultComponent?: string,
+    defaultComponentImage?: string
+  ): Promise<V1alpha2DevWorkspaceSpecTemplateComponents | undefined> {
+    // if a devfile contains a parent, we should not add a default dev container
+    if (devfileContext.devfile?.parent) {
+      return undefined;
+    }
     // search in main devWorkspace
     const devComponents = devfileContext.devWorkspace.spec?.template?.components
       ?.filter(component => component.container)
@@ -26,9 +38,16 @@ export class DevContainerComponentFinder {
         component => component.container && component.container.mountSources !== false
       );
 
-    // only one, fine, else error
     if (!devComponents || devComponents.length === 0) {
-      throw new Error('Not able to find any dev container component in DevWorkspace');
+      // do not inject a default component if injectDefaultComponent parameter is false
+      if (!injectDefaultComponent || injectDefaultComponent !== 'true') {
+        return undefined;
+      }
+      this.devContainerComponentInserter.insert(devfileContext, defaultComponentImage);
+
+      let devComponents = devfileContext.devWorkspace.spec.template.components.filter(component => component.container);
+
+      return devComponents[0];
     } else if (devComponents.length === 1) {
       return devComponents[0];
     } else {

package/src/devfile/dev-container-component-inserter.ts

@@ -0,0 +1,49 @@
+/**********************************************************************
+ * 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 { DevfileContext } from '../api/devfile-context';
+import { V1alpha2DevWorkspaceSpecTemplateComponents } from '@devfile/api';
+import { injectable } from 'inversify';
+
+/**
+ * Adds a new component on empty devfile with specific name and image
+ */
+@injectable()
+export class DevContainerComponentInserter {
+  readonly DEFAULT_DEV_CONTAINER_IMAGE = 'quay.io/devfile/universal-developer-image:ubi8-latest';
+  readonly DEFAULT_DEV_CONTAINER_NAME = 'dev';
+
+  async insert(devfileContext: DevfileContext, defaultComponentImage?: string): Promise<void> {
+    if (!devfileContext.devWorkspace.spec) {
+      devfileContext.devWorkspace.spec = {
+        started: true,
+      };
+    }
+    if (!devfileContext.devWorkspace.spec.template) {
+      devfileContext.devWorkspace.spec.template = {};
+    }
+    if (!devfileContext.devWorkspace.spec.template.components) {
+      devfileContext.devWorkspace.spec.template.components = [];
+    }
+
+    const devContainerImage = defaultComponentImage ? defaultComponentImage : this.DEFAULT_DEV_CONTAINER_IMAGE;
+    console.log(
+      `No container component has been found. A default container component with image ${devContainerImage} will be added.`
+    );
+    const devContainerComponent: V1alpha2DevWorkspaceSpecTemplateComponents = {
+      name: this.DEFAULT_DEV_CONTAINER_NAME,
+      container: {
+        image: devContainerImage,
+      },
+    };
+
+    devfileContext.devWorkspace.spec.template.components.push(devContainerComponent);
+  }
+}

package/src/devfile/devfile-module.ts

@@ -10,9 +10,11 @@
 import { ContainerModule, interfaces } from 'inversify';
 
 import { DevContainerComponentFinder } from './dev-container-component-finder';
+import { DevContainerComponentInserter } from './dev-container-component-inserter';
 
 const devfileModule = new ContainerModule((bind: interfaces.Bind) => {
   bind(DevContainerComponentFinder).toSelf().inSingletonScope();
+  bind(DevContainerComponentInserter).toSelf().inSingletonScope();
 });
 
 export { devfileModule };

package/src/generate.ts

@@ -9,9 +9,11 @@
  ***********************************************************************/
 
 import {
+  V221Devfile,
+  V221DevfileMetadata,
   V1alpha2DevWorkspace,
+  V1alpha2DevWorkspaceMetadata,
   V1alpha2DevWorkspaceSpecContributions,
-  V1alpha2DevWorkspaceSpecTemplateComponents,
   V1alpha2DevWorkspaceTemplate,
   V1alpha2DevWorkspaceTemplateSpec,
 } from '@devfile/api';
@@ -21,30 +23,52 @@ 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
-    // write templates and then DevWorkspace in a single file
-    const allContentArray = context.devWorkspaceTemplates.map(template => jsYaml.dump(template));
-    allContentArray.push(jsYaml.dump(context.devWorkspace));
+    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');
+      const generatedContent = allContentArray.join('---\n');
 
-    await fs.writeFile(outputFile, generatedContent, 'utf-8');
+      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> {
+  async generateContent(
+    devfileContent: string,
+    editorContent: string,
+    injectDefaultComponent?: string,
+    defaultComponentImage?: string
+  ): Promise<DevfileContext> {
     const devfile = jsYaml.load(devfileContent);
 
     // const originalDevfile = Object.assign({}, devfile);
@@ -55,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;
@@ -68,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;
@@ -84,6 +108,7 @@ export class Generate {
       metadata: devfileMetadata,
       spec: {
         started: true,
+        routingClass: 'che',
         template: devfileCopy,
         contributions: [editorSpecContribution],
       },
@@ -99,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);