winrm-client/tests/e2e/interactive.e2e.test.ts

Make WinRM service calls from NodeJS

import { runInteractivePowershell, runInteractiveCommand } from '../../index';
import { InteractivePromptOutput } from '../../src/types';

const { JEST_WINRM_PASS, JEST_WINRM_USER, JEST_WINRM_HOST } = process.env;

if (!JEST_WINRM_PASS || !JEST_WINRM_USER || !JEST_WINRM_HOST) {
  throw new Error('Missing environment variables');
}
jest.setTimeout(60_000);

describe('interactive commands', () => {
  const executionTimeout = 30000; // 30 second execution timeout for tests

  it('should handle PowerShell prompt for confirmation', async () => {
    const prompts: InteractivePromptOutput[] = [
      {
        pattern: /\[Y\] Yes\s+\[N\] No.*\(default is "Y"\):/i,
        response: 'N',
      },
    ];

    const result = await runInteractivePowershell(
      'Remove-Item -Path "C:\\temp\\nonexistent.txt" -Confirm',
      JEST_WINRM_HOST,
      JEST_WINRM_USER,
      JEST_WINRM_PASS,
      5985,
      prompts,
      executionTimeout
    );

    expect(result).toContain('Cannot find path');
  }, 45000);

  //TODO: skipped because there is no user to test with
  it.skip('should handle password prompts securely', async () => {
    const prompts: InteractivePromptOutput[] = [
      {
        pattern: /Password:/i,
        response: 'SecurePassword123!',
        isSecure: true,
      },
    ];

    const result = await runInteractivePowershell(
      '$cred = Get-Credential -UserName "testuser" -Message "Enter password"; Write-Host "Credential created"',
      JEST_WINRM_HOST,
      JEST_WINRM_USER,
      JEST_WINRM_PASS,
      5985,
      prompts,
      executionTimeout
    );

    expect(result).toContain('Credential created');
  }, 45000);

  it('should handle multiple prompt patterns in sequence', async () => {
    const prompts: InteractivePromptOutput[] = [
      {
        pattern: /Enter your name:/i,
        response: 'TestUser',
      },
      {
        pattern: /Enter your age:/i,
        response: '25',
      },
      {
        pattern: /Confirm \(Y\/N\):/i,
        response: 'N',
      },
    ];

    const command =
      'Write-Host \'Enter your name:\' -NoNewline; $name = Read-Host; Write-Host \'Enter your age:\' -NoNewline; $age = Read-Host; Write-Host \'Confirm (Y/N):\' -NoNewline; $confirm = Read-Host; Write-Host \"Name: \" $name \" Age: \" $age \" Confirmed: \" $confirm\"';

    const result = await runInteractivePowershell(
      command,
      JEST_WINRM_HOST,
      JEST_WINRM_USER,
      JEST_WINRM_PASS,
      5985,
      prompts,
      executionTimeout
    );

    expect(result).toContain('Name: TestUser Age: 25 Confirmed: N');
  }, 45000);

  it('should handle CMD interactive commands', async () => {
    const prompts: InteractivePromptOutput[] = [
      {
        pattern: /Press any key to continue/i,
        response: ' ', // Space character
      },
    ];

    const result = await runInteractiveCommand(
      'echo Press any key to continue && pause',
      JEST_WINRM_HOST,
      JEST_WINRM_USER,
      JEST_WINRM_PASS,
      5985,
      prompts,
      executionTimeout,
      10000
    );

    expect(result).toContain('Press any key to continue');
  }, 45000);

  it('should timeout when no matching prompt is found', async () => {
    const prompts: InteractivePromptOutput[] = [
      {
        pattern: /This pattern will never match/i,
        response: 'response',
      },
    ];

    await expect(
      runInteractivePowershell(
        'Read-Host "Enter something"',
        JEST_WINRM_HOST,
        JEST_WINRM_USER,
        JEST_WINRM_PASS,
        5985,
        prompts,
        5000, // 5 second timeout for quicker test
        6000 // 6 second http timeout for quicker test
      )
    ).rejects.toThrow('timed out');
  }, 10000);

  it('should handle commands that complete without interaction', async () => {
    const prompts: InteractivePromptOutput[] = [
      {
        pattern: /This won't be needed/i,
        response: 'not used',
      },
    ];

    const result = await runInteractivePowershell(
      'Write-Host "Simple command without interaction"',
      JEST_WINRM_HOST,
      JEST_WINRM_USER,
      JEST_WINRM_PASS,
      5985,
      prompts,
      executionTimeout
    );

    expect(result).toContain('Simple command without interaction');
  }, 45000);

  it('should handle custom sync detector', async () => {
    const prompts: InteractivePromptOutput[] = [
      {
        detector: (output: string) => output.toLowerCase().includes('confirm'),
        response: 'N',
      },
    ];

    const result = await runInteractivePowershell(
      'Remove-Item -Path "C:\\temp\\nonexistent.txt" -Confirm',
      JEST_WINRM_HOST,
      JEST_WINRM_USER,
      JEST_WINRM_PASS,
      5985,
      prompts,
      executionTimeout
    );

    expect(result).toContain('Cannot find path');
  }, 45000);

  it('should handle custom async detector', async () => {
    const prompts: InteractivePromptOutput[] = [
      {
        asyncDetector: async (output: string): Promise<string> => {
          // Simulate async processing
          await new Promise((resolve) => setTimeout(resolve, 10));
          return output.toLowerCase().includes('confirm') ? 'N' : '';
        },
      },
    ];

    const result = await runInteractivePowershell(
      'Remove-Item -Path "C:\\temp\\nonexistent.txt" -Confirm',
      JEST_WINRM_HOST,
      JEST_WINRM_USER,
      JEST_WINRM_PASS,
      5985,
      prompts,
      executionTimeout
    );

    expect(result).toContain('Cannot find path');
  }, 45000);

  it('should handle mixed detection methods in one session', async () => {
    const prompts: InteractivePromptOutput[] = [
      {
        pattern: /Enter your name:/i,
        response: 'TestUser',
      },
      {
        detector: (output: string) => output.includes('Enter your age:'),
        response: '25',
      },
      {
        asyncDetector: async (output: string): Promise<string> => {
          await new Promise((resolve) => setTimeout(resolve, 5));
          return output.includes('Confirm') ? 'N' : '';
        },
      },
    ];

    const command =
      'Write-Host \'Enter your name:\' -NoNewline; $name = Read-Host; Write-Host \'Enter your age:\' -NoNewline; $age = Read-Host; Write-Host \'Confirm (Y/N):\' -NoNewline; $confirm = Read-Host; Write-Host \"Name: \" $name \" Age: \" $age \" Confirmed: \" $confirm\"';

    const result = await runInteractivePowershell(
      command,
      JEST_WINRM_HOST,
      JEST_WINRM_USER,
      JEST_WINRM_PASS,
      5985,
      prompts,
      executionTimeout
    );

    expect(result).toContain('Name: TestUser Age: 25 Confirmed: N');
  }, 45000);
});