https://github.com/macmade/gmock-xcode

Xcode integration for GoogleMock through XCTest
https://github.com/macmade/gmock-xcode

c-plus-plus gmock google-test googlemock googlemock-test gtest integration test testing testing-tools xcode xcodebuild xctest

Last synced: 6 months ago
JSON representation

Xcode integration for GoogleMock through XCTest

• Host: GitHub
• URL: https://github.com/macmade/gmock-xcode
• Owner: macmade
• License: mit
• Created: 2015-01-13T21:43:13.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2023-02-24T10:22:50.000Z (over 2 years ago)
• Last Synced: 2025-03-29T08:11:24.643Z (7 months ago)
• Topics: c-plus-plus, gmock, google-test, googlemock, googlemock-test, gtest, integration, test, testing, testing-tools, xcode, xcodebuild, xctest
• Language: C++
• Size: 3.29 MB
• Stars: 22
• Watchers: 4
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
GoogleMock - Xcode

==================

[![Build Status](https://img.shields.io/github/actions/workflow/status/macmade/gmock-xcode/ci-mac.yaml?label=macOS&logo=apple)](https://github.com/macmade/gmock-xcode/actions/workflows/ci-mac.yaml)

[![Issues](http://img.shields.io/github/issues/macmade/gmock-xcode.svg?logo=github)](https://github.com/macmade/gmock-xcode/issues)

![Status](https://img.shields.io/badge/status-legacy-red.svg?logo=git)

![License](https://img.shields.io/badge/license-mit-brightgreen.svg?logo=open-source-initiative)  

[![Contact](https://img.shields.io/badge/follow-@macmade-blue.svg?logo=twitter&style=social)](https://twitter.com/macmade)

[![Sponsor](https://img.shields.io/badge/sponsor-macmade-pink.svg?logo=github-sponsors&style=social)](https://github.com/sponsors/macmade)

About

-----

This project consists of an integration of the GoogleMock library to Apple's Xcode IDE.

Since version 5, Xcode provides a nice way to write unit tests with the `XCTest` framework.  

Unit tests written with `XCTest` are integrated to the IDE, providing visual feedback when running tests. They are also integrated with the different build toolchains, like `xcodebuild` or Facebook's `xctool`.

It was specifially designed for Objective-C, writing unit tests for other languages (such as C++) is not so great with `XCTest`. 

Of course, this is possible using Objective-C++, but writing an Objective-C class for each C++ test case leads to some undesired overhead.

GoogleMock is nice unit testing library for C++. The only issue is that it does not integrate well with Xcode, as does `XCTest`.  

This mean the IDE won't provide visual feedback for the unit tests written with GoogleMock, and you'll have to look at the console output to inspect any failed test.

So this project fixes this issue by bridging GoogleMock to `XCTest`.

### Implementation details

`XCTest` works by analysing test classes at runtime, thanks to Objective-C dynamic nature.  

Basically, when the test bundle is loaded, it will look for all classes extending `XCTestCase`, and look for methods beginning with the `test` prefix.

If such a class is available, it will then create an instance, and launch each test method, reporting the result to the IDE.

This project consists of a framework which has to be linked to the unit test bundle. The framework includes GoogleMock, so you don't have to build it by yourself.

It works by querying each GoogleMock test case. For each one, a specific subclass of `XCTestCase` will be dynamically created at runtime.  

For each test in a test case, an Objective-C method will be created and added to the `XCTestCase` subclass.

The GoogleMock test cases are then run, reporting the usual output to the console.

Then, as we created new classes compatible with `XCTest`, it will find them, and run them as usual.  

Each method will simply look at the GoogleMock test result, and report the status using `XCTest` assertions, so we got visual feedback, as if we had written our test cases using `XCTest`.

Project Configuration

---------------------

In order to use these features, your unit test bundle needs to be linked to the provided frameworks.

The easiest way to do this is to include the provided Xcode project (`GoogleMock.xcodeproj`) as a subproject of your own Xcode project, so all targets are available.

Then, from the `Build Phases` screen of your unit test's target, add the following frameworks to the `Target Dependancies` step:

 * GoogleMock

Adds the same frameworks to the `Link Binary With Libraries` step, and you're done.  

Your unit test bundle is now ready to use GoogleMock.

Writing tests

-------------

Writing GoogleMock tests is also straightforward.  

Simply include `` to your `.cpp` file, and write your tests as usual.

For instance:

    #include 

    

    using namespace testing;

    

    TEST( MyTestCase, MyTest )

    {

        ASSERT_TRUE( true );

    }

In the above example, a subclass of `XCTestCase` named `MyTestCase` will be created at runtime, with a test method called `testMyTest`, so you can easily inspect the results of your GoogleMock tests directly from the Xcode tests tab.

License

-------

The GoogleMock Xcode integration library is released under the terms of the MIT License.

Repository Infos

----------------

    Owner:			Jean-David Gadina - XS-Labs

    Web:			www.xs-labs.com

    Blog:			www.noxeos.com

    Twitter:		@macmade

    GitHub:			github.com/macmade

    LinkedIn:		ch.linkedin.com/in/macmade/

    StackOverflow:	stackoverflow.com/users/182676/macmade