test/embedding/embedding_test.dart

// Copyright (c) 2020, the Dart project authors.  Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

// @dart=2.10

import 'dart:io';

import 'package:path/path.dart' as path;
import 'package:test/test.dart';
import 'package:test_process/test_process.dart';
import '../descriptor.dart' as d;
import '../golden_file.dart';
import '../test_pub.dart';

const _command_runner = 'tool/test-bin/pub_command_runner.dart';

String snapshot;

/// Runs `dart tool/test-bin/pub_command_runner.dart [args]` and appends the output to [buffer].
Future<void> runEmbedding(List<String> args, StringBuffer buffer,
    {String workingDirextory,
    Map<String, String> environment,
    dynamic exitCode = 0}) async {
  final process = await TestProcess.start(
    Platform.resolvedExecutable,
    [snapshot, ...args],
    environment: environment,
    workingDirectory: workingDirextory,
  );
  await process.shouldExit(exitCode);

  buffer.writeln([
    '\$ $_command_runner ${args.join(' ')}',
    ...await process.stdout.rest.toList(),
  ].join('\n'));
  final stdErr = await process.stderr.rest.toList();
  if (stdErr.isNotEmpty) {
    buffer.writeln(stdErr.map((e) => '[E] $e').join('\n'));
  }
  buffer.write('\n');
}

Future<void> main() async {
  setUpAll(() async {
    final tempDir = Directory.systemTemp.createTempSync();
    snapshot = path.join(tempDir.path, 'command_runner.dart.snapshot');
    final r = Process.runSync(
        Platform.resolvedExecutable, ['--snapshot=$snapshot', _command_runner]);
    expect(r.exitCode, 0, reason: r.stderr);
  });

  tearDownAll(() {
    File(snapshot).parent.deleteSync(recursive: true);
  });
  test('help text', () async {
    final buffer = StringBuffer();
    await runEmbedding([''], buffer, exitCode: 64);
    await runEmbedding(['--help'], buffer);
    await runEmbedding(['pub'], buffer, exitCode: 64);
    await runEmbedding(['pub', '--help'], buffer);
    await runEmbedding(['pub', 'get', '--help'], buffer);
    await runEmbedding(['pub', 'global'], buffer, exitCode: 64);
    expectMatchesGoldenFile(
        buffer.toString(), 'test/embedding/goldens/helptext.txt');
  });

  test('run works, though hidden', () async {
    final buffer = StringBuffer();
    await d.dir(appPath, [
      d.pubspec({
        'name': 'myapp',
        'environment': {
          'sdk': '>=2.0.0 <3.0.0',
        },
      }),
      d.dir('bin', [
        d.file('main.dart', '''
import 'dart:io';
main() { 
  print("Hi");
  exit(123);
}
''')
      ]),
    ]).create();
    await runEmbedding(
      ['pub', 'get'],
      buffer,
      workingDirextory: d.path(appPath),
    );
    await runEmbedding(
      ['pub', 'run', 'bin/main.dart'],
      buffer,
      exitCode: 123,
      workingDirextory: d.path(appPath),
    );
    expectMatchesGoldenFile(
      buffer.toString(),
      'test/embedding/goldens/run.txt',
    );
  });
}