fix: Fixed integration tests

Author: kevinwang5658

package.json

@@ -19,12 +19,12 @@
     "js-yaml": "^4.1.0",
     "js-yaml-source-map": "^0.2.2",
     "json-source-map": "^0.6.1",
+    "latest-semver": "^4.0.0",
+    "nanoid": "^5.0.9",
     "parse-json": "^8.1.0",
     "react": "^18.3.1",
     "semver": "^7.5.4",
-    "latest-semver": "^4.0.0",
-    "supports-color": "^9.4.0",
-    "nanoid": "^5.0.9"
+    "supports-color": "^9.4.0"
   },
   "description": "Codify allows users to configure settings, install new packages, and automate their systems using code instead of the GUI. Get set up on a new laptop in one click, maintain a Codify file within your project so anyone can get started and never lose your cool apps or favourite settings again.",
   "devDependencies": {
@@ -38,15 +38,15 @@
     "@types/semver": "^7.5.4",
     "@types/strip-ansi": "^5.2.1",
     "@typescript-eslint/eslint-plugin": "^8.16.0",
-    "codify-plugin-lib": "^1.0.129",
+    "codify-plugin-lib": "^1.0.130",
     "esbuild": "^0.24.0",
     "esbuild-plugin-copy": "^2.1.1",
     "eslint": "^8.51.0",
     "eslint-config-oclif": "^5",
-    "eslint-config-oclif-typescript": "^3",
+    "eslint-config-oclif-typescript": "^3.1.13",
     "eslint-config-prettier": "^9.0.0",
-    "mocha": "^10",
     "memfs": "^4.14.0",
+    "mocha": "^10",
     "oclif": "^4.15.29",
     "shx": "^0.3.3",
     "strip-ansi": "^7.1.0",

src/common/types.ts

@@ -1,5 +1,8 @@
-// eslint-disable-next-line @typescript-eslint/ban-types
-export type NonMethodKeys<T> = { [P in keyof T]: T[P] extends Function ? never : P }[keyof T];
+/* eslint no-use-before-define: 0 */
+export type NonMethodKeys<T> = {
+  [key in keyof T]: T[key] extends Function ? never : key
+}[keyof T];
 export type RemoveMethods<T> = Pick<T, NonMethodKeys<T>>;
 
 export type RemoveErrorMethods<T> = Omit<RemoveMethods<T>, 'name'>;
+/* eslint no-use-before-define: 2 */

src/entities/resource-config.ts

@@ -43,6 +43,13 @@ export class ResourceConfig implements ConfigBlock {
     this.sourceMapKey = sourceMapKey;
   }
 
+  static fromJson(json: ResourceJson): ResourceConfig {
+    return new ResourceConfig({
+      ...json.core,
+      ...json.parameters,
+    })
+  }
+
   get id() {
     return this.name ? `${this.type}.${this.name}` : this.type;
   }

src/orchestrators/import.ts

@@ -1,6 +1,7 @@
-import { ResourceConfig , ResourceConfig as SchemaResourceConfig } from 'codify-schemas';
+import { ResourceJson } from 'codify-schemas';
 
 import { Project } from '../entities/project.js';
+import { ResourceConfig } from '../entities/resource-config.js';
 import { ProcessName, SubProcessName, ctx } from '../events/context.js';
 import { CodifyParser } from '../parser/index.js';
 import { DependencyMap, PluginManager } from '../plugins/plugin-manager.js';
@@ -102,15 +103,18 @@ export class ImportOrchestrator {
     for (const type of typeIds) {
       ctx.subprocessStarted(SubProcessName.IMPORT_RESOURCE, type);
       try {
-        const config: SchemaResourceConfig = {
-          type,
-          ...userSuppliedProperties.get(type),
+        const config: ResourceJson = {
+          core: { type },
+          parameters: userSuppliedProperties.get(type) ?? {},
         };
 
         const response = await pluginManager.importResource(config);
 
         if (response.result !== null && response.result.length > 0) {
-          importedConfigs.push(...response.result);
+          importedConfigs.push(...response
+            ?.result
+            ?.map((r) => ResourceConfig.fromJson(r)) ?? []
+          );
         } else {
           errors.push(`Unable to import resource '${type}', resource not found`);
         }

src/plugins/plugin-manager.ts

@@ -1,6 +1,7 @@
 import { 
   GetResourceInfoResponseData,
   ImportResponseData,
+  ResourceJson,
   ValidateResponseData,
 } from 'codify-schemas';
 
@@ -66,18 +67,18 @@ export class PluginManager {
     return plugin.getResourceInfo(type);
   }
 
-  async importResource(config: ResourceConfig): Promise<ImportResponseData> {
-    const pluginName = this.resourceToPluginMapping.get(config.type);
+  async importResource(config: ResourceJson): Promise<ImportResponseData> {
+    const pluginName = this.resourceToPluginMapping.get(config.core.type);
     if (!pluginName) {
-      throw new Error(`Unable to find plugin for resource: ${config.type}`);
+      throw new Error(`Unable to find plugin for resource: ${config.core.type}`);
     }
 
     const plugin = this.plugins.get(pluginName)
     if (!plugin) {
-      throw new Error(`Unable to find plugin for resource ${config.type}`);
+      throw new Error(`Unable to find plugin for resource ${config.core.type}`);
     }
 
-    return plugin.import(config.toJson());
+    return plugin.import(config);
   }
 
   async getPlan(project: Project): Promise<Plan> {

src/plugins/plugin.ts

@@ -24,7 +24,16 @@ const getResourceInfoResponseValidator = ajv.compile(GetResourceInfoResponseData
 const importResponseValidator = ajv.compile(ImportResponseDataSchema);
 const planResponseValidator = ajv.compile(PlanResponseDataSchema);
 
-export class Plugin {
+export interface IPlugin {
+  initialize(secureMode: boolean): Promise<InitializeResponseData>;
+  validate(configs: ResourceConfig[]): Promise<ValidateResponseData>;
+  getResourceInfo(type: string): Promise<GetResourceInfoResponseData>;
+  import(config: ResourceJson): Promise<ImportResponseData>;
+  plan(request: PlanRequestData): Promise<ResourcePlan>;
+  apply(plan: ResourcePlan): Promise<void>;
+}
+
+export class Plugin implements IPlugin {
 
   process?: PluginProcess;
   name: string;

test/orchestrator/destroy/destroy.test.ts

@@ -14,6 +14,7 @@ vi.mock('../../../src/plugins/plugin.js', async () => {
 
 describe('Destroy orchestrator tests', () => {
   it('Can destroy a resource (simple, no required attributes, from Codify.json)', async () => {
+    console.log('start')
     const reporter = new MockReporter({
       validatePlan(plan: Plan) {
         expect(plan.getResourcePlan('mock.0')).toMatchObject({
@@ -25,6 +26,7 @@ describe('Destroy orchestrator tests', () => {
       }
     });
 
+    console.log('middle')
     MockOs.create('mock', {
       propA: 'current',
       propB: 1,

test/orchestrator/mocks/plugin.ts

@@ -1,19 +1,20 @@
-import { Plugin } from 'codify-plugin-lib'
-import { GetResourceInfoResponseData, ImportResponseData, InitializeResponseData, ResourceConfig as SchemaResourceConfig, ValidateResponseData } from 'codify-schemas';
+import { Plugin as PluginLibrary } from 'codify-plugin-lib'
+import { GetResourceInfoResponseData, ImportResponseData, InitializeResponseData,
+  PlanRequestData, ResourceJson, ValidateResponseData } from 'codify-schemas';
 
 import { ResourcePlan } from '../../../src/entities/plan.js';
-import { PlanRequest } from '../../../src/entities/plan-request.js';
 import { ResourceConfig } from '../../../src/entities/resource-config.js';
+import { IPlugin } from '../../../src/plugins/plugin.js';
 import { MockResource } from './resource.js';
 
-export class MockPlugin {
+export class MockPlugin implements IPlugin {
   name = 'default';
   version = '0.0.0'
   path = '/'
-  plugin!: Plugin;
+  plugin!: PluginLibrary;
 
   async initialize(secureMode: boolean): Promise<InitializeResponseData> {
-    this.plugin = Plugin.create(
+    this.plugin = PluginLibrary.create(
       'default',
       [new MockResource()],
     );
@@ -22,24 +23,19 @@ export class MockPlugin {
   }
 
   async validate(configs: ResourceConfig[]): Promise<ValidateResponseData> {
-    const rawConfigs = configs.map((c) => c.raw);
-    return this.plugin.validate({ configs: rawConfigs });
+    return this.plugin.validate({ configs: configs.map((c) => c.toJson()) });
   }
 
   async getResourceInfo(type: string): Promise<GetResourceInfoResponseData> {
     return this.plugin.getResourceInfo({ type });
   }
 
-  async import(config: SchemaResourceConfig): Promise<ImportResponseData> {
-    return this.plugin.import({ config })
+  async import(config: ResourceJson): Promise<ImportResponseData> {
+    return this.plugin.import(config)
   }
 
-  async plan(request: PlanRequest): Promise<ResourcePlan> {
-    const data = await this.plugin.plan({
-      desired: request.desired,
-      state: request.state,
-      isStateful: request.isStateful
-    });
+  async plan(request: PlanRequestData): Promise<ResourcePlan> {
+    const data = await this.plugin.plan(request);
 
     return new ResourcePlan(data);
   }

test/orchestrator/mocks/resource.ts

@@ -1,9 +1,10 @@
 import { CreatePlan, DestroyPlan, ModifyPlan, ParameterChange, Resource, ResourceSettings } from 'codify-plugin-lib';
 import { StringIndexedObject } from 'codify-schemas';
 
-import schema from './resource-schema.json';
 import { MockOs } from './system.js';
 
+const schema = (await import('./resource-schema.json', { assert: { type: 'json' } })).default;
+
 export interface MockResourceConfig extends StringIndexedObject {
   propA: string;
   propB: number;