[pigeon] Add the iOS tests in the new harness as non-default options (#…

…2867) * Move Obj-C tests into the new harness * Modernize imports in ObjC tests * Fix new generation code for merge * Plumb in new integration tests * Format * Add Dart-based support for the new unit test harness * Restore the old path in run_tests.sh * Restore ios_unit_tests temporarily, but with symlinks * Point to new location for generated files * Hack the imports to work in both locations * Switch from symlinks to project location changes * Update README
flutter · Nov 30, 2022 · e1dc854 · e1dc854
1 parent 6d9f6c6
commit e1dc854
Show file tree

Hide file tree

Showing 28 changed files with 559 additions and 116 deletions.
diff --git a/packages/pigeon/platform_tests/README.md b/packages/pigeon/platform_tests/README.md
@@ -29,3 +29,10 @@ supported plugin languages. It covers:
 Dart unit tests for null-safe mode. This is a legacy structure from before
 NNBD was the only mode Pigeon supported; these should be folded back into
 the main tests.
+
+## ios\_unit\_tests
+
+This is a legacy harness that is only necessary for CI, and will be
+removed in the future. See
+[this PR](https://github.com/flutter/packages/pull/2816) for more
+details.
diff --git a/packages/pigeon/platform_tests/alternate_language_test_plugin/example/ios/Podfile b/packages/pigeon/platform_tests/alternate_language_test_plugin/example/ios/Podfile
@@ -29,6 +29,10 @@ flutter_ios_podfile_setup
 
 target 'Runner' do
   flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))
+
+  target 'RunnerTests' do
+    inherit! :search_paths
+  end
 end
 
 post_install do |installer|

diff --git a/...latform_tests/alternate_language_test_plugin/example/ios/Runner.xcodeproj/project.pbxproj b/...latform_tests/alternate_language_test_plugin/example/ios/Runner.xcodeproj/project.pbxproj
diff --git a/..._language_test_plugin/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/..._language_test_plugin/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme
@@ -37,6 +37,17 @@
          </BuildableReference>
       </MacroExpansion>
       <Testables>
+         <TestableReference
+            skipped = "NO"
+            parallelizable = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "33AA165E291EB8B600ECBEEB"
+               BuildableName = "RunnerTests.xctest"
+               BlueprintName = "RunnerTests"
+               ReferencedContainer = "container:Runner.xcodeproj">
+            </BuildableReference>
+         </TestableReference>
       </Testables>
    </TestAction>
    <LaunchAction

diff --git a/...ts/alternate_language_test_plugin/example/ios/Runner.xcworkspace/contents.xcworkspacedata b/...ts/alternate_language_test_plugin/example/ios/Runner.xcworkspace/contents.xcworkspacedata
diff --git a/..._tests/ios/RunnerTests/AllDatatypesTest.m → ...xample/ios/RunnerTests/AllDatatypesTest.m b/..._tests/ios/RunnerTests/AllDatatypesTest.m → ...xample/ios/RunnerTests/AllDatatypesTest.m
@@ -2,9 +2,15 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#import <Flutter/Flutter.h>
-#import <XCTest/XCTest.h>
+@import Flutter;
+@import XCTest;
+
+#ifdef LEGACY_HARNESS
 #import "AllDatatypes.gen.h"
+#else
+@import alternate_language_test_plugin;
+#endif
+
 #import "EchoMessenger.h"
 
 ///////////////////////////////////////////////////////////////////////////////////////////

diff --git a/...tests/ios/RunnerTests/AsyncHandlersTest.m → ...ample/ios/RunnerTests/AsyncHandlersTest.m b/...tests/ios/RunnerTests/AsyncHandlersTest.m → ...ample/ios/RunnerTests/AsyncHandlersTest.m
@@ -2,9 +2,15 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#import <Flutter/Flutter.h>
-#import <XCTest/XCTest.h>
+@import Flutter;
+@import XCTest;
+
+#ifdef LEGACY_HARNESS
 #import "AsyncHandlers.gen.h"
