feat!: add resource imports (#10)

BREAKING CHANGE: removed remote parameter from git-clone resource

* Upgraded to latest lib version and fixed schemas to support imports

* Added import requiredParameters and fixed bugs

* Improved path import

Author: kevinwang5658

package-lock.json

@@ -21,8 +21,8 @@
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
     "semver": "^7.6.0",
-    "codify-plugin-lib": "1.0.88",
-    "codify-schemas": "1.0.45",
+    "codify-plugin-lib": "1.0.100",
+    "codify-schemas": "1.0.52",
     "chalk": "^5.3.0",
     "debug": "^4.3.4",
     "plist": "^3.1.0"

package.json

@@ -18,6 +18,13 @@ export class AsdfGlobalResource extends Resource<AsdfGlobalConfig> {
       id: 'asdf-global',
       dependencies: ['asdf', 'asdf-plugin'],
       schema: AsdfGlobalSchema,
+      import: {
+        requiredParameters: ['plugin'],
+        refreshKeys: ['plugin', 'version'],
+        defaultRefreshValues: {
+          version: 'latest'
+        }
+      }
     }
   }
 

src/resources/asdf/asdf-global.ts

@@ -20,5 +20,13 @@
       "description": "The directory to run the install command"
     }
   },
+  "oneOf": [
+    {
+      "required": ["plugin", "versions"]
+    },
+    {
+      "required": ["directory"]
+    }
+  ],
   "additionalProperties": false
 }

src/resources/asdf/asdf-install-schema.json

@@ -4,9 +4,9 @@ import * as fs from 'node:fs/promises';
 import path from 'node:path';
 
 import { SpawnStatus, codifySpawn } from '../../utils/codify-spawn.js';
+import { FileUtils } from '../../utils/file-utils.js';
 import AsdfInstallSchema from './asdf-install-schema.json';
 import { AsdfPluginVersionsParameter } from './version-parameter.js';
-import { FileUtils } from '../../utils/file-utils.js';
 
 export interface AsdfInstallConfig extends ResourceConfig {
   plugin?: string;
@@ -28,6 +28,10 @@ export class AsdfInstallResource extends Resource<AsdfInstallConfig> {
         directory: { type: 'directory', inputTransformation: (input) => untildify(input) },
         versions: { type: 'stateful', definition: new AsdfPluginVersionsParameter() }
       },
+      import: {
+        requiredParameters: ['directory'],
+        refreshKeys: ['directory']
+      }
     }
   }
 

src/resources/asdf/asdf-install.ts

@@ -36,6 +36,13 @@ export class AsdfLocalResource extends Resource<AsdfLocalConfig> {
         version: {
           canModify: true,
         }
+      },
+      import: {
+        requiredParameters: ['plugin', 'directory'],
+        refreshKeys: ['plugin', 'version', 'directory'],
+        defaultRefreshValues: {
+          version: 'latest',
+        }
       }
     }
   }
@@ -85,6 +92,7 @@ export class AsdfLocalResource extends Resource<AsdfLocalConfig> {
 
     if (parameters.directory) {
       const { status, data } = await codifySpawn(`asdf current ${parameters.plugin}`, { throws: false, cwd: parameters.directory });
+
       if (status === SpawnStatus.ERROR || data.trim() === '') {
         return null;
       }

src/resources/asdf/asdf-local.ts

@@ -32,7 +32,10 @@ export class AwsProfileResource extends Resource<AwsProfileConfig> {
         output: { default: 'json' },
         profile: { default: 'default' },
       },
-      inputTransformation: CSVCredentialsParameter.transform
+      inputTransformation: CSVCredentialsParameter.transform,
+      import: {
+        requiredParameters: ['profile']
+      }
     };
   }
 

src/resources/aws-cli/profile/aws-profile.ts

@@ -4,13 +4,9 @@
   "title": "Git-clone resource",
   "type": "object",
   "properties": {
-    "remote": {
-      "type": "string",
-      "description": "Remote tracking url to clone repo from. Equivalent to repository and only one should be specified"
-    },
     "repository": {
       "type": "string",
-      "description": "Remote repository to clone repo from. Equivalent to remote and only one should be specified"
+      "description": "Remote repository to clone repo from."
     },
     "parentDirectory": {
       "type": "string",
@@ -25,5 +21,9 @@
       "description": "Automatically verifies the ssh connection for ssh git clones. Defaults to true."
     }
   },
-  "additionalProperties": false
+  "additionalProperties": false,
+  "oneOf": [
+    { "required": ["repository", "directory"] },
+    { "required": ["repository", "parentDirectory"] }
+  ]
 }

src/resources/git/clone/git-clone-schema.json

@@ -1,4 +1,4 @@
-import { CreatePlan, Resource, ResourceSettings } from 'codify-plugin-lib';
+import { CreatePlan, DestroyPlan, Resource, ResourceSettings } from 'codify-plugin-lib';
 import { ResourceConfig } from 'codify-schemas';
 import path from 'node:path';
 
