FED-4419 Migrate builder test to functional test, refactor gold file setup

.github/workflows/ci.yml

@@ -53,7 +53,6 @@ jobs:
           DART_VERSION="${{ steps.setup-dart.outputs.dart-version }}"
           if [[ "$DART_VERSION" =~ ^3 ]]; then
             ./tool/delete_dart_2_only_files.sh
-            ./tool/update_tests_for_dart_3.sh
             # Stage these changes so they don't show up in the generated file `git diff` check below
             git add .
           fi
@@ -146,7 +145,6 @@ jobs:
           DART_VERSION="${{ steps.setup-dart.outputs.dart-version }}"
           if [[ "$DART_VERSION" =~ ^3 ]]; then
             ./tool/delete_dart_2_only_files.sh
-            ./tool/update_tests_for_dart_3.sh
           fi
 
       - name: Analyze package source
@@ -196,7 +194,7 @@ jobs:
         run: |
           DART_VERSION="${{ steps.setup-dart.outputs.dart-version }}"
           if [[ "$DART_VERSION" =~ ^3 ]]; then
-            (cd ../.. && ./tool/delete_dart_2_only_files.sh && ./tool/update_tests_for_dart_3.sh)
+            (cd ../.. && ./tool/delete_dart_2_only_files.sh)
           fi
 
       - name: Validate dependencies

test_fixtures/gold_output_files/README.md

@@ -4,8 +4,3 @@ To re-generate the gold files in this directory using the over_react builder, ru
 ```sh
 dart tool/update_gold_output_files.dart
 ```
-
-If that deletes other generated files throughout over_react (which usually only happens after it prompts you about conflicting outputs), you can restore them by running a build: 
-```sh
-dart run build_runner build
-```

test_fixtures/gold_output_files/backwards_compatible/basic.over_react.g.dart.goldFile

@@ -6,6 +6,8 @@ part of 'basic.dart';
 
 // **************************************************************************
 // OverReactBuilder (package:over_react/src/builder.dart)
+//
+// Using nullSafety: false. {languageVersion: 2.11, source: libraryVersionComment}
 // **************************************************************************
 
 // React component factory implementation.

test_fixtures/gold_output_files/backwards_compatible/basic_library.over_react.g.dart.goldFile

@@ -6,6 +6,8 @@ part of 'basic_library.dart';
 
 // **************************************************************************
 // OverReactBuilder (package:over_react/src/builder.dart)
+//
+// Using nullSafety: false. {languageVersion: 2.11, source: libraryVersionComment}
 // **************************************************************************
 
 // React component factory implementation.

test_fixtures/gold_output_files/backwards_compatible/props_mixin.over_react.g.dart.goldFile

@@ -6,6 +6,8 @@ part of 'props_mixin.dart';
 
 // **************************************************************************
 // OverReactBuilder (package:over_react/src/builder.dart)