+#else
+@import alternate_language_test_plugin;
+#endif
+
 #import "MockBinaryMessenger.h"
 
 ///////////////////////////////////////////////////////////////////////////////////////////

diff --git a/...nit_tests/ios/RunnerTests/EchoMessenger.h → ...n/example/ios/RunnerTests/EchoMessenger.h b/...nit_tests/ios/RunnerTests/EchoMessenger.h → ...n/example/ios/RunnerTests/EchoMessenger.h
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#import <Flutter/Flutter.h>
-#import <Foundation/Foundation.h>
+@import Flutter;
+@import Foundation;
 
 NS_ASSUME_NONNULL_BEGIN
 

diff --git a/...nit_tests/ios/RunnerTests/EchoMessenger.m → ...n/example/ios/RunnerTests/EchoMessenger.m b/...nit_tests/ios/RunnerTests/EchoMessenger.m → ...n/example/ios/RunnerTests/EchoMessenger.m
diff --git a/...ios_unit_tests/ios/RunnerTests/EnumTest.m → ...plugin/example/ios/RunnerTests/EnumTest.m b/...ios_unit_tests/ios/RunnerTests/EnumTest.m → ...plugin/example/ios/RunnerTests/EnumTest.m
@@ -2,10 +2,16 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#import <Flutter/Flutter.h>
-#import <XCTest/XCTest.h>
-#import "EchoMessenger.h"
+@import Flutter;
+@import XCTest;
+
+#ifdef LEGACY_HARNESS
 #import "Enum.gen.h"
+#else
+@import alternate_language_test_plugin;
+#endif
+
+#import "EchoMessenger.h"
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 @interface EnumTest : XCTestCase

diff --git a/.../ios/RunnerTests/HandlerBinaryMessenger.h → .../ios/RunnerTests/HandlerBinaryMessenger.h b/.../ios/RunnerTests/HandlerBinaryMessenger.h → .../ios/RunnerTests/HandlerBinaryMessenger.h
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#import <Flutter/Flutter.h>
-#import <Foundation/Foundation.h>
+@import Flutter;
+@import Foundation;
 
 NS_ASSUME_NONNULL_BEGIN
 

diff --git a/.../ios/RunnerTests/HandlerBinaryMessenger.m → .../ios/RunnerTests/HandlerBinaryMessenger.m b/.../ios/RunnerTests/HandlerBinaryMessenger.m → .../ios/RunnerTests/HandlerBinaryMessenger.m
diff --git a/...ios_unit_tests/ios/RunnerTests/ListTest.m → ...plugin/example/ios/RunnerTests/ListTest.m b/...ios_unit_tests/ios/RunnerTests/ListTest.m → ...plugin/example/ios/RunnerTests/ListTest.m
@@ -2,10 +2,16 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#import <Flutter/Flutter.h>
-#import <XCTest/XCTest.h>
-#import "EchoMessenger.h"
+@import Flutter;
+@import XCTest;
+
+#ifdef LEGACY_HARNESS
 #import "List.gen.h"
+#else
+@import alternate_language_test_plugin;
+#endif
+
+#import "EchoMessenger.h"
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 @interface ListTest : XCTestCase

diff --git a/...sts/ios/RunnerTests/MockBinaryMessenger.h → ...ple/ios/RunnerTests/MockBinaryMessenger.h b/...sts/ios/RunnerTests/MockBinaryMessenger.h → ...ple/ios/RunnerTests/MockBinaryMessenger.h
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#import <Flutter/Flutter.h>
-#import <Foundation/Foundation.h>
+@import Flutter;
+@import Foundation;
 
 NS_ASSUME_NONNULL_BEGIN
 

