OCDSpec2 1.5.1

A testing library for Mac or iOS projects, for the obsessive compulsive, like me!

Installation and Setup

OCDSpec is now on CocoaPods! This is makes it far simpler to get started.

Install The Project Templates (one time installation)

The simplest way to get started is to use the provided templates to create a seperate specs target. This requires a one-time install script. Just run:

curl -L https://raw.github.com/OCDSpec/OCDSpec2/master/install_templates.sh | bash

This script does not require administrative permissions, and if it asks for them something is wrong.

Create the spec target

OCDSpec has project templates, for iOS and Mac so you can add a target to your project using the appropriate test runner for your platform. Create a new target and choose the OCDSpec Test Runner appropriate for your platform.

You can name this target whatever you like, I usually name it Specs.

Podfile

Finally add this to your podfile:

target :test do
  link_with '<Your Spec Target Name>'

  pod 'OCDSpec2'
end

After this run a pod install. Now when you build your spec target it will automatically run the tests and fail the build if any tests fail. I like to make my test target a dependency of my main applications target, so my tests fail the build.

Creating your first spec

To create a new spec use the template for a new Spec File, and add it to your spec target:

This will create a file with one failing test.

Running specs

• Choose the spec scheme
• Build (Cmd+B)

If you set the spec target as a dependency of the main target you can just build the main one without switching schemes.

Autocompletion for XCode

Once the podfile is installed you can install XCode autocompletions if you like. This is only needed once on your machine, although you may want to re-run it when you update OCDSpec. Simply run:

curl https://raw.github.com/OCDSpec/OCDSpec2/master/install_autocompletions.sh | bash

Features

• Describe and example blocks
  • Describe blocks can be nested
  • Any describe block can have a before-each and after-each block
  • A context created with OCDSpec2Context is a top-level describe block
• Xcode integration
  • Auto-completion, just type "Desc", "It", "ExpectObj", "ExpectInt", etc.
  • Templates for easy creation of testing targets and spec files
  • Highlights any lines with failed expectations
• Catches exceptions
  • This makes it compatible with OCMock
• Pending

Example spec

#import <OCDSpec2/OCDSpec2.h>

#import "Widget.h"

OCDSpec2Context(WidgetSpec) {

  __block Widget* widget;

  BeforeEach(^{
    widget = [[[Widget alloc] init] autorelease];
  });

  Describe(@"-gadgets", ^{

    It(@"is a non-empty array", ^{
      [ExpectObj(widget.gadgets) toExist];
      [ExpectInt([widget.gadgets count]) toBe: 3];
    });

    It(@"contains gadget instances", ^{
      [ExpectObj([widget.gadgets objectAtIndex:0]) toBeKindOfClass: [Gadget self]];
    });

    It(@"makes lots of money", ^{
      Pending();
    });

  });

}

Assertion/expectation methods

• ExpectObj(id)
  • toBe:(id)other
  • toBeEqualTo:(id)other
  • toExist
  • toBeNil
  • toBeMemberOfClass:(Class)cls
  • toBeKindOfClass:(Class)cls
• ExpectInt(long long)
  • toBe:(long long)other
  • toBeTrue
  • toBeFalse
  • toNotBeFalse
• ExpectFloat(double)
  • toBe:(double)other withPrecision:(double)precision
• ExpectStr(NSString*)
  • toContain:(NSString*)substring
  • toStartWith:(NSString*)substring
• ExpectArray(NSArray*)
  • toContain:(id)obj
• ExpectBlock(void(^)(void))
  • toNotRaiseException
• Pending()
• PendingStr(NSString*)

Running code before tests

To run some code once just before the entire test suite, create a class that conforms to the OCDSPrelude protocol, which just requires a -(void)run method. Here's an example:

#import <UIKit/UIKit.h>
#import <objc/runtime.h>

#import <OCDSpec2/OCDSpec2.h>

NSString* StubbedNibName(void) {
  return nil;
}

@interface ViewPrelude : NSObject<OCDSPrelude>
@end

@implementation ViewPrelude

- (void) run {
  method_setImplementation(class_getInstanceMethod([UIViewController self], @selector(nibName)),
                           (IMP)StubbedNibName);
}

@end

Change log

• 1.5.1
  • CocoaPods
• 1.5
  • Fixed the exit code for the latest iOS changes
• 1.4
  • Added Pending() and PendingStr() which produce warnings instead of errors
• 1.3
  • Added block expectations for noticing exceptions
  • Examples now catch exceptions and report them automatically
  • Changed syntax so it wouldn't clash with OCMock, but it's not backwards compatible
• 1.2
  • BeforeEach, AfterEach, and example blocks (it) are now allowed at the top level of a Context without a describe
  • Describe blocks can be nested now
  • BeforeEach and AfterEach are executed intuitively when nested (in order of depth)
• 1.1.1
  • Added boolean code snippet too
• 1.1
  • Added code snippets
• 1.0
  • Did all the stuff
  • Wrote all the codez

Working on OCDSpec2 itself

• Building the OCDSpec2 scheme will run all the unit tests and the acceptance test
• Make sure you test everything you add
• Make your tests better than my tests

Installing Templates and Autocompletion From Local Repo

cd <OCDSpec2 repo>

./install_templates.sh local
./install_autocompletion.sh local

Credits

• Inspired by Eric Smith's OCDSpec.

License

Copyright (c) 2013 OCDSpec Team

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.