aboutsummaryrefslogtreecommitdiff
path: root/UnitTesting/GTMGoogleTestRunner.mm
blob: 5bc1d5f37a106dd8179799f91842fce72ac72664 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
//
//  GTMGoogleTestRunner.mm
//
//  Copyright 2013 Google Inc.
//
//  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.
//

#if !defined(__has_feature) || !__has_feature(objc_arc)
#error "This file requires ARC support."
#endif

// This is a SenTest/XCTest based unit test that will run all of the GoogleTest
// https://code.google.com/p/googletest/
// based tests in the project, and will report results correctly via SenTest so
// that Xcode can pick them up in it's UI.

// SenTest dynamically creates one SenTest per GoogleTest.
// GoogleTest is set up using a custom event listener (GoogleTestPrinter)
// which knows how to log GoogleTest test results in a manner that SenTest (and
// the Xcode IDE) understand.

// Note that this does not able you to control individual tests from the Xcode
// UI. You can only turn on/off all of the C++ tests. It does however give
// you output that you can click on in the Xcode UI and immediately jump to a
// test failure.

// This class is not compiled as part of the standard Google Toolbox For Mac
// project because of it's dependency on https://code.google.com/p/googletest/

// To use this:
// - If you are using XCTest (vs SenTest) make sure to define GTM_USING_XCTEST
//   in the settings for your testing bundle.
// - Add GTMGoogleTestRunner to your test bundle sources.
// - Add gtest-all.cc from gtest to your test bundle sources.
// - Write some C++ tests and add them to your test bundle sources.
// - Build and run tests. Your C++ tests should just execute.

#if GTM_USING_XCTEST
#import <XCTest/XCTest.h>
#define SenTestCase XCTestCase
#define SenTestSuite XCTestSuite
#else  // GTM_USING_XCTEST
#import <SenTestingKit/SenTestingKit.h>
#endif  // GTM_USING_XCTEST

#include "third_party/gtest/include/gtest/gtest.h"

using ::testing::EmptyTestEventListener;
using ::testing::TestCase;
using ::testing::TestEventListeners;
using ::testing::TestInfo;
using ::testing::TestPartResult;
using ::testing::TestResult;
using ::testing::UnitTest;

namespace {

// A gtest printer that takes care of reporting gtest results via the
// SenTest interface. Note that a test suite in SenTest == a test case in gtest
// and a test case in SenTest == a test in gtest.
// This will handle fatal and non-fatal gtests properly.
class GoogleTestPrinter : public EmptyTestEventListener {
 public:
  GoogleTestPrinter(SenTestCase *test_case) : test_case_(test_case) {}
  
  virtual ~GoogleTestPrinter() {}

  virtual void OnTestPartResult(const TestPartResult &test_part_result) {
    if (!test_part_result.passed()) {
      NSString *file = @(test_part_result.file_name());
      int line = test_part_result.line_number();
      NSString *summary = @(test_part_result.summary());

      // gtest likes to give multi-line summaries. These don't look good in
      // the Xcode UI, so we clean them up.
      NSString *oneLineSummary =
          [summary stringByReplacingOccurrencesOfString:@"\n" withString:@" "];
#if GTM_USING_XCTEST
      BOOL expected = test_part_result.nonfatally_failed();
      [test_case_ recordFailureWithDescription:oneLineSummary
                                        inFile:file
                                        atLine:line
                                      expected:expected];
#else  // GTM_USING_XCTEST
      NSException *exception =
          [NSException failureInFile:file
                              atLine:line
                     withDescription:@"%@", oneLineSummary];

      // failWithException: will log appropriately.
      [test_case_ failWithException:exception];
#endif  // GTM_USING_XCTEST
    }
  }

 private:
  SenTestCase *test_case_;
};

}  // namespace

// GTMGoogleTestRunner is a GTMTestCase that makes a sub test suite populated
// with all of the GoogleTest unit tests.
@interface GTMGoogleTestRunner : SenTestCase {
  NSString *testName_;
}

// The name for a test is the GoogleTest name which is "TestCase.Test"
- (id)initWithName:(NSString *)testName;
@end

@implementation GTMGoogleTestRunner

+ (id)defaultTestSuite {
  int argc = 0;
  char *argv = NULL;

  // Initialize GoogleTest with no values.
  testing::InitGoogleTest(&argc, &argv);
  SenTestSuite *result =
      [[SenTestSuite alloc] initWithName:NSStringFromClass(self)];
  UnitTest *test = UnitTest::GetInstance();

  // Walk the GoogleTest tests, adding sub tests and sub suites as appropriate.
  int total_test_case_count = test->total_test_case_count();
  for (int i = 0; i < total_test_case_count; ++i) {
    const TestCase *test_case = test->GetTestCase(i);
    int total_test_count = test_case->total_test_count();
    SenTestSuite *subSuite =
        [[SenTestSuite alloc] initWithName:@(test_case->name())];
    [result addTest:subSuite];
    for (int j = 0; j < total_test_count; ++j) {
      const TestInfo *test_info = test_case->GetTestInfo(j);
      NSString *testName = [NSString stringWithFormat:@"%s.%s",
                            test_case->name(), test_info->name()];
      SenTestCase *senTest = [[self alloc] initWithName:testName];
      [subSuite addTest:senTest];
    }
  }
  return result;
}

- (id)initWithName:(NSString *)testName {
  if ((self = [super initWithSelector:@selector(runGoogleTest)])) {
    testName_ = testName;
  }
  return self;
}

- (NSString *)name {
  // A SenTest name must be "-[foo bar]" or it won't be parsed properly.
  NSRange dot = [testName_ rangeOfString:@"."];
  return [NSString stringWithFormat:@"-[%@ %@]",
          [testName_ substringToIndex:dot.location],
          [testName_ substringFromIndex:dot.location + 1]];
}

- (void)runGoogleTest {
  // Initialize GoogleTest with no values.
  int argc = 0;
  char *argv = NULL;
  testing::InitGoogleTest(&argc, &argv);

  // Gets hold of the event listener list.
  TestEventListeners& listeners = UnitTest::GetInstance()->listeners();

  // Adds a listener to the end. Google Test takes the ownership.
  listeners.Append(new GoogleTestPrinter(self));

  // Remove the default printer.
  delete listeners.Release(listeners.default_result_printer());

  // Since there is no way of running a single GoogleTest directly, we use the
  // filter mechanism in GoogleTest to simulate it for us.
  ::testing::GTEST_FLAG(filter) = [testName_ UTF8String];

  // Intentionally ignore return value of RUN_ALL_TESTS. We will be printing
  // the output appropriately, and there is no reason to mark this test as
  // "failed" if RUN_ALL_TESTS returns non-zero.
  (void)RUN_ALL_TESTS();
}

@end