From 8e6aec5ed7d04a19311e8c0d260a02ed5c99dce2 Mon Sep 17 00:00:00 2001 From: Muxi Yan Date: Fri, 10 Feb 2017 09:40:18 -0800 Subject: [PATCH] Separate/Restore public test interfaces and internal ones --- .../{internal_testing => }/GRPCCall+Tests.h | 27 +------- .../{internal_testing => }/GRPCCall+Tests.m | 43 +------------ .../internal_testing/GRPCCall+InternalTests.h | 57 +++++++++++++++++ .../internal_testing/GRPCCall+InternalTests.m | 61 +++++++++++++++++++ src/objective-c/tests/GRPCClientTests.m | 3 +- src/objective-c/tests/InteropTests.m | 3 +- .../tests/InteropTestsLocalCleartext.m | 3 +- src/objective-c/tests/InteropTestsLocalSSL.m | 3 +- src/objective-c/tests/InteropTestsRemote.m | 3 +- .../InteropTestsRemoteWithCronet.m | 3 +- src/objective-c/tests/Podfile | 2 +- 11 files changed, 133 insertions(+), 75 deletions(-) rename src/objective-c/GRPCClient/{internal_testing => }/GRPCCall+Tests.h (69%) rename src/objective-c/GRPCClient/{internal_testing => }/GRPCCall+Tests.m (64%) create mode 100644 src/objective-c/GRPCClient/internal_testing/GRPCCall+InternalTests.h create mode 100644 src/objective-c/GRPCClient/internal_testing/GRPCCall+InternalTests.m diff --git a/src/objective-c/GRPCClient/internal_testing/GRPCCall+Tests.h b/src/objective-c/GRPCClient/GRPCCall+Tests.h similarity index 69% rename from src/objective-c/GRPCClient/internal_testing/GRPCCall+Tests.h rename to src/objective-c/GRPCClient/GRPCCall+Tests.h index 92c718a7493..184ad09c5c8 100644 --- a/src/objective-c/GRPCClient/internal_testing/GRPCCall+Tests.h +++ b/src/objective-c/GRPCClient/GRPCCall+Tests.h @@ -31,7 +31,7 @@ * */ -#import "../GRPCCall.h" +#import "GRPCCall.h" /** * Methods to let tune down the security of gRPC connections for specific hosts. These shouldn't be @@ -45,9 +45,6 @@ * * Must be called before any gRPC call to that host is made. It's illegal to pass the same host to * more than one invocation of the methods of this category. - * - * This function is for internal testing of gRPC only. It is not part of gRPC's public interface. - * Do not use in production. To enable, set the preprocessor flag GRPC_TEST_OBJC. */ + (void)useTestCertsPath:(NSString *)certsPath testName:(NSString *)testName @@ -58,34 +55,12 @@ * * Must be called before any gRPC call to that host is made. It's illegal to pass the same host to * more than one invocation of the methods of this category. - * - * This function is for internal testing of gRPC only. It is not part of gRPC's public interface. - * Do not use in production. To enable, set the preprocessor flag GRPC_TEST_OBJC. */ + (void)useInsecureConnectionsForHost:(NSString *)host; /** * Resets all host configurations to their default values, and flushes all connections from the * cache. - * - * This function is for internal testing of gRPC only. It is not part of gRPC's public interface. - * Do not use in production. To enable, set the preprocessor flag GRPC_TEST_OBJC. */ + (void)resetHostSettings; - -/** - * Enables logging of op batches. Memory consumption increases as more ops are logged. - * - * This function is for internal testing of gRPC only. It is not part of gRPC's public interface. - * Do not use in production. To enable, set the preprocessor flag GRPC_TEST_OBJC. - */ -+ (void)enableOpBatchLog:(BOOL)enabled; - -/** - * Obtain the logged op batches. Invoking this method will clean the log. - * - * This function is for internal testing of gRPC only. It is not part of gRPC's public interface. - * Do not use in production. To enable, set the preprocessor flag GRPC_TEST_OBJC. - */ -+ (NSArray *)obtainAndCleanOpBatchLog; @end diff --git a/src/objective-c/GRPCClient/internal_testing/GRPCCall+Tests.m b/src/objective-c/GRPCClient/GRPCCall+Tests.m similarity index 64% rename from src/objective-c/GRPCClient/internal_testing/GRPCCall+Tests.m rename to src/objective-c/GRPCClient/GRPCCall+Tests.m index 40bd2a9c803..656cba8fec6 100644 --- a/src/objective-c/GRPCClient/internal_testing/GRPCCall+Tests.m +++ b/src/objective-c/GRPCClient/GRPCCall+Tests.m @@ -33,15 +33,13 @@ #import "GRPCCall+Tests.h" -#import "../private/GRPCHost.h" -#import "../private/GRPCOpBatchLog.h" +#import "private/GRPCHost.h" @implementation GRPCCall (Tests) + (void)useTestCertsPath:(NSString *)certsPath testName:(NSString *)testName forHost:(NSString *)host { -#ifdef GRPC_TEST_OBJC if (!host || !certsPath || !testName) { [NSException raise:NSInvalidArgumentException format:@"host, path and name must be provided."]; } @@ -56,53 +54,14 @@ GRPCHost *hostConfig = [GRPCHost hostWithAddress:host]; [hostConfig setTLSPEMRootCerts:certs withPrivateKey:nil withCertChain:nil error:nil]; hostConfig.hostNameOverride = testName; -#else - NSLog(@"This function is for internal testing of gRPC only. " - "It is not part of gRPC's public interface. Do not use in production. " - "To enable, set the preprocessor flag GRPC_TEST_OBJC."); -#endif } + (void)useInsecureConnectionsForHost:(NSString *)host { -#ifdef GRPC_TEST_OBJC GRPCHost *hostConfig = [GRPCHost hostWithAddress:host]; hostConfig.secure = NO; -#else - NSLog(@"This function is for internal testing of gRPC only. " - "It is not part of gRPC's public interface. Do not use in production. " - "To enable, set the preprocessor flag GRPC_TEST_OBJC."); -#endif } + (void)resetHostSettings { -#ifdef GRPC_TEST_OBJC [GRPCHost resetAllHostSettings]; -#else - NSLog(@"This function is for internal testing of gRPC only. " - "It is not part of gRPC's public interface. Do not use in production. " - "To enable, set the preprocessor flag GRPC_TEST_OBJC."); -#endif } - -+ (void)enableOpBatchLog:(BOOL)enabled { -#ifdef GRPC_TEST_OBJC - [GRPCOpBatchLog enableOpBatchLog:enabled]; -#else - NSLog(@"This function is for internal testing of gRPC only. " - "It is not part of gRPC's public interface. Do not use in production. " - "To enable, set the preprocessor flag GRPC_TEST_OBJC."); -#endif -} - -+ (NSArray *)obtainAndCleanOpBatchLog { -#ifdef GRPC_TEST_OBJC - return [GRPCOpBatchLog obtainAndCleanOpBatchLog]; -#else - NSLog(@"This function is for internal testing of gRPC only. " - "It is not part of gRPC's public interface. Do not use in production. " - "To enable, set the preprocessor flag GRPC_TEST_OBJC."); - return nil; -#endif -} - @end diff --git a/src/objective-c/GRPCClient/internal_testing/GRPCCall+InternalTests.h b/src/objective-c/GRPCClient/internal_testing/GRPCCall+InternalTests.h new file mode 100644 index 00000000000..6c12ce6355e --- /dev/null +++ b/src/objective-c/GRPCClient/internal_testing/GRPCCall+InternalTests.h @@ -0,0 +1,57 @@ +/* + * + * Copyright 2017, Google Inc. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following disclaimer + * in the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Google Inc. nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + */ + +#import "../GRPCCall.h" + +/** + * Methods used for gRPC internal tests. DO NOT USE. + */ +@interface GRPCCall (InternalTests) + +/** + * Enables logging of op batches. Memory consumption increases as more ops are logged. + * + * This function is for internal testing of gRPC only. It is not part of gRPC's public interface. + * Do not use in production. To enable, set the preprocessor flag GRPC_TEST_OBJC. + */ ++ (void)enableOpBatchLog:(BOOL)enabled; + +/** + * Obtain the logged op batches. Invoking this method will clean the log. + * + * This function is for internal testing of gRPC only. It is not part of gRPC's public interface. + * Do not use in production. To enable, set the preprocessor flag GRPC_TEST_OBJC. + */ ++ (NSArray *)obtainAndCleanOpBatchLog; + +@end diff --git a/src/objective-c/GRPCClient/internal_testing/GRPCCall+InternalTests.m b/src/objective-c/GRPCClient/internal_testing/GRPCCall+InternalTests.m new file mode 100644 index 00000000000..43c1c078316 --- /dev/null +++ b/src/objective-c/GRPCClient/internal_testing/GRPCCall+InternalTests.m @@ -0,0 +1,61 @@ +/* + * + * Copyright 2017, Google Inc. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following disclaimer + * in the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Google Inc. nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + */ + +#import "GRPCCall+InternalTests.h" + +#import "../private/GRPCOpBatchLog.h" + +@implementation GRPCCall (InternalTests) + ++ (void)enableOpBatchLog:(BOOL)enabled { +#ifdef GRPC_TEST_OBJC + [GRPCOpBatchLog enableOpBatchLog:enabled]; +#else + NSLog(@"This function is for internal testing of gRPC only. " + "It is not part of gRPC's public interface. Do not use in production. " + "To enable, set the preprocessor flag GRPC_TEST_OBJC."); +#endif +} + ++ (NSArray *)obtainAndCleanOpBatchLog { +#ifdef GRPC_TEST_OBJC + return [GRPCOpBatchLog obtainAndCleanOpBatchLog]; +#else + NSLog(@"This function is for internal testing of gRPC only. " + "It is not part of gRPC's public interface. Do not use in production. " + "To enable, set the preprocessor flag GRPC_TEST_OBJC."); + return nil; +#endif +} + +@end diff --git a/src/objective-c/tests/GRPCClientTests.m b/src/objective-c/tests/GRPCClientTests.m index a1bb835e5d4..76c15003f60 100644 --- a/src/objective-c/tests/GRPCClientTests.m +++ b/src/objective-c/tests/GRPCClientTests.m @@ -37,7 +37,8 @@ #import #import #import -#import +#import +#import #import #import #import diff --git a/src/objective-c/tests/InteropTests.m b/src/objective-c/tests/InteropTests.m index 592dca9dde5..4e5a5287c2f 100644 --- a/src/objective-c/tests/InteropTests.m +++ b/src/objective-c/tests/InteropTests.m @@ -37,7 +37,8 @@ #import #import -#import +#import +#import #import #import #import diff --git a/src/objective-c/tests/InteropTestsLocalCleartext.m b/src/objective-c/tests/InteropTestsLocalCleartext.m index 6e7624e2046..0b8a0e47756 100644 --- a/src/objective-c/tests/InteropTestsLocalCleartext.m +++ b/src/objective-c/tests/InteropTestsLocalCleartext.m @@ -31,7 +31,8 @@ * */ -#import +#import +#import #import "InteropTests.h" diff --git a/src/objective-c/tests/InteropTestsLocalSSL.m b/src/objective-c/tests/InteropTestsLocalSSL.m index 12007bbd681..d974c2db27b 100644 --- a/src/objective-c/tests/InteropTestsLocalSSL.m +++ b/src/objective-c/tests/InteropTestsLocalSSL.m @@ -31,7 +31,8 @@ * */ -#import +#import +#import #import "InteropTests.h" diff --git a/src/objective-c/tests/InteropTestsRemote.m b/src/objective-c/tests/InteropTestsRemote.m index b0a64a3caed..ad7efebc81c 100644 --- a/src/objective-c/tests/InteropTestsRemote.m +++ b/src/objective-c/tests/InteropTestsRemote.m @@ -31,7 +31,8 @@ * */ -#import +#import +#import #import "InteropTests.h" diff --git a/src/objective-c/tests/InteropTestsRemoteWithCronet/InteropTestsRemoteWithCronet.m b/src/objective-c/tests/InteropTestsRemoteWithCronet/InteropTestsRemoteWithCronet.m index c8742b7fe8c..660865abb44 100644 --- a/src/objective-c/tests/InteropTestsRemoteWithCronet/InteropTestsRemoteWithCronet.m +++ b/src/objective-c/tests/InteropTestsRemoteWithCronet/InteropTestsRemoteWithCronet.m @@ -31,7 +31,8 @@ * */ -#import +#import +#import #import #import diff --git a/src/objective-c/tests/Podfile b/src/objective-c/tests/Podfile index 5ada61c3d40..941031ff88e 100644 --- a/src/objective-c/tests/Podfile +++ b/src/objective-c/tests/Podfile @@ -103,7 +103,7 @@ post_install do |installer| # Activate Cronet for the dedicated build configuration 'Cronet', which will be used solely by # the test target 'InteropTestsRemoteWithCronet' - # Activate GRPCCall+Tests functions for the dedicated build configuration 'Test', which will + # Activate GRPCCall+InternalTests functions for the dedicated build configuration 'Test', which will # be used by all test targets using it. if target.name == 'gRPC' target.build_configurations.each do |config|