plugin-install.nut.ts

/*
 * Copyright 2025, 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 path from 'node:path';
import fs from 'node:fs';
import os from 'node:os';
import { expect, config } from 'chai';
import { TestSession, execCmd, execInteractiveCmd, Interaction } from '@salesforce/cli-plugins-testkit';
import { Messages } from '@salesforce/core';

Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
const messages = Messages.loadMessages('@salesforce/plugin-trust', 'verify');

config.truncateThreshold = 0;

describe('plugins:install commands', () => {
  const SIGNED_MODULE_NAME = '@salesforce/plugin-user';
  const UNSIGNED_MODULE_NAME = '@mshanemc/plugin-streaming';
  const UNSIGNED_MODULE_NAME2 = '@mshanemc/sfdx-sosl';
  let session: TestSession;
  let configDir: string;

  before(async () => {
    session = await TestSession.create({ devhubAuthStrategy: 'NONE' });
    await fs.promises.mkdir(path.join(session.homeDir, '.sf'), { recursive: true });

    const fileData: string = JSON.stringify({ acknowledged: true }, null, 2);
    await fs.promises.writeFile(path.join(session.homeDir, '.sf', 'acknowledgedUsageCollection.json'), fileData);

    configDir = path.join(session.homeDir, '.config', 'sf');
    await fs.promises.mkdir(configDir, { recursive: true });

    const unsignedMod: string = JSON.stringify([UNSIGNED_MODULE_NAME2], null, 2);
    await fs.promises.writeFile(path.join(configDir, 'unsignedPluginAllowList.json'), unsignedMod);

    // ensure that this repo's version of the plugin is used and NOT the one that shipped with the CLI
    execCmd('plugins:link .', {
      cwd: path.dirname(session.dir),
      ensureExitCode: 0,
      cli: 'sf',
    });
  });

  after(async () => {
    await session?.zip(undefined, 'artifacts');
    try {
      await session?.clean();
    } catch (error) {
      // ignore
    }
  });

  it('plugins:install signed plugin', () => {
    const result = execCmd(`plugins:install ${SIGNED_MODULE_NAME}`, {
      ensureExitCode: 0,
      cli: 'sf',
    });
    expect(result.shellOutput.stdout).to.contain(messages.getMessage('SignatureCheckSuccess', [SIGNED_MODULE_NAME]));
  });

  it('plugins:install prompts on unsigned plugin (denies)', async () => {
    const result = await execInteractiveCmd(
      `plugins:install ${UNSIGNED_MODULE_NAME}`,
      { 'continue the installation': Interaction.No },
      {
        ensureExitCode: 'nonZero',
        cli: 'sf',
      }
    );

    expect(replaceAllWhitespace(result.stdout)).to.contain(
      replaceAllWhitespace(messages.getMessage('InstallConfirmation', [UNSIGNED_MODULE_NAME]))
    );
    expect(result.stdout).to.contain('Do you want to continue the installation?');
    expect(result.stderr).to.contain('The user canceled the plugin installation');
  });

  it('plugins:install prompts on unsigned plugin (accepts)', async () => {
    const result = await execInteractiveCmd(
      `plugins:install ${UNSIGNED_MODULE_NAME}`,
      { 'continue the installation': Interaction.Yes },
      {
        ensureExitCode: 0,
        cli: 'sf',
      }
    );
    expect(replaceAllWhitespace(result.stdout)).to.contain(
      replaceAllWhitespace(messages.getMessage('InstallConfirmation', [UNSIGNED_MODULE_NAME]))
    );
    expect(result.stdout).to.contain('Do you want to continue the installation?');
    expect(result.stdout).to.contain('Finished digital signature check');
  });

  // yes, macos.  oclif sometimes uses XDG, which also exists on gha's ubuntu and windows runners, but isn't handled by testkit
  // see https://salesforce-internal.slack.com/archives/G02K6C90RBJ/p1669664263661369
  (os.platform() === 'darwin' ? it : it.skip)('plugins:install unsigned plugin in the allow list', () => {
    expect(fs.existsSync(configDir)).to.be.true;
    expect(fs.existsSync(path.join(configDir, 'unsignedPluginAllowList.json'))).to.be.true;
    const result = execCmd(`plugins:install ${UNSIGNED_MODULE_NAME2}`, {
      ensureExitCode: 0,
      cli: 'sf',
    });
    expect(result.shellOutput.stdout).to.contain(messages.getMessage('SkipSignatureCheck', [UNSIGNED_MODULE_NAME2]));
  });
});

const replaceAllWhitespace = (str: string): string => str.replaceAll('\n', '').replaceAll(' ', '');