tools/engine_tool/test/query_command_test.dart

// Copyright 2013 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:convert' as convert;

import 'package:engine_build_configs/engine_build_configs.dart';
import 'package:engine_tool/src/commands/command_runner.dart';
import 'package:engine_tool/src/environment.dart';
import 'package:litetest/litetest.dart';
import 'package:logging/logging.dart' as log;
import 'package:platform/platform.dart';

import 'fixtures.dart' as fixtures;
import 'utils.dart';

void main() {
  final BuilderConfig linuxTestConfig = BuilderConfig.fromJson(
    path: 'ci/builders/linux_test_config.json',
    map: convert.jsonDecode(fixtures.testConfig('Linux', Platform.linux))
        as Map<String, Object?>,
  );

  final BuilderConfig macTestConfig = BuilderConfig.fromJson(
    path: 'ci/builders/mac_test_config.json',
    map: convert.jsonDecode(fixtures.testConfig('Mac-12', Platform.macOS))
        as Map<String, Object?>,
  );

  final BuilderConfig winTestConfig = BuilderConfig.fromJson(
    path: 'ci/builders/win_test_config.json',
    map: convert.jsonDecode(fixtures.testConfig('Windows-11', Platform.windows))
        as Map<String, Object?>,
  );

  final Map<String, BuilderConfig> configs = <String, BuilderConfig>{
    'linux_test_config': linuxTestConfig,
    'linux_test_config2': linuxTestConfig,
    'mac_test_config': macTestConfig,
    'win_test_config': winTestConfig,
  };

  List<String> stringsFromLogs(List<log.LogRecord> logs) {
    return logs.map((log.LogRecord r) => r.message).toList();
  }

  final List<CannedProcess> cannedProcesses = <CannedProcess>[
    CannedProcess((List<String> command) => command.contains('desc'),
        stdout: fixtures.gnDescOutput()),
  ];

  test('query command returns builds for the host platform.', () async {
    final TestEnvironment testEnvironment = TestEnvironment.withTestEngine(
      cannedProcesses: cannedProcesses,
    );
    try {
      final Environment env = testEnvironment.environment;
      final ToolCommandRunner runner = ToolCommandRunner(
        environment: env,
        configs: configs,
      );
      final int result = await runner.run(<String>[
        'query',
        'builders',
      ]);
      expect(result, equals(0));
      expect(
        stringsFromLogs(testEnvironment.testLogs),
        equals(<String>[
          'Add --verbose to see detailed information about each builder\n',
          '\n',
          '"linux_test_config" builder:\n',
          '   "ci/build_name" config\n',
          '   "linux/host_debug" config\n',
          '   "linux/android_debug_arm64" config\n',
          '   "ci/android_debug_rbe_arm64" config\n',
          '"linux_test_config2" builder:\n',
          '   "ci/build_name" config\n',
          '   "linux/host_debug" config\n',
          '   "linux/android_debug_arm64" config\n',
          '   "ci/android_debug_rbe_arm64" config\n',
        ]),
      );
    } finally {
      testEnvironment.cleanup();
    }
  });

  test('query command with --builder returns only from the named builder.',
      () async {
    final TestEnvironment testEnvironment = TestEnvironment.withTestEngine(
      cannedProcesses: cannedProcesses,
    );
    try {
      final Environment env = testEnvironment.environment;
      final ToolCommandRunner runner = ToolCommandRunner(
        environment: env,
        configs: configs,
      );
      final int result = await runner.run(<String>[
        'query',
        'builders',
        '--builder',
        'linux_test_config',
      ]);
      expect(result, equals(0));
      expect(
          stringsFromLogs(testEnvironment.testLogs),
          equals(<String>[
            'Add --verbose to see detailed information about each builder\n',
            '\n',
            '"linux_test_config" builder:\n',
            '   "ci/build_name" config\n',
            '   "linux/host_debug" config\n',
            '   "linux/android_debug_arm64" config\n',
            '   "ci/android_debug_rbe_arm64" config\n',
          ]));
    } finally {
      testEnvironment.cleanup();
    }
  });

  test('query command with --all returns all builds.', () async {
    final TestEnvironment testEnvironment = TestEnvironment.withTestEngine(
      cannedProcesses: cannedProcesses,
    );
    try {
      final Environment env = testEnvironment.environment;
      final ToolCommandRunner runner = ToolCommandRunner(
        environment: env,
        configs: configs,
      );
      final int result = await runner.run(<String>[
        'query',
        'builders',
        '--all',
      ]);
      expect(result, equals(0));
      expect(
        testEnvironment.testLogs.length,
        equals(30),
      );
    } finally {
      testEnvironment.cleanup();
    }
  });

  test('query targets', () async {
    final TestEnvironment testEnvironment = TestEnvironment.withTestEngine(
      cannedProcesses: cannedProcesses,
    );
    try {
      final Environment env = testEnvironment.environment;
      final ToolCommandRunner runner = ToolCommandRunner(
        environment: env,
        configs: configs,
      );
      final int result = await runner.run(<String>[
        'query',
        'targets',
      ]);
      expect(result, equals(0));

      final List<String> expected = <String>[
        '//flutter/display_list:display_list_unittests',
        '//flutter/flow:flow_unittest',
        '//flutter/fml:fml_arc_unittests',
      ];

      final List<String> testLogs = stringsFromLogs(testEnvironment.testLogs);
      for (final String testLog in testLogs) {
        // Expect one of the expected targets to be in the output.
        // Then remove it from the list of expected targets.
        for (final String target in expected) {
          if (testLog.contains(target)) {
            expected.remove(target);
            break;
          }
        }
      }

      expect(
        expected.isEmpty,
        isTrue,
        reason: 'All expected targets were found',
      );
    } finally {
      testEnvironment.cleanup();
    }
  });
}