queryResolver.test.ts

import 'vscode-test';
import 'mocha';
import * as yaml from 'js-yaml';
import * as chaiAsPromised from 'chai-as-promised';
import * as sinon from 'sinon';
import * as chai from 'chai';
import * as sinonChai from 'sinon-chai';
import * as pq from 'proxyquire';
import { KeyType } from '../../../contextual/keyType';

const proxyquire = pq.noPreserveCache().noCallThru();
chai.use(chaiAsPromised);
chai.use(sinonChai);
const expect = chai.expect;

describe('queryResolver', () => {
  let module: Record<string, Function>;
  let writeFileSpy: sinon.SinonSpy;
  let getQlPackForDbschemeSpy: sinon.SinonStub;
  let getPrimaryDbschemeSpy: sinon.SinonStub;
  let mockCli: Record<string, sinon.SinonStub | Record<string, sinon.SinonStub>>;
  beforeEach(() => {
    mockCli = {
      resolveQueriesInSuite: sinon.stub(),
      cliConstraints: {
        supportsAllowLibraryPacksInResolveQueries: sinon.stub().returns(true),
      }
    };
    module = createModule();
  });

  describe('resolveQueries', () => {
    it('should resolve a query', async () => {
      mockCli.resolveQueriesInSuite.returns(['a', 'b']);
      const result = await module.resolveQueries(mockCli, { dbschemePack: 'my-qlpack' }, KeyType.DefinitionQuery);
      expect(result).to.deep.equal(['a', 'b']);
      expect(writeFileSpy.getCall(0).args[0]).to.match(/.qls$/);
      expect(yaml.safeLoad(writeFileSpy.getCall(0).args[1])).to.deep.equal([{
        from: 'my-qlpack',
        queries: '.',
        include: {
          kind: 'definitions',
          'tags contain': 'ide-contextual-queries/local-definitions'
        }
      }]);
    });

    it('should resolve a query from the queries pack if this is an old CLI', async () => {
      // pretend this is an older CLI
      (mockCli.cliConstraints as any).supportsAllowLibraryPacksInResolveQueries.returns(false);
      mockCli.resolveQueriesInSuite.returns(['a', 'b']);
      const result = await module.resolveQueries(mockCli, { dbschemePackIsLibraryPack: true, dbschemePack: 'my-qlpack', queryPack: 'my-qlpack2' }, KeyType.DefinitionQuery);
      expect(result).to.deep.equal(['a', 'b']);
      expect(writeFileSpy.getCall(0).args[0]).to.match(/.qls$/);
      expect(yaml.safeLoad(writeFileSpy.getCall(0).args[1])).to.deep.equal([{
        from: 'my-qlpack2',
        queries: '.',
        include: {
          kind: 'definitions',
          'tags contain': 'ide-contextual-queries/local-definitions'
        }
      }]);
    });

    it('should throw an error when there are no queries found', async () => {
      mockCli.resolveQueriesInSuite.returns([]);

      // TODO: Figure out why chai-as-promised isn't failing the test on an
      // unhandled rejection.
      try {
        await module.resolveQueries(mockCli, { dbschemePack: 'my-qlpack' }, KeyType.DefinitionQuery);
        // should reject
        expect(true).to.be.false;
      } catch (e) {
        expect(e.message).to.eq(
          'Couldn\'t find any queries tagged ide-contextual-queries/local-definitions in any of the following packs: my-qlpack.'
        );
      }
    });
  });

  describe('qlpackOfDatabase', () => {
    it('should get the qlpack of a database', async () => {
      getQlPackForDbschemeSpy.resolves('my-qlpack');
      const db = {
        contents: {
          datasetUri: {
            fsPath: '/path/to/database'
          }
        }
      };
      const result = await module.qlpackOfDatabase(mockCli, db);
      expect(result).to.eq('my-qlpack');
      expect(getPrimaryDbschemeSpy).to.have.been.calledWith('/path/to/database');
    });
  });

  function createModule() {
    writeFileSpy = sinon.spy();
    getQlPackForDbschemeSpy = sinon.stub();
    getPrimaryDbschemeSpy = sinon.stub();
    return proxyquire('../../../contextual/queryResolver', {
      'fs-extra': {
        writeFile: writeFileSpy
      },

      '../helpers': {
        getQlPackForDbscheme: getQlPackForDbschemeSpy,
        getPrimaryDbscheme: getPrimaryDbschemeSpy,
        getOnDiskWorkspaceFolders: () => ({}),
        showAndLogErrorMessage: () => ({})
      }
    });
  }
});