|
| 1 | +import * as fs from 'fs-extra'; |
| 2 | +import ProjectConfig from '@dxatscale/sfpowerscripts.core/lib/project/ProjectConfig'; |
| 3 | +import Ajv, { _ } from 'ajv'; |
| 4 | +import ReleaseDefinitionGeneratorConfigSchema from './ReleaseDefinitionGeneratorConfigSchema'; |
| 5 | +import lodash = require('lodash'); |
| 6 | +import yaml from 'js-yaml'; |
| 7 | +import { Logger } from '@dxatscale/sfp-logger'; |
| 8 | +const path = require('path'); |
| 9 | + |
| 10 | +export default class ReleaseConfig { |
| 11 | + private _releaseDefinitionGeneratorSchema: ReleaseDefinitionGeneratorConfigSchema; |
| 12 | + |
| 13 | + get releaseDefinitionGeneratorConfigSchema() { |
| 14 | + // Return clone of releaseDefinition for immutability |
| 15 | + return lodash.cloneDeep(this._releaseDefinitionGeneratorSchema); |
| 16 | + } |
| 17 | + |
| 18 | + public constructor(private logger: Logger, pathToReleaseDefinition: string) { |
| 19 | + this._releaseDefinitionGeneratorSchema = yaml.load(fs.readFileSync(pathToReleaseDefinition, 'utf8')); |
| 20 | + this.validateReleaseDefinitionGeneratorConfig(this._releaseDefinitionGeneratorSchema); |
| 21 | + |
| 22 | + // Easy to handle here than with schema |
| 23 | + if ( |
| 24 | + this._releaseDefinitionGeneratorSchema.includeOnlyArtifacts && |
| 25 | + this.releaseDefinitionGeneratorConfigSchema.excludeArtifacts |
| 26 | + ) { |
| 27 | + throw new Error('Error: Invalid schema: either use includeArtifacts or excludeArtifacts'); |
| 28 | + } |
| 29 | + // Easy to handle here than with schema |
| 30 | + if ( |
| 31 | + this._releaseDefinitionGeneratorSchema.includeOnlyPackageDependencies && |
| 32 | + this.releaseDefinitionGeneratorConfigSchema.excludePackageDependencies |
| 33 | + ) { |
| 34 | + throw new Error( |
| 35 | + 'Error: Invalid schema: either use includePackageDependencies or excludePackageDependencies' |
| 36 | + ); |
| 37 | + } |
| 38 | + |
| 39 | + // Workaround for jsonschema not supporting validation based on dependency value |
| 40 | + if ( |
| 41 | + this._releaseDefinitionGeneratorSchema.releasedefinitionProperties?.baselineOrg && |
| 42 | + !this._releaseDefinitionGeneratorSchema.releasedefinitionProperties?.skipIfAlreadyInstalled |
| 43 | + ) |
| 44 | + throw new Error("Release option 'skipIfAlreadyInstalled' must be true for 'baselineOrg'"); |
| 45 | + } |
| 46 | + |
| 47 | + public getPackagesAsPerReleaseConfig(directory?: string): string[] { |
| 48 | + let packages: string[] = []; |
| 49 | + let projectConfig = ProjectConfig.getSFDXProjectConfig(directory); |
| 50 | + //Read sfdx project json |
| 51 | + let sfdxPackages = ProjectConfig.getAllPackagesFromProjectConfig(projectConfig); |
| 52 | + for (const sfdxPackage of sfdxPackages) { |
| 53 | + if (this.getArtifactPredicate(sfdxPackage)) { |
| 54 | + packages.push(sfdxPackage); |
| 55 | + } |
| 56 | + } |
| 57 | + |
| 58 | + return packages; |
| 59 | + } |
| 60 | + |
| 61 | + private validateReleaseDefinitionGeneratorConfig( |
| 62 | + releaseDefinitionGeneratorSchema: ReleaseDefinitionGeneratorConfigSchema |
| 63 | + ): void { |
| 64 | + let schema = fs.readJSONSync( |
| 65 | + path.join(__dirname, '..', '..', '..', 'resources', 'schemas', 'releasedefinitiongenerator.schema.json'), |
| 66 | + { encoding: 'UTF-8' } |
| 67 | + ); |
| 68 | + |
| 69 | + let validator = new Ajv({ allErrors: true }).compile(schema); |
| 70 | + let validationResult = validator(releaseDefinitionGeneratorSchema); |
| 71 | + |
| 72 | + if (!validationResult) { |
| 73 | + let errorMsg: string = |
| 74 | + `Release definition generation config does not meet schema requirements, ` + |
| 75 | + `found ${validator.errors.length} validation errors:\n`; |
| 76 | + |
| 77 | + validator.errors.forEach((error, errorNum) => { |
| 78 | + errorMsg += `\n${errorNum + 1}: ${error.instancePath}: ${error.message} ${JSON.stringify( |
| 79 | + error.params, |
| 80 | + null, |
| 81 | + 4 |
| 82 | + )}`; |
| 83 | + }); |
| 84 | + |
| 85 | + throw new Error(errorMsg); |
| 86 | + } |
| 87 | + } |
| 88 | + |
| 89 | + private getArtifactPredicate(artifact: string): boolean { |
| 90 | + if (this.releaseDefinitionGeneratorConfigSchema.includeOnlyArtifacts) { |
| 91 | + return this.releaseDefinitionGeneratorConfigSchema.includeOnlyArtifacts?.includes(artifact); |
| 92 | + } else if (this.releaseDefinitionGeneratorConfigSchema.excludeArtifacts) { |
| 93 | + return !this.releaseDefinitionGeneratorConfigSchema.excludeArtifacts?.includes(artifact); |
| 94 | + } else return true; |
| 95 | + } |
| 96 | +} |
0 commit comments