[UsePythonV0] Download python from registry

Tasks/UsePythonVersionV0/Strings/resources.resjson/en-US/resources.resjson

@@ -6,6 +6,8 @@
   "loc.group.displayName.advanced": "Advanced",
   "loc.input.label.versionSpec": "Version spec",
   "loc.input.help.versionSpec": "Version range or exact version of a Python version to use, using semver's version range syntax. [More information](https://go.microsoft.com/fwlink/?LinkID=2006180)",
+  "loc.input.label.allowUnstable": "Allow downloading unstable releases",
+  "loc.input.help.allowUnstable": "Allow downloading unstable python versions from registry.",
   "loc.input.label.addToPath": "Add to PATH",
   "loc.input.help.addToPath": "Whether to prepend the retrieved Python version to the PATH environment variable to make it available in subsequent tasks or scripts without using the output variable.",
   "loc.input.label.architecture": "Architecture",
@@ -16,7 +18,8 @@
   "loc.messages.PyPyNotFound": "Could not find an installation of PyPy%d in Agent.ToolsDirectory.",
   "loc.messages.ToolNotFoundMicrosoftHosted": "If this is a Microsoft-hosted agent, check that this image supports side-by-side versions of %s at %s.",
   "loc.messages.ToolNotFoundSelfHosted": "If this is a self-hosted agent, see how to configure side-by-side %s versions at %s.",
-  "loc.messages.VersionNotFound": "Version spec %s for architecture %s did not match any version in Agent.ToolsDirectory.",
-  "loc.messages.ExactVersionNotRecommended": "Specifying an exact version is not recommended on Microsoft-Hosted agents. Patch versions of Python can be replaced by new ones on Hosted agents without notice, which will cause builds to fail unexpectedly. It is recommended to specify only major or major and minor version (Example: `3` or `3.6`)",
-  "loc.messages.PythonVersionRetirement": "Python 3.5 has reached its end of life and will be removed from the ms-hosted images on January, 24. Please update Python version if you use ms-hosted agents. For more information about this - https://github.com/actions/virtual-environments"
+  "loc.messages.VersionNotFound": "Version spec %s for architecture %s did not match any version in Agent.ToolsDirectory or in python-versions registry (https://github.com/actions/python-versions).",
+  "loc.messages.PythonVersionRetirement": "Python 3.5 has reached its end of life and will be removed from the ms-hosted images on January, 24. Please update Python version if you use ms-hosted agents. For more information about this - https://github.com/actions/virtual-environments",
+  "loc.messages.DownloadNotFound": "Could not find Python matching spec %s in the python-versions registry. Beware that we don't support downloading python from registry on self-hosted agents.",
+  "loc.messages.DownloadFailed": "Failed to download Python from the registry. Error: %s."
 }

Tasks/UsePythonVersionV0/TaskParameters.ts

@@ -0,0 +1,6 @@
+export default interface TaskParameters {
+  versionSpec: string,
+  allowUnstable?: boolean,
+  addToPath: boolean,
+  architecture: string
+}

Tasks/UsePythonVersionV0/Tests/L0.ts

@@ -42,22 +42,74 @@ describe('UsePythonVersion L0 Suite', function () {
         assert(testRunner.succeeded, 'task should have succeeded');
     });
 
