fix: fixes for pip resource + tests

Author: kevinwang5658

src/resources/python/pip/pip.ts

@@ -1,12 +1,11 @@
 import {
   CreatePlan,
   DestroyPlan,
+  getPty,
   ModifyPlan,
   ParameterChange,
-  RefreshContext,
   Resource,
-  ResourceSettings,
-  getPty
+  ResourceSettings
 } from 'codify-plugin-lib';
 import { ResourceConfig } from 'codify-schemas';
 
@@ -32,24 +31,20 @@ export class PipResource extends Resource<PipResourceConfig> {
           type: 'array',
           itemType: 'object',
           canModify: true,
-          isElementEqual(desired: PipListResult | string, current: PipListResult | string) {
-            if (typeof desired === 'string' && typeof current === 'string') {
-              return desired === current;
-            }
-
-            // We can do this check because of the pre-filtering we are doing in refresh. It converts the current to match the desired if it is defined.
-            return (desired as PipListResult).name === (current as PipListResult).name;
-          }
+          isElementEqual: this.isEqual,
+          filterInStatelessMode: (desired, current) =>
+            current.filter((c) => desired.find((d) => this.isSame(c, d)))
         },
         virtualEnv: { type: 'directory' }
       },
       allowMultiple: {
         identifyingParameters: ['virtualEnv']
-      }
+      },
+      dependencies: ['pyenv', 'git-repository']
     }
   }
 
-  async refresh(parameters: Partial<PipResourceConfig>, context: RefreshContext<PipResourceConfig>): Promise<Partial<PipResourceConfig> | Partial<PipResourceConfig>[] | null> {
+  async refresh(parameters: Partial<PipResourceConfig>): Promise<Partial<PipResourceConfig> | Partial<PipResourceConfig>[] | null> {
     const pty = getPty()
 
     const { status: pipStatus } = await pty.spawnSafe('which pip');
@@ -93,14 +88,13 @@ export class PipResource extends Resource<PipResourceConfig> {
         return { name, version };
       });
 
-    console.log(parsedInstalledPackages);
-
     return {
       ...parameters,
       install: parsedInstalledPackages,
     }
   }
 
+  // Pip cannot be individually installed. It's installed via installing python. This only installs packages when python is first created.
   async create(plan: CreatePlan<PipResourceConfig>): Promise<void> {
     const { install, virtualEnv } = plan.desiredConfig;
 
@@ -123,11 +117,8 @@ export class PipResource extends Resource<PipResourceConfig> {
     }
   }
 
