feat: Add pip-sync resource + added schema for pip

Author: kevinwang5658

src/index.ts

@@ -17,7 +17,8 @@ import { JenvResource } from './resources/java/jenv/jenv.js';
 import { NvmResource } from './resources/node/nvm/nvm.js';
 import { Pnpm } from './resources/node/pnpm/pnpm.js';
 import { PgcliResource } from './resources/pgcli/pgcli.js';
-import { PipResource } from './resources/python/pip/pip.js';
+import { Pip } from './resources/python/pip/pip.js';
+import { PipSync } from './resources/python/pip-sync/pip-sync.js';
 import { PyenvResource } from './resources/python/pyenv/pyenv.js';
 import { VenvProject } from './resources/python/venv/venv-project.js';
 import { Virtualenv } from './resources/python/virtualenv/virtualenv.js';
@@ -67,6 +68,7 @@ runPlugin(Plugin.create(
     new Pnpm(),
     new WaitGithubSshKey(),
     new VenvProject(),
-    new PipResource(),
+    new Pip(),
+    new PipSync()
   ])
 )

src/resources/python/pip-sync/pip-sync-schema.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://www.codifycli.com/pip-sync.json",
+  "title": "Pip-sync resource",
+  "type": "object",
+  "description": "Install and manage though pip-tools by installing + uninstalling packages using pip-sync",
+  "properties": {
+    "virtualEnv": {
+      "type": "string",
+      "description": "A virtual env to activate before issuing commands."
+    },
+    "requirementFiles": {
+      "type": "array",
+      "items": { "type":  "string" },
+      "description": "A list of requirement files to supply pip-sync."
+    },
+    "cwd": {
+      "type": "string",
+      "description": "The working directory to run commands from. If cwd is supplied, the other parameters can be specified as relative to cwd."
+    }
+  },
+  "additionalProperties": false,
+  "required": ["requirementFiles"]
+}

src/resources/python/pip-sync/pip-sync.ts

@@ -0,0 +1,59 @@
+import { CreatePlan, DestroyPlan, RefreshContext, Resource, ResourceSettings, getPty } from 'codify-plugin-lib';
+import { ResourceConfig } from 'codify-schemas';
+
+import { codifySpawn } from '../../../utils/codify-spawn.js';
+import schema from './pip-sync-schema.json'
+import { RequirementFilesParameter } from './requirement-files-parameter.js';
+
+export interface PipSyncConfig extends ResourceConfig {
+  requirementFiles: string[];
+  virtualEnv?: string;
+  cwd?: string;
+}
+
+export class PipSync extends Resource<PipSyncConfig> {
+  getSettings(): ResourceSettings<PipSyncConfig> {
+    return {
+      id: 'pip-sync',
+      schema,
+      parameterSettings: {
+        requirementFiles: { type: 'stateful', definition: new RequirementFilesParameter() },
+        virtualEnv: { type: 'directory', setting: true },
+        cwd: { type: 'directory', setting: true }
+      },
+      dependencies: ['pyenv', 'pip', 'venv-project', 'virtualenv-project', 'virtualenv'],
+      allowMultiple: {
+        identifyingParameters: ['virtualEnv'],
+      }
+    };
+  }
+
+  async refresh(parameters: Partial<PipSyncConfig>, context: RefreshContext<PipSyncConfig>): Promise<Partial<PipSyncConfig> | Partial<PipSyncConfig>[] | null> {
+    const pty = getPty()
+
+    const { status: pipStatus } = await pty.spawnSafe(PipSync.withVirtualEnv('which pip', parameters.virtualEnv), { cwd: parameters.cwd ?? undefined });
+    if (pipStatus === 'error') {
+      return null;
+    }
+
+    const { status: pipSyncStatus } = await pty.spawnSafe(PipSync.withVirtualEnv('which pip-sync', parameters.virtualEnv), { cwd: parameters.cwd ?? undefined })
+    return pipSyncStatus === 'error' ? null : parameters;
+  }
+
+  async create(plan: CreatePlan<PipSyncConfig>): Promise<void> {
+    await codifySpawn(PipSync.withVirtualEnv('pip install pip-tools'), { cwd: plan.desiredConfig.cwd ?? undefined })
+  }
+
+  async destroy(plan: DestroyPlan<PipSyncConfig>): Promise<void> {
+    await codifySpawn(PipSync.withVirtualEnv('pip uninstall -y pip-tools'), { cwd: plan.currentConfig.cwd ?? undefined })
+  }
+
+  static withVirtualEnv(command: string, virtualEnv?: string, ): string {
+    if (!virtualEnv) {
+      return command;
+    }
+
+    return `source ${virtualEnv}/bin/activate; ${command}; deactivate`;
+  }
+
+}

