script/tool/test/test_dart_fixes_command_test.dart

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

import 'package:args/command_runner.dart';
import 'package:file/file.dart';
import 'package:flutter_plugin_tools/src/common/core.dart';
import 'package:flutter_plugin_tools/src/test_dart_fixes_command.dart';
import 'package:git/git.dart';
import 'package:platform/platform.dart';
import 'package:test/test.dart';

import 'mocks.dart';
import 'util.dart';

void main() {
  group('TestDartFixesCommand', () {
    late NativePlatform mockPlatform;
    late Directory packagesDir;
    late CommandRunner<void> runner;
    late RecordingProcessRunner processRunner;
    late TestDartFixesCommand command;

    setUp(() {
      mockPlatform = createMockPlatform();
      final GitDir gitDir;
      (:packagesDir, :processRunner, gitProcessRunner: _, :gitDir) = configureBaseCommandMocks(
        platform: mockPlatform,
      );
      command = TestDartFixesCommand(
        packagesDir,
        processRunner: processRunner,
        platform: mockPlatform,
        gitDir: gitDir,
      );

      runner = CommandRunner<void>('test_dart_fixes', 'Test for $TestDartFixesCommand');
      runner.addCommand(command);
    });

    test('runs on each package with a test_fixes directory', () async {
      final RepositoryPackage package1 = createFakePackage(
        'package1',
        packagesDir,
        examples: <String>[],
        extraFiles: <String>['test_fixes/empty.dart', 'test_fixes/empty.dart.expect'],
      );
      final RepositoryPackage package2 = createFakePackage(
        'package2',
        packagesDir,
        examples: <String>[],
        extraFiles: <String>['test_fixes/empty.dart', 'test_fixes/empty.dart.expect'],
      );
      createFakePackage('package3', packagesDir, examples: <String>[]);

      final List<String> output = await runCapturingPrint(runner, <String>['test-dart-fixes']);

      expect(
        output,
        containsAllInOrder(<Matcher>[
          contains('Running for package1'),
          contains('Running for package2'),
          contains('Running for package3'),
          contains('SKIPPING: No test_fixes directory.'),
        ]),
      );

      expect(
        processRunner.recordedCalls,
        orderedEquals(<ProcessCall>[
          ProcessCall(getFlutterCommand(mockPlatform), const <String>[
            'pub',
            'get',
          ], command.testDirectories[package1.displayName]!.path),
          ProcessCall('dart', const <String>[
            'fix',
            '--compare-to-golden',
          ], command.testDirectories[package1.displayName]!.path),
          ProcessCall(getFlutterCommand(mockPlatform), const <String>[
            'pub',
            'get',
          ], command.testDirectories[package2.displayName]!.path),
          ProcessCall('dart', const <String>[
            'fix',
            '--compare-to-golden',
          ], command.testDirectories[package2.displayName]!.path),
        ]),
      );
    });

    test('fails when dart fix test fails', () async {
      createFakePackage(
        'package1',
        packagesDir,
        examples: <String>[],
        extraFiles: <String>['test_fixes/fix.dart', 'test_fixes/fix.dart.expect'],
      );

      processRunner.mockProcessesForExecutable['dart'] = <FakeProcessInfo>[
        FakeProcessInfo(MockProcess(exitCode: 1), const <String>['fix', '--compare-to-golden']),
      ];

      Error? commandError;
      final List<String> output = await runCapturingPrint(
        runner,
        <String>['test-dart-fixes'],
        errorHandler: (e) {
          commandError = e;
        },
      );

      expect(commandError, isA<ToolExit>());
      expect(
        output,
        containsAllInOrder(<Matcher>[
          contains('The following packages had errors:'),
          contains('  package1'),
        ]),
      );
    });
  });
}