test: add a test for shorebird.yaml compiling that uses disk

.github/workflows/shorebird_ci.yml

@@ -48,6 +48,7 @@ jobs:
         if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest'
         # TODO(eseidel): We can't run all flutter_tools tests until we make
         # our changes not throw exceptions on missing shorebird.yaml.
+        # https://github.com/shorebirdtech/shorebird/issues/2392
         run: ../../bin/flutter test test/general.shard/shorebird
         working-directory: packages/flutter_tools
 

packages/flutter_tools/lib/src/ios/mac.dart

@@ -519,7 +519,7 @@ Future<XcodeBuildResult> buildXcodeProject({
     }
 
     try {
-      updateShorebirdYaml(buildInfo, app.shorebirdYamlPath);
+      updateShorebirdYaml(buildInfo, app.shorebirdYamlPath, environment: globals.platform.environment);
     } on Exception catch (error) {
       globals.printError('[shorebird] failed to generate shorebird configuration.\n$error');
       return XcodeBuildResult(success: false);

packages/flutter_tools/lib/src/shorebird/shorebird_yaml.dart

@@ -9,14 +9,14 @@ import '../base/file_system.dart';
 import '../build_info.dart';
 import '../globals.dart' as globals;
 
-void updateShorebirdYaml(BuildInfo buildInfo, String shorebirdYamlPath) {
+void updateShorebirdYaml(BuildInfo buildInfo, String shorebirdYamlPath, {required Map<String, String> environment}) {
   final File shorebirdYaml = globals.fs.file(shorebirdYamlPath);
   if (!shorebirdYaml.existsSync()) {
     throw Exception('shorebird.yaml not found at $shorebirdYamlPath');
   }
   final YamlDocument input = loadYamlDocument(shorebirdYaml.readAsStringSync());
   final YamlMap yamlMap = input.contents as YamlMap;
-  final Map<String, dynamic> compiled = compileShorebirdYaml(yamlMap, flavor: buildInfo.flavor, environment: globals.platform.environment);
+  final Map<String, dynamic> compiled = compileShorebirdYaml(yamlMap, flavor: buildInfo.flavor, environment: environment);
   // Currently we write out over the same yaml file, we should fix this to
   // write to a new .json file instead and avoid naming confusion between the
   // input and compiled files.

packages/flutter_tools/test/general.shard/shorebird/shorebird_yaml_test.dart

@@ -2,6 +2,9 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+import 'dart:io';
+
+import 'package:flutter_tools/src/build_info.dart';
 import 'package:flutter_tools/src/shorebird/shorebird_yaml.dart';
 import 'package:test/test.dart';
 import 'package:yaml/yaml.dart';
@@ -69,5 +72,27 @@ base_url: https://example.com
         'patch_public_key': '4-a',
       });
     });
+    test('edit in place', () {
+      const String yamlContents = '''
+app_id: 1-a
+auto_update: false
+flavors:
+  foo: 2-a
+  bar: 3-a
+base_url: https://example.com
+''';
+    // Make a temporary file to test editing in place.
+      final Directory tempDir = Directory.systemTemp.createTempSync('shorebird_yaml_test.');
+      final File tempFile = File('${tempDir.path}/shorebird.yaml');
+      tempFile.writeAsStringSync(yamlContents);
+      updateShorebirdYaml(const BuildInfo(BuildMode.release, 'foo', treeShakeIcons: false), tempFile.path, environment: <String, String>{'SHOREBIRD_PUBLIC_KEY': '4-a'});
+      final String updatedContents = tempFile.readAsStringSync();
+      // Order is not guaranteed, so parse as YAML to compare.
+      final YamlDocument updated = loadYamlDocument(updatedContents);
+      final YamlMap yamlMap = updated.contents as YamlMap;
+      expect(yamlMap['app_id'], '2-a');
+      expect(yamlMap['auto_update'], false);
+      expect(yamlMap['base_url'], 'https://example.com');
+    });
   });
 }