test/src/process_runner_test.dart

// Copyright 2020 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:io';

import 'package:process_runner/process_runner.dart';
import 'package:process_runner/test/fake_process_manager.dart';
import 'package:test/test.dart';

void main() {
  final stdinCaptured = <String>[];
  void captureStdin(String item) {
    stdinCaptured.add(item);
  }

  var fakeProcessManager = FakeProcessManager(captureStdin);
  var processRunner = ProcessRunner(processManager: fakeProcessManager);
  final testPath = Platform.isWindows ? r'C:\tmp\foo' : '/tmp/foo';

  setUp(() {
    stdinCaptured.clear();
    fakeProcessManager = FakeProcessManager(captureStdin);
    processRunner = ProcessRunner(
        processManager: fakeProcessManager,
        defaultWorkingDirectory: Directory(testPath));
  });

  tearDown(() {});

  group('Output Capture', () {
    test('runProcess works', () async {
      final calls = <FakeInvocationRecord, List<ProcessResult>>{
        FakeInvocationRecord(<String>['command', 'arg1', 'arg2'],
            workingDirectory: testPath): <ProcessResult>[
          ProcessResult(0, 0, 'output1', ''),
        ],
      };
      fakeProcessManager.fakeResults = calls;
      await processRunner.runProcess(calls.keys.first.invocation);
      fakeProcessManager.verifyCalls(calls.keys);
    });
    test('runProcess returns correct output', () async {
      final calls = <FakeInvocationRecord, List<ProcessResult>>{
        FakeInvocationRecord(<String>['command', 'arg1', 'arg2'],
            workingDirectory: testPath): <ProcessResult>[
          ProcessResult(0, 0, 'output1', 'stderr1'),
        ],
      };
      fakeProcessManager.fakeResults = calls;
      final result =
          await processRunner.runProcess(calls.keys.first.invocation);
      fakeProcessManager.verifyCalls(calls.keys);
      expect(result.stdout, equals('output1'));
      expect(result.stderr, equals('stderr1'));
      expect(result.output, equals('output1stderr1'));
    });
    test('runProcess fails properly', () async {
      final calls = <FakeInvocationRecord, List<ProcessResult>>{
        FakeInvocationRecord(<String>['command', 'arg1', 'arg2'],
            workingDirectory: ''): <ProcessResult>[
          ProcessResult(0, -1, 'output1', 'stderr1'),
        ],
      };
      fakeProcessManager.fakeResults = calls;
      await expectLater(
          () => processRunner.runProcess(calls.keys.first.invocation),
          throwsException);
    });
    test('runProcess returns the failed results properly', () async {
      final calls = <FakeInvocationRecord, List<ProcessResult>>{
        FakeInvocationRecord(<String>['command', 'arg1', 'arg2'],
            workingDirectory: testPath): <ProcessResult>[
          ProcessResult(0, -1, 'output1', 'stderr1'),
        ],
      };
      fakeProcessManager.fakeResults = calls;
      final result = await processRunner.runProcess(calls.keys.first.invocation,
          failOk: true);
      expect(result.stdout, equals('output1'));
      expect(result.stderr, equals('stderr1'));
      expect(result.output, equals('output1stderr1'));
    });

    test('runProcess with stdin works', () async {
      final calls = <FakeInvocationRecord, List<ProcessResult>>{
        FakeInvocationRecord(<String>['command', 'arg1', 'arg2'],
            workingDirectory: testPath): <ProcessResult>[
          ProcessResult(0, 0, 'output1', ''),
        ],
      };
      fakeProcessManager.fakeResults = calls;
      final stdin = Stream<List<int>>.fromIterable(<List<int>>[
        'input'.codeUnits,
      ]);
      final result = await processRunner.runProcess(
        calls.keys.first.invocation,
        stdin: stdin,
      );
      expect(result.stdout, equals('output1'));
      expect(stdinCaptured, equals(<String>['input']));
    });

    test('runProcess with runInShell works', () async {
      final calls = <FakeInvocationRecord, List<ProcessResult>>{
        FakeInvocationRecord(
          <String>['command', 'arg1', 'arg2'],
          workingDirectory: testPath,
          runInShell: true,
        ): <ProcessResult>[
          ProcessResult(0, 0, 'output1', ''),
        ],
      };
      fakeProcessManager.fakeResults = calls;
      await processRunner.runProcess(
        calls.keys.first.invocation,
        runInShell: true,
      );
      fakeProcessManager.verifyCalls(calls.keys);
    });

    test('runProcess passes includeParentEnvironment to manager', () async {
      processRunner = ProcessRunner(
        processManager: fakeProcessManager,
        defaultWorkingDirectory: Directory(testPath),
        includeParentEnvironment: false,
      );
      final calls = <FakeInvocationRecord, List<ProcessResult>>{
        FakeInvocationRecord(
          <String>['command', 'arg1', 'arg2'],
          workingDirectory: testPath,
          includeParentEnvironment: false,
        ): <ProcessResult>[
          ProcessResult(0, 0, 'output1', ''),
        ],
      };
      fakeProcessManager.fakeResults = calls;
      await processRunner.runProcess(
        <String>['command', 'arg1', 'arg2'],
      );
      fakeProcessManager.verifyCalls(calls.keys);
    });

    test('runProcess throws when process manager throws', () async {
      fakeProcessManager.commandsThrow = true;
      final calls = <FakeInvocationRecord, List<ProcessResult>>{
        FakeInvocationRecord(<String>['command', 'arg1', 'arg2'],
            workingDirectory: testPath): <ProcessResult>[
          ProcessResult(0, -1, 'output1', 'stderr1'),
        ],
      };
      fakeProcessManager.fakeResults = calls;
      await expectLater(
        () => processRunner.runProcess(calls.keys.first.invocation),
        throwsA(isA<ProcessRunnerException>()),
      );
    });
  });
}