add check-latest for python versions

actions · dmitry-shibanov · Jul 25, 2022 · May 4, 2022 · May 6, 2022 · May 9, 2022
commit 4841389b470d15d781fd39a2bf1711c2cde4c3b4
@@ -91,3 +91,26 @@ jobs:
     - name: Run simple code
       run: python -c 'import math; print(math.factorial(5))'
 
+  check-latest:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.8", "3.9", "3.10"]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Python and check latest
+        uses: ./
+        with:
+          python-version: ${{ matrix.python-version }}
+          check-latest: true
+      - name: Validate version
+        run: |
+          $pythonVersion = (python --version)
+          if ("$pythonVersion" -NotMatch "${{ matrix.python }}"){
+            Write-Host "The current version is $pythonVersion; expected version is ${{ matrix.python }}"
+            exit 1
+          }
+          $pythonVersion
+        shell: pwsh
@@ -1,6 +1,7 @@
-import io = require('@actions/io');
-import fs = require('fs');
-import path = require('path');
+import * as io from '@actions/io';
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
 
 const toolDir = path.join(
   __dirname,
@@ -19,6 +20,7 @@ process.env['RUNNER_TOOL_CACHE'] = toolDir;
 process.env['RUNNER_TEMP'] = tempDir;
 
 import * as tc from '@actions/tool-cache';
+import * as core from '@actions/core';
 import * as finder from '../src/find-python';
 import * as installer from '../src/install-python';
 
@@ -31,6 +33,9 @@ describe('Finder tests', () => {
   });
 
   it('Finds Python if it is installed', async () => {
+    const getBooleanInputSpy = jest.spyOn(core, 'getBooleanInput');
+    getBooleanInputSpy.mockImplementation((input) => false);
+
     const pythonDir: string = path.join(toolDir, 'Python', '3.0.0', 'x64');
     await io.mkdirP(pythonDir);
     fs.writeFileSync(`${pythonDir}.complete`, 'hello');
@@ -42,6 +47,9 @@ describe('Finder tests', () => {
     const findSpy: jest.SpyInstance = jest.spyOn(tc, 'getManifestFromRepo');
     findSpy.mockImplementation(() => <tc.IToolRelease[]>manifestData);
 
+    const getBooleanInputSpy = jest.spyOn(core, 'getBooleanInput');
+    getBooleanInputSpy.mockImplementation((input) => false);
+
     const installSpy: jest.SpyInstance = jest.spyOn(
       installer,
       'installCpythonFromRelease'
@@ -59,6 +67,9 @@ describe('Finder tests', () => {
     const findSpy: jest.SpyInstance = jest.spyOn(tc, 'getManifestFromRepo');
     findSpy.mockImplementation(() => <tc.IToolRelease[]>manifestData);
 
+    const getBooleanInputSpy = jest.spyOn(core, 'getBooleanInput');
+    getBooleanInputSpy.mockImplementation((input) => false);
+
     const installSpy: jest.SpyInstance = jest.spyOn(
       installer,
       'installCpythonFromRelease'
@@ -77,6 +88,53 @@ describe('Finder tests', () => {
     await finder.useCpythonVersion('1.2.3-beta.2', 'x64');
   });
 
+  it('Check-latest true, finds the latest version in the manifest', async () => {
+    const findSpy: jest.SpyInstance = jest.spyOn(tc, 'getManifestFromRepo');
+    findSpy.mockImplementation(() => <tc.IToolRelease[]>manifestData);
+
+    const getBooleanInputSpy = jest.spyOn(core, 'getBooleanInput');
+    getBooleanInputSpy.mockImplementation((input) => true);
+
+    const cnSpy: jest.SpyInstance = jest.spyOn(process.stdout, 'write');
+    cnSpy.mockImplementation(line => {
+      // uncomment to debug
+      // process.stderr.write('write:' + line + '\n');
+    });
+
+    const infoSpy: jest.SpyInstance = jest.spyOn(core, 'info');
+    infoSpy.mockImplementation(() => {
+
+    });
+
+    const debugSpy: jest.SpyInstance = jest.spyOn(core, 'debug');
+    debugSpy.mockImplementation(() => {
+
+    });
+
+    const pythonDir: string = path.join(toolDir, 'Python', '1.2.2', 'x64');
+    const expPath: string = path.join(toolDir, 'Python', '1.2.3', 'x64');
+
+    const installSpy: jest.SpyInstance = jest.spyOn(
+      installer,
+      'installCpythonFromRelease'
+    );
+    installSpy.mockImplementation(async () => {
+      await io.mkdirP(expPath);
+      fs.writeFileSync(`${expPath}.complete`, 'hello');
+    });
+
+    await io.mkdirP(pythonDir);
+    await io.rmRF(expPath);
+
+    fs.writeFileSync(`${pythonDir}.complete`, 'hello');
+    // This will throw if it doesn't find it in the cache and in the manifest (because no such version exists)
+    await finder.useCpythonVersion('1.2', 'x64');
+
+    expect(infoSpy).toHaveBeenCalledWith("Resolved as '1.2.3'");
+    expect(infoSpy).toHaveBeenCalledWith('Version 1.2.3 was not found in the local cache');
+    expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${os.EOL}`);
+  });
+
   it('Errors if Python is not installed', async () => {
     // This will throw if it doesn't find it in the cache and in the manifest (because no such version exists)
     let thrown = false;

@@ -11,6 +11,9 @@ inputs:
     required: false
   architecture:
     description: 'The target architecture (x86, x64) of the Python interpreter.'
+  check-latest:
+    description: 'Set this option if you want the action to check for the latest available version that satisfies the version spec.'
+    default: false
   token:
     description: Used to pull python distributions from actions/python-versions. Since there's a default, this is typically not supplied by the user.
     default: ${{ github.token }}