diff --git a/...sts/ios/RunnerTests/MockBinaryMessenger.m → ...ple/ios/RunnerTests/MockBinaryMessenger.m b/...sts/ios/RunnerTests/MockBinaryMessenger.m → ...ple/ios/RunnerTests/MockBinaryMessenger.m
diff --git a/...tests/ios/RunnerTests/MultipleArityTest.m → ...ample/ios/RunnerTests/MultipleArityTest.m b/...tests/ios/RunnerTests/MultipleArityTest.m → ...ample/ios/RunnerTests/MultipleArityTest.m
@@ -2,10 +2,16 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#import <Flutter/Flutter.h>
-#import <XCTest/XCTest.h>
-#import "HandlerBinaryMessenger.h"
+@import Flutter;
+@import XCTest;
+
+#ifdef LEGACY_HARNESS
 #import "MultipleArity.gen.h"
+#else
+@import alternate_language_test_plugin;
+#endif
+
+#import "HandlerBinaryMessenger.h"
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 @interface MultipleAritytest : XCTestCase

diff --git a/...tests/ios/RunnerTests/NonNullFieldsTest.m → ...ample/ios/RunnerTests/NonNullFieldsTest.m b/...tests/ios/RunnerTests/NonNullFieldsTest.m → ...ample/ios/RunnerTests/NonNullFieldsTest.m
@@ -3,10 +3,16 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#import <Flutter/Flutter.h>
-#import <XCTest/XCTest.h>
-#import "EchoMessenger.h"
+@import Flutter;
+@import XCTest;
+
+#ifdef LEGACY_HARNESS
 #import "NonNullFields.gen.h"
+#else
+@import alternate_language_test_plugin;
+#endif
+
+#import "EchoMessenger.h"
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 @interface NonNullFieldsTest : XCTestCase

diff --git a/...it_tests/ios/RunnerTests/NullFieldsTest.m → .../example/ios/RunnerTests/NullFieldsTest.m b/...it_tests/ios/RunnerTests/NullFieldsTest.m → .../example/ios/RunnerTests/NullFieldsTest.m
@@ -2,10 +2,16 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#import <Flutter/Flutter.h>
-#import <XCTest/XCTest.h>
-#import "EchoMessenger.h"
+@import Flutter;
+@import XCTest;
+
+#ifdef LEGACY_HARNESS
 #import "NullFields.gen.h"
+#else
+@import alternate_language_test_plugin;
+#endif
+
+#import "EchoMessenger.h"
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 @interface NullFieldsSearchRequest ()

diff --git a/...sts/ios/RunnerTests/NullableReturnsTest.m → ...ple/ios/RunnerTests/NullableReturnsTest.m b/...sts/ios/RunnerTests/NullableReturnsTest.m → ...ple/ios/RunnerTests/NullableReturnsTest.m
@@ -2,10 +2,16 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#import <XCTest/XCTest.h>
+@import XCTest;
+
+#ifdef LEGACY_HARNESS
+#import "NullableReturns.gen.h"
+#else
+@import alternate_language_test_plugin;
+#endif
+
 #import "EchoMessenger.h"
 #import "MockBinaryMessenger.h"
-#import "NullableReturns.gen.h"
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 @interface MockNullableArgHostApi : NSObject <NullableArgHostApi>

diff --git a/...nit_tests/ios/RunnerTests/PrimitiveTest.m → ...n/example/ios/RunnerTests/PrimitiveTest.m b/...nit_tests/ios/RunnerTests/PrimitiveTest.m → ...n/example/ios/RunnerTests/PrimitiveTest.m
@@ -2,10 +2,16 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#import <Flutter/Flutter.h>
-#import <XCTest/XCTest.h>
-#import "EchoMessenger.h"
+@import Flutter;
+@import XCTest;
+
+#ifdef LEGACY_HARNESS
 #import "Primitive.gen.h"
+#else
+@import alternate_language_test_plugin;
+#endif
+
+#import "EchoMessenger.h"
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 @interface PrimitiveTest : XCTestCase

