Separate/Restore public test interfaces and internal ones

pull/9247/head
Muxi Yan 8 years ago
parent 14c76cf2c9
commit 8e6aec5ed7
  1. 27
      src/objective-c/GRPCClient/GRPCCall+Tests.h
  2. 43
      src/objective-c/GRPCClient/GRPCCall+Tests.m
  3. 57
      src/objective-c/GRPCClient/internal_testing/GRPCCall+InternalTests.h
  4. 61
      src/objective-c/GRPCClient/internal_testing/GRPCCall+InternalTests.m
  5. 3
      src/objective-c/tests/GRPCClientTests.m
  6. 3
      src/objective-c/tests/InteropTests.m
  7. 3
      src/objective-c/tests/InteropTestsLocalCleartext.m
  8. 3
      src/objective-c/tests/InteropTestsLocalSSL.m
  9. 3
      src/objective-c/tests/InteropTestsRemote.m
  10. 3
      src/objective-c/tests/InteropTestsRemoteWithCronet/InteropTestsRemoteWithCronet.m
  11. 2
      src/objective-c/tests/Podfile

@ -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

@ -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

@ -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

@ -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

@ -37,7 +37,8 @@
#import <GRPCClient/GRPCCall.h>
#import <GRPCClient/GRPCCall+ChannelArg.h>
#import <GRPCClient/GRPCCall+OAuth2.h>
#import <GRPCClient/internal_testing/GRPCCall+Tests.h>
#import <GRPCClient/GRPCCall+Tests.h>
#import <GRPCClient/internal_testing/GRPCCall+InternalTests.h>
#import <ProtoRPC/ProtoMethod.h>
#import <RemoteTest/Messages.pbobjc.h>
#import <RxLibrary/GRXWriteable.h>

@ -37,7 +37,8 @@
#import <Cronet/Cronet.h>
#import <GRPCClient/GRPCCall+ChannelArg.h>
#import <GRPCClient/internal_testing/GRPCCall+Tests.h>
#import <GRPCClient/GRPCCall+Tests.h>
#import <GRPCClient/internal_testing/GRPCCall+InternalTests.h>
#import <GRPCClient/GRPCCall+Cronet.h>
#import <ProtoRPC/ProtoRPC.h>
#import <RemoteTest/Messages.pbobjc.h>

@ -31,7 +31,8 @@
*
*/
#import <GRPCClient/internal_testing/GRPCCall+Tests.h>
#import <GRPCClient/GRPCCall+Tests.h>
#import <GRPCClient/internal_testing/GRPCCall+InternalTests.h>
#import "InteropTests.h"

@ -31,7 +31,8 @@
*
*/
#import <GRPCClient/internal_testing/GRPCCall+Tests.h>
#import <GRPCClient/GRPCCall+Tests.h>
#import <GRPCClient/internal_testing/GRPCCall+InternalTests.h>
#import "InteropTests.h"

@ -31,7 +31,8 @@
*
*/
#import <GRPCClient/internal_testing/GRPCCall+Tests.h>
#import <GRPCClient/GRPCCall+Tests.h>
#import <GRPCClient/internal_testing/GRPCCall+InternalTests.h>
#import "InteropTests.h"

@ -31,7 +31,8 @@
*
*/
#import <GRPCClient/internal_testing/GRPCCall+Tests.h>
#import <GRPCClient/GRPCCall+Tests.h>
#import <GRPCClient/internal_testing/GRPCCall+InternalTests.h>
#import <Cronet/Cronet.h>
#import <GRPCClient/GRPCCall+Cronet.h>

@ -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|

Loading…
Cancel
Save