-  async destroy(plan: DestroyPlan<PipResourceConfig>): Promise<void> {
-    const { install, virtualEnv } = plan.currentConfig;
-
-    await this.pipUninstall(install, virtualEnv);
-  }
+  // Pip cannot be individually destroyed.
+  async destroy(plan: DestroyPlan<PipResourceConfig>): Promise<void> {}
 
   private async pipInstall(packages: Array<PipListResult | string>, virtualEnv?: string): Promise<void> {
     const packagesToInstall = packages.map((p) => {
@@ -159,29 +150,43 @@ export class PipResource extends Resource<PipResourceConfig> {
 
     await codifySpawn(
       (virtualEnv ? `source ${virtualEnv}/bin/activate; ` : '')
-      + `pip install ${packagesToUninstall.join(' ')}`
+      + `pip uninstall -y ${packagesToUninstall.join(' ')}`
     )
   }
 
-  findMatchingForModify(d: PipListResult | string, cList: Array<PipListResult | string>): PipListResult | string | undefined {
-    return cList.find((c) => {
-      if (typeof d === 'string' && typeof c === 'string') {
-        return d === c;
-      }
+  findMatchingForModify(a: PipListResult | string, bList: Array<PipListResult | string>): PipListResult | string | undefined {
+    return bList.find((b) => this.isEqual(a, b))
+  }
 
-      if (!(typeof d === 'object' && typeof c === 'object')) {
-        return false;
-      }
+  isEqual(a: PipListResult | string, b: PipListResult | string): boolean {
+    if (typeof a === 'string' && typeof b === 'string') {
+      return a === b;
+    }
 
-      if (d.name !== c.name) {
-        return false;
-      }
+    if (!(typeof a === 'object' && typeof b === 'object')) {
+      return false;
+    }
 
-      if (d.version && d.version !== c.version) {
-        return false
-      }
+    if (a.name !== b.name) {
+      return false;
+    }
+
+    if (a.version && a.version !== b.version) {
+      return false
+    }
+
+    return true;
+  }
+
+  isSame(a: PipListResult | string, b: PipListResult | string): boolean {
+    if (typeof a === 'string' && typeof b === 'string') {
+      return a === b;
+    }
+
+    if (!(typeof a === 'object' && typeof b === 'object')) {
+      return false;
+    }
 
-      return true;
-    })
+    return a.name === b.name;
   }
 }

test/python/pip.test.ts

@@ -4,48 +4,89 @@ import * as path from 'node:path';
 import { execSync } from 'child_process';
 import fs from 'node:fs';
 import os from 'node:os';
+import { ResourceOperation } from 'codify-schemas';
 
-describe('Pyenv resource integration tests', () => {
+describe('Pip resource integration tests', () => {
   const pluginPath = path.resolve('./src/index.ts');
 
-  it('Installs pyenv and python (this installs on a clean system without readline, openSSL, etc.)', { timeout: 500000 }, async () => {
+  it('Installs python', { timeout: 500000 }, async () => {
     await PluginTester.fullTest(pluginPath, [
       {
         type: 'pyenv',
-        pythonVersions: ['3.11']
-      }
+        pythonVersions: ['3.11'],
+        global: '3.11'
+      },
     ], {
       skipUninstall: true,
       validateApply: () => {
-        expect(() => execSync('source ~/.zshrc; which pyenv', { shell: 'zsh' })).to.not.throw();
+        expect(execSync('source ~/.zshrc; python --version', { shell: 'zsh' }).toString()).to.include('3.11');
       }
-    });
-  });
+    })
+  })
 
-  it ('Can install additional python versions. (this installs after openSSL and readline have been installed)', { timeout: 700000 }, async () => {
+  it('Installs python and installs a package using pip', { timeout: 300000 }, async () => {
     await PluginTester.fullTest(pluginPath, [
       {
-        type: 'homebrew',
-        formulae: ['readline', 'openssl@3']
-      },
-      {
-        type: 'pyenv',
-        pythonVersions: ['3.11', '3.12'],
-        global: '3.12',
+        type: 'pip',
+        install: [
+          'ffmpeg',
+          { name:  'qoverage', version:  "0.1.12"},
+        ]
       }
     ], {
+      skipUninstall: true,
+      validatePlan: (plans) => {
+        console.log(JSON.stringify(plans, null, 2))
+      },
       validateApply: () => {
-        expect(execSync('source ~/.zshrc; python --version', { shell: 'zsh' }).toString('utf-8')).to.include('3.12');
+        const installedDependencies = execSync('source ~/.zshrc; pip list --format=json --disable-pip-version-check', { shell: 'zsh' }).toString()
+        const parsed = JSON.parse(installedDependencies) as Array<{ name: string; version: string; }>;
 
-        const versions = execSync('source ~/.zshrc; pyenv versions', { shell: 'zsh' }).toString('utf-8')
-        expect(versions).to.include('3.12')
-        expect(versions).to.include('3.11')
+        expect(parsed.some((p) => p.name === 'ffmpeg')).to.be.true;
+        expect(parsed.some((p) => p.name === 'qoverage' && p.version === '0.1.12')).to.be.true;
       },
-      validateDestroy: () => {
-        expect(fs.existsSync(path.resolve(os.homedir(), '.pyenv'))).to.be.false;
-        expect(fs.readFileSync(path.resolve(os.homedir(), '.zshrc'), 'utf-8')).to.not.contain('pyenv');
-        expect(() => execSync('source ~/.zshrc; which pyenv', { shell: 'zsh' })).to.throw();
+      testModify: {
+        modifiedConfigs: [
+          {
+            type: 'pip',
+            install: [
+              'ffmpeg',
+              'ansible-roster',
+              { name:  'qoverage', version:  "0.1.13"},
+            ]
+          }
+        ],
+        validateModify: (plans) => {
+          expect(plans.length).to.eq(1);
+          const plan = plans[0];
+          expect(plan).toMatchObject(  {
+              "operation": "modify",
+              "resourceType": "pip",
+              "parameters": expect.arrayContaining([
+                expect.objectContaining({
+                  "name": "install",
+                  "previousValue": [
+                    "ffmpeg",
+                    {
+                      "name": "qoverage",
+                      "version": "0.1.12"
+                    }
+                  ],
+                  "newValue": [
+                    "ffmpeg",
+                    "ansible-roster",
+                    {
+                      "name": "qoverage",
+                      "version": "0.1.13"
+                    }
+                  ],
+                  "operation": "modify"
+                })
+              ])
+            }
+          )
+        }
       }
-    })
-  })
+    });
+  });
 })