diff --git a/..._unit_tests/ios/RunnerTests/RunnerTests.m → ...gin/example/ios/RunnerTests/RunnerTests.m b/..._unit_tests/ios/RunnerTests/RunnerTests.m → ...gin/example/ios/RunnerTests/RunnerTests.m
@@ -2,8 +2,13 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#import <XCTest/XCTest.h>
+@import XCTest;
+
+#ifdef LEGACY_HARNESS
 #import "Message.gen.h"
+#else
+@import alternate_language_test_plugin;
+#endif
 
 @interface ACMessageSearchReply ()
 + (ACMessageSearchReply *)fromMap:(NSDictionary *)dict;

diff --git a/packages/pigeon/platform_tests/alternate_language_test_plugin/ios/Classes/.gitignore b/packages/pigeon/platform_tests/alternate_language_test_plugin/ios/Classes/.gitignore
@@ -0,0 +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.
+*.gen.h
+*.gen.m
diff --git a/...n/platform_tests/alternate_language_test_plugin/ios/Classes/AlternateLanguageTestPlugin.h b/...n/platform_tests/alternate_language_test_plugin/ios/Classes/AlternateLanguageTestPlugin.h
@@ -4,5 +4,8 @@
 
 #import <Flutter/Flutter.h>
 
-@interface AlternateLanguageTestPlugin : NSObject <FlutterPlugin>
+#import "AllDatatypes.gen.h"
+#import "AllVoid.gen.h"
+
+@interface AlternateLanguageTestPlugin : NSObject <FlutterPlugin, AllVoidHostApi, HostEverything>
 @end
diff --git a/...n/platform_tests/alternate_language_test_plugin/ios/Classes/AlternateLanguageTestPlugin.m b/...n/platform_tests/alternate_language_test_plugin/ios/Classes/AlternateLanguageTestPlugin.m
@@ -4,21 +4,36 @@
 
 #import "AlternateLanguageTestPlugin.h"
 
+#import "AllDatatypes.gen.h"
+#import "AllVoid.gen.h"
+
+/**
+ * This plugin is currently a no-op since only unit tests have been set up.
+ * In the future, this will register Pigeon APIs used in integration tests.
+ */
 @implementation AlternateLanguageTestPlugin
 + (void)registerWithRegistrar:(NSObject<FlutterPluginRegistrar> *)registrar {
-  FlutterMethodChannel *channel =
-      [FlutterMethodChannel methodChannelWithName:@"alternate_language_test_plugin"
-                                  binaryMessenger:[registrar messenger]];
-  AlternateLanguageTestPlugin *instance = [[AlternateLanguageTestPlugin alloc] init];
-  [registrar addMethodCallDelegate:instance channel:channel];
+  AlternateLanguageTestPlugin *plugin = [[AlternateLanguageTestPlugin alloc] init];
+  AllVoidHostApiSetup(registrar.messenger, plugin);
+  HostEverythingSetup(registrar.messenger, plugin);
+}
+
+#pragma mark AllVoidHostApi implementation
+
+- (void)doitWithError:(FlutterError *_Nullable *_Nonnull)error {
+  // No-op.
+}
+
+#pragma mark HostEverything implementation
+
+- (nullable Everything *)giveMeEverythingWithError:(FlutterError *_Nullable *_Nonnull)error {
+  // Currently unused in integration tests, so just return an empty object.
+  return [[Everything alloc] init];
 }
 
-- (void)handleMethodCall:(FlutterMethodCall *)call result:(FlutterResult)result {
-  if ([@"getPlatformVersion" isEqualToString:call.method]) {
-    result([@"iOS " stringByAppendingString:[[UIDevice currentDevice] systemVersion]]);
-  } else {
-    result(FlutterMethodNotImplemented);
-  }
+- (nullable Everything *)echoEverything:(Everything *)everything
+                                  error:(FlutterError *_Nullable *_Nonnull)error {
+  return everything;
 }
 
 @end