@@ -12,8 +12,7 @@ export interface GitCloneConfig extends ResourceConfig {
   autoVerifySSH: boolean
   directory?: string,
   parentDirectory?: string,
-  remote?: string,
-  repository?: string,
+  repository: string,
 }
 
 export class GitCloneResource extends Resource<GitCloneConfig> {
@@ -22,65 +21,52 @@ export class GitCloneResource extends Resource<GitCloneConfig> {
       id: 'git-clone',
       schema: Schema,
       parameterSettings: {
-        autoVerifySSH: { default: true },
+        parentDirectory: { type: 'directory' },
+        directory: { type: 'directory' },
+        autoVerifySSH: { type: 'setting', default: true },
       },
-    }
-  }
-
-  override async validate(parameters: Partial<GitCloneConfig>): Promise<void> {
-    if (parameters.parentDirectory && parameters.directory) {
-      throw new Error('Cannot specify both parentDirectory and directory together')
-    }
-
-    if (parameters.remote && parameters.repository) {
-      throw new Error('Cannot specify both remote and repository together')
+      import: {
+        requiredParameters: ['directory']
+      }
     }
   }
 
   override async refresh(parameters: Partial<GitCloneConfig>): Promise<Partial<GitCloneConfig> | null> {
-    const repositoryUrl = parameters.repository?? parameters.remote!;
-
     if (parameters.parentDirectory) {
-      const parentDirectory = path.resolve(untildify(parameters.parentDirectory));
-
-      const folderName = this.extractBasename(repositoryUrl);
+      const folderName = this.extractBasename(parameters.repository!);
       if (!folderName) {
         throw new Error('Invalid git repository or remote name. Un-able to parse');
       }
 
-      const fullPath = path.join(parentDirectory, folderName);
+      const fullPath = path.join(parameters.parentDirectory, folderName);
 
       const exists = await FileUtils.checkDirExistsOrThrowIfFile(fullPath);
       if (!exists) {
         return null;
       }
 
       const { data: url } = await codifySpawn('git config --get remote.origin.url', { cwd: fullPath });
-      if (this.extractBasename(url) !== folderName) {
-        console.log(this.extractBasename(url))
-        console.log(folderName)
-        throw new Error(`Folder found at location: '${fullPath}'. However the remote url '${url}' repo does not match desired repo '${repositoryUrl}'`);
-      }
 
-      return parameters;
+      return {
+        parentDirectory: parameters.parentDirectory,
+        repository: url.trim(),
+        autoVerifySSH: parameters.autoVerifySSH,
+      }
     }
 
     if (parameters.directory) {
-      const directory = path.resolve(untildify(parameters.directory));
-
-      const exists = await FileUtils.checkDirExistsOrThrowIfFile(directory);
+      const exists = await FileUtils.checkDirExistsOrThrowIfFile(parameters.directory);
       if (!exists) {
         return null;
       }
 
-      const { data: url } = await codifySpawn('git config --get remote.origin.url', { cwd: directory });
-      if (this.extractBasename(url) !== this.extractBasename(repositoryUrl)) {
-        console.log(this.extractBasename(url))
-        console.log(this.extractBasename(url))
-        throw new Error(`Folder found at location: '${directory}'. However the remote url '${url}' does not match desired url '${repositoryUrl}'`);
-      }
+      const { data: url } = await codifySpawn('git config --get remote.origin.url', { cwd: parameters.directory });
 
-      return parameters;
+      return {
+        directory: parameters.directory,
+        repository: url.trim(),
+        autoVerifySSH: parameters.autoVerifySSH,
+      }
     }
 
     throw new Error('Either directory or parent directory must be supplied');
@@ -89,24 +75,25 @@ export class GitCloneResource extends Resource<GitCloneConfig> {
 
   override async create(plan: CreatePlan<GitCloneConfig>): Promise<void> {
     const config = plan.desiredConfig;
-    const repositoryUrl = config.repository ?? config.remote!;
 
     if (plan.desiredConfig.autoVerifySSH) {
-      await this.autoVerifySSHForFirstAttempt(repositoryUrl)
+      await this.autoVerifySSHForFirstAttempt(config.repository)
     }
 
     if (config.parentDirectory) {
       const parentDirectory = path.resolve(untildify(config.parentDirectory));
       await FileUtils.createDirIfNotExists(parentDirectory);
-      await codifySpawn(`git clone --progress ${repositoryUrl}`, { cwd: parentDirectory });
+      await codifySpawn(`git clone --progress ${config.repository}`, { cwd: parentDirectory });
     } else {
       const directory = path.resolve(untildify(config.directory!));
-      await codifySpawn(`git clone --progress ${repositoryUrl} ${directory}`);
+      await codifySpawn(`git clone --progress ${config.repository} ${directory}`);
     }
   }
 
-  override async destroy(): Promise<void> {
+  override async destroy(plan: DestroyPlan<GitCloneConfig>): Promise<void> {
     // Do nothing here. We don't want to destroy a user's repository.
+    throw new Error(`The git-clone resource is not designed to delete folders. 
+Please delete ${plan.currentConfig.directory ?? (plan.currentConfig.parentDirectory! + this.extractBasename(plan.currentConfig.repository))} manually and re-apply`);
   }
 
   // Converts https://github.com/kevinwang5658/codify-homebrew-plugin.git => codify-homebrew-plugin

src/resources/git/clone/git-clone.ts

@@ -18,16 +18,13 @@ export class JenvAddParameter extends ArrayStatefulParameter<JenvConfig, string>
      *   17.0.11
      *   openjdk64-17.0.11
      */
-    const versions = new Set(
+    return [...new Set(
       data
         .split(/\n/)
         // Regex to split out the version part
         .map((v) => this.getFirstRegexGroup(/^[ *] ([\d.A-Za-z-]+)[ \\n]?/g, v))
-    );
-
-    return desired
-      ?.filter((v) => versions.has(v))
-      ?.filter(Boolean) ?? null;
+        .filter(Boolean) as string[]
+    )]
   }
 
   override async addItem(param: string): Promise<void> {