src/objective-c/tests/TestBase.h

/*
 *
 * Copyright 2019 gRPC authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

#import <XCTest/XCTest.h>

#import <GRPCClient/GRPCTypes.h>

/**
 * This is an abstract class that needs to be subclassed. See |+host|.
 */
@interface TestBase : XCTestCase
/**
 * The test suite to run, checking if the current XCTestCase instance is the base class.
 * If so, run no tests (disabled). Otherwise, proceed to normal execution.
 */
@property(class, readonly) XCTestSuite *defaultTestSuite;

/**
 * Host to send the RPCs to. The base implementation returns nil, which would make all tests to
 * fail.
 * Override in a subclass to perform these tests against a specific address.
 */
+ (NSString *)host;

/**
 * Bytes of overhead of test proto responses due to encoding. This is used to exercise the behavior
 * when responses are just above or below the max response size. For some reason, the local and
 * remote servers enconde responses with different overhead (?), so this is defined per-subclass.
 */
- (int32_t)encodingOverhead;

/*
 * The transport to be used. The base implementation returns NULL. Subclasses should override to
 * appropriate settings.
 */
+ (GRPCTransportID)transport;

/**
 * The root certificates to be used. The base implementation returns nil. Subclasses should override
 * to appropriate settings.
 */
+ (NSString *)PEMRootCertificates;

/**
 * The host name to be used for TLS verification in the tests.
 */
+ (NSString *)hostNameOverride;

/**
 * Indication of whether the test is connecting to a remote server.
 */
+ (BOOL)isRemoteTest;

@end