+//
+// Using nullSafety: false. {languageVersion: 2.11, source: libraryVersionComment}
 // **************************************************************************
 
 mixin $ExamplePropsMixinClass implements ExamplePropsMixinClass {

test_fixtures/gold_output_files/backwards_compatible/state_mixin.over_react.g.dart.goldFile

@@ -6,6 +6,8 @@ part of 'state_mixin.dart';
 
 // **************************************************************************
 // OverReactBuilder (package:over_react/src/builder.dart)
+//
+// Using nullSafety: false. {languageVersion: 2.11, source: libraryVersionComment}
 // **************************************************************************
 
 mixin $ExampleStateMixinClass implements ExampleStateMixinClass {

test_fixtures/gold_output_files/dart2_only/basic.over_react.g.dart.goldFile

@@ -6,6 +6,8 @@ part of 'basic.dart';
 
 // **************************************************************************
 // OverReactBuilder (package:over_react/src/builder.dart)
+//
+// Using nullSafety: false. {languageVersion: 2.11, source: libraryVersionComment}
 // **************************************************************************
 
 // React component factory implementation.

test_fixtures/gold_output_files/dart2_only/basic_library.over_react.g.dart.goldFile

@@ -6,6 +6,8 @@ part of 'basic_library.dart';
 
 // **************************************************************************
 // OverReactBuilder (package:over_react/src/builder.dart)
+//
+// Using nullSafety: false. {languageVersion: 2.11, source: libraryVersionComment}
 // **************************************************************************
 
 // React component factory implementation.

test_fixtures/gold_output_files/dart2_only/component2/basic.over_react.g.dart.goldFile

@@ -6,6 +6,8 @@ part of 'basic.dart';
 
 // **************************************************************************
 // OverReactBuilder (package:over_react/src/builder.dart)
+//
+// Using nullSafety: false. {languageVersion: 2.11, source: libraryVersionComment}
 // **************************************************************************
 
 // React component factory implementation.

test_fixtures/gold_output_files/dart2_only/component2/basic_library.over_react.g.dart.goldFile

@@ -6,6 +6,8 @@ part of 'basic_library.dart';
 
 // **************************************************************************
 // OverReactBuilder (package:over_react/src/builder.dart)
+//
+// Using nullSafety: false. {languageVersion: 2.11, source: libraryVersionComment}
 // **************************************************************************
 
 // React component factory implementation.

test_fixtures/gold_output_files/dart2_only/missing_over_react_g_part/library.over_react.g.dart.goldFile

@@ -6,6 +6,8 @@ part of 'library.dart';
 
 // **************************************************************************
 // OverReactBuilder (package:over_react/src/builder.dart)
+//
+// Using nullSafety: false. {languageVersion: 2.11, source: libraryVersionComment}
 // **************************************************************************
 
 // React component factory implementation.

test_fixtures/gold_output_files/dart2_only/props_mixin.over_react.g.dart.goldFile

@@ -6,6 +6,8 @@ part of 'props_mixin.dart';
 
 // **************************************************************************
 // OverReactBuilder (package:over_react/src/builder.dart)
+//
+// Using nullSafety: false. {languageVersion: 2.11, source: libraryVersionComment}
 // **************************************************************************
 
 @deprecated

test_fixtures/gold_output_files/dart2_only/state_mixin.over_react.g.dart.goldFile

@@ -6,6 +6,8 @@ part of 'state_mixin.dart';
 
 // **************************************************************************
 // OverReactBuilder (package:over_react/src/builder.dart)
+//
+// Using nullSafety: false. {languageVersion: 2.11, source: libraryVersionComment}
 // **************************************************************************
 
 @deprecated

test_fixtures/gold_output_files/mixin_based/basic.over_react.g.dart.goldFile

@@ -6,6 +6,8 @@ part of 'basic.dart';
 
 // **************************************************************************
 // OverReactBuilder (package:over_react/src/builder.dart)
+//
+// Using nullSafety: false. {languageVersion: 2.11, source: libraryVersionComment}
 // **************************************************************************
 
 // React component factory implementation.

test_fixtures/gold_output_files/mixin_based/basic_library.over_react.g.dart.goldFile

@@ -6,6 +6,8 @@ part of 'basic_library.dart';
 
 // **************************************************************************
 // OverReactBuilder (package:over_react/src/builder.dart)
+//
+// Using nullSafety: false. {languageVersion: 2.11, source: libraryVersionComment}
 // **************************************************************************
 
 // React component factory implementation.

test_fixtures/gold_output_files/mixin_based/basic_two_nine.over_react.g.dart.goldFile

@@ -6,6 +6,8 @@ part of 'basic_two_nine.dart';
 
 // **************************************************************************
 // OverReactBuilder (package:over_react/src/builder.dart)
+//
+// Using nullSafety: false. {languageVersion: 2.11, source: libraryVersionComment}
 // **************************************************************************
 
 // React component factory implementation.

test_fixtures/gold_output_files/mixin_based/missing_over_react_g_part/library.over_react.g.dart.goldFile

@@ -6,6 +6,8 @@ part of 'library.dart';
 
 // **************************************************************************
 // OverReactBuilder (package:over_react/src/builder.dart)
+//
+// Using nullSafety: false. {languageVersion: 2.11, source: libraryVersionComment}
 // **************************************************************************
 
 // React component factory implementation.

test_fixtures/gold_output_files/mixin_based/props_mixin.over_react.g.dart.goldFile

@@ -6,6 +6,8 @@ part of 'props_mixin.dart';
 
 // **************************************************************************
 // OverReactBuilder (package:over_react/src/builder.dart)
+//
+// Using nullSafety: false. {languageVersion: 2.11, source: libraryVersionComment}
 // **************************************************************************
 
 @Deprecated('This API is for use only within generated code.'

test_fixtures/gold_output_files/mixin_based/state_mixin.over_react.g.dart.goldFile

@@ -6,6 +6,8 @@ part of 'state_mixin.dart';
 
 // **************************************************************************
 // OverReactBuilder (package:over_react/src/builder.dart)
+//
+// Using nullSafety: false. {languageVersion: 2.11, source: libraryVersionComment}
 // **************************************************************************
 
 @Deprecated('This API is for use only within generated code.'

test_fixtures/gold_output_files/mixin_based/two_nine_with_multiple_factories.over_react.g.dart.goldfile

@@ -6,6 +6,8 @@ part of 'two_nine_with_multiple_factories.dart';
 
 // **************************************************************************
 // OverReactBuilder (package:over_react/src/builder.dart)
+//
+// Using nullSafety: false. {languageVersion: 2.11, source: libraryVersionComment}
 // **************************************************************************
 
 // React component factory implementation.

test_fixtures/gold_output_files/mixin_based/type_parameters.over_react.g.dart.goldFile

@@ -6,6 +6,8 @@ part of 'type_parameters.dart';
 
 // **************************************************************************
 // OverReactBuilder (package:over_react/src/builder.dart)
+//
+// Using nullSafety: false. {languageVersion: 2.11, source: libraryVersionComment}
 // **************************************************************************
 
 @Deprecated('This API is for use only within generated code.'

test_fixtures/test_packages/builder/pubspec.yaml

@@ -0,0 +1,9 @@
+name: over_react__test__builder_tests
+publish_to: none
+environment:
+  sdk: ">=2.19.0 <4.0.0"
+dependencies:
+  over_react:
+    path: ../../../
+dev_dependencies:
+  build_runner: any

tool/update_gold_output_files.dart

@@ -3,56 +3,43 @@ import 'dart:io';
 import 'package:glob/glob.dart';
 import 'package:glob/list_local_fs.dart';
 import 'package:path/path.dart' as p;
+import 'package:yaml/yaml.dart';
 
-final sourceFixturesDir = Directory('test_fixtures/source_files');
+final sourceFixtureDir = Directory('test_fixtures/test_packages/builder');
 final goldsDir = Directory('test_fixtures/gold_output_files');
 
-/// A temporary directory used to generate new golds.
-final tmpSourceDir = Directory('test/tmp_test_files');
-
-/// Updates gold files in [goldsDir] by re-generating them from a copy of the files in [sourceFixturesDir].
+/// Updates gold files in [goldsDir] by re-generating them from a copy of the files in [sourceFixtureDir].
 Future<void> main() async {
-  print('Copying files from ${sourceFixturesDir.path} to temporary directory ${tmpSourceDir.path}');
-  if (tmpSourceDir.existsSync()) tmpSourceDir.deleteSync(recursive: true);
-  tmpSourceDir.createSync(recursive: true);
-  for (final file in Glob(p.join(sourceFixturesDir.path, '**')).listSync().whereType<File>()) {
-    final newPath = p.join(tmpSourceDir.path, p.relative(file.path, from: sourceFixturesDir.path));
-    File(newPath).parent.createSync(recursive: true);
-    file.copySync(newPath);
-  }
+  final sourceFixturePubspec =
+      loadYaml(File(p.join(sourceFixtureDir.path, 'pubspec.yaml')).readAsStringSync());
+  final sourceFixturePackageName = sourceFixturePubspec['name'] as String;
 
-  print('Building files in temporary directory ${tmpSourceDir.path}');
-  final buildProcess = await Process.start(
-      'dart', ['run', 'build_runner', 'build', '--build-filter=${p.join(tmpSourceDir.path, '**')}'],
-      mode: ProcessStartMode.inheritStdio);
+  print('Building files in test fixture ${goldsDir.path}');
+
+  print('Building files in ${sourceFixtureDir.path} to .dart_tool...');
+  final buildProcess = await Process.start('dart', ['run', 'build_runner', 'build'],
+      workingDirectory: sourceFixtureDir.path, mode: ProcessStartMode.inheritStdio);
   // Wait for build to complete.
   final buildExitCode = await buildProcess.exitCode;
   if (buildExitCode != 0) {
     stderr.writeln(
-        '^ Build failures are expected for "missing_over_react_g_part" files, and can be ignored.');
+        '\n^ Build failures are expected for "missing_over_react_g_part" files, and can be ignored.\n');
   }
 
   print('Copying built files to golds directory ${goldsDir.path}');
-  final generatedTmpFiles =
-      Glob(p.join(tmpSourceDir.path, '**.over_react.g.dart')).listSync().whereType<File>().toList();
-  if (generatedTmpFiles.isEmpty) {
-    throw Exception('No generated files were found in ${tmpSourceDir.path}.'
-        ' Ensure in build.yaml the over_react builder runs on directory with build_to:source');
+  final outputPath = p.join(
+      sourceFixtureDir.path, '.dart_tool', 'build', 'generated', sourceFixturePackageName, 'lib');
+  late final generatedTmpFiles =
+      Glob(p.join(outputPath, '**.over_react.g.dart')).listSync().whereType<File>().toList();
+  if (!Directory(outputPath).existsSync() || generatedTmpFiles.isEmpty) {
+    throw Exception(
+        'No generated files were found in $outputPath; something is probably wrong with the paths in this script.');
   }
   for (final file in generatedTmpFiles) {
-    final newPath =
-        p.join(goldsDir.path, p.relative(file.path, from: tmpSourceDir.path)) + '.goldFile';
+    final newPath = p.join(goldsDir.path, p.relative(file.path, from: outputPath)) + '.goldFile';
     File(newPath).parent.createSync(recursive: true);
     file.copySync(newPath);
   }
 
-  print('Cleaning up temporary directory ${tmpSourceDir.path}');
-  tmpSourceDir.deleteSync(recursive: true);
-
   print('Done!');
-
-  print('\nIf non-gold generated files throughout this package got deleted'
-      ' (which usually only happens after it prompts you about conflicting outputs),'
-      ' you can restore them by running a build:\n\n'
-      '    dart run build_runner build');
 }