Xcode: TEST vs DEBUG preprocessor macros
Preprocessor macros will not work, you need to check the environment at runtime.
Objective-c
static BOOL isRunningTests(void)
{
NSDictionary* environment = [[NSProcessInfo processInfo] environment];
return (environment[@"XCTestConfigurationFilePath"] != nil);
}
Swift
var unitTesting : Bool
{
return ProcessInfo.processInfo.environment["XCTestConfigurationFilePath"] != nil
}
(Updated for Xcode 11)
You might consider adding a new build configuration.
In xcode 4, click on your project on the left hand navigator.
In the main window, click on your project, and then select the "info" tab.
Click the "+" button to add a new configuration (you can call yours "test" if you like").
Now, click on your target, and go to the build settings tab.
Search for "preprocessor macros"
Here, you can add preprocessor macros for your new build configuration.
Just double click on your new "test" configuration, and add TESTING=1.
Finally, edit your build scheme. Select the test options for your scheme. There should be a "Build Configuration" drop down menu. Select your "test" configuration.
Instead of creating a Test build configuration, I:
-
created a
Tests-Prefix.pch
file:#define TEST 1 #import <SenTestingKit/SenTestingKit.h> #import "CocoaPlant-Prefix.pch"
entered its path in the Prefix Header field of the Tests target's build settings.
-
added the following code to the top of a file I created called
MyAppDefines.h
, imported inMyApp-Prefix.pch
:#ifdef TEST #define TEST_CLASS NSClassFromString(@"AppDelegateTests") // any test class #define BUNDLE [NSBundle bundleForClass:TEST_CLASS] #define APP_NAME @"Tests" #else #define BUNDLE [NSBundle mainBundle] #define APP_NAME [[BUNDLE infoDictionary] objectForKey:(NSString *)kCFBundleNameKey] #endif
This allows me to use BUNDLE
where ever I mean [NSBundle mainBundle]
and also have it work when I run Tests.
Importing SenTestingKit in Tests-Prefix.pch
also speeds up the compiling of the SenTestingKit Framework and allows me to leave out #import <SenTestingKit/SenTestingKit.h>
from the top of all the tests files.
I decided to add a check for an environment variable in the code itself, instead of using the isRunningTests() suggestion Robert made.
- Edit the current Scheme (Product/Scheme/Edit Scheme) or Command+<
- Click on the Test configuration
- Click on Arguments Uncheck "Use the Run action's arguments and environment variables
- Expand Environment Variable section and add the variable TESTING with value YES
- Add this to your code somewhere and call is whenever you need to:
+ (BOOL) isTesting { NSDictionary* environment = [[NSProcessInfo processInfo] environment]; return [environment objectForKey:@"TESTING"] != nil; }
The screen should look like this when you are done.
The code above will find the TESTING environment variable when running in test mode or application mode. This code goes in your application, not the unit test files. You can use
#ifdef DEBUG
...
#endif
To prevent the code from being executed in production.
If you create a Test build configuration and then set the "Other Swift Flags" property of your Target to "-DTEST" it will define a TEST macro that will work in your swift code. Make sure you set it in the build settings of your App target so that you can use it in your App's Swift code.
Then with this set, you can test your code like so:
func testMacro() {
#if !TEST
// skipping over this block of code for unit tests
#endif
}