dart_script_runner/test/config_test.dart

import 'dart:io';

import 'package:script_runner/script_runner.dart';
import 'package:test/test.dart';
import 'package:file/file.dart';
import 'package:file/memory.dart';
import 'package:path/path.dart' as path;

void main() {
  late FileSystem fs;

  group('ScriptRunnerConfig', () {
    group('pubspec.yaml loader', () {
      setUp(() async {
        fs = MemoryFileSystem();
        await _writePubspec(fs);
      });

      test('works', () async {
        final conf = await ScriptRunnerConfig.get(fs);
        final testScr = conf.scriptsMap['test']!;
        expect(testScr.name, 'test');
        expect(testScr.cmd, 'echo "hello"');
        expect(testScr.args, []);
      });
    });

    group('script_runner.yaml loader', () {
      setUp(() async {
        fs = MemoryFileSystem();
        await _writeCustomConf(fs);
      });

      test('works', () async {
        final conf = await ScriptRunnerConfig.get(fs);
        final testScr = conf.scriptsMap['test']!;
        expect(testScr.name, 'test');
        expect(testScr.cmd, 'echo "hello"');
        expect(testScr.args, []);
      });
    });

    group('search up directories', () {
      setUp(() async {
        fs = MemoryFileSystem();
        await _writePubspec(fs);
        var tmpDir = fs.directory(path.join(fs.currentDirectory.path, 'test'));
        tmpDir.createSync();
        fs.currentDirectory = tmpDir;
      });

      test('works', () async {
        final conf = await ScriptRunnerConfig.get(fs);
        final testScr = conf.scriptsMap['test']!;
        expect(testScr.name, 'test');
        expect(testScr.cmd, 'echo "hello"');
        expect(testScr.args, []);
      });
    });

    group('env injection', () {
      fs = MemoryFileSystem();
      final fooFile = fs.file('/tmp/foo.txt');

      setUp(() async {
        fs = MemoryFileSystem();
        await _writePubspec(
          fs,
          [
            'script_runner:',
            '  shell:',
            '    linux: /bin/zsh',
            '    macos: /bin/bash',
            '    windows: powershell.exe',
            '  scripts:',
            '    - name: test',
            '      cwd: .',
            '      cmd: "echo \\"\$FOO\\" > ${fooFile.path}"',
            '      env:',
            '        FOO: bar',
          ].join('\n'),
        );
      });

      test('works', () async {
        final conf = await ScriptRunnerConfig.get(fs);
        final testScr = conf.scriptsMap['test']!;
        expect(testScr.name, 'test');
        expect(testScr.cmd, 'echo "\$FOO" > ${fooFile.path}');
        expect(testScr.args, []);
        expect(testScr.env, {'FOO': 'bar'});
        // await testScr.run();
        // final contents = await fooFile.readAsString();
        // expect(contents, 'bar\n');
      });
    });
  });

  group('ScriptRunnerShellConfig', () {
    group('no shell', () {
      setUp(() async {
        fs = MemoryFileSystem();
        await _writePubspec(
          fs,
          [
            'script_runner:',
            '  scripts:',
            '    - name: test',
            '      cwd: .',
            '      cmd: echo "hello"',
          ].join('\n'),
        );
      });

      test('works', () async {
        final conf = await ScriptRunnerConfig.get(fs);
        expect(conf.shell.shell, Platform.environment['SHELL']);
      });
    });

    group('plain shell', () {
      setUp(() async {
        fs = MemoryFileSystem();
        await _writePubspec(
          fs,
          [
            'script_runner:',
            '  shell: /bin/zsh',
            '  scripts:',
            '    - name: test',
            '      cwd: .',
            '      cmd: echo "hello"',
          ].join('\n'),
        );
      });

      test('works', () async {
        final conf = await ScriptRunnerConfig.get(fs);
        expect(conf.shell.shell, '/bin/zsh');
      });
    });

    group('per os config', () {
      setUp(() async {
        fs = MemoryFileSystem();
        await _writePubspec(
          fs,
          [
            'script_runner:',
            '  shell:',
            '    linux: /bin/zsh',
            '    macos: /bin/bash',
            '    windows: powershell.exe',
            '  scripts:',
            '    - name: test',
            '      cwd: .',
            '      cmd: echo "hello"',
          ].join('\n'),
        );
      });

      test('works', () async {
        final conf = await ScriptRunnerConfig.get(fs);
        final osShells = {
          'linux': '/bin/zsh',
          'macos': '/bin/bash',
          'windows': 'powershell.exe',
        };
        final myOsShell = Platform.isWindows
            ? 'windows'
            : Platform.isMacOS
                ? 'macos'
                : 'linux';
        expect(conf.shell.windows, osShells['windows']!);
        expect(conf.shell.macos, osShells['macos']!);
        expect(conf.shell.linux, osShells['linux']!);
        expect(conf.shell.shell, osShells[myOsShell]!);
      });
    });
  });
}

Future<void> _writeCustomConf(FileSystem fs, [String? contents]) async {
  final homeDir = fs.directory(Platform.environment['HOME']!);
  homeDir.create(recursive: true);
  fs.currentDirectory = homeDir;
  final pubFile =
      fs.file(path.join(fs.currentDirectory.path, 'script_runner.yaml'));
  pubFile.create(recursive: true);
  print('writing custom conf to ${pubFile.path}');
  await pubFile.writeAsString(
    contents ??
        [
          'shell: /bin/sh',
          'scripts:',
          '  - name: test',
          '    cwd: .',
          '    cmd: echo "hello"',
        ].join('\n'),
  );
}

Future<void> _writePubspec(FileSystem fs, [String? contents]) async {
  final homeDir = fs.directory(Platform.environment['HOME']!);
  homeDir.create(recursive: true);
  fs.currentDirectory = homeDir;
  final pubFile = fs.file(path.join(fs.currentDirectory.path, 'pubspec.yaml'));
  pubFile.create(recursive: true);
  print('writing pubspec to ${pubFile.path}');
  await pubFile.writeAsString(
    contents ??
        [
          'script_runner:',
          '  shell: /bin/sh',
          '  scripts:',
          '    - name: test',
          '      cwd: .',
          '      cmd: echo "hello"',
        ].join('\n'),
  );
}