search.test.ts

/*
 * Copyright (c) 2025, Salesforce, Inc.
 * SPDX-License-Identifier: Apache-2
 * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
 */

import {ux} from '@oclif/core';
import {expect} from 'chai';
import {afterEach, beforeEach} from 'mocha';
import sinon from 'sinon';
import DocsSearch from '../../../src/commands/docs/search.js';
import {createIsolatedConfigHooks, createTestCommand, runSilent} from '../../helpers/test-setup.js';

describe('docs search', () => {
  const hooks = createIsolatedConfigHooks();

  beforeEach(hooks.beforeEach);

  afterEach(hooks.afterEach);

  async function createCommand(flags: Record<string, unknown>, args: Record<string, unknown>) {
    return createTestCommand(DocsSearch, hooks.getConfig(), flags, args);
  }

  it('errors when query is missing in search mode', async () => {
    const command: any = await createCommand({}, {});

    const errorStub = sinon.stub(command, 'error').throws(new Error('Expected error'));

    try {
      await command.run();
      expect.fail('Should have thrown');
    } catch {
      // expected
    }

    expect(errorStub.calledOnce).to.equal(true);
  });

  it('lists docs in json mode', async () => {
    const command: any = await createCommand({list: true, json: true}, {});

    const listStub = sinon.stub().returns([{id: 'a', title: 'A', filePath: 'a.md'}]);
    command.operations = {...command.operations, listDocs: listStub};

    const result = await runSilent(() => command.run());

    expect(result.entries).to.have.length(1);
  });

  it('prints no results message when search returns empty in non-json mode', async () => {
    const command: any = await createCommand({limit: 5}, {query: 'x'});

    sinon.stub(command, 'jsonEnabled').returns(false);
    const searchStub = sinon.stub().returns([]);
    command.operations = {...command.operations, searchDocs: searchStub};

    const stdoutStub = sinon.stub(ux, 'stdout');

    const result = await command.run();

    expect(result.results).to.have.length(0);
    expect(stdoutStub.calledOnce).to.equal(true);
  });

  it('returns results in json mode', async () => {
    const command: any = await createCommand({json: true, limit: 5}, {query: 'x'});

    const searchStub = sinon.stub().returns([{entry: {id: 'a', title: 'A', filePath: 'a.md'}, score: 0.1}]);
    command.operations = {...command.operations, searchDocs: searchStub};

    const result = await runSilent(() => command.run());

    expect(result.results).to.have.length(1);
  });
});