[pigeon] Use a shared generation step for platform_tests/ (#2823)

stuartmorgan-g · web-flow · commit 9134c12377b2 · 2022-11-23T23:18:04.000Z
* Reorganize process helpers to reduce duplicate code * Add wrappers for common process commands * WIP generation consolidation * Re-add the Java special casing that the bash version did * Fix gradlew check * Add ignores for Dart for now * Update README * Typo fix * Autoformat * Fix Windows * Windows command fix * Try returning to runInShell:true to see if that fixes the CI hang * Revert more of _runWindowsUnitTests for CI debugging * Add missed early return for failure * Verbose build, and disable Dart generation to further reduce differences * Revert "Verbose build, and disable Dart generation to further reduce differences" This reverts commit ddfbf8b. * Revert "Revert more of _runWindowsUnitTests for CI debugging" This reverts commit e4e867c. * Revert "Try returning to runInShell:true to see if that fixes the CI hang" This reverts commit a124e08. * Fix Windows includes
diff --git a/packages/pigeon/platform_tests/README.md b/packages/pigeon/platform_tests/README.md
@@ -5,7 +5,11 @@ of Pigeon-generated code. The [test script](../tool/run_tests.dart) generates
 native code from [pigeons/](../pigeons/) into the native test scaffolding, and
 then drives the tests there.
 
-To run these tests, use [`run_tests.dart`](../tool/run_tests.dart)
+To run these tests, use [`run_tests.dart`](../tool/run_tests.dart).
+
+Alternately, if you are running them directly (e.g., from within a platform
+IDE), you can use [`generate.dart`](../tool/generate.dart) to generate the
+necessary Pigeon output.
 
 ## test\_plugin
 
diff --git a/packages/pigeon/platform_tests/alternate_language_test_plugin/lib/.gitignore b/packages/pigeon/platform_tests/alternate_language_test_plugin/lib/.gitignore
@@ -0,0 +1,9 @@
+# TODO(stuartmorgan): Remove this, so that review will show the effects of
+# changes on generated files. This will need a way to avoid unnecessary churn,
+# such as a flag to suppress version stamp generation.
+*.gen.dart
+# TODO(stuartmorgan): Add exceptions for specific files that are used in
+# integration tests, as they will need to be checked in to avoid analysis
+# failures. The exclusion of other files is to prevent having multiple
+# copies of all of the Dart output until more tests are restructured to
+# minimize duplication.
diff --git a/packages/pigeon/platform_tests/ios_unit_tests/ios/Runner.xcodeproj/project.pbxproj b/packages/pigeon/platform_tests/ios_unit_tests/ios/Runner.xcodeproj/project.pbxproj
diff --git a/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/AllDatatypesTest.m b/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/AllDatatypesTest.m
@@ -4,8 +4,8 @@
 
 #import <Flutter/Flutter.h>
 #import <XCTest/XCTest.h>
+#import "AllDatatypes.gen.h"
 #import "EchoMessenger.h"
-#import "all_datatypes.gen.h"
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 @interface AllDatatypesTest : XCTestCase
diff --git a/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/AsyncHandlersTest.m b/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/AsyncHandlersTest.m
@@ -4,8 +4,8 @@
 
 #import <Flutter/Flutter.h>
 #import <XCTest/XCTest.h>
+#import "AsyncHandlers.gen.h"
 #import "MockBinaryMessenger.h"
-#import "async_handlers.gen.h"
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 @interface Value ()
diff --git a/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/EnumTest.m b/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/EnumTest.m
@@ -5,7 +5,7 @@
 #import <Flutter/Flutter.h>
 #import <XCTest/XCTest.h>
 #import "EchoMessenger.h"
-#import "enum.gen.h"
+#import "Enum.gen.h"
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 @interface EnumTest : XCTestCase
@@ -15,14 +15,14 @@ @interface EnumTest : XCTestCase
 @implementation EnumTest
 
 - (void)testEcho {
-  ACDataWithEnum *data = [[ACDataWithEnum alloc] init];
-  data.state = ACEnumStateError;
+  DataWithEnum *data = [[DataWithEnum alloc] init];
+  data.state = EnumStateError;
   EchoBinaryMessenger *binaryMessenger =
-      [[EchoBinaryMessenger alloc] initWithCodec:ACEnumApi2HostGetCodec()];
-  ACEnumApi2Flutter *api = [[ACEnumApi2Flutter alloc] initWithBinaryMessenger:binaryMessenger];
+      [[EchoBinaryMessenger alloc] initWithCodec:EnumApi2HostGetCodec()];
+  EnumApi2Flutter *api = [[EnumApi2Flutter alloc] initWithBinaryMessenger:binaryMessenger];
   XCTestExpectation *expectation = [self expectationWithDescription:@"callback"];
   [api echoData:data
-      completion:^(ACDataWithEnum *_Nonnull result, NSError *_Nullable error) {
+      completion:^(DataWithEnum *_Nonnull result, NSError *_Nullable error) {
         XCTAssertEqual(data.state, result.state);
         [expectation fulfill];
       }];
diff --git a/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/ListTest.m b/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/ListTest.m
@@ -5,7 +5,7 @@
 #import <Flutter/Flutter.h>
 #import <XCTest/XCTest.h>
 #import "EchoMessenger.h"
-#import "list.gen.h"
+#import "List.gen.h"
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 @interface ListTest : XCTestCase
@@ -15,18 +15,18 @@ @interface ListTest : XCTestCase
 @implementation ListTest
 
 - (void)testListInList {
-  LSTTestMessage *top = [[LSTTestMessage alloc] init];
-  LSTTestMessage *inside = [[LSTTestMessage alloc] init];
+  TestMessage *top = [[TestMessage alloc] init];
+  TestMessage *inside = [[TestMessage alloc] init];
   inside.testList = @[ @1, @2, @3 ];
   top.testList = @[ inside ];
   EchoBinaryMessenger *binaryMessenger =
-      [[EchoBinaryMessenger alloc] initWithCodec:LSTEchoApiGetCodec()];
-  LSTEchoApi *api = [[LSTEchoApi alloc] initWithBinaryMessenger:binaryMessenger];
+      [[EchoBinaryMessenger alloc] initWithCodec:EchoApiGetCodec()];
+  EchoApi *api = [[EchoApi alloc] initWithBinaryMessenger:binaryMessenger];
   XCTestExpectation *expectation = [self expectationWithDescription:@"callback"];
   [api echoMsg:top
-      completion:^(LSTTestMessage *_Nonnull result, NSError *_Nullable err) {
+      completion:^(TestMessage *_Nonnull result, NSError *_Nullable err) {
         XCTAssertEqual(1u, result.testList.count);
-        XCTAssertTrue([result.testList[0] isKindOfClass:[LSTTestMessage class]]);
+        XCTAssertTrue([result.testList[0] isKindOfClass:[TestMessage class]]);
         XCTAssertEqualObjects(inside.testList, [result.testList[0] testList]);
         [expectation fulfill];
       }];
diff --git a/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/MultipleArityTest.m b/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/MultipleArityTest.m
@@ -5,7 +5,7 @@
 #import <Flutter/Flutter.h>
 #import <XCTest/XCTest.h>
 #import "HandlerBinaryMessenger.h"
-#import "multiple_arity.gen.h"
+#import "MultipleArity.gen.h"
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 @interface MultipleAritytest : XCTestCase
diff --git a/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/NonNullFieldsTest.m b/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/NonNullFieldsTest.m
@@ -6,7 +6,7 @@
 #import <Flutter/Flutter.h>
 #import <XCTest/XCTest.h>
 #import "EchoMessenger.h"
-#import "non_null_fields.gen.h"
+#import "NonNullFields.gen.h"
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 @interface NonNullFieldsTest : XCTestCase
@@ -16,7 +16,7 @@ @interface NonNullFieldsTest : XCTestCase
 @implementation NonNullFieldsTest
 
 - (void)testMake {
-  NNFNonNullFieldSearchRequest *request = [NNFNonNullFieldSearchRequest makeWithQuery:@"hello"];
+  NonNullFieldSearchRequest *request = [NonNullFieldSearchRequest makeWithQuery:@"hello"];
   XCTAssertEqualObjects(@"hello", request.query);
 }
 
diff --git a/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/NullFieldsTest.m b/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/NullFieldsTest.m
@@ -5,7 +5,7 @@
 #import <Flutter/Flutter.h>
 #import <XCTest/XCTest.h>
 #import "EchoMessenger.h"
-#import "null_fields.gen.h"
+#import "NullFields.gen.h"
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 @interface NullFieldsSearchRequest ()
diff --git a/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/NullableReturnsTest.m b/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/NullableReturnsTest.m
@@ -5,10 +5,10 @@
 #import <XCTest/XCTest.h>
 #import "EchoMessenger.h"
 #import "MockBinaryMessenger.h"
-#import "nullable_returns.gen.h"
+#import "NullableReturns.gen.h"
 
 ///////////////////////////////////////////////////////////////////////////////////////////
-@interface MockNullableArgHostApi : NSObject <NRNullableArgHostApi>
+@interface MockNullableArgHostApi : NSObject <NullableArgHostApi>
 @property(nonatomic, assign) BOOL didCall;
 @property(nonatomic, copy) NSNumber *x;
 @end
@@ -33,9 +33,9 @@ @implementation NullableReturnsTest
 
 - (void)testNullableParameterWithFlutterApi {
   EchoBinaryMessenger *binaryMessenger =
-      [[EchoBinaryMessenger alloc] initWithCodec:NRNullableArgHostApiGetCodec()];
-  NRNullableArgFlutterApi *api =
-      [[NRNullableArgFlutterApi alloc] initWithBinaryMessenger:binaryMessenger];
+      [[EchoBinaryMessenger alloc] initWithCodec:NullableArgHostApiGetCodec()];
+  NullableArgFlutterApi *api =
+      [[NullableArgFlutterApi alloc] initWithBinaryMessenger:binaryMessenger];
   XCTestExpectation *expectation = [self expectationWithDescription:@"callback"];
   [api doitX:nil
       completion:^(NSNumber *_Nonnull result, NSError *_Nullable error) {
@@ -48,12 +48,12 @@ - (void)testNullableParameterWithFlutterApi {
 - (void)testNullableParameterWithHostApi {
   MockNullableArgHostApi *api = [[MockNullableArgHostApi alloc] init];
   MockBinaryMessenger *binaryMessenger =
-      [[MockBinaryMessenger alloc] initWithCodec:NRNullableArgHostApiGetCodec()];
+      [[MockBinaryMessenger alloc] initWithCodec:NullableArgHostApiGetCodec()];
   NSString *channel = @"dev.flutter.pigeon.NullableArgHostApi.doit";
-  NRNullableArgHostApiSetup(binaryMessenger, api);
+  NullableArgHostApiSetup(binaryMessenger, api);
   XCTAssertNotNil(binaryMessenger.handlers[channel]);
   XCTestExpectation *expectation = [self expectationWithDescription:@"callback"];
-  NSData *arguments = [NRNullableArgHostApiGetCodec() encode:@[ [NSNull null] ]];
+  NSData *arguments = [NullableArgHostApiGetCodec() encode:@[ [NSNull null] ]];
   binaryMessenger.handlers[channel](arguments, ^(NSData *data) {
     [expectation fulfill];
   });
diff --git a/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/PrimitiveTest.m b/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/PrimitiveTest.m
@@ -5,7 +5,7 @@
 #import <Flutter/Flutter.h>
 #import <XCTest/XCTest.h>
 #import "EchoMessenger.h"
-#import "primitive.gen.h"
+#import "Primitive.gen.h"
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 @interface PrimitiveTest : XCTestCase
diff --git a/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/RunnerTests.m b/packages/pigeon/platform_tests/ios_unit_tests/ios/RunnerTests/RunnerTests.m
@@ -3,7 +3,7 @@
 // found in the LICENSE file.
 
 #import <XCTest/XCTest.h>
-#import "message.gen.h"
+#import "Message.gen.h"
 
 @interface ACMessageSearchReply ()
 + (ACMessageSearchReply *)fromMap:(NSDictionary *)dict;
diff --git a/packages/pigeon/platform_tests/test_plugin/lib/.gitignore b/packages/pigeon/platform_tests/test_plugin/lib/.gitignore
@@ -0,0 +1,9 @@
+# TODO(stuartmorgan): Remove this, so that review will show the effects of
+# changes on generated files. This will need a way to avoid unnecessary churn,
+# such as a flag to suppress version stamp generation.
+*.gen.dart
+# TODO(stuartmorgan): Add exceptions for specific files that are used in
+# integration tests, as they will need to be checked in to avoid analysis
+# failures. The exclusion of other files is to prevent having multiple
+# copies of all of the Dart output until more tests are restructured to
+# minimize duplication.
diff --git a/packages/pigeon/platform_tests/test_plugin/windows/CMakeLists.txt b/packages/pigeon/platform_tests/test_plugin/windows/CMakeLists.txt
@@ -83,38 +83,38 @@ add_executable(${TEST_RUNNER}
   test/pigeon_test.cpp
   test/primitive_test.cpp
   # Generated sources.
-  test/all_datatypes.g.cpp
-  test/all_datatypes.g.h
-  test/all_void.g.cpp
-  test/all_void.g.h
-  test/async_handlers.g.cpp
-  test/async_handlers.g.h
-  test/enum.g.cpp
-  test/enum.g.h
-  test/host2flutter.g.cpp
-  test/host2flutter.g.h
-  test/list.g.cpp
-  test/list.g.h
-  test/message.g.cpp
-  test/message.g.h
-  test/multiple_arity.g.cpp
-  test/multiple_arity.g.h
-  test/non_null_fields.g.cpp
-  test/non_null_fields.g.h
-  test/null_fields.g.cpp
-  test/null_fields.g.h
-  test/nullable_returns.g.cpp
-  test/nullable_returns.g.h
-  test/primitive.g.cpp
-  test/primitive.g.h
-  test/void_arg_flutter.g.cpp
-  test/void_arg_flutter.g.h
-  test/void_arg_host.g.cpp
-  test/void_arg_host.g.h
-  test/voidflutter.g.cpp
-  test/voidflutter.g.h
-  test/voidhost.g.cpp
-  test/voidhost.g.h
+  test/all_datatypes.gen.cpp
+  test/all_datatypes.gen.h
+  test/all_void.gen.cpp
+  test/all_void.gen.h
+  test/async_handlers.gen.cpp
+  test/async_handlers.gen.h
+  test/enum.gen.cpp
+  test/enum.gen.h
+  test/host2flutter.gen.cpp
+  test/host2flutter.gen.h
+  test/list.gen.cpp
+  test/list.gen.h
+  test/message.gen.cpp
+  test/message.gen.h
+  test/multiple_arity.gen.cpp
+  test/multiple_arity.gen.h
+  test/non_null_fields.gen.cpp
+  test/non_null_fields.gen.h
+  test/null_fields.gen.cpp
+  test/null_fields.gen.h
+  test/nullable_returns.gen.cpp
+  test/nullable_returns.gen.h
+  test/primitive.gen.cpp
+  test/primitive.gen.h
+  test/void_arg_flutter.gen.cpp
+  test/void_arg_flutter.gen.h
+  test/void_arg_host.gen.cpp
+  test/void_arg_host.gen.h
+  test/voidflutter.gen.cpp
+  test/voidflutter.gen.h
+  test/voidhost.gen.cpp
+  test/voidhost.gen.h
   # Test utilities.
   test/utils/echo_messenger.cpp
   test/utils/echo_messenger.h
diff --git a/packages/pigeon/platform_tests/test_plugin/windows/test/.gitignore b/packages/pigeon/platform_tests/test_plugin/windows/test/.gitignore
@@ -1,5 +1,5 @@
 # TODO(stuartmorgan): Remove this, so that review will show the effects of
 # changes on generated files. This will need a way to avoid unnecessary churn,
 # such as a flag to suppress version stamp generation.
-*.g.h
-*.g.cpp
+*.gen.h
+*.gen.cpp
diff --git a/packages/pigeon/platform_tests/test_plugin/windows/test/multiple_arity_test.cpp b/packages/pigeon/platform_tests/test_plugin/windows/test/multiple_arity_test.cpp
@@ -4,7 +4,7 @@
 
 #include <gtest/gtest.h>
 
-#include "test/multiple_arity.g.h"
+#include "test/multiple_arity.gen.h"
 #include "test/utils/fake_host_messenger.h"
 
 namespace multiple_arity_pigeontest {
diff --git a/packages/pigeon/platform_tests/test_plugin/windows/test/non_null_fields_test.cpp b/packages/pigeon/platform_tests/test_plugin/windows/test/non_null_fields_test.cpp
@@ -4,7 +4,7 @@
 
 #include <gtest/gtest.h>
 
-#include "non_null_fields.g.h"
+#include "non_null_fields.gen.h"
 
 namespace non_null_fields_pigeontest {
 
diff --git a/packages/pigeon/platform_tests/test_plugin/windows/test/null_fields_test.cpp b/packages/pigeon/platform_tests/test_plugin/windows/test/null_fields_test.cpp
@@ -5,7 +5,7 @@
 #include <flutter/encodable_value.h>
 #include <gtest/gtest.h>
 
-#include "null_fields.g.h"
+#include "null_fields.gen.h"
 
 namespace null_fields_pigeontest {
 
diff --git a/packages/pigeon/platform_tests/test_plugin/windows/test/nullable_returns_test.cpp b/packages/pigeon/platform_tests/test_plugin/windows/test/nullable_returns_test.cpp
@@ -6,7 +6,7 @@
 
 #include <optional>
 
-#include "test/nullable_returns.g.h"
+#include "test/nullable_returns.gen.h"
 #include "test/utils/fake_host_messenger.h"
 
 namespace nullable_returns_pigeontest {
diff --git a/packages/pigeon/platform_tests/test_plugin/windows/test/pigeon_test.cpp b/packages/pigeon/platform_tests/test_plugin/windows/test/pigeon_test.cpp
@@ -10,7 +10,7 @@
 #include <memory>
 #include <string>
 
-#include "message.g.h"
+#include "message.gen.h"
 
 namespace test_plugin {
 namespace test {
diff --git a/packages/pigeon/platform_tests/test_plugin/windows/test/primitive_test.cpp b/packages/pigeon/platform_tests/test_plugin/windows/test/primitive_test.cpp
@@ -4,7 +4,7 @@
 
 #include <gtest/gtest.h>
 
-#include "test/primitive.g.h"
+#include "test/primitive.gen.h"
 #include "test/utils/fake_host_messenger.h"
 
 namespace primitive_pigeontest {
diff --git a/packages/pigeon/run_tests.sh b/packages/pigeon/run_tests.sh
diff --git a/packages/pigeon/tool/generate.dart b/packages/pigeon/tool/generate.dart
diff --git a/packages/pigeon/tool/run_tests.dart b/packages/pigeon/tool/run_tests.dart
diff --git a/packages/pigeon/tool/shared/generation.dart b/packages/pigeon/tool/shared/generation.dart
diff --git a/packages/pigeon/tool/shared/native_project_runners.dart b/packages/pigeon/tool/shared/native_project_runners.dart
diff --git a/packages/pigeon/tool/shared/process_utils.dart b/packages/pigeon/tool/shared/process_utils.dart
