SymphonyElectron/spec/c9ShellHandler.spec.ts

describe('C9 shell handler', () => {
  const webContentsMocked = {
    send: jest.fn(),
    session: {
      resolveProxy: jest.fn(),
    },
    getURL: jest.fn(),
  };
  const mockSpawnEvents = new Map<String, any>();
  const mockSpawn = jest.fn();
  const mockGetCommandLineArgs = jest.fn();
  const mockGetGuid = jest.fn();
  const mockKill = jest.fn();
  let mockIsWindows: boolean;

  jest.mock('child_process', () => {
    return {
      spawn: mockSpawn,
      ChildProcess: () => {},
    };
  });

  jest.mock('../src/common/utils', () => {
    return {
      getCommandLineArgs: mockGetCommandLineArgs,
      getGuid: mockGetGuid,
    };
  });

  jest.mock('../src/common/env', () => {
    return {
      isDevEnv: false,
      isElectronQA: true,
      isMac: false,
      isWindowsOS: mockIsWindows,
      isLinux: false,
    };
  });

  beforeEach(() => {
    jest.clearAllMocks().resetModules().resetAllMocks();
    mockSpawnEvents.clear();
    mockSpawn.mockImplementation((_cmd, _args) => {
      return {
        on: (event, callback) => {
          mockSpawnEvents.set(event, callback);
        },
        stdout: { on: jest.fn() },
        stderr: { on: jest.fn() },
        kill: mockKill,
      };
    });
    webContentsMocked.session.resolveProxy = jest
      .fn()
      .mockImplementation(() => Promise.resolve(''));
    mockIsWindows = true;
  });

  describe('launch', () => {
    it('success', async () => {
      const { loadC9Shell } = require('../src/app/c9-shell-handler');
      await loadC9Shell(webContentsMocked as any);
      expect(webContentsMocked.send).lastCalledWith('c9-status-event', {
        status: { status: 'starting' },
      });

      mockSpawnEvents.get('spawn')();
      expect(webContentsMocked.send).lastCalledWith('c9-status-event', {
        status: expect.objectContaining({ status: 'active' }),
      });
    });

    it('failure', async () => {
      const { loadC9Shell } = require('../src/app/c9-shell-handler');
      await loadC9Shell(webContentsMocked as any);
      expect(webContentsMocked.send).lastCalledWith('c9-status-event', {
        status: { status: 'starting' },
      });

      mockSpawnEvents.get('close')(1);
      expect(webContentsMocked.send).lastCalledWith('c9-status-event', {
        status: expect.objectContaining({ status: 'inactive' }),
      });
    });

    it('with attach', async () => {
      mockGetCommandLineArgs.mockReturnValue('--c9pipe=custompipe');

      const { loadC9Shell } = require('../src/app/c9-shell-handler');
      await loadC9Shell(webContentsMocked as any);
      expect(webContentsMocked.send).lastCalledWith('c9-status-event', {
        status: { status: 'active', pipeName: 'symphony-c9-custompipe' },
      });
    });

    it('cached status on relaunch', async () => {
      const { loadC9Shell } = require('../src/app/c9-shell-handler');
      await loadC9Shell(webContentsMocked as any);
      expect(webContentsMocked.send).lastCalledWith('c9-status-event', {
        status: { status: 'starting' },
      });

      mockSpawnEvents.get('spawn')();
      expect(webContentsMocked.send).lastCalledWith('c9-status-event', {
        status: expect.objectContaining({ status: 'active' }),
      });

      loadC9Shell(webContentsMocked as any);
      expect(webContentsMocked.send).lastCalledWith('c9-status-event', {
        status: expect.objectContaining({ status: 'active' }),
      });
    });

    it('args', async () => {
      mockGetCommandLineArgs.mockImplementation((_, name) =>
        name === '--proxy-server=' ? '--proxy-server=512' : null,
      );
      webContentsMocked.session.resolveProxy = jest
        .fn()
        .mockImplementation(() => Promise.resolve(''));
      mockGetGuid.mockReturnValue('just-another-guid');
      const { loadC9Shell } = require('../src/app/c9-shell-handler');

      await loadC9Shell(webContentsMocked as any);

      expect(mockSpawn).toBeCalledWith(
        expect.stringContaining('c9shell.exe'),
        ['--symphonyHost', 'just-another-guid', '--proxyServer', ''],
        { stdio: 'pipe' },
      );
    });

    it('args, when resolveProxy returns DIRECT', async () => {
      mockGetCommandLineArgs.mockImplementation((_, name) =>
        name === '--proxy-server=' ? '--proxy-server=512' : null,
      );
      webContentsMocked.session.resolveProxy = jest
        .fn()
        .mockImplementation(() => Promise.resolve('DIRECT'));
      mockGetGuid.mockReturnValue('just-another-guid');
      const { loadC9Shell } = require('../src/app/c9-shell-handler');

      await loadC9Shell(webContentsMocked as any);

      expect(mockSpawn).toBeCalledWith(
        expect.stringContaining('c9shell.exe'),
        ['--symphonyHost', 'just-another-guid', '--proxyServer', 'DIRECT'],
        { stdio: 'pipe' },
      );
    });

    it('args, when resolveProxy returns string starting with PROXY ', async () => {
      mockGetCommandLineArgs.mockImplementation((_, name) =>
        name === '--proxy-server=' ? '--proxy-server=512' : null,
      );
      webContentsMocked.session.resolveProxy = jest
        .fn()
        .mockImplementation(() => Promise.resolve('PROXY 52.207.140.132:8443'));
      mockGetGuid.mockReturnValue('just-another-guid');
      const { loadC9Shell } = require('../src/app/c9-shell-handler');

      await loadC9Shell(webContentsMocked as any);

      expect(mockSpawn).toBeCalledWith(
        expect.stringContaining('c9shell.exe'),
        [
          '--symphonyHost',
          'just-another-guid',
          '--proxyServer',
          '52.207.140.132:8443',
        ],
        { stdio: 'pipe' },
      );
    });

    it('args, when --proxy-server= is not passed as argument, do not pass resolved proxy to cloud9', async () => {
      mockGetCommandLineArgs.mockReturnValue('');
      webContentsMocked.session.resolveProxy = jest
        .fn()
        .mockImplementation(() => Promise.resolve('DIRECT'));
      mockGetGuid.mockReturnValue('just-another-guid');
      const { loadC9Shell } = require('../src/app/c9-shell-handler');

      await loadC9Shell(webContentsMocked as any);

      expect(mockSpawn).toBeCalledWith(
        expect.stringContaining('c9shell.exe'),
        ['--symphonyHost', 'just-another-guid'],
        { stdio: 'pipe' },
      );
    });

    it('args, when --proxy-pac-url= is not passed as argument, do not pass resolved proxy to cloud9', async () => {
      mockGetCommandLineArgs.mockReturnValue('');
      webContentsMocked.session.resolveProxy = jest
        .fn()
        .mockImplementation(() => Promise.resolve('DIRECT'));
      mockGetGuid.mockReturnValue('just-another-guid');
      const { loadC9Shell } = require('../src/app/c9-shell-handler');

      await loadC9Shell(webContentsMocked as any);

      expect(mockSpawn).toBeCalledWith(
        expect.stringContaining('c9shell.exe'),
        ['--symphonyHost', 'just-another-guid'],
        { stdio: 'pipe' },
      );
    });

    it('non-windows', async () => {
      mockIsWindows = false;
      const { loadC9Shell } = require('../src/app/c9-shell-handler');
      await loadC9Shell(webContentsMocked as any);
      expect(mockSpawn).not.toBeCalled();
    });
  });

  describe('terminate', () => {
    it('success', async () => {
      const {
        loadC9Shell,
        terminateC9Shell,
      } = require('../src/app/c9-shell-handler');
      await loadC9Shell(webContentsMocked as any);
      expect(webContentsMocked.send).lastCalledWith('c9-status-event', {
        status: { status: 'starting' },
      });

      terminateC9Shell(webContentsMocked as any);
      expect(mockKill).toBeCalledTimes(1);
    });

    it('no terminate if never started', () => {
      const { terminateC9Shell } = require('../src/app/c9-shell-handler');
      terminateC9Shell(webContentsMocked as any);
      expect(mockKill).toBeCalledTimes(0);
    });

    it('no terminate if already exited', async () => {
      const {
        loadC9Shell,
        terminateC9Shell,
      } = require('../src/app/c9-shell-handler');
      await loadC9Shell(webContentsMocked as any);
      expect(webContentsMocked.send).lastCalledWith('c9-status-event', {
        status: { status: 'starting' },
      });

      mockSpawnEvents.get('close')(1);
      expect(webContentsMocked.send).lastCalledWith('c9-status-event', {
        status: expect.objectContaining({ status: 'inactive' }),
      });

      terminateC9Shell(webContentsMocked as any);
      expect(mockKill).toBeCalledTimes(0);
    });
  });
});