/* * Copyright 2026, Salesforce, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import childProcess from 'node:child_process'; import Sinon from 'sinon'; import { expect } from 'chai'; import { fromStub, spyMethod, stubInterface, stubMethod } from '@salesforce/ts-sinon'; import which from 'which'; import { Config, Interfaces } from '@oclif/core'; import { Lifecycle } from '@salesforce/core'; import { ux } from '@oclif/core'; import { Connection } from '@jsforce/jsforce-node'; import { Doctor } from '../src/doctor.js'; import { Diagnostics } from '../src/diagnostics.js'; let oclifConfig: Config; const getVersionDetailStub = (overrides?: Partial): Interfaces.VersionDetails => { const defaults: Interfaces.VersionDetails = { cliVersion: 'sfdx-cli/7.160.0', architecture: 'darwin-x64', nodeVersion: 'node-v16.17.0', osVersion: 'Darwin 21.6.0', shell: 'zsh', rootPath: '/Users/foo/testdir', pluginVersions: { org: { version: '2.2.0', type: 'core', root: 'foo', }, source: { version: '2.0.13', type: 'core', root: 'bar', }, 'salesforce-alm': { version: '54.8.1', type: 'core', root: 'baz', }, }, }; return { ...defaults, ...overrides }; }; describe('Diagnostics', () => { const sandbox = Sinon.createSandbox(); const lifecycle = Lifecycle.getInstance(); let childProcessExecFileStub: sinon.SinonStub; let drAddSuggestionSpy: sinon.SinonSpy; let lifecycleEmitSpy: sinon.SinonSpy; beforeEach(() => { stubMethod(sandbox, ux, 'stdout'); sandbox.stub(which, 'sync').returns('/usr/local/bin/npm'); childProcessExecFileStub = sandbox.stub(childProcess, 'execFile'); drAddSuggestionSpy = spyMethod(sandbox, Doctor.prototype, 'addSuggestion'); lifecycleEmitSpy = spyMethod(sandbox, lifecycle, 'emit'); oclifConfig = { name: 'sfdx-cli', version: '7.160.0', pjson: { engines: { node: 'node-v16.17.0', }, }, plugins: [{ name: '@salesforce/plugin-org' }, { name: '@salesforce/plugin-source' }, { name: 'salesforce-alm' }], getPluginsList: () => oclifConfig.plugins, versionDetails: {}, } as unknown as Config; }); afterEach(() => { sandbox.restore(); // Reset the instance for testing // eslint-disable-next-line @typescript-eslint/ban-ts-comment // @ts-ignore delete Doctor.instance; }); it('run() executes all methods ending in "Check"', () => { const dr = Doctor.init(oclifConfig); const diagnostics = new Diagnostics(dr, oclifConfig); const results = diagnostics.run(); // This will have to be updated with each new test expect(results.length).to.equal(6); expect(childProcessExecFileStub.called).to.be.true; expect(lifecycleEmitSpy.called).to.be.true; expect(lifecycleEmitSpy.args[0][0]).to.equal('Doctor:diagnostic'); expect(lifecycleEmitSpy.args[0][1]).to.have.property('testName'); expect(lifecycleEmitSpy.args[0][1]).to.have.property('status'); }); describe('proxyEnvVarsCheck', () => { const httpProxy = 'http://test.dr.diagnostics'; const httpsProxy = 'https://test.dr.diagnostics'; const noProxy = 'point.break'; it('passes with no proxy env vars', async () => { const dr = Doctor.init(oclifConfig); stubMethod(sandbox, dr, 'getDiagnosis').returns({ proxyEnvVars: [], }); const diagnostics = new Diagnostics(dr, oclifConfig); await diagnostics.proxyEnvVarsCheck(); expect(lifecycleEmitSpy.callCount, 'Expected no "Doctor:diagnostic" event fired').to.equal(0); expect(drAddSuggestionSpy.called, 'Expected no suggestions to be added').to.be.false; }); it('passes with matching proxy env vars', async () => { const dr = Doctor.init(oclifConfig); stubMethod(sandbox, dr, 'getDiagnosis').returns({ proxyEnvVars: [ ['http_proxy', httpProxy], ['https_proxy', httpsProxy], ['no_proxy', noProxy], ['HTTP_PROXY', httpProxy], ['HTTPS_PROXY', httpsProxy], ['NO_PROXY', noProxy], ], }); const diagnostics = new Diagnostics(dr, oclifConfig); await diagnostics.proxyEnvVarsCheck(); expect(lifecycleEmitSpy.callCount, 'Expected "Doctor:diagnostic" event fired 4 times').to.equal(4); expect(drAddSuggestionSpy.callCount, 'Expected suggestion to be added for no_proxy').to.equal(1); }); it('passes with proxy env vars in only lowercase', async () => { const dr = Doctor.init(oclifConfig); stubMethod(sandbox, dr, 'getDiagnosis').returns({ proxyEnvVars: [ ['http_proxy', httpProxy], ['https_proxy', httpsProxy], ['no_proxy', noProxy], ], }); const diagnostics = new Diagnostics(dr, oclifConfig); await diagnostics.proxyEnvVarsCheck(); expect(lifecycleEmitSpy.callCount, 'Expected "Doctor:diagnostic" event fired 4 times').to.equal(4); expect(drAddSuggestionSpy.callCount, 'Expected suggestion to be added for no_proxy').to.equal(1); }); it('fails with non-matching proxy env vars', async () => { const dr = Doctor.init(oclifConfig); stubMethod(sandbox, dr, 'getDiagnosis').returns({ proxyEnvVars: [ ['http_proxy', httpProxy], ['https_proxy', httpsProxy], ['no_proxy', noProxy], ['HTTP_PROXY', 'http://test.foo.diagnostics'], ['HTTPS_PROXY', 'https://test.bar.diagnostics'], ['NO_PROXY', 'something'], ], }); const diagnostics = new Diagnostics(dr, oclifConfig); await diagnostics.proxyEnvVarsCheck(); expect(lifecycleEmitSpy.callCount, 'Expected "Doctor:diagnostic" event fired 4 times').to.equal(4); expect(drAddSuggestionSpy.callCount, 'Expected 4 suggestions to be added').to.equal(4); }); }); describe('networkCheck', () => { it('passes when all URLs can be reached', async () => { stubMethod(sandbox, Connection.prototype, 'request').resolves('{}'); const dr = Doctor.init(oclifConfig); const diagnostics = new Diagnostics(dr, oclifConfig); await diagnostics.networkCheck(); expect(drAddSuggestionSpy.called).to.be.false; expect(lifecycleEmitSpy.called).to.be.true; expect(lifecycleEmitSpy.args[0][1]).to.deep.equal({ status: 'pass', testName: 'can access: https://test.salesforce.com', }); }); it('fails when one URL cannot be reached', async () => { stubMethod(sandbox, Connection.prototype, 'request').rejects( '{"error":"unsupported_grant_type","error_description":"grant type not supported"}' ); const dr = Doctor.init(oclifConfig); const diagnostics = new Diagnostics(dr, oclifConfig); await diagnostics.networkCheck(); expect(drAddSuggestionSpy.called).to.be.true; expect(lifecycleEmitSpy.called).to.be.true; expect(lifecycleEmitSpy.args[0][1]).to.deep.equal({ status: 'fail', testName: "can't access: https://test.salesforce.com", }); }); it('fails when one URL cannot be reached and others can be', async () => { stubMethod(sandbox, Connection.prototype, 'request') .onFirstCall() .resolves('{}') .rejects('{"error":"unsupported_grant_type","error_description":"grant type not supported"}'); const dr = Doctor.init(oclifConfig); const diagnostics = new Diagnostics(dr, oclifConfig); await diagnostics.networkCheck(); expect(drAddSuggestionSpy.called).to.be.true; expect(lifecycleEmitSpy.called).to.be.true; expect(lifecycleEmitSpy.args[0][1]).to.deep.equal({ status: 'pass', testName: 'can access: https://test.salesforce.com', }); expect(lifecycleEmitSpy.args[1][1]).to.deep.equal({ status: 'fail', testName: "can't access: https://appexchange.salesforce.com/services/data", }); }); }); describe('outdatedCliVersionCheck', () => { it('passes when CLI version is equal to latest', async () => { childProcessExecFileStub.callsFake( (cmd: string, args: string[], opts: unknown, cb: (e: unknown, stdout: unknown, stderr: unknown) => void) => { expect(cmd).to.equal('/usr/local/bin/npm'); expect(args).to.deep.equal(['view', 'sfdx-cli', 'dist-tags.latest']); cb(null, '7.160.0', ''); } ); const dr = Doctor.init(oclifConfig); const diagnostics = new Diagnostics(dr, oclifConfig); await diagnostics.outdatedCliVersionCheck(); expect(drAddSuggestionSpy.called).to.be.false; expect(lifecycleEmitSpy.called).to.be.true; expect(lifecycleEmitSpy.args[0][1]).to.deep.equal({ testName: 'using latest or latest-rc CLI version', status: 'pass', }); }); it('passes when CLI version is greater than latest', async () => { childProcessExecFileStub.callsFake( (cmd: string, args: string[], opts: unknown, cb: (e: unknown, stdout: unknown, stderr: unknown) => void) => { expect(cmd).to.equal('/usr/local/bin/npm'); expect(args).to.deep.equal(['view', 'sfdx-cli', 'dist-tags.latest']); cb(null, '7.159.0', ''); } ); const dr = Doctor.init(oclifConfig); const diagnostics = new Diagnostics(dr, oclifConfig); await diagnostics.outdatedCliVersionCheck(); expect(drAddSuggestionSpy.called).to.be.false; expect(lifecycleEmitSpy.called).to.be.true; expect(lifecycleEmitSpy.args[0][1]).to.deep.equal({ testName: 'using latest or latest-rc CLI version', status: 'pass', }); }); it('fails when CLI version is less than latest', async () => { childProcessExecFileStub.callsFake( (cmd: string, args: string[], opts: unknown, cb: (e: unknown, stdout: unknown, stderr: unknown) => void) => { expect(cmd).to.equal('/usr/local/bin/npm'); expect(args).to.deep.equal(['view', 'sfdx-cli', 'dist-tags.latest']); cb(null, '7.162.0', ''); } ); const dr = Doctor.init(oclifConfig); const diagnostics = new Diagnostics(dr, oclifConfig); await diagnostics.outdatedCliVersionCheck(); expect(drAddSuggestionSpy.called).to.be.true; expect(lifecycleEmitSpy.called).to.be.true; expect(lifecycleEmitSpy.args[0][1]).to.deep.equal({ testName: 'using latest or latest-rc CLI version', status: 'fail', }); }); it('fails when npm request fails', async () => { childProcessExecFileStub.callsFake( (cmd: string, args: string[], opts: unknown, cb: (e: unknown, stdout: unknown, stderr: unknown) => void) => { expect(cmd).to.equal('/usr/local/bin/npm'); expect(args).to.deep.equal(['view', 'sfdx-cli', 'dist-tags.latest']); cb({ code: 1 }, '', 'connection timeout'); } ); const dr = Doctor.init(oclifConfig); const diagnostics = new Diagnostics(dr, oclifConfig); await diagnostics.outdatedCliVersionCheck(); expect(drAddSuggestionSpy.called).to.be.true; expect(lifecycleEmitSpy.called).to.be.true; expect(lifecycleEmitSpy.args[0][1]).to.deep.equal({ testName: 'using latest or latest-rc CLI version', status: 'unknown', }); }); }); describe('salesforceDxPluginCheck', () => { it('passes when salesforcedx plugin not installed', async () => { const dr = Doctor.init(oclifConfig); const diagnostics = new Diagnostics(dr, oclifConfig); await diagnostics.salesforceDxPluginCheck(); expect(drAddSuggestionSpy.called).to.be.false; expect(lifecycleEmitSpy.called).to.be.true; expect(lifecycleEmitSpy.args[0][1]).to.deep.equal({ testName: 'salesforcedx plugin isn’t installed', status: 'pass', }); }); it('fails when salesforcedx plugin is installed', async () => { const versionDetail = getVersionDetailStub(); versionDetail.pluginVersions = {}; versionDetail.pluginVersions['salesforcedx'] = { version: '1.0.0', root: 'path/to/root', type: 'core' }; // @ts-expect-error: stubbing a private property oclifConfig.versionDetails = versionDetail; const dr = Doctor.init(oclifConfig); const diagnostics = new Diagnostics(dr, oclifConfig); await diagnostics.salesforceDxPluginCheck(); expect(drAddSuggestionSpy.called).to.be.true; expect(lifecycleEmitSpy.called).to.be.true; expect(lifecycleEmitSpy.args[0][1]).to.deep.equal({ testName: 'salesforcedx plugin is installed', status: 'fail', }); }); }); describe('deprecatedCliCheck', () => { it('fails when sfdx 7 installed', async () => { const dr = Doctor.init(oclifConfig); const diagnostics = new Diagnostics(dr, oclifConfig); await diagnostics.deprecatedCliCheck(); expect(drAddSuggestionSpy.called).to.be.true; expect(lifecycleEmitSpy.called).to.be.true; expect(lifecycleEmitSpy.args[0][1]).to.deep.equal({ testName: 'using sfdx-cli version 7', status: 'fail', }); }); it('fails when sf 1 installed', async () => { oclifConfig.name = '@salesforce/cli'; oclifConfig.version = '1.0.0'; const dr = Doctor.init(oclifConfig); const diagnostics = new Diagnostics(dr, oclifConfig); await diagnostics.deprecatedCliCheck(); expect(drAddSuggestionSpy.called).to.be.true; expect(lifecycleEmitSpy.called).to.be.true; expect(lifecycleEmitSpy.args[0][1]).to.deep.equal({ testName: 'using @salesforce/cli version 1', status: 'fail', }); }); it('passes when sf 2 is installed', async () => { oclifConfig.name = '@salesforce/cli'; oclifConfig.version = '2.0.0'; const dr = Doctor.init(oclifConfig); const diagnostics = new Diagnostics(dr, oclifConfig); await diagnostics.deprecatedCliCheck(); expect(drAddSuggestionSpy.called).to.be.false; expect(lifecycleEmitSpy.called).to.be.false; }); }); describe('linkedPluginCheck', () => { it('passes when linked plugin not found', async () => { const dr = Doctor.init(oclifConfig); const diagnostics = new Diagnostics(dr, oclifConfig); await diagnostics.linkedPluginCheck(); expect(drAddSuggestionSpy.called).to.be.false; expect(lifecycleEmitSpy.called).to.be.true; expect(lifecycleEmitSpy.args[0][1]).to.deep.equal({ testName: "you don't have any linked plugins", status: 'pass', }); }); it('fails when linked plugin is found', async () => { oclifConfig = fromStub( stubInterface(sandbox, { pjson: { engines: { node: 'node-v16.17.0', }, }, plugins: [ { name: '@salesforce/plugin-org', type: 'core' }, { name: '@salesforce/plugin-source', type: 'link' }, { name: 'salesforce-alm', type: 'core' }, ], getPluginsList: () => [ { name: '@salesforce/plugin-org', type: 'core' }, { name: '@salesforce/plugin-source', type: 'link' }, { name: 'salesforce-alm', type: 'core' }, ], }) ); const dr = Doctor.init(oclifConfig); const diagnostics = new Diagnostics(dr, oclifConfig); await diagnostics.linkedPluginCheck(); expect(drAddSuggestionSpy.called).to.be.true; expect(lifecycleEmitSpy.called).to.be.true; expect(lifecycleEmitSpy.args[0][1]).to.deep.equal({ testName: 'you have at least one linked plugin', status: 'fail', }); }); }); });