Code review Entity* and IotTemplate*

devdotnetorg · devdotnetorg · commit 684901c41017 · 2023-07-05T00:33:45.000+05:00
diff --git a/schemas/template.fastiot.files.schema.json b/schemas/template.fastiot.files.schema.json
diff --git a/schemas/template.fastiot.schema.yaml b/schemas/template.fastiot.schema.yaml
@@ -1,3 +1,4 @@
+# for https://github.com/redhat-developer/vscode-yaml
 id:
   type: string
   required: true
diff --git a/schemas/template.schema.yaml b/schemas/template.schema.yaml
@@ -1,3 +1,4 @@
+# for https://www.npmjs.com/package/yaml-schema-validator-fork
 id:
   type: string
   required: true
diff --git a/src/Entity/EntityBase.ts b/src/Entity/EntityBase.ts
@@ -6,6 +6,7 @@ import { EntityType } from './EntityType';
 import { EntityBaseAttribute } from './EntityBaseAttribute';
 import { IoTHelper } from '../Helper/IoTHelper';
 import { IotResult,StatusResult } from '../IotResult';
+import { FilesValidator } from '../Validator/FilesValidator';
 
 export abstract class EntityBase<T extends EntityBaseAttribute> {
   protected readonly _entityLabel:string; //for understandable log
@@ -38,17 +39,23 @@ export abstract class EntityBase<T extends EntityBaseAttribute> {
   public Attributes: T;
   public Type:EntityType=EntityType.none;
 
-  protected _pathFolderSchemas: string;
+  protected readonly _pathFolderSchema: string;
+  protected readonly _fileNameSchemaRootYaml: string;
+  protected readonly _fileNameSchemaDirStructure: string;
 
-  constructor( entityLabel:string, entitiesLabel:string,
-    TCreator: new(pathFolderSchemas?: string) => T,
-    pathFolderSchemas: string
+  constructor(entityLabel:string, entitiesLabel:string,
+    TCreator: new(pathFolderSchema:string,fileNameSchemaRootYaml:string) => T,
+    pathFolderSchema: string,
+    fileNameSchemaRootYaml: string, fileNameSchemaDirStructure: string
     ){
       this._entityLabel=entityLabel;
       this._entitiesLabel=entitiesLabel;
-      this.Attributes=new TCreator(pathFolderSchemas);
+      this.Attributes=new TCreator(pathFolderSchema,fileNameSchemaRootYaml);
+      //
+      this._pathFolderSchema=pathFolderSchema;
+      this._fileNameSchemaRootYaml=fileNameSchemaRootYaml;
+      this._fileNameSchemaDirStructure=fileNameSchemaDirStructure;
       //
-      this._pathFolderSchemas=pathFolderSchemas;
       this._validationErrors.push("non");
   }
 
@@ -58,31 +65,36 @@ export abstract class EntityBase<T extends EntityBaseAttribute> {
       this.Type= type;
       this._recoverySourcePath=recoverySourcePath;
       this._yamlFilePath=yamlFilePath;
-      this.ValidateEntityBase();
-      if(!this.IsValid) return;
-      //if(this.IsValid) this.Parse(path);
-      let attributes = this.Attributes as any; 
-      attributes.Init(this.YAMLFilePath);
-      if(attributes.IsValid) {
-        //ok
-        //check if folder matches entity and id
-        if(this.RootNameDir!=attributes.Id)
-          this._validationErrors.push(`${this._entityLabel} folder name ${this.RootNameDir} `+
-            `does not match id value ${attributes.Id}.`+
-            `You need to rename the folder or change the ${this._entityLabel} id.`);
-      }else{
+      //Attributes
+      //let attributes = this.Attributes as any;
+      this._validationErrors=[];
+      const isValidAttributes = this.Attributes.InitBaseAttribute(this.YAMLFilePath);
+      if(!isValidAttributes)
         //error
-        this._validationErrors = attributes.ValidationErrors.slice();
-      }
+        this._validationErrors = this.Attributes.ValidationErrors.slice();
+      if(!this.IsValid) return;
+      //Base
+      this.ValidateBase();
+      if(!this.IsValid) return;
     } catch (err: any){
       this._validationErrors.push(`Error Init ${this._entitiesLabel}. Error: ${err}`);
     }
   }
   
-  private ValidateEntityBase(){
+  private ValidateBase(){
     this._validationErrors=[];
-    if (!fs.existsSync(this.YAMLFilePath)) 
-      this._validationErrors.push(`${this.YAMLFilePath} file does not exist`);
+    //checking folder structure
+    //FilesValidator
+    let filesValidator=new FilesValidator(this._pathFolderSchema);
+    let result = filesValidator.ValidateFiles(this.RootDir,this._fileNameSchemaDirStructure);
+    const validationErrors=<Array<string>>result.returnObject;
+    this._validationErrors = validationErrors.slice();
+    //check if folder matches entity and id
+        if(this.RootNameDir!=this.Attributes.Id)
+          this._validationErrors.push(`${this._entityLabel} folder name ${this.RootNameDir} `+
+            `does not match id value ${this.Attributes.Id}.`+
+            `You need to rename the folder or change the ${this._entityLabel} id.`);
+    //
   }
 
   public Move(destDir:string):IotResult {
diff --git a/src/Entity/EntityBaseAttribute.ts b/src/Entity/EntityBaseAttribute.ts
@@ -2,7 +2,8 @@ import * as vscode from 'vscode';
 import * as fs from 'fs';
 import * as path from 'path';
 import YAML from 'yaml';
-import { YamlSchemaValidator } from '../Validator/YamlSchemaValidator';
+import { YamlValidatorRedHat } from '../Validator/YamlValidatorRedHat';
+import { IYamlValidator } from '../Validator/IYamlValidator';
 
 export class EntityBaseAttribute {
   private _id:string="";  
@@ -40,27 +41,39 @@ export class EntityBaseAttribute {
   public get Tags(): Array<string> {
     return this._tags;}
   //Validation
-  public get IsValid(): boolean {
+  protected get IsValid(): boolean {
     if(this._validationErrors.length==0) return true;else return false;}
   protected _validationErrors:Array<string>=[]; 
   public get ValidationErrors(): Array<string> {
       return this._validationErrors;}
 
-  protected _schemasFolderPath: string;
+  protected readonly _pathFolderSchema: string;
+  protected readonly _fileNameSchemaRootYaml: string;
 
-  constructor(schemasFolderPath: string|undefined
+  constructor(pathFolderSchema:string,fileNameSchemaRootYaml:string
     ){
+      this._pathFolderSchema=pathFolderSchema;
+      this._fileNameSchemaRootYaml=fileNameSchemaRootYaml;
       this._validationErrors.push("non");
-      this._schemasFolderPath=schemasFolderPath ?? "non";
     }
 
-  protected Parse(filePath:string){
+  public InitBaseAttribute(yamlFilePath:string):boolean
+  {
+    let result:boolean;
+    result=this.ParseBaseAttribute(yamlFilePath);
+    if(!result) false;
+    result=this.PostCheckAfterParse(yamlFilePath);
+    //
+    return  result;
+  }
+
+  private ParseBaseAttribute(yamlFilePath:string):boolean{
     try {
       //validate
-      this.ValidateBaseAttribute(filePath);
-      if(!this.IsValid) return;
+      this.ValidateBaseAttribute(yamlFilePath);
+      if(!this.IsValid) return false;
       //
-      const file = fs.readFileSync(filePath, 'utf8');
+      const file = fs.readFileSync(yamlFilePath, 'utf8');
       const obj=YAML.parse(file);
       //one value
       this._id=obj.id;
@@ -109,16 +122,33 @@ export class EntityBaseAttribute {
       while(true)
       //next
     } catch (err: any){
-      this._validationErrors.push(`File: ${filePath} Error parsing attributes: ${err}`);
+      this._validationErrors.push(`File: ${yamlFilePath} Error parsing attributes: ${err}`);
+    }
+    return this.IsValid;
+  }
+
+  private PostCheckAfterParse(yamlFilePath:string):boolean{
+    try {
+      //check id=""
+      if (this.Id=="") this._validationErrors.push("id cannot be empty");
+    } catch (err: any){
+      this._validationErrors.push(`File: ${yamlFilePath} Error PostCheckAfterParce: ${err}`);
     }
+    return this.IsValid;
   }
 
   private ValidateBaseAttribute(yamlFilePath:string)
   {
     this._validationErrors=[];
-    //YamlSchemaValidator
-    let yamlSchemaValidator=new YamlSchemaValidator(this._schemasFolderPath);
-    let result = yamlSchemaValidator.ValidateSchema(yamlFilePath,"entitybase.schema.yaml");
+    //exist
+    if (!fs.existsSync(yamlFilePath))
+    {
+      this._validationErrors.push(`${yamlFilePath} file does not exist`);
+      return;
+    }
+    //YamlValidator
+    let yamlValidator:IYamlValidator=new YamlValidatorRedHat(this._pathFolderSchema);
+    let result = yamlValidator.ValidateSchema(yamlFilePath,this._fileNameSchemaRootYaml);
     const validationErrors=<Array<string>>result.returnObject;
     this._validationErrors = validationErrors.slice();
   }
diff --git a/src/Entity/EntityCollection.ts b/src/Entity/EntityCollection.ts
@@ -411,7 +411,7 @@ export abstract class EntityCollection <A extends EntityBaseAttribute, T extends
 
 }
 
-//TODO убрать, заменить на Interface IConfig
+//TODO убрать, заменить на Interface IConfig. Все еще под ???
 
 export interface IConfigEntityCollection {
   extVersion: string;
diff --git a/src/Templates/IotTemplate.ts b/src/Templates/IotTemplate.ts
@@ -13,6 +13,27 @@ import { IotDevice } from '../IotDevice';
 import { IotConfiguration } from '../Configuration/IotConfiguration';
 import { FilesValidator } from '../Validator/FilesValidator';
 
+/*
+load order:
+Create:
+1) IotTemplate - constructor
+2) EntityBase - constructor
+3) IotTemplateAttribute - constructor
+4) EntityBaseAttribute - constructor
+Init:
+1) IotTemplate - Init
+2) EntityBase - Init
+3) EntityBaseAttribute - InitBaseAttribute
+4) EntityBaseAttribute - ParseBaseAttribute
+5) EntityBaseAttribute - ValidateBaseAttribute
+6) EntityBaseAttribute - PostCheckAfterParse
+7) EntityBase - ValidateBase
+8) IotTemplateAttribute - Init
+9) IotTemplateAttribute - Parse
+10) IotTemplateAttribute - Validate
+11) IotTemplate - Validate
+*/
+
 export class IotTemplate extends EntityBase<IotTemplateAttribute> {
   public get StoragePath(): string {
     return this.RootDir+"\\storage";}
@@ -23,30 +44,27 @@ export class IotTemplate extends EntityBase<IotTemplateAttribute> {
 
   private _mergeDictionary:Map<string,string>= new Map<string,string>();
 
-  constructor(pathFolderSchemas: string
+  constructor(pathFolderSchema: string
     ){
-      super("template","templates",IotTemplateAttribute,pathFolderSchemas);
+      super("template","templates",IotTemplateAttribute,
+      pathFolderSchema,"template.fastiot.schema.yaml","template.fastiot.files.schema.json");
   }
 
   public Init(type:EntityType,yamlFilePath:string,recoverySourcePath?:string)
   {
     super.Init(type,yamlFilePath,recoverySourcePath);
     if(!this.IsValid) return;
-    //next
+    //Attributes
+    const isValidAttributes = this.Attributes.Init(yamlFilePath);
+    if(!isValidAttributes)
+        //error
+        this._validationErrors = this.Attributes.ValidationErrors.slice();
+    if(!this.IsValid) return;
     this.Validate();
-    //if(this.IsValid) this.Parse(filePath);
   }
 
   protected Validate(){
     this._validationErrors=[];
-    //checking folder structure
-    //FilesValidator
-    let filesValidator=new FilesValidator(this._pathFolderSchemas);
-    let result = filesValidator.ValidateFiles(this.RootDir,"template.files.schema.json");
-    const validationErrors=<Array<string>>result.returnObject;
-    this._validationErrors = validationErrors.slice();
-    //check id=""
-    if (this.Attributes.Id=="") this._validationErrors.push("id cannot be empty");
     // TODO: проверка наличия файлов для dotnetapp.csproj которые внутри
   }
 
diff --git a/src/Templates/IotTemplateAttribute.ts b/src/Templates/IotTemplateAttribute.ts
@@ -2,10 +2,8 @@ import * as vscode from 'vscode';
 import * as fs from 'fs';
 import * as path from 'path';
 import YAML from 'yaml';
-
 import { EntityBaseAttribute } from '../Entity/EntityBaseAttribute';
 import { IoTHelper } from '../Helper/IoTHelper';
-import { YamlSchemaValidator } from '../Validator/YamlSchemaValidator';
 
 export class IotTemplateAttribute extends EntityBaseAttribute {
   private _typeProj:string="";  
@@ -30,33 +28,29 @@ export class IotTemplateAttribute extends EntityBaseAttribute {
     //dotnetapp.csproj => .csproj
     return IoTHelper.GetFileExtensions(this.MainFileProj);}
   
-  constructor(schemasFolderPath?: string){
-      super(schemasFolderPath);
+  constructor(pathFolderSchema:string,fileNameSchemaRootYaml:string){
+      super(pathFolderSchema,fileNameSchemaRootYaml);
   }
 
-  public Init(filePath:string)
+  public Init(yamlFilePath:string):boolean
   {
-    //Base Init 
-    super.Parse(filePath);
-    //
-    if(!this.IsValid) return;
-    //next
-    this.Validate(filePath);
-    if(this.IsValid) this.Parse(filePath);
+    //Init
+    return this.Parse(yamlFilePath);
   }
 
-  protected Validate(yamlFilePath:string){
+  private Validate(yamlFilePath:string){
     this._validationErrors=[];
-    //YamlSchemaValidator
-    let yamlSchemaValidator=new YamlSchemaValidator(this._schemasFolderPath);
-    let result = yamlSchemaValidator.ValidateSchema(yamlFilePath,"template.schema.yaml");
-    const validationErrors=<Array<string>>result.returnObject;
-    this._validationErrors = validationErrors.slice();
+    //custom Validator
+
   }
 
-  protected Parse(filePath:string){
+  private Parse(yamlFilePath:string):boolean{
     try {
-      const file = fs.readFileSync(filePath, 'utf8');
+      //validate
+      this.Validate(yamlFilePath);
+      if(!this.IsValid) return false;
+      //
+      const file = fs.readFileSync(yamlFilePath, 'utf8');
       const obj=YAML.parse(file);
       //one value
       this._typeProj=obj.typeProj;
@@ -93,8 +87,9 @@ export class IotTemplateAttribute extends EntityBaseAttribute {
       } 
       while(true)
       //next
-  } catch (err: any){
-      this._validationErrors.push(`File: ${filePath} Error parsing attributes: ${err}`);
+    } catch (err: any){
+      this._validationErrors.push(`File: ${yamlFilePath} Error parsing attributes: ${err}`);
     }
+    return this.IsValid;
   }
 }
diff --git a/src/Validator/IYamlValidator.ts b/src/Validator/IYamlValidator.ts
@@ -0,0 +1,11 @@
+import * as vscode from 'vscode';
+import * as fs from 'fs';
+import * as path from 'path';
+import { IotResult,StatusResult } from '../IotResult';
+import { IotDevice } from '../IotDevice';
+import { IotTemplate } from '../Templates/IotTemplate';
+import { LogLevel } from '../shared/LogLevel';
+
+export interface IYamlValidator {
+  ValidateSchema (yamlFilePath:string, schemaFileName:string):IotResult;
+}
diff --git a/src/Validator/YamlValidatorFork.ts b/src/Validator/YamlValidatorFork.ts
@@ -2,8 +2,9 @@ import * as vscode from 'vscode';
 import * as fs from 'fs';
 import * as path from 'path';
 import { IotResult,StatusResult } from '../IotResult';
+import { IYamlValidator } from './IYamlValidator';
 
-export class YamlSchemaValidator {  
+export class YamlValidatorFork implements IYamlValidator {  
   private readonly _schemasFolderPath: string;
   
   constructor(schemasFolderPath: string){
diff --git a/src/Validator/YamlValidatorRedHat.ts b/src/Validator/YamlValidatorRedHat.ts
diff --git a/src/actionsLaunch/addLaunch.ts b/src/actionsLaunch/addLaunch.ts

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+# for https://github.com/redhat-developer/vscode-yaml`
`1`	`2`	`id:`
`2`	`3`	`type: string`
`3`	`4`	`required: true`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+# for https://www.npmjs.com/package/yaml-schema-validator-fork`
`1`	`2`	`id:`
`2`	`3`	`type: string`
`3`	`4`	`required: true`
Original file line number	Diff line number	Diff line change
`@@ -411,7 +411,7 @@ export abstract class EntityCollection <A extends EntityBaseAttribute, T extends`
`411`	`411`
`412`	`412`	`}`
`413`	`413`
`414`		`-//TODO убрать, заменить на Interface IConfig`
	`414`	`+//TODO убрать, заменить на Interface IConfig. Все еще под ???`
`415`	`415`
`416`	`416`	`export interface IConfigEntityCollection {`
`417`	`417`	`extVersion: string;`