@eclipse-che/che-devworkspace-generator 7.78.0-next-5aa7ed4 → 7.78.0

package/src/devfile-schema/devfile-schema-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 { DevfileSchemaValidator } from './devfile-schema-validator';
+
+const devfileSchemaModule = new ContainerModule((bind: interfaces.Bind) => {
+  bind(DevfileSchemaValidator).toSelf().inSingletonScope();
+});
+
+export { devfileSchemaModule };

package/src/devfile-schema/devfile-schema-validator.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 { injectable } from 'inversify';
+
+import * as devfileSchemaV200 from './2.0.0/devfile.json';
+import * as devfileSchemaV210 from './2.1.0/devfile.json';
+import * as devfileSchemaV220 from './2.2.0/devfile.json';
+import * as devfileSchemaV221 from './2.2.1/devfile.json';
+import * as devfileSchemaV222 from './2.2.2/devfile.json';
+import * as Validator from 'jsonschema';
+import { DevfileSchemaVersion } from '../api/devfile-context';
+
+@injectable()
+export class DevfileSchemaValidator {
+  getDevfileSchema(version: string) {
+    switch (version) {
+      case DevfileSchemaVersion.V200:
+        return devfileSchemaV200;
+      case DevfileSchemaVersion.V210:
+        return devfileSchemaV210;
+      case DevfileSchemaVersion.V220:
+        return devfileSchemaV220;
+      case DevfileSchemaVersion.V221:
+        return devfileSchemaV221;
+      case DevfileSchemaVersion.V222:
+        return devfileSchemaV222;
+      default:
+        throw new Error(`Dev Workspace generator tool doesn't support devfile version: ${version}`);
+    }
+  }
+
+  // Validates devfile against schema
+  validateDevfile(devfile: any, version: string) {
+    const schema = this.getDevfileSchema(version);
+    const validatorResult = Validator.validate(devfile, schema, { nestedErrors: true });
+
+    return validatorResult;
+  }
+}

package/src/generate.ts

@@ -59,7 +59,7 @@ export class Generate {
       await fs.writeFile(outputFile, generatedContent, 'utf-8');
     }
 
-    console.log(`DevWorkspace ${context.devWorkspaceTemplates[0].metadata.name} was generated.`);
+    console.log(`DevWorkspace ${context.devWorkspaceTemplates[0].metadata.name} was generated`);
     return context;
   }
 
@@ -71,7 +71,6 @@ export class Generate {
   ): Promise<DevfileContext> {
     const devfile = jsYaml.load(devfileContent);
 
-    // const originalDevfile = Object.assign({}, devfile);
     // sets the suffix to the devfile name
     const suffix = devfile.metadata.name || '';
 

package/src/inversify/inversify-binding.ts

@@ -16,6 +16,7 @@ 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 { devfileSchemaModule } from '../devfile-schema/devfile-schema-module';
 import { bitbucketModule } from '../bitbucket/bitbucket-module';
 import { bitbucketServerModule } from '../bitbucket-server/bitbucket-server-module';
 
@@ -35,6 +36,7 @@ export class InversifyBinding {
     this.container.load(bitbucketServerModule);
     this.container.load(resolveModule);
     this.container.load(pluginRegistryModule);
+    this.container.load(devfileSchemaModule);
 
     this.container.bind(Symbol.for('AxiosInstance')).toConstantValue(options.axiosInstance);
     this.container.bind('string').toConstantValue(options.pluginRegistryUrl).whenTargetNamed('PLUGIN_REGISTRY_URL');

package/src/main.ts

@@ -11,6 +11,7 @@
 import * as axios from 'axios';
 import * as fs from 'fs-extra';
 import { Generate } from './generate';
+import { DevfileSchemaValidator } from './devfile-schema/devfile-schema-validator';
 import * as jsYaml from 'js-yaml';
 import { InversifyBinding } from './inversify/inversify-binding';
 import { UrlFetcher } from './fetch/url-fetcher';
@@ -18,6 +19,7 @@ import { PluginRegistryResolver } from './plugin-registry/plugin-registry-resolv
 import { V1alpha2DevWorkspaceSpecTemplate } from '@devfile/api';
 import { DevfileContext } from './api/devfile-context';
 import { GitUrlResolver } from './resolve/git-url-resolver';
+import { ValidatorResult } from 'jsonschema';
 
 export class Main {
   /**
@@ -100,6 +102,24 @@ export class Main {
       devfileContent = params.devfileContent;
     }
 
+    const jsYamlDevfileContent = jsYaml.load(devfileContent);
+    const schemaVersion = jsYamlDevfileContent.schemaVersion;
+    if (!schemaVersion) {
+      throw new Error(`Devfile is not valid, schemaVersion is required`);
+    }
+
+    // validate devfile
+    const devfileSchemaValidator = container.get(DevfileSchemaValidator);
+    console.log(`Validating devfile`);
+    const validationResult: ValidatorResult = devfileSchemaValidator.validateDevfile(
+      jsYamlDevfileContent,
+      schemaVersion
+    );
+    if (!validationResult.valid) {
+      throw new Error(`Devfile schema validation failed. Error: ${validationResult.toString()}`);
+    }
+    console.log(`Devfile is valid with schema version ${schemaVersion}`);
+
     // enhance projects
     devfileContent = this.replaceIfExistingProjects(devfileContent, params.projects);