cukunity 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,15 @@
+source 'http://rubygems.org'
+
+gem 'json', '>= 1.6.5'
+gem 'term-ansicolor', '>= 1.0.6'
+
+group :development do
+  gem 'rspec', '~> 2.8.0'
+  gem 'yard', '~> 0.7'
+  gem 'rdoc', '~> 3.12'
+  gem 'cucumber', '>= 0'
+  gem 'bundler', '~> 1.0.0'
+  gem 'jeweler', '~> 1.8.3'
+  gem 'reek', '~> 1.2.8'
+  gem 'roodi', '~> 2.1.0'
+end

data/Gemfile.lock

@@ -0,0 +1,60 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.0.0)
+    cucumber (1.1.4)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (~> 2.7.1)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.6)
+    diff-lcs (1.1.3)
+    gherkin (2.7.6)
+      json (>= 1.4.6)
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.5)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    reek (1.2.8)
+      ruby2ruby (~> 1.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    roodi (2.1.0)
+      ruby_parser
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    ruby2ruby (1.3.1)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.3.1)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.10)
+    term-ansicolor (1.0.7)
+    yard (0.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  cucumber
+  jeweler (~> 1.8.3)
+  json (>= 1.6.5)
+  rdoc (~> 3.12)
+  reek (~> 1.2.8)
+  roodi (~> 2.1.0)
+  rspec (~> 2.8.0)
+  term-ansicolor (>= 1.0.6)
+  yard (~> 0.7)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Mario Freitas
+
+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.

data/README.md

@@ -0,0 +1,214 @@
+cukunity
+========
+
+cukunity is an automation/testing framework that simplifies BDD testing of
+UNITY 3D games.
+
+## Description
+
+cukunity is a tool inspired by the principles of Behaviour Driven Development.
+Cukunity is a portmanteau of "Cucumber" and "Unity", and as so it provides
+helpers to play nicely with cucumber, although it can be used standalone for
+automation purposes.
+
+In short, cukunity provides:
+
+* A platform-agnostic API to install, uninstall, and execute Unity3D games on real hardware (no simulators or emulators required).
+* A platform-agnostic API for simulating touch and keyboard input on your Unity3D games.
+* The `cukunity` executable to help you bootstrap your Unity3D Projects, and so on.
+* Default step definitions and helpers for Cucumber.
+* Default rake tasks with which you can run Cucumber easily from.
+
+## Limitations
+
+Currently, the following limitations apply:
+
+* Only Android 2.x and iOS 5.x are supported (in the future, it would be nice to have more platforms like Desktop/Flash/WebPlayer).
+* iOS testing is only possible on MacOSX (since Xcode only runs on MacOSX).
+* Currently, iOS testing will only work if you check the "Development Build" setting on the Build Settings window of your Unity project.
+* Android testing is currently only possible on MacOSX, although this may change in the future with the inclusion of Windows/Linux (don't take this as a promise).
+
+## Requirements
+
+* Ruby 1.9.x (you probably want to install it via [RVM](http://beginrescueend.com)).
+* To use cukunity with cucumber, you need to install cucumber (e.g. `gem install cucumber`)
+* Mac OS X 10.6 and above (tested on Snow Leopard but should work on Lion too).
+* To test on iOS devices, you need [XCode
+* 4.2](https://developer.apple.com/xcode/) or above (including the iOS SDK) and [mobiledevice](https://github.com/imkira/mobiledevice).
+* To test on Android devices, you need [Android SDK](http://developer.android.com/sdk/) including the platform-tools package.
+
+## Installation
+
+In order to install cukunity, first make sure you have Ruby 1.9.x installed, and then type the following:
+
+```
+gem install cukunity
+```
+
+If you prefer to live on the edge, get and install the latest code from the repository:
+
+```
+git clone git://github.com/imkira/cukunity.git
+cd cukunity
+rake install
+```
+
+## Usage
+
+```
+Usage: cukunity [options] <command>
+
+Commands:
+doctor              Check your system for the required platform tools.
+bootstrap <path>    Bootstrap your Unity project.
+features [<path>]   Run cucumber against path containing feature files.
+
+Options:
+    -v, --[no-]verbose               Enable/Disable verbose mode.
+        --[no-]android               Enable/Disable for Android development.
+        --[no-]ios                   Enable/Disable for Android development.
+    -h, --help                       This help screen.
+```
+
+### Checking your system for problems
+
+After you install cukunity, please make sure you run `cukunity doctor`
+to check your system for problems.
+This command will check if you have the necessary tools in order to use
+cukunity for iOS/Android testing. You can also pass `no-ios` or `no-android`
+if you don't plan on testing on such platform.
+
+### Bootstraping your cukunity project
+
+To bootstrap cukunity, make sure you type the following:
+
+```
+cukunity bootstrap <path/to/your/Unity/project's/root/directory>
+```
+
+This will generate the necessary files within `Assets/Plugins`.
+After this, please make sure you drag and drop a prefab called `CukunityInstance.prefab`
+on to the first scene of your Unity3D project. You don't need to worry about
+what happens to the prefab you just dragged when loading other scenes, or to
+place it in every scene of your project. That has already been taken care of!
+
+Finally, just rebuild your Unity3D project for Android/iOS (for iOS, make sure
+you check the "Development Build" setting on the Build Settings window of your
+Unity project).
+
+### Running your cukunity features with cucumber
+
+As an utility command, you can run your cukunity features via cucumber with:
+
+```
+cukunity features <path/to/your/cucumber/features/directory>
+```
+
+This command will `require 'cukunity/cucumber'` automatically for you,
+and launch cucumber with the specified features directory as test input.
+You will need to specify either `no-ios` or `no-android` to disable
+testing on the specified platform.
+
+## Default Step Definitions
+
+The following list of step definitions is already available via `cukunity features`
+command (alternatively `require 'cukunity/cucumber'`), so you don't need to
+make a copy to yourself. It may find it useful though to use it as reference or
+to modify it to suit your needs.
+
+* [Installing your Game](http://github.com/imkira/cukunity/blob/master/lib/cukunity/cucumber/step_definitions/install_steps.rb)
+* [Launching your Game](http://github.com/imkira/cukunity/blob/master/lib/cukunity/cucumber/step_definitions/install_steps.rb)
+* [Get Current Scene Information](http://github.com/imkira/cukunity/blob/master/lib/cukunity/cucumber/step_definitions/get_scene_command_steps.rb)
+* [Keyboard Input Simulation](http://github.com/imkira/cukunity/blob/master/lib/cukunity/cucumber/step_definitions/keyboard_input_steps.rb)
+* [Touch Input Simulation](http://github.com/imkira/cukunity/blob/master/lib/cukunity/cucumber/step_definitions/touch_input_steps.rb)
+* [Visible Object Selectors](http://github.com/imkira/cukunity/blob/master/lib/cukunity/cucumber/step_definitions/select_visible_steps.rb)
+* [Force Load Unity Level](http://github.com/imkira/cukunity/blob/master/lib/cukunity/cucumber/step_definitions/load_level_command_steps.rb)
+
+### i18n Support
+
+[i18n](http://github.com/imkira/cukunity/blob/master/lib/cukunity/cucumber/step_definitions/i18n) support is also available.
+Currently [Japanese](http://github.com/imkira/cukunity/blob/master/lib/cukunity/cucumber/step_definitions/i18n/ja) language is supported.
+
+## Sample Scenarios
+
+The following is a sample of how you could use cukunity with Cucumber to
+test a "Sokoban" game.
+
+```
+Feature: Cukunity's Default Step Definitions Sample
+  In order to test Unity games using cukunity without having to reinvent the wheel
+  As a programmer
+  I want to be able to use cukunity's default step definitions
+
+  Background:
+    # Specify fixtures/sokoban.apk (Android) or fixtures/sokoban.app (iOS) as the target game. 
+    Given I install the app "fixtures/sokoban"
+    # launch it on device
+    And I launch it
+    # You probably don't need this, but this will cause an Application.LoadLevel of "demo_title" level.
+    And I load the "demo_title" level
+
+  Scenario: Application finished launching
+    # Verbose: make sure it is running.
+    Then it should be running
+    # Verbose: make sure the "demo_title" level is running.
+    And it should be playing "demo_title" level
+    # Make sure "MainMenu" GameObject exists.
+    And I should have a GameObject named "MainMenu"
+    # Make sure "OptionsMenu" GameObject does not exist.
+    And I should not have a GameObject named "OptionsMenu"
+
+  Scenario: Clear game
+    # Tap the visible GameObject called "Play"
+    When I tap "Play"
+    # Tap the visible GameObject called "Up"
+    And I tap "Up"
+    # <ommited for simplicity>
+    # A GameObject called "GameClear" should be visible.
+    Then I should see "GameClear"
+    # A label showing it took us "40" steps should be visible.
+    And I should read "40"
+
+  Scenario: Set player name 
+    # Tap the visible GameObject called "PlayerName"
+    When I tap "PlayerName"
+    # When the keyboard is displayed on screen, type "Super Player".
+    And I type "Super Player"
+    # Then, there should be a label showing the current player's name.
+    Then I should read "Super Player"
+
+  Scenario: Quit application by tap the "Quit" menu button
+    # Tap a visible GameObject called "Quit"
+    When I tap "Quit" and wait 3 seconds
+    # The application should not be running anymore.
+    Then it should not be running
+```
+
+The original Unity project that includes the code of the game and cukunity support
+is available [here](http://github.com/imkira/cukunity/blob/master/Unity).
+The sample feature files can be found [here](http://github.com/imkira/cukunity/blob/master/features).
+
+## Documentation
+
+TODO: place link to documentation.
+
+## Tutorial
+
+TODO: place video here.
+
+## Contribute
+
+* Found a bug?
+* Want to contribute and add a new feature?
+
+Please fork this project and send me a pull request!
+
+## License
+
+cukunity is licensed under the MIT license:
+
+www.opensource.org/licenses/MIT
+
+## Copyright
+
+Copyright (c) 2012 Mario Freitas. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "cukunity"
+  gem.homepage = "http://github.com/imkira/cukunity"
+  gem.license = "MIT"
+  gem.summary = %Q{cukunity is an automation/testing framework that simplifies BDD testing of Unity 3D games.}
+  gem.description = %Q{cukunity is a tool inspired by the principles of Behaviour Driven Development. Cukunity is a portmanteau of "Cucumber" and "Unity", and as so it provides helpers to play nicely with cucumber, although it can be used standalone for automation. }
+  gem.email = "imkira@gmail.com"
+  gem.authors = ["Mario Freitas"]
+  # dependencies defined in Gemfile
+  gem.add_dependency 'json', '>= 1.6.5'
+  gem.add_dependency 'term-ansicolor', '>= 1.0.6'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'cucumber/rake/task'
+namespace :features do
+  load File.join(File.dirname(__FILE__), 'lib/cukunity/tasks/cucumber.rake')
+end
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+require 'roodi'
+require 'roodi_task'
+RoodiTask.new do |t|
+  t.verbose = false
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/Unity/Assets/Demo/Art/Buttons/down.png.meta

@@ -0,0 +1,28 @@
+fileFormatVersion: 1
+guid: dea5ec1f7cfa140208966f1ae39f30e8
+TextureImporter:
+  importerVersion: 2
+  maxTextureSize: 1024
+  textureFormat: -3
+  grayscaleToAlpha: 0
+  npotScale: 0
+  generateCubemap: 0
+  isReadable: 0
+  textureType: 2
+  mipmaps:
+    generation: 0
+    correctGamma: 0
+    border: 0
+    filter: 0
+    fadeout: 0
+    fadeoutStart: 1
+    fadeoutEnd: 3
+  bumpmap:
+    generation: 0
+    bumpyness: 0.25
+    filter: 0
+  textureSettings:
+    filterMode: 0
+    anisoLevel: 1
+    mipmapBias: -1
+    wrapMode: 1

data/Unity/Assets/Demo/Art/Buttons/left.png.meta

@@ -0,0 +1,28 @@
+fileFormatVersion: 1
+guid: a5e3c7cddeac8434390c49b4554ad4de
+TextureImporter:
+  importerVersion: 2
+  maxTextureSize: 1024
+  textureFormat: -3
+  grayscaleToAlpha: 0
+  npotScale: 0
+  generateCubemap: 0
+  isReadable: 0
+  textureType: 2
+  mipmaps:
+    generation: 0
+    correctGamma: 0
+    border: 0
+    filter: 0
+    fadeout: 0
+    fadeoutStart: 1
+    fadeoutEnd: 3
+  bumpmap:
+    generation: 0
+    bumpyness: 0.25
+    filter: 0
+  textureSettings:
+    filterMode: 0
+    anisoLevel: 1
+    mipmapBias: -1
+    wrapMode: 1

data/Unity/Assets/Demo/Art/Buttons/ok.png.meta

@@ -0,0 +1,28 @@
+fileFormatVersion: 1
+guid: 294d9cfd510f448c48bffb15830d65c5
+TextureImporter:
+  importerVersion: 2
+  maxTextureSize: 1024
+  textureFormat: -3
+  grayscaleToAlpha: 0
+  npotScale: 0
+  generateCubemap: 0
+  isReadable: 0
+  textureType: 2
+  mipmaps:
+    generation: 0
+    correctGamma: 0
+    border: 0
+    filter: 0
+    fadeout: 0
+    fadeoutStart: 1
+    fadeoutEnd: 3
+  bumpmap:
+    generation: 0
+    bumpyness: 0.25
+    filter: 0
+  textureSettings:
+    filterMode: 0
+    anisoLevel: 1
+    mipmapBias: -1
+    wrapMode: 1

data/Unity/Assets/Demo/Art/Buttons/options.png.meta

@@ -0,0 +1,28 @@
+fileFormatVersion: 1
+guid: b9ce92f88c5054551a419c3dc96f9154
+TextureImporter:
+  importerVersion: 2
+  maxTextureSize: 1024
+  textureFormat: -3
+  grayscaleToAlpha: 0
+  npotScale: 0
+  generateCubemap: 0
+  isReadable: 0
+  textureType: 2
+  mipmaps:
+    generation: 0
+    correctGamma: 0
+    border: 0
+    filter: 0
+    fadeout: 0
+    fadeoutStart: 1
+    fadeoutEnd: 3
+  bumpmap:
+    generation: 0
+    bumpyness: 0.25
+    filter: 0
+  textureSettings:
+    filterMode: 0
+    anisoLevel: 1
+    mipmapBias: -1
+    wrapMode: 1

data/Unity/Assets/Demo/Art/Buttons/play.png.meta

@@ -0,0 +1,28 @@
+fileFormatVersion: 1
+guid: 245716ed6d6b34c8eb6b0f0cb045d349
+TextureImporter:
+  importerVersion: 2
+  maxTextureSize: 1024
+  textureFormat: -3
+  grayscaleToAlpha: 0
+  npotScale: 0
+  generateCubemap: 0
+  isReadable: 0
+  textureType: 2
+  mipmaps:
+    generation: 0
+    correctGamma: 0
+    border: 0
+    filter: 0
+    fadeout: 0
+    fadeoutStart: 1
+    fadeoutEnd: 3
+  bumpmap:
+    generation: 0
+    bumpyness: 0.25
+    filter: 0
+  textureSettings:
+    filterMode: 0
+    anisoLevel: 1
+    mipmapBias: -1
+    wrapMode: 1

data/Unity/Assets/Demo/Art/Buttons/quit.png.meta

@@ -0,0 +1,28 @@
+fileFormatVersion: 1
+guid: e0c1621d587d148eebb29e19c54ebfbd
+TextureImporter:
+  importerVersion: 2
+  maxTextureSize: 1024
+  textureFormat: -3
+  grayscaleToAlpha: 0
+  npotScale: 0
+  generateCubemap: 0
+  isReadable: 0
+  textureType: 2
+  mipmaps:
+    generation: 0
+    correctGamma: 0
+    border: 0
+    filter: 0
+    fadeout: 0
+    fadeoutStart: 1
+    fadeoutEnd: 3
+  bumpmap:
+    generation: 0
+    bumpyness: 0.25
+    filter: 0
+  textureSettings:
+    filterMode: 0
+    anisoLevel: 1
+    mipmapBias: -1
+    wrapMode: 1

data/Unity/Assets/Demo/Art/Buttons/retry.png.meta

@@ -0,0 +1,28 @@
+fileFormatVersion: 1
+guid: 6d2a7fa7adc514907913b709fc943b4d
+TextureImporter:
+  importerVersion: 2
+  maxTextureSize: 1024
+  textureFormat: -3
+  grayscaleToAlpha: 0
+  npotScale: 0
+  generateCubemap: 0
+  isReadable: 0
+  textureType: 2
+  mipmaps:
+    generation: 0
+    correctGamma: 0
+    border: 0
+    filter: 0
+    fadeout: 0
+    fadeoutStart: 1
+    fadeoutEnd: 3
+  bumpmap:
+    generation: 0
+    bumpyness: 0.25
+    filter: 0
+  textureSettings:
+    filterMode: 0
+    anisoLevel: 1
+    mipmapBias: -1
+    wrapMode: 1

data/Unity/Assets/Demo/Art/Buttons/right.png.meta

@@ -0,0 +1,28 @@
+fileFormatVersion: 1
+guid: 43049661c4511470fa71aad33e85ad48
+TextureImporter:
+  importerVersion: 2
+  maxTextureSize: 1024
+  textureFormat: -3
+  grayscaleToAlpha: 0
+  npotScale: 0
+  generateCubemap: 0
+  isReadable: 0
+  textureType: 2
+  mipmaps:
+    generation: 0
+    correctGamma: 0
+    border: 0
+    filter: 0
+    fadeout: 0
+    fadeoutStart: 1
+    fadeoutEnd: 3
+  bumpmap:
+    generation: 0
+    bumpyness: 0.25
+    filter: 0
+  textureSettings:
+    filterMode: 0
+    anisoLevel: 1
+    mipmapBias: -1
+    wrapMode: 1

data/Unity/Assets/Demo/Art/Buttons/up.png.meta

@@ -0,0 +1,28 @@
+fileFormatVersion: 1
+guid: 09485302c089b4248b1f5d79e71bf75c
+TextureImporter:
+  importerVersion: 2
+  maxTextureSize: 1024
+  textureFormat: -3
+  grayscaleToAlpha: 0
+  npotScale: 0
+  generateCubemap: 0
+  isReadable: 0
+  textureType: 2
+  mipmaps:
+    generation: 0
+    correctGamma: 0
+    border: 0
+    filter: 0
+    fadeout: 0
+    fadeoutStart: 1
+    fadeoutEnd: 3
+  bumpmap:
+    generation: 0
+    bumpyness: 0.25
+    filter: 0
+  textureSettings:
+    filterMode: 0
+    anisoLevel: 1
+    mipmapBias: -1
+    wrapMode: 1

data/Unity/Assets/Demo/Art/Buttons.meta

@@ -0,0 +1,2 @@
+fileFormatVersion: 1
+guid: 8e1e5144422744982863dd87298e939b