feat: added install files parameter to pip

Author: kevinwang5658

src/resources/python/pip/install-files.ts

@@ -0,0 +1,57 @@
+import { ParameterSetting, Plan, StatefulParameter, getPty } from 'codify-plugin-lib';
+
+import { codifySpawn } from '../../../utils/codify-spawn.js';
+import { PipResourceConfig } from './pip.js';
+
+export class PipInstallFilesParameter extends StatefulParameter<PipResourceConfig, Array<string>> {
+  getSettings(): ParameterSetting {
+    return {
+      type: 'array',
+      itemType: 'directory',
+    }
+  }
+
+  async refresh(desired: null | string[], config: Partial<PipResourceConfig>): Promise<null | string[]> {
+    const $ = getPty();
+
+    return (await Promise.all(desired?.map(async (d) => {
+      const { data } = await $.spawnSafe(`pip -vvv freeze -r ${d}`)
+
+      if (!data || data.includes('WARNING:')) {
+        return null;
+      }
+
+      return d;
+    }) ?? [])).filter(Boolean) as string[];
+  }
+
+  async add(valueToAdd: string[], plan: Plan<PipResourceConfig>): Promise<void> {
+    if (valueToAdd.length === 0) {
+      return;
+    }
+
+    await codifySpawn(`pip install ${valueToAdd.map((v) => `-r ${v}`).join(' ')}`)
+  }
+
+  async modify(newValue: string[], previousValue: string[], plan: Plan<PipResourceConfig>): Promise<void> {
+    const toInstall = newValue.filter((n) => !previousValue.includes(n));
+    const toUninstall = previousValue.filter((p) => !newValue.includes(p));
+
+    if (toUninstall.length > 0) {
+      await codifySpawn(`pip uninstall ${toUninstall.map((v) => `-r ${v}`).join(' ')}`)
+    }
+
+    if (toInstall.length > 0) {
+      await codifySpawn(`pip install ${toInstall.map((v) => `-r ${v}`).join(' ')}`)
+    }
+  }
+  
+  async remove(valueToRemove: string[], plan: Plan<PipResourceConfig>): Promise<void> {
+    if (valueToRemove.length === 0) {
+      return;
+    }
+
+    await codifySpawn(`pip uninstall ${valueToRemove.map((v) => `-r ${v}`).join(' ')}`)
+  }
+
+}

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

@@ -31,6 +31,13 @@
           }
         ]
       }
+    },
+    "installFiles": {
+      "description": "A list of requirement files to install.",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
     }
   },
   "additionalProperties": false,

src/resources/python/pip/pip.ts

@@ -11,15 +11,17 @@ import { ResourceConfig } from 'codify-schemas';
 
 import { codifySpawn } from '../../../utils/codify-spawn.js';
 import schema from './pip-schema.json';
+import { PipInstallFilesParameter } from './install-files.js';
 
 interface PipListResult {
   name: string;
   version?: string;
 }
 
 export interface PipResourceConfig extends ResourceConfig {
-  install: Array<PipListResult | string>,
-  virtualEnv?: string,
+  install: Array<PipListResult | string>;
+  installFiles: string[];
+  virtualEnv?: string;
 }
 
 export class Pip extends Resource<PipResourceConfig> {
@@ -37,6 +39,7 @@ export class Pip extends Resource<PipResourceConfig> {
           filterInStatelessMode: (desired, current) =>
             current.filter((c) => desired.find((d) => this.isSame(c, d)))
         },
+        installFiles: { type: 'stateful', definition: new PipInstallFilesParameter(), },
         virtualEnv: { type: 'directory', setting: true }
       },
       allowMultiple: {

test/python/pip.test.ts

@@ -25,13 +25,17 @@ describe('Pip resource integration tests', () => {
   })
 
   it('Installs python and installs a package using pip', { timeout: 300000 }, async () => {
+    const requirementsPath = path.join(os.homedir(), 'requirements.txt')
+    fs.writeFileSync(requirementsPath, 'aayush-color')
+
     await PluginTester.fullTest(pluginPath, [
       {
         type: 'pip',
         install: [
           'ffmpeg',
           { name:  'qoverage', version:  "0.1.12"},
-        ]
+        ],
+        installFiles: [requirementsPath]
       }
     ], {
       skipUninstall: true,