src/resources/python/pip-sync/requirement-files-parameter.ts

@@ -0,0 +1,36 @@
+import { ArrayParameterSetting, Plan, StatefulParameter, getPty } from 'codify-plugin-lib';
+
+import { codifySpawn } from '../../../utils/codify-spawn.js';
+import { PipSync, PipSyncConfig } from './pip-sync.js';
+
+export class RequirementFilesParameter extends StatefulParameter<PipSyncConfig, string[]> {
+  getSettings(): ArrayParameterSetting {
+    return {
+      type: 'array',
+      itemType: 'directory',
+      canModify: true,
+    }
+  }
+
+  async refresh(desired: null | string[], config: Partial<PipSyncConfig>): Promise<null | string[]> {
+    if (!desired || desired?.length === 0) {
+      return null;
+    }
+    
+    const pty = getPty();
+    const { status } = await pty.spawnSafe(PipSync.withVirtualEnv(`pip-sync -n ${desired?.join(' ')}`),  { cwd: config.cwd ?? undefined })
+    return status === 'error' ? null : desired;
+  }
+
+  async add(valueToAdd: string[], plan: Plan<PipSyncConfig>): Promise<void> {
+    await codifySpawn(PipSync.withVirtualEnv(`pip-sync ${valueToAdd.join(' ')}`), { cwd: plan.desiredConfig?.cwd ?? undefined })
+  }
+  
+  async modify(newValue: string[], _: string[], plan: Plan<PipSyncConfig>): Promise<void> {
+    await codifySpawn(PipSync.withVirtualEnv(`pip-sync ${newValue.join(' ')}`), { cwd: plan.desiredConfig?.cwd ?? undefined })
+  }
+  
+  async remove(valueToRemove: string[], plan: Plan<PipSyncConfig>): Promise<void> {
+    await codifySpawn(PipSync.withVirtualEnv(`pip-sync ${valueToRemove.join(' ')}`),  { cwd: plan.currentConfig?.cwd ?? undefined })
+  }
+}

src/resources/python/pip/pip-schema.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://www.codifycli.com/pip.json",
+  "title": "Pip resource",
+  "type": "object",
+  "description": "Install and manage packages using pip",
+  "properties": {
+    "virtualEnv": {
+      "type": "string",
+      "description": "A virtual env to activate before issuing pip commands."
+    },
+    "install": {
+      "type": "array",
+      "description": "Packages to install.",
+      "items":  {
+        "oneOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string"
+              },
+              "version": {
+                "type": "string"
+              }
+            },
+            "required": ["name"]
+          }
+        ]
+      }
+    }
+  },
+  "additionalProperties": false,
+  "required": ["install"]
+}

src/resources/python/pip/pip.ts

@@ -1,15 +1,16 @@
 import {
   CreatePlan,
   DestroyPlan,
-  getPty,
   ModifyPlan,
   ParameterChange,
   Resource,
-  ResourceSettings
+  ResourceSettings,
+  getPty
 } from 'codify-plugin-lib';
 import { ResourceConfig } from 'codify-schemas';
 
 import { codifySpawn } from '../../../utils/codify-spawn.js';
+import schema from './pip-schema.json';
 
 interface PipListResult {
   name: string;
@@ -21,11 +22,12 @@ export interface PipResourceConfig extends ResourceConfig {
   virtualEnv?: string,
 }
 
-export class PipResource extends Resource<PipResourceConfig> {
+export class Pip extends Resource<PipResourceConfig> {
 
   getSettings(): ResourceSettings<PipResourceConfig> {
     return {
       id: 'pip',
+      schema,
       parameterSettings: {
         install: {
           type: 'array',
@@ -35,7 +37,7 @@ export class PipResource extends Resource<PipResourceConfig> {
           filterInStatelessMode: (desired, current) =>
             current.filter((c) => desired.find((d) => this.isSame(c, d)))
         },
-        virtualEnv: { type: 'directory' }
+        virtualEnv: { type: 'directory', setting: true }
       },
       allowMultiple: {
         identifyingParameters: ['virtualEnv']