+    it('downloads python from registry on Windows', function () {
+        const testFile = path.join(__dirname, 'L0DownloadsFromRegistryWindows.js');
+        const testRunner = new MockTestRunner(testFile);
+
+        testRunner.run();
+
+        const pythonDir = path.join('C', 'tools', 'Python', '3.10.1', 'x64');
+        const pythonBinDir = path.join(pythonDir, 'Scripts');
+        const pythonAppdataDir = path.join('testappdata', 'Python', 'Python310', 'Scripts');
+
+        assert(didSetVariable(testRunner, 'pythonLocation', pythonDir));
+        assert(didPrependPath(testRunner, pythonDir));
+        assert(didPrependPath(testRunner, pythonBinDir));
+        assert(didPrependPath(testRunner, pythonAppdataDir));
+        assert.strictEqual(testRunner.stderr.length, 0, 'should not have written to stderr');
+        assert(testRunner.succeeded, 'task should have succeeded');
+    });
+
+    it('downloads python from registry on Ubuntu', function () {
+        const testFile = path.join(__dirname, 'L0DownloadsFromRegistryUbuntu.js');
+        const testRunner = new MockTestRunner(testFile);
+
+        testRunner.run();
+
+        const pythonDir = path.join('opt', 'hostedtoolcache', 'Python', '3.10.1', 'x64');
+        const pythonBinDir = path.join(pythonDir, 'bin');
+
+        assert(didSetVariable(testRunner, 'pythonLocation', pythonDir));
+        assert(didPrependPath(testRunner, pythonDir));
+        assert(didPrependPath(testRunner, pythonBinDir));
+        assert.strictEqual(testRunner.stderr.length, 0, 'should not have written to stderr');
+        assert(testRunner.succeeded, 'task should have succeeded');
+    });
+
+    it('downloads unstable python from registry', function () {
+        const testFile = path.join(__dirname, 'L0DownloadsUnstable.js');
+        const testRunner = new MockTestRunner(testFile);
+
+        testRunner.run();
+
+        const pythonDir = path.join('opt', 'hostedtoolcache', 'Python', '3.11.1', 'x64');
+        const pythonBinDir = path.join(pythonDir, 'bin');
+
+        assert(didSetVariable(testRunner, 'pythonLocation', pythonDir));
+        assert(didPrependPath(testRunner, pythonDir));
+        assert(didPrependPath(testRunner, pythonBinDir));
+        assert.strictEqual(testRunner.stderr.length, 0, 'should not have written to stderr');
+        assert(testRunner.succeeded, 'task should have succeeded');
+    });
+
     it('fails when version is not found', function () {
         const testFile = path.join(__dirname, 'L0FailsWhenVersionIsMissing.js');
         const testRunner = new MockTestRunner(testFile);
 
         testRunner.run();
 
+        assert(testRunner.createdErrorIssue('loc_mock_DownloadFailed Error: loc_mock_DownloadNotFound 3.11.x'));
+
         const errorMessage = [
-            'loc_mock_VersionNotFound 3.x x64',
+            'loc_mock_VersionNotFound 3.11.x x64',
             'loc_mock_ListAvailableVersions $(Agent.ToolsDirectory)',
             '2.6.0 (x86)',
             '2.7.13 (x86)',
             '2.6.0 (x64)',
             '2.7.13 (x64)',
             'loc_mock_ToolNotFoundMicrosoftHosted Python https://aka.ms/hosted-agent-software',
             'loc_mock_ToolNotFoundSelfHosted Python https://go.microsoft.com/fwlink/?linkid=871498',
-        ].join(os.EOL);
+        ].join('\r\n');
 
         assert(testRunner.createdErrorIssue(errorMessage));
         assert(testRunner.failed, 'task should have failed');

Tasks/UsePythonVersionV0/Tests/L0DownloadsFromRegistryUbuntu.ts

@@ -0,0 +1,104 @@
+import * as path from 'path';
+import * as fs from 'fs';
+
+import { TaskMockRunner } from 'azure-pipelines-task-lib/mock-run';
+
+const taskPath = path.join(__dirname, '..', 'main.js');
+const taskRunner = new TaskMockRunner(taskPath);
+
+taskRunner.setInput('versionSpec', '3.10.x');
+taskRunner.setInput('addToPath', 'true');
+taskRunner.setInput('architecture', 'x64');
+
+// `getVariable` is not supported by `TaskLibAnswers`
+process.env['AGENT_TOOLSDIRECTORY'] = '$(Agent.ToolsDirectory)';
+
+let pythonWasInstalled = false;
+
+// Mock azure-pipelines-tool-lib
+taskRunner.registerMock('azure-pipelines-tool-lib/tool', {
+    findLocalTool() {
+        if (!pythonWasInstalled) {
+            return null;
+        }
+
+        return path.join('opt', 'hostedtoolcache', 'Python', '3.10.1', 'x64');
+    },
+    findLocalToolVersions: () => ['2.6.0', '2.7.13'],
+    downloadTool: () => Promise.resolve('/home/python.tar.gz'),
+    extractTar: () => Promise.resolve('/home/extracted/python'),
+    extractZip() {
+        throw new Error('This should never be called');
+    },
+});
+
+taskRunner.registerMock('os', {
+    platform() {
+        return 'linux';
+    },
+    arch() {
+        return 'x64';
+    },
+    EOL: '\r\n'
+});
+
+// Can't mock process, so have to mock taskutil instead
+enum Platform {
+    Windows,
+    MacOS,
+    Linux
+}
+
+taskRunner.registerMock('./taskutil', {
+    Platform,
+    getPlatform() {
+        return Platform.Linux;
+    }
+});
+
+const tl = require('azure-pipelines-task-lib/mock-task');
+const tlClone = Object.assign({}, tl);
+tlClone.exec = function(command, args, options) {
+    if (command !== 'bash' || args !== './setup.sh') {
+        throw new Error(`Invalid command and arguments: ${command} ${args}`);
+    }
+
+    if (options.cwd !== '/home/extracted/python') {
+        throw new Error(`Invalid python installer dir path: ${options.cwd}`);
+    }
+
+    pythonWasInstalled = true;
+};
+taskRunner.registerMock('azure-pipelines-task-lib/mock-task', tlClone);
+
+// Test manifest contains stable python 3.10.1, so the task should find it
+taskRunner.registerMock('typed-rest-client', {
+    RestClient: class {
+        get(_url: string) {
+            return Promise.resolve({
+                result: JSON.parse(fs.readFileSync(path.join(__dirname, 'data', 'versions-manifest.json')).toString())
+            });
+        }
+    }
+});
+
+const lsbPath = '/etc/lsb-release';
+taskRunner.registerMock('fs', {
+    existsSync(filePath) {
+        if (filePath !== lsbPath) {
+            throw new Error(`Tried to check the wrong file for existance: ${filePath}`);
+        }
+
+        return true;
+    },
+
+    readFileSync(filePath) {
+        if (filePath !== lsbPath) {
+            throw new Error(`Tried to read the wrong file: ${filePath}`);
+        }
+
+        return 'DISTRIB_RELEASE=18.04';
+    }
+});
+
+taskRunner.run();

Tasks/UsePythonVersionV0/Tests/L0DownloadsFromRegistryWindows.ts

@@ -0,0 +1,86 @@
+import * as path from 'path';
+import * as fs from 'fs';
+
+import { TaskMockRunner } from 'azure-pipelines-task-lib/mock-run';
+
+const taskPath = path.join(__dirname, '..', 'main.js');
+const taskRunner = new TaskMockRunner(taskPath);
+
+taskRunner.setInput('versionSpec', '3.10.x');
+taskRunner.setInput('addToPath', 'true');
+taskRunner.setInput('architecture', 'x64');
+
+// `getVariable` is not supported by `TaskLibAnswers`
+process.env['AGENT_TOOLSDIRECTORY'] = '$(Agent.ToolsDirectory)';
+process.env['APPDATA'] = 'testappdata';
+
+let pythonWasInstalled = false;
+
+// Mock azure-pipelines-tool-lib
+taskRunner.registerMock('azure-pipelines-tool-lib/tool', {
+    findLocalTool() {
+        if (!pythonWasInstalled) {
+            return null;
+        }
+
+        return path.join('C', 'tools', 'Python', '3.10.1', 'x64');
+    },
+    findLocalToolVersions: () => ['2.6.0', '2.7.13'],
+    downloadTool: () => Promise.resolve('C:/downloaded/python.zip'),
+    extractZip: () => Promise.resolve('C:/extracted/python'),
+    extractTar() {
+        throw new Error('This should never be called');
+    },
+});
+
+taskRunner.registerMock('os', {
+    platform() {
+        return 'win32';
+    },
+    arch() {
+        return 'x64';
+    },
+    EOL: '\r\n'
+});
+
+// Can't mock process, so have to mock taskutil instead
+enum Platform {
+    Windows,
+    MacOS,
+    Linux
+}
+
+taskRunner.registerMock('./taskutil', {
+    Platform,
+    getPlatform() {
+        return Platform.Windows;
+    }
+});
+
+const tl = require('azure-pipelines-task-lib/mock-task');
+const tlClone = Object.assign({}, tl);
+tlClone.exec = function(command, args, options) {
+    if (command !== 'powershell' || args !== './setup.ps1') {
+        throw new Error(`Invalid command and arguments: ${command} ${args}`);
+    }
+
+    if (options.cwd !== 'C:/extracted/python') {
+        throw new Error(`Invalid python installer dir path: ${options.cwd}`);
+    }
+
+    pythonWasInstalled = true;
+};
+taskRunner.registerMock('azure-pipelines-task-lib/mock-task', tlClone);
+
+// Test manifest contains stable python 3.10.1, so the task should find it
+taskRunner.registerMock('typed-rest-client', {
+    RestClient: class {
+        get(_url: string) {
+            return Promise.resolve({
+                result: JSON.parse(fs.readFileSync(path.join(__dirname, 'data', 'versions-manifest.json')).toString())
+            });
+        }
+    }
+});
+
+taskRunner.run();