test: refactor e2e tests (#700)

* test: refactor e2e tests * refactor process run on e2e on test * fix test e2e * remove flutter test from non flutter templates * fix docs site * update version
VeryGoodOpenSource · Mar 28, 2023 · d22e66b · d22e66b
1 parent 8715f51
commit d22e66b
Show file tree

Hide file tree

Showing 19 changed files with 282 additions and 290 deletions.
diff --git a/lib/src/version.dart b/lib/src/version.dart
diff --git a/test/fixtures/async_main/pubspec.yaml b/test/fixtures/async_main/pubspec.yaml
@@ -8,3 +8,4 @@ environment:
 
 dev_dependencies:
   test: ^1.19.2
+  test_api: 0.4.18
diff --git a/test/helpers/expect_successful_process_result.dart b/test/helpers/expect_successful_process_result.dart
@@ -0,0 +1,29 @@
+import 'dart:io';
+
+import 'package:mason/mason.dart';
+import 'package:test/test.dart';
+
+Future<ProcessResult> expectSuccessfulProcessResult(
+  String executable,
+  List<String> arguments, {
+  required String workingDirectory,
+  bool validateStderr = true,
+}) async {
+  final result = await Process.run(
+    executable,
+    arguments,
+    workingDirectory: workingDirectory,
+    runInShell: true,
+  );
+  expect(
+    result.exitCode,
+    equals(ExitCode.success.code),
+    reason:
+        '''`$executable ${arguments.join(' ')}` in $workingDirectory failed with "${result.stderr}" and "${result.stdout}"''',
+  );
+  if (validateStderr) {
+    expect(result.stderr, isEmpty);
+  }
+
+  return result;
+}
diff --git a/test/helpers/helpers.dart b/test/helpers/helpers.dart
@@ -1,2 +1,3 @@
 export 'command_helper.dart';
 export 'copy_directory.dart';
+export 'expect_successful_process_result.dart';
diff --git a/test/src/commands/create/e2e/dart_cli/dart_cli_test.dart b/test/src/commands/create/e2e/dart_cli/dart_cli_test.dart
@@ -25,43 +25,56 @@ void main() {
       );
       expect(result, equals(ExitCode.success.code));
 
-      final formatResult = await Process.run(
+      final workingDirectory = path.join(directory.path, 'very_good_dart_cli');
+
+      // add coverage to collect coverage on dart test
+      await expectSuccessfulProcessResult(
+        'dart',
+        ['pub', 'add', 'coverage:1.2.0'],
+        workingDirectory: workingDirectory,
+      );
+
+      await expectSuccessfulProcessResult(
         'dart',
         ['format', '--set-exit-if-changed', '.'],
-        workingDirectory: path.join(directory.path, 'very_good_dart_cli'),
-        runInShell: true,
+        workingDirectory: workingDirectory,
       );
-      expect(formatResult.exitCode, equals(ExitCode.success.code));
-      expect(formatResult.stderr, isEmpty);
 
-      final analyzeResult = await Process.run(
+      final analyzeResult = await expectSuccessfulProcessResult(
         'flutter',
         ['analyze', '.'],
-        workingDirectory: path.join(directory.path, 'very_good_dart_cli'),
-        runInShell: true,
+        workingDirectory: workingDirectory,
       );
-      expect(analyzeResult.exitCode, equals(ExitCode.success.code));
-      expect(analyzeResult.stderr, isEmpty);
       expect(analyzeResult.stdout, contains('No issues found!'));
 
-      final testResult = await Process.run(
-        'flutter',
-        ['test', '--no-pub', '--coverage', '--reporter', 'compact'],
-        workingDirectory: path.join(directory.path, 'very_good_dart_cli'),
-        runInShell: true,
+      final testResult = await expectSuccessfulProcessResult(
+        'dart',
+        ['test', '--coverage=coverage', '--reporter=compact'],
+        workingDirectory: workingDirectory,
       );
-      expect(testResult.exitCode, equals(ExitCode.success.code));
-      expect(testResult.stderr, isEmpty);
       expect(testResult.stdout, contains('All tests passed!'));
 
-      final testCoverageResult = await Process.run(
+      // collect coverage
+      await expectSuccessfulProcessResult(
+        'dart',
+        [
+          'pub',
+          'run',
+          'coverage:format_coverage',
+          '--lcov',
+          '--in=coverage',
+          '--out=coverage/lcov.info',
+          '--packages=.dart_tool/package_config.json',
+          '--report-on=lib',
+        ],
+        workingDirectory: workingDirectory,
+      );
+
+      final testCoverageResult = await expectSuccessfulProcessResult(
         'genhtml',
         ['coverage/lcov.info', '-o', 'coverage'],
-        workingDirectory: path.join(directory.path, 'very_good_dart_cli'),
-        runInShell: true,
+        workingDirectory: workingDirectory,
       );
-      expect(testCoverageResult.exitCode, equals(ExitCode.success.code));
-      expect(testCoverageResult.stderr, isEmpty);
       expect(testCoverageResult.stdout, contains('lines......: 100.0%'));
     }),
     timeout: const Timeout(Duration(minutes: 2)),

diff --git a/test/src/commands/create/e2e/dart_package/dart_pkg_test.dart b/test/src/commands/create/e2e/dart_package/dart_pkg_test.dart
@@ -19,43 +19,56 @@ void main() {
       );
       expect(result, equals(ExitCode.success.code));
 
-      final formatResult = await Process.run(
+      final workingDirectory = path.join(directory.path, 'very_good_dart');
+
+      // add coverage to collect coverage on dart test
+      await expectSuccessfulProcessResult(
+        'dart',
+        ['pub', 'add', 'coverage:1.2.0'],
+        workingDirectory: workingDirectory,
+      );
+
+      await expectSuccessfulProcessResult(
         'dart',
         ['format', '--set-exit-if-changed', '.'],
-        workingDirectory: path.join(directory.path, 'very_good_dart'),
-        runInShell: true,
+        workingDirectory: workingDirectory,
       );
-      expect(formatResult.exitCode, equals(ExitCode.success.code));
-      expect(formatResult.stderr, isEmpty);
 
-      final analyzeResult = await Process.run(
+      final analyzeResult = await expectSuccessfulProcessResult(
         'flutter',
         ['analyze', '.'],
-        workingDirectory: path.join(directory.path, 'very_good_dart'),
-        runInShell: true,
+        workingDirectory: workingDirectory,
       );
-      expect(analyzeResult.exitCode, equals(ExitCode.success.code));
-      expect(analyzeResult.stderr, isEmpty);
       expect(analyzeResult.stdout, contains('No issues found!'));
 
-      final testResult = await Process.run(
-        'flutter',
-        ['test', '--no-pub', '--coverage', '--reporter', 'compact'],
-        workingDirectory: path.join(directory.path, 'very_good_dart'),
-        runInShell: true,
+      final testResult = await expectSuccessfulProcessResult(
+        'dart',
+        ['test', '--coverage=coverage', '--reporter=compact'],
+        workingDirectory: workingDirectory,
       );
-      expect(testResult.exitCode, equals(ExitCode.success.code));
-      expect(testResult.stderr, isEmpty);
       expect(testResult.stdout, contains('All tests passed!'));
 
-      final testCoverageResult = await Process.run(
+      // collect coverage
+      await expectSuccessfulProcessResult(
+        'dart',
+        [
+          'pub',
+          'run',
+          'coverage:format_coverage',
+          '--lcov',
+          '--in=coverage',
+          '--out=coverage/lcov.info',
+          '--packages=.dart_tool/package_config.json',
+          '--report-on=lib',
+        ],
+        workingDirectory: workingDirectory,
+      );
+
+      final testCoverageResult = await expectSuccessfulProcessResult(
         'genhtml',
         ['coverage/lcov.info', '-o', 'coverage'],
-        workingDirectory: path.join(directory.path, 'very_good_dart'),
-        runInShell: true,
+        workingDirectory: workingDirectory,
       );
-      expect(testCoverageResult.exitCode, equals(ExitCode.success.code));
-      expect(testCoverageResult.stderr, isEmpty);
       expect(testCoverageResult.stdout, contains('lines......: 100.0%'));
     }),
     timeout: const Timeout(Duration(minutes: 2)),

diff --git a/test/src/commands/create/e2e/docs_site/docs_site_test.dart b/test/src/commands/create/e2e/docs_site/docs_site_test.dart
@@ -18,40 +18,32 @@ void main() {
       );
       expect(result, equals(ExitCode.success.code));
 
-      final installResult = await Process.run(
+      final workingDirectory = path.join(directory.path, 'very_good_docs_site');
+
+      await expectSuccessfulProcessResult(
         'npm',
         ['install'],
-        workingDirectory: path.join(directory.path, 'very_good_docs_site'),
-        runInShell: true,
+        workingDirectory: workingDirectory,
+        validateStderr: false,
       );
-      expect(installResult.exitCode, equals(ExitCode.success.code));
 
-      final formatResult = await Process.run(
+      await expectSuccessfulProcessResult(
         'npm',
         ['run', 'format'],
-        workingDirectory: path.join(directory.path, 'very_good_docs_site'),
-        runInShell: true,
+        workingDirectory: workingDirectory,
       );
-      expect(formatResult.exitCode, equals(ExitCode.success.code));
-      expect(formatResult.stderr, isEmpty);
 
-      final lintResult = await Process.run(
+      await expectSuccessfulProcessResult(
         'npm',
         ['run', 'lint'],
-        workingDirectory: path.join(directory.path, 'very_good_docs_site'),
-        runInShell: true,
+        workingDirectory: workingDirectory,
       );
-      expect(lintResult.exitCode, equals(ExitCode.success.code));
-      expect(lintResult.stderr, isEmpty);
 
-      final buildResult = await Process.run(
+      await expectSuccessfulProcessResult(
         'npm',
         ['run', 'build'],
-        workingDirectory: path.join(directory.path, 'very_good_docs_site'),
-        runInShell: true,
+        workingDirectory: workingDirectory,
       );
-      expect(buildResult.exitCode, equals(ExitCode.success.code));
-      expect(buildResult.stderr, isEmpty);
     }),
     timeout: const Timeout(Duration(minutes: 2)),
   );

diff --git a/test/src/commands/create/e2e/flame_game/flame_game_test.dart b/test/src/commands/create/e2e/flame_game/flame_game_test.dart
@@ -26,43 +26,36 @@ void main() {
       );
       expect(result, equals(ExitCode.success.code));
 
-      final formatResult = await Process.run(
+      final workingDirectory = path.join(
+        directory.path,
+        'very_good_flame_game',
+      );
+
+      await expectSuccessfulProcessResult(
         'dart',
         ['format', '--set-exit-if-changed', '.'],
-        workingDirectory: path.join(directory.path, 'very_good_flame_game'),
-        runInShell: true,
+        workingDirectory: workingDirectory,
       );
-      expect(formatResult.exitCode, equals(ExitCode.success.code));
-      expect(formatResult.stderr, isEmpty);
 
-      final analyzeResult = await Process.run(
+      final analyzeResult = await expectSuccessfulProcessResult(
         'flutter',
         ['analyze', '.'],
-        workingDirectory: path.join(directory.path, 'very_good_flame_game'),
-        runInShell: true,
+        workingDirectory: workingDirectory,
       );
-      expect(analyzeResult.exitCode, equals(ExitCode.success.code));
-      expect(analyzeResult.stderr, isEmpty);
       expect(analyzeResult.stdout, contains('No issues found!'));
 
-      final testResult = await Process.run(
+      final testResult = await expectSuccessfulProcessResult(
         'flutter',
         ['test', '--no-pub', '--coverage', '--reporter', 'compact'],
-        workingDirectory: path.join(directory.path, 'very_good_flame_game'),
-        runInShell: true,
+        workingDirectory: workingDirectory,
       );
-      expect(testResult.exitCode, equals(ExitCode.success.code));
-      expect(testResult.stderr, isEmpty);
       expect(testResult.stdout, contains('All tests passed!'));
 
-      final testCoverageResult = await Process.run(
+      final testCoverageResult = await expectSuccessfulProcessResult(
         'genhtml',
         ['coverage/lcov.info', '-o', 'coverage'],
-        workingDirectory: path.join(directory.path, 'very_good_flame_game'),
-        runInShell: true,
+        workingDirectory: workingDirectory,
       );
-      expect(testCoverageResult.exitCode, equals(ExitCode.success.code));
-      expect(testCoverageResult.stderr, isEmpty);
       expect(testCoverageResult.stdout, contains('lines......: 97.8%'));
     }),
   );

diff --git a/test/src/commands/create/e2e/flutter_app/core_test.dart b/test/src/commands/create/e2e/flutter_app/core_test.dart
@@ -19,43 +19,33 @@ void main() {
       );
       expect(result, equals(ExitCode.success.code));
 
-      final formatResult = await Process.run(
+      final workingDirectory = path.join(directory.path, 'very_good_core');
+
+      await expectSuccessfulProcessResult(
         'dart',
         ['format', '--set-exit-if-changed', '.'],
-        workingDirectory: path.join(directory.path, 'very_good_core'),
-        runInShell: true,
+        workingDirectory: workingDirectory,
       );
-      expect(formatResult.exitCode, equals(ExitCode.success.code));
-      expect(formatResult.stderr, isEmpty);
 
-      final analyzeResult = await Process.run(
+      final analyzeResult = await expectSuccessfulProcessResult(
         'flutter',
         ['analyze', '.'],
-        workingDirectory: path.join(directory.path, 'very_good_core'),
-        runInShell: true,
+        workingDirectory: workingDirectory,
       );
-      expect(analyzeResult.exitCode, equals(ExitCode.success.code));
-      expect(analyzeResult.stderr, isEmpty);
       expect(analyzeResult.stdout, contains('No issues found!'));
 
-      final testResult = await Process.run(
+      final testResult = await expectSuccessfulProcessResult(
         'flutter',
         ['test', '--no-pub', '--coverage', '--reporter', 'compact'],
-        workingDirectory: path.join(directory.path, 'very_good_core'),
-        runInShell: true,
+        workingDirectory: workingDirectory,
       );
-      expect(testResult.exitCode, equals(ExitCode.success.code));
-      expect(testResult.stderr, isEmpty);
       expect(testResult.stdout, contains('All tests passed!'));
 
-      final testCoverageResult = await Process.run(
+      final testCoverageResult = await expectSuccessfulProcessResult(
         'genhtml',
         ['coverage/lcov.info', '-o', 'coverage'],
-        workingDirectory: path.join(directory.path, 'very_good_core'),
-        runInShell: true,
+        workingDirectory: workingDirectory,
       );
-      expect(testCoverageResult.exitCode, equals(ExitCode.success.code));
-      expect(testCoverageResult.stderr, isEmpty);
       expect(testCoverageResult.stdout, contains('lines......: 100.0%'));
     }),
     timeout: const Timeout(Duration(minutes: 2)),