|
| 1 | +// Copyright (c) Microsoft Corporation. All rights reserved. |
| 2 | +// Licensed under the MIT License. |
| 3 | + |
| 4 | +import * as assert from 'assert'; |
| 5 | +import * as sinon from 'sinon'; |
| 6 | +import { LogOutputChannel, Uri } from 'vscode'; |
| 7 | +import { PackageManager, PythonEnvironment, PythonEnvironmentApi } from '../../../api'; |
| 8 | +import * as errorUtils from '../../../common/errors/utils'; |
| 9 | +import * as windowApis from '../../../common/window.apis'; |
| 10 | +import { PipPackageManager } from '../../../managers/builtin/pipPackageManager'; |
| 11 | +import * as pipUtils from '../../../managers/builtin/pipUtils'; |
| 12 | +import * as builtinUtils from '../../../managers/builtin/utils'; |
| 13 | +import { VenvManager } from '../../../managers/builtin/venvManager'; |
| 14 | +import { CondaPackageManager } from '../../../managers/conda/condaPackageManager'; |
| 15 | +import * as condaUtils from '../../../managers/conda/condaUtils'; |
| 16 | +import { PoetryManager } from '../../../managers/poetry/poetryManager'; |
| 17 | +import { PoetryPackageManager } from '../../../managers/poetry/poetryPackageManager'; |
| 18 | +import * as poetryUtils from '../../../managers/poetry/poetryUtils'; |
| 19 | + |
| 20 | +suite('Package manager headless conformance', () => { |
| 21 | + const environment = { |
| 22 | + envId: { id: 'test-environment', managerId: 'test-manager' }, |
| 23 | + environmentPath: Uri.file('/path/to/environment'), |
| 24 | + } as PythonEnvironment; |
| 25 | + |
| 26 | + teardown(() => { |
| 27 | + sinon.restore(); |
| 28 | + }); |
| 29 | + |
| 30 | + function createManagers(): PackageManager[] { |
| 31 | + const api = {} as PythonEnvironmentApi; |
| 32 | + const log = { |
| 33 | + error: sinon.stub(), |
| 34 | + info: sinon.stub(), |
| 35 | + show: sinon.stub(), |
| 36 | + } as unknown as LogOutputChannel; |
| 37 | + return [ |
| 38 | + new PipPackageManager(api, log, { getProjectsByEnvironment: sinon.stub().returns([]) } as unknown as VenvManager), |
| 39 | + new CondaPackageManager(api, log), |
| 40 | + new PoetryPackageManager(api, log, {} as PoetryManager), |
| 41 | + ]; |
| 42 | + } |
| 43 | + |
| 44 | + test('does not invoke interactive package input when no packages are provided', async () => { |
| 45 | + const pipPicker = sinon.stub(pipUtils, 'getWorkspacePackagesToInstall'); |
| 46 | + const condaPicker = sinon.stub(condaUtils, 'getCommonCondaPackagesToInstall'); |
| 47 | + const poetryInput = sinon.stub(windowApis, 'showInputBox'); |
| 48 | + |
| 49 | + for (const manager of createManagers()) { |
| 50 | + await manager.manage(environment, { install: [], runHeadless: true }); |
| 51 | + } |
| 52 | + |
| 53 | + assert.ok(pipPicker.notCalled); |
| 54 | + assert.ok(condaPicker.notCalled); |
| 55 | + assert.ok(poetryInput.notCalled); |
| 56 | + }); |
| 57 | + |
| 58 | + test('rejects failures without showing error notifications', async () => { |
| 59 | + const operationError = new Error('package operation failed'); |
| 60 | + sinon.stub(windowApis, 'withProgress').callsFake(async (_options, task) => task({} as never, {} as never)); |
| 61 | + sinon.stub(builtinUtils, 'managePackages').rejects(operationError); |
| 62 | + sinon.stub(condaUtils, 'managePackages').rejects(operationError); |
| 63 | + sinon.stub(poetryUtils, 'getPoetry').resolves(undefined); |
| 64 | + const showErrorMessage = sinon.stub(windowApis, 'showErrorMessage').resolves(undefined); |
| 65 | + const showErrorMessageWithLogs = sinon.stub(errorUtils, 'showErrorMessageWithLogs').resolves(); |
| 66 | + |
| 67 | + for (const manager of createManagers()) { |
| 68 | + await assert.rejects( |
| 69 | + manager.manage(environment, { install: ['requests'], runHeadless: true }), |
| 70 | + ); |
| 71 | + } |
| 72 | + |
| 73 | + assert.ok(showErrorMessage.notCalled); |
| 74 | + assert.ok(showErrorMessageWithLogs.notCalled); |
| 75 | + }); |
| 76 | +}); |
0 commit comments