Skip to content
This repository has been archived by the owner on Sep 4, 2018. It is now read-only.

Commit

Permalink
Small doc update.
Browse files Browse the repository at this point in the history
  • Loading branch information
Rob Holland committed Apr 21, 2010
1 parent fc10478 commit 76502e3
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 20 deletions.
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,4 +1,4 @@
Copyright (c) 2009 Rob Holland
Copyright (c) 2010 Unboxed Consulting

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
Expand Down
37 changes: 18 additions & 19 deletions README.rdoc
Expand Up @@ -3,20 +3,6 @@
iCuke allows you to test an iPhone application with cucumber. It provides a selection of step definitions similar to
those provided for testing web applications.

iCuke provides an XML version of the iPhone's screen and the ability to simulate events such as taps or typing. This
is done via a HTTP interface which iCuke attaches to your application process.

iCuke requires no code changes to your application to work, however, it relies on accessibility information to
function sensibly.

iCuke uses applescript to drive Xcode in order to launch the application into the iPhone Simulator. It is intended
that iCuke will leave your Xcode project configuration (such as active target/configuration) as it found it. Please
let us know if that is not the case.

If your application can be used via the VoiceOver screen reader then iCuke should not have any problems. Please see
the apple documentation on making your application Accessible for more details on how to ensure iCuke will work with
your application.

== Usage

Install the gem and load the iCuke step definitions in a cucumber support file:
Expand All @@ -25,18 +11,31 @@ require 'icuke/cucumber'

Write some scenarios like:

Background:
Given "iCuke" from "app/iCuke/iCuke.xcodeproj" is loaded in the simulator
Background:
Given "iCuke" from "app/iCuke/iCuke.xcodeproj" is loaded in the simulator

Scenario: User views the About screen
When I tap "About"
Then I should see "Author:"

Scenario: User views the About screen
When I tap "About"
Then I should see "Author:"
== How it works

iCuke uses applescript to drive Xcode in order to launch your application into the iPhone Simulator. A preload library
is used to add a HTTP server into your application.

The HTTP server allows us to see an XML version of the iPhone's screen, and to emulate taps/swipes etc.

iCuke should not require any code changes to your application to work, however, it relies on accessibility information
to function sensibly. If your accessibility information is not accurate, iCuke may not work as expected.

== Bugs

iCuke does not currently automate enabling the Accessibility Inspecter, which is required to be running for iCuke to
function. I am still deciding how best to achieve this is in a reliable fashion.

iCuke does not support testing applications on real devices, because I don't know of a way get a preload library to load
on the device.

iCuke does not support drags, scrolling or pinches yet. They'll be here soon!

== Note on Patches/Pull Requests
Expand Down

0 comments on commit 76502e3

Please sign in to comment.