Update CODEOWNERS

.github/CODEOWNERS

@@ -1 +1,2 @@
-* @actions/setup-actions-team
+* @actions/actions-service
+* @actions/runner-images-team

README.md

@@ -55,7 +55,7 @@ The action defaults to searching for a dependency file (`requirements.txt` for p
 
  - For `pip`, the action will cache the global cache directory
  - For `pipenv`, the action will cache virtualenv directory
- - For `poetry`, the action will cache virtualenv directories -- one for each poetry project found
+ - For `poetry`, the action will cache virtualenv directory
 
 **Caching pip dependencies:**
 

__tests__/cache-restore.test.ts

@@ -1,10 +1,8 @@
-import * as path from 'path';
 import * as core from '@actions/core';
 import * as cache from '@actions/cache';
 import * as exec from '@actions/exec';
 import * as io from '@actions/io';
 import {getCacheDistributor} from '../src/cache-distributions/cache-factory';
-import {State} from '../src/cache-distributions/cache-distributor';
 import * as utils from './../src/utils';
 
 describe('restore-cache', () => {
@@ -15,7 +13,7 @@ describe('restore-cache', () => {
   const requirementsLinuxHash =
     '2d0ff7f46b0e120e3d3294db65768b474934242637b9899b873e6283dfd16d7c';
   const poetryLockHash =
-    'f24ea1ad73968e6c8d80c16a093ade72d9332c433aeef979a0dd943e6a99b2ab';
+    '571bf984f8d210e6a97f854e479fdd4a2b5af67b5fdac109ec337a0ea16e7836';
   const poetryConfigOutput = `
 cache-dir = "/Users/patrick/Library/Caches/pypoetry"
 experimental.new-installer = false
@@ -29,7 +27,7 @@ virtualenvs.path = "{cache-dir}/virtualenvs"  # /Users/patrick/Library/Caches/py
   let infoSpy: jest.SpyInstance;
   let warningSpy: jest.SpyInstance;
   let debugSpy: jest.SpyInstance;
-  let saveStateSpy: jest.SpyInstance;
+  let saveSatetSpy: jest.SpyInstance;
   let getStateSpy: jest.SpyInstance;
   let setOutputSpy: jest.SpyInstance;
 
@@ -54,8 +52,8 @@ virtualenvs.path = "{cache-dir}/virtualenvs"  # /Users/patrick/Library/Caches/py
     debugSpy = jest.spyOn(core, 'debug');
     debugSpy.mockImplementation(input => undefined);
 
-    saveStateSpy = jest.spyOn(core, 'saveState');
+    saveSatetSpy = jest.spyOn(core, 'saveState');
-    saveStateSpy.mockImplementation(input => undefined);
+    saveSatetSpy.mockImplementation(input => undefined);
 
     getStateSpy = jest.spyOn(core, 'getState');
     getStateSpy.mockImplementation(input => undefined);
@@ -102,68 +100,21 @@ virtualenvs.path = "{cache-dir}/virtualenvs"  # /Users/patrick/Library/Caches/py
 
   describe('Restore dependencies', () => {
     it.each([
-      [
+      ['pip', '3.8.12', undefined, requirementsHash],
-        'pip',
+      ['pip', '3.8.12', '**/requirements-linux.txt', requirementsLinuxHash],
-        '3.8.12',
-        '__tests__/data/**/requirements.txt',
-        requirementsHash,
-        undefined
-      ],
-      [
-        'pip',
-        '3.8.12',
-        '__tests__/data/**/requirements-linux.txt',
-        requirementsLinuxHash,
-        undefined
-      ],
       [
         'pip',
         '3.8.12',
         '__tests__/data/requirements-linux.txt',
-        requirementsLinuxHash,
+        requirementsLinuxHash
-        undefined
       ],
-      [
+      ['pip', '3.8.12', '__tests__/data/requirements.txt', requirementsHash],
-        'pip',
+      ['pipenv', '3.9.1', undefined, pipFileLockHash],
-        '3.8.12',
+      ['pipenv', '3.9.12', '__tests__/data/requirements.txt', requirementsHash],
-        '__tests__/data/requirements.txt',
+      ['poetry', '3.9.1', undefined, poetryLockHash]
-        requirementsHash,
-        undefined
-      ],
-      [
-        'pipenv',
-        '3.9.1',
-        '__tests__/data/**/Pipfile.lock',
-        pipFileLockHash,
-        undefined
-      ],
-      [
-        'pipenv',
-        '3.9.12',
-        '__tests__/data/requirements.txt',
-        requirementsHash,
-        undefined
-      ],
-      [
-        'poetry',
-        '3.9.1',
-        '__tests__/data/**/poetry.lock',
-        poetryLockHash,
-        [
-          '/Users/patrick/Library/Caches/pypoetry/virtualenvs',
-          path.join(__dirname, 'data', 'inner', '.venv'),
-          path.join(__dirname, 'data', '.venv')
-        ]
-      ]
     ])(
       'restored dependencies for %s by primaryKey',
-      async (
+      async (packageManager, pythonVersion, dependencyFile, fileHash) => {
-        packageManager,
-        pythonVersion,
-        dependencyFile,
-        fileHash,
-        cachePaths
-      ) => {
         const cacheDistributor = getCacheDistributor(
           packageManager,
           pythonVersion,
@@ -172,21 +123,10 @@ virtualenvs.path = "{cache-dir}/virtualenvs"  # /Users/patrick/Library/Caches/py
 
         await cacheDistributor.restoreCache();
 
-        if (cachePaths !== undefined) {
-          expect(saveStateSpy).toHaveBeenCalledWith(
-            State.CACHE_PATHS,
-            cachePaths
-          );
-        }
-
         if (process.platform === 'linux' && packageManager === 'pip') {
           expect(infoSpy).toHaveBeenCalledWith(
             `Cache restored from key: setup-python-${process.env['RUNNER_OS']}-20.04-Ubuntu-python-${pythonVersion}-${packageManager}-${fileHash}`
           );
-        } else if (packageManager === 'poetry') {
-          expect(infoSpy).toHaveBeenCalledWith(
-            `Cache restored from key: setup-python-${process.env['RUNNER_OS']}-python-${pythonVersion}-${packageManager}-v2-${fileHash}`
-          );
         } else {
           expect(infoSpy).toHaveBeenCalledWith(
             `Cache restored from key: setup-python-${process.env['RUNNER_OS']}-python-${pythonVersion}-${packageManager}-${fileHash}`
@@ -224,13 +164,8 @@ virtualenvs.path = "{cache-dir}/virtualenvs"  # /Users/patrick/Library/Caches/py
 
   describe('Dependencies changed', () => {
     it.each([
-      ['pip', '3.8.12', '__tests__/data/**/requirements.txt', pipFileLockHash],
+      ['pip', '3.8.12', undefined, pipFileLockHash],
-      [
+      ['pip', '3.8.12', '**/requirements-linux.txt', pipFileLockHash],
-        'pip',
-        '3.8.12',
-        '__tests__/data/**/requirements-linux.txt',
-        pipFileLockHash
-      ],
       [
         'pip',
         '3.8.12',
@@ -238,9 +173,9 @@ virtualenvs.path = "{cache-dir}/virtualenvs"  # /Users/patrick/Library/Caches/py
         pipFileLockHash
       ],
       ['pip', '3.8.12', '__tests__/data/requirements.txt', pipFileLockHash],
-      ['pipenv', '3.9.1', '__tests__/data/**/Pipfile.lock', requirementsHash],
+      ['pipenv', '3.9.1', undefined, requirementsHash],
       ['pipenv', '3.9.12', '__tests__/data/requirements.txt', requirementsHash],
-      ['poetry', '3.9.1', '__tests__/data/**/poetry.lock', requirementsHash]
+      ['poetry', '3.9.1', undefined, requirementsHash]
     ])(
       'restored dependencies for %s by primaryKey',
       async (packageManager, pythonVersion, dependencyFile, fileHash) => {

__tests__/cache-save.test.ts

@@ -18,7 +18,7 @@ describe('run', () => {
   let infoSpy: jest.SpyInstance;
   let warningSpy: jest.SpyInstance;
   let debugSpy: jest.SpyInstance;
-  let saveStateSpy: jest.SpyInstance;
+  let saveSatetSpy: jest.SpyInstance;
   let getStateSpy: jest.SpyInstance;
   let getInputSpy: jest.SpyInstance;
   let setFailedSpy: jest.SpyInstance;
@@ -43,8 +43,8 @@ describe('run', () => {
     debugSpy = jest.spyOn(core, 'debug');
     debugSpy.mockImplementation(input => undefined);
 
-    saveStateSpy = jest.spyOn(core, 'saveState');
+    saveSatetSpy = jest.spyOn(core, 'saveState');
-    saveStateSpy.mockImplementation(input => undefined);
+    saveSatetSpy.mockImplementation(input => undefined);
 
     getStateSpy = jest.spyOn(core, 'getState');
     getStateSpy.mockImplementation(input => {

__tests__/data/inner/poetry.lock

@@ -1 +0,0 @@
-../poetry.lock

__tests__/data/inner/pyproject.toml

@@ -1 +0,0 @@
-../pyproject.toml

dist/cache-save/index.js

@@ -59711,9 +59711,6 @@ class CacheDistributor {
         this.cacheDependencyPath = cacheDependencyPath;
         this.CACHE_KEY_PREFIX = 'setup-python';
     }
-    handleLoadedCache() {
-        return __awaiter(this, void 0, void 0, function* () { });
-    }
     restoreCache() {
         return __awaiter(this, void 0, void 0, function* () {
             const { primaryKey, restoreKey } = yield this.computeKeys();
@@ -59726,7 +59723,6 @@ class CacheDistributor {
             core.saveState(State.CACHE_PATHS, cachePath);
             core.saveState(State.STATE_CACHE_PRIMARY_KEY, primaryKey);
             const matchedKey = yield cache.restoreCache(cachePath, primaryKey, restoreKey);
-            yield this.handleLoadedCache();
             this.handleMatchResult(matchedKey, primaryKey);
         });
     }

dist/setup/index.js

@@ -65787,9 +65787,6 @@ class CacheDistributor {
         this.cacheDependencyPath = cacheDependencyPath;
         this.CACHE_KEY_PREFIX = 'setup-python';
     }
-    handleLoadedCache() {
-        return __awaiter(this, void 0, void 0, function* () { });
-    }
     restoreCache() {
         return __awaiter(this, void 0, void 0, function* () {
             const { primaryKey, restoreKey } = yield this.computeKeys();
@@ -65802,7 +65799,6 @@ class CacheDistributor {
             core.saveState(State.CACHE_PATHS, cachePath);
             core.saveState(State.STATE_CACHE_PRIMARY_KEY, primaryKey);
             const matchedKey = yield cache.restoreCache(cachePath, primaryKey, restoreKey);
-            yield this.handleLoadedCache();
             this.handleMatchResult(matchedKey, primaryKey);
         });
     }
@@ -66082,13 +66078,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __asyncValues = (this && this.__asyncValues) || function (o) {
-    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
-    var m = o[Symbol.asyncIterator], i;
-    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
-    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
-    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -66101,48 +66090,38 @@ const core = __importStar(__nccwpck_require__(2186));
 const cache_distributor_1 = __importDefault(__nccwpck_require__(8953));
 const utils_1 = __nccwpck_require__(1314);
 class PoetryCache extends cache_distributor_1.default {
-    constructor(pythonVersion, patterns = '**/poetry.lock', poetryProjects = new Set()) {
+    constructor(pythonVersion, patterns = '**/poetry.lock') {
         super('poetry', patterns);
         this.pythonVersion = pythonVersion;
         this.patterns = patterns;
-        this.poetryProjects = poetryProjects;
     }
     getCacheGlobalDirectories() {
-        var e_1, _a;
         return __awaiter(this, void 0, void 0, function* () {
-            // Same virtualenvs path may appear for different projects, hence we use a Set
+            const poetryConfig = yield this.getPoetryConfiguration();
-            const paths = new Set();
+            const cacheDir = poetryConfig['cache-dir'];
-            const globber = yield glob.create(this.patterns);
+            const virtualenvsPath = poetryConfig['virtualenvs.path'].replace('{cache-dir}', cacheDir);
-            try {
+            const paths = [virtualenvsPath];
-                for (var _b = __asyncValues(globber.globGenerator()), _c; _c = yield _b.next(), !_c.done;) {
+            if (poetryConfig['virtualenvs.in-project'] === true) {
-                    const file = _c.value;
+                paths.push(path.join(process.cwd(), '.venv'));
-                    const basedir = path.dirname(file);
+            }
-                    core.debug(`Processing Poetry project at ${basedir}`);
+            const pythonLocation = yield io.which('python');
-                    this.poetryProjects.add(basedir);
+            if (pythonLocation) {
-                    const poetryConfig = yield this.getPoetryConfiguration(basedir);
+                core.debug(`pythonLocation is ${pythonLocation}`);
-                    const cacheDir = poetryConfig['cache-dir'];
+                const { exitCode, stderr } = yield exec.getExecOutput(`poetry env use ${pythonLocation}`, undefined, { ignoreReturnCode: true });
-                    const virtualenvsPath = poetryConfig['virtualenvs.path'].replace('{cache-dir}', cacheDir);
+                if (exitCode) {
-                    paths.add(virtualenvsPath);
+                    utils_1.logWarning(stderr);
-                    if (poetryConfig['virtualenvs.in-project']) {
-                        paths.add(path.join(basedir, '.venv'));
-                    }
                 }
             }
-            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            else {
-            finally {
+                utils_1.logWarning('python binaries were not found in PATH');
-                try {
-                    if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
-                }
-                finally { if (e_1) throw e_1.error; }
             }
-            return [...paths];
+            return paths;
         });
     }
     computeKeys() {
         return __awaiter(this, void 0, void 0, function* () {
             const hash = yield glob.hashFiles(this.patterns);
-            // "v2" is here to invalidate old caches of this cache distributor, which were created broken:
+            const primaryKey = `${this.CACHE_KEY_PREFIX}-${process.env['RUNNER_OS']}-python-${this.pythonVersion}-${this.packageManager}-${hash}`;
-            const primaryKey = `${this.CACHE_KEY_PREFIX}-${process.env['RUNNER_OS']}-python-${this.pythonVersion}-${this.packageManager}-v2-${hash}`;
             const restoreKey = undefined;
             return {
                 primaryKey,
@@ -66150,33 +66129,12 @@ class PoetryCache extends cache_distributor_1.default {
             };
         });
     }
-    handleLoadedCache() {
+    getPoetryConfiguration() {
-        const _super = Object.create(null, {
-            handleLoadedCache: { get: () => super.handleLoadedCache }
-        });
         return __awaiter(this, void 0, void 0, function* () {
-            yield _super.handleLoadedCache.call(this);
+            const { stdout, stderr, exitCode } = yield exec.getExecOutput('poetry', [
-            // After the cache is loaded -- make sure virtualenvs use the correct Python version (the one that we have just installed).
+                'config',
-            // This will handle invalid caches, recreating virtualenvs if necessary.
+                '--list'
-            const pythonLocation = yield io.which('python');
+            ]);
-            if (pythonLocation) {
-                core.debug(`pythonLocation is ${pythonLocation}`);
-            }
-            else {
-                utils_1.logWarning('python binaries were not found in PATH');
-                return;
-            }
-            for (const poetryProject of this.poetryProjects) {
-                const { exitCode, stderr } = yield exec.getExecOutput('poetry', ['env', 'use', pythonLocation], { ignoreReturnCode: true, cwd: poetryProject });
-                if (exitCode) {
-                    utils_1.logWarning(stderr);
-                }
-            }
-        });
-    }
-    getPoetryConfiguration(basedir) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { stdout, stderr, exitCode } = yield exec.getExecOutput('poetry', ['config', '--list'], { cwd: basedir });
             if (exitCode && stderr) {
                 throw new Error('Could not get cache folder path for poetry package manager');
             }

docs/advanced-usage.md

@@ -259,7 +259,7 @@ If `check-latest` is set to `true`, the action first checks if the cached versio
 ```yaml
 steps:
   - uses: actions/checkout@v3
-  - uses: actions/setup-python@v4
+  - uses: actions/setup-python@v3
     with:
       python-version: '3.7'
       check-latest: true

src/cache-distributions/cache-distributor.ts

@@ -19,7 +19,6 @@ abstract class CacheDistributor {
     primaryKey: string;
     restoreKey: string[] | undefined;
   }>;
-  protected async handleLoadedCache() {}
 
   public async restoreCache() {
     const {primaryKey, restoreKey} = await this.computeKeys();
@@ -42,8 +41,6 @@ abstract class CacheDistributor {
       restoreKey
     );
 
-    await this.handleLoadedCache();
-
     this.handleMatchResult(matchedKey, primaryKey);
   }
 

src/cache-distributions/poetry-cache.ts

@@ -10,44 +10,52 @@ import {logWarning} from '../utils';
 class PoetryCache extends CacheDistributor {
   constructor(
     private pythonVersion: string,
-    protected patterns: string = '**/poetry.lock',
+    protected patterns: string = '**/poetry.lock'
-    protected poetryProjects: Set<string> = new Set<string>()
   ) {
     super('poetry', patterns);
   }
 
   protected async getCacheGlobalDirectories() {
-    // Same virtualenvs path may appear for different projects, hence we use a Set
+    const poetryConfig = await this.getPoetryConfiguration();
-    const paths = new Set<string>();
-    const globber = await glob.create(this.patterns);
 
-    for await (const file of globber.globGenerator()) {
+    const cacheDir = poetryConfig['cache-dir'];
-      const basedir = path.dirname(file);
+    const virtualenvsPath = poetryConfig['virtualenvs.path'].replace(
-      core.debug(`Processing Poetry project at ${basedir}`);
+      '{cache-dir}',
-      this.poetryProjects.add(basedir);
+      cacheDir
+    );
 
-      const poetryConfig = await this.getPoetryConfiguration(basedir);
+    const paths = [virtualenvsPath];
 
-      const cacheDir = poetryConfig['cache-dir'];
+    if (poetryConfig['virtualenvs.in-project'] === true) {
-      const virtualenvsPath = poetryConfig['virtualenvs.path'].replace(
+      paths.push(path.join(process.cwd(), '.venv'));
-        '{cache-dir}',
-        cacheDir
-      );
-
-      paths.add(virtualenvsPath);
-
-      if (poetryConfig['virtualenvs.in-project']) {
-        paths.add(path.join(basedir, '.venv'));
-      }
     }
 
-    return [...paths];
+    const pythonLocation = await io.which('python');
+
+    if (pythonLocation) {
+      core.debug(`pythonLocation is ${pythonLocation}`);
+      const {
+        exitCode,
+        stderr
+      } = await exec.getExecOutput(
+        `poetry env use ${pythonLocation}`,
+        undefined,
+        {ignoreReturnCode: true}
+      );
+
+      if (exitCode) {
+        logWarning(stderr);
+      }
+    } else {
+      logWarning('python binaries were not found in PATH');
+    }
+
+    return paths;
   }
 
   protected async computeKeys() {
     const hash = await glob.hashFiles(this.patterns);
-    // "v2" is here to invalidate old caches of this cache distributor, which were created broken:
+    const primaryKey = `${this.CACHE_KEY_PREFIX}-${process.env['RUNNER_OS']}-python-${this.pythonVersion}-${this.packageManager}-${hash}`;
-    const primaryKey = `${this.CACHE_KEY_PREFIX}-${process.env['RUNNER_OS']}-python-${this.pythonVersion}-${this.packageManager}-v2-${hash}`;
     const restoreKey = undefined;
     return {
       primaryKey,
@@ -55,39 +63,11 @@ class PoetryCache extends CacheDistributor {
     };
   }
 
-  protected async handleLoadedCache() {
+  private async getPoetryConfiguration() {
-    await super.handleLoadedCache();
+    const {stdout, stderr, exitCode} = await exec.getExecOutput('poetry', [
-
+      'config',
-    // After the cache is loaded -- make sure virtualenvs use the correct Python version (the one that we have just installed).
+      '--list'
-    // This will handle invalid caches, recreating virtualenvs if necessary.
+    ]);
-
-    const pythonLocation = await io.which('python');
-    if (pythonLocation) {
-      core.debug(`pythonLocation is ${pythonLocation}`);
-    } else {
-      logWarning('python binaries were not found in PATH');
-      return;
-    }
-
-    for (const poetryProject of this.poetryProjects) {
-      const {exitCode, stderr} = await exec.getExecOutput(
-        'poetry',
-        ['env', 'use', pythonLocation],
-        {ignoreReturnCode: true, cwd: poetryProject}
-      );
-
-      if (exitCode) {
-        logWarning(stderr);
-      }
-    }
-  }
-
-  private async getPoetryConfiguration(basedir: string) {
-    const {stdout, stderr, exitCode} = await exec.getExecOutput(
-      'poetry',
-      ['config', '--list'],
-      {cwd: basedir}
-    );
 
     if (exitCode && stderr) {
       throw new Error(