cuesmash 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61ac71212da28dd89ced337ad1a6700018b6426a
+  data.tar.gz: f7a6eb00adbda3872dd692de2b7a964bcbbe142d
+SHA512:
+  metadata.gz: d85247a3c87e31b31b3440c7d6d85a1287b89ddfb9935a36e7027d164137d2780df716f3412b1e7a376af448bdb407df6314437152c9e9eceaf6a75ed5ec0d67
+  data.tar.gz: bd365bf32a45215624256701874e67a9b0b7540b77be6fa620272443c4539df8ddbf74c3853343115943c79300f8c054a82c8fdfb759c75bdcae24b32f2d76e4

data/.cuesmash.yml

@@ -0,0 +1,12 @@
+devices:
+  iPhone 5s:
+    [7.1, 8.0]
+
+  iPhone 5:
+    [7.1, 8.0]
+
+  iPhone 6:
+    [8.0]
+
+  iPhone 6 Plus:
+    [8.0]

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.2
+script: bundle exec rspec spec
+notifications:
+  email:
+    - jarod@ustwo.com

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cuesmash.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    cuesmash (0.0.1)
+      CFPropertyList
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    CFPropertyList (2.2.8)
+    coderay (1.0.9)
+    diff-lcs (1.2.5)
+    ffi (1.9.0)
+    formatador (0.2.4)
+    guard (1.8.0)
+      formatador (>= 0.2.4)
+      listen (>= 1.0.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (3.0.0)
+      guard (>= 1.8)
+      rspec (~> 2.13)
+    listen (1.1.6)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.3)
+    method_source (0.8.1)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.0)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    slop (3.4.4)
+    thor (0.18.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  cuesmash!
+  guard-rspec
+  pry
+  rake
+  rspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, :cli => '--color --format doc' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Alex Fish
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alex Fish
+
+MIT License
+
+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,61 @@
+cuesmash
+========
+
+<!-- [![Gem Version](https://badge.fury.io/rb/cuesmash.png)](http://badge.fury.io/rb/cuesmash)
+[![Build Status](https://travis-ci.org/ustwo/cuesmash.png?branch=master)](https://travis-ci.org/ustwo/cuesmash) -->
+
+Cuesmash provides an interface to run a suite of appium-cucumber tests against an iOS application using a mocked backend. This is a fork of [calasmash](https://github.com/ustwo/cuesmash) that supports appium instead of calabash.
+
+## Installation
+
+From the git repo:
+
+    rake install
+
+Once we get to a first release of them gem there will be a gem install
+
+<!-- Add this line to your application's Gemfile:
+
+    gem 'cuesmash'
+
+And then execute:
+
+    $ bundle install -->
+
+## Usage
+
+###Commands
+
+    cuesmash help [COMMAND]  # Describe available commands or one specific command
+    cuesmash init            # set up the project
+    cuesmash test OPTIONS    # Usage: cuesmash test [OPTIONS]
+
+### Test Options
+
+    --tags -t the tags to pass to Cucumber, for multiple tags pass one -t option per tag
+    --scheme -s the Xcode scheme to build
+    --ios -i the iOS version to build with
+    --output -o The output directory for the test report
+    --format -f The format of the test report
+    --debug -d output debug information
+
+## Configuration
+
+Cover what the appium.txt file does.
+[http://appium.io/slate/en/tutorial/ios.html?ruby#starting-the-console](http://appium.io/slate/en/tutorial/ios.html?ruby#starting-the-console)
+
+Cover how to configure the travis.yml file
+[http://docs.travis-ci.com/user/languages/objective-c/](http://docs.travis-ci.com/user/languages/objective-c/)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## TODO:
+
+1. reporting - at the end of a run provide reports of the results.
+2. passing build options to xcodebuild (sandbox, mocked, live).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/cuesmash

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require 'cuesmash/start'
+
+Cuesmash::Start.start

data/cuesmash.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "cuesmash"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Alex Fish", "Jarod McBride"]
+  spec.email         = ["fish@ustwo.co.uk", "jarod@ustwo.com"]
+  spec.description   = "A gift for Juan"
+  spec.summary       = "Compile an app, point the app at sinatra, run cucumber with appium"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+
+  spec.add_runtime_dependency "CFPropertyList"
+  spec.add_runtime_dependency "thor"
+
+  spec.executables << "cuesmash"
+end

data/lib/cuesmash/appium_server.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+module Cuesmash
+
+  #
+  # Provides an interface for starting the appium server
+  #
+  # @author [jarod]
+  #
+  class AppiumServer
+
+    # Public: the output directory for the tests
+    attr_accessor :output
+
+    # Public: the output format for the tests
+    attr_accessor :format
+
+    #
+    # Create a new instance of AppiumServer
+    #
+    def initialize()
+    end
+
+    #
+    # Run the appium server
+    #
+    def start_server
+      started
+
+      command = "appium --log-level debug"
+
+      @stdin, @stdout, @stderr, @wait_thr = Open3.popen3(command)
+      Logger.info "Appium running with pid: #{@wait_thr.pid}"
+
+      if Logger.debug?
+        [@stdout, @stderr].each do |stream|
+          Thread.new do
+            until (line = stream.gets).nil? do
+              Logger.debug line
+            end
+          end
+        end
+      end
+    end
+
+    #
+    # Stop the appium server
+    #
+    def stop_server
+      Process.kill('INT', @wait_thr.pid)
+      @stdin.close
+      @stdout.close
+      @stderr.close
+
+      completed
+    end
+
+    private
+
+    #
+    # Output a nice message for starting
+    #
+    def started
+      Logger.info "Starting Appium Server"
+    end
+
+    #
+    # Output a nice message for completing
+    #
+    def completed
+      Logger.info "Stopping Appium server 👌"
+    end
+  end
+end

data/lib/cuesmash/appium_text.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+module Cuesmash
+
+  #
+  # Creates the appium.txt file that is needed by appium
+  #
+  # @author [jarod]
+  #
+  class AppiumText
+
+    attr_accessor :platform_version
+    attr_accessor :app
+    attr_accessor :platform_name
+    attr_accessor :device_name
+
+    #
+    # Create a new appium_text instance. These params are based off the appium.txt
+    # [caps] format.
+    #
+    # @param  platform_name [String] The platform_name platformName = "iOS"
+    # @param  device_name [String] deviceName = "iPhone Simulator"
+    # @param  platform_version [String] platformVersion = "7.1"
+    # @param  app [String] path to built .app file
+    #
+    # @return [AppiumText] A appiumtext instance
+    def initialize(platform_name:, device_name:, platform_version:, app:)
+      @platform_name = platform_name
+      @device_name = device_name
+      @platform_version = platform_version
+      @app = app
+    end
+
+    def execute
+      started
+      update
+      completed
+    end
+
+
+    private
+
+    def started
+      Logger.info "Updating appium.txt"
+    end
+
+    def update
+      text = file_text
+      IO.write("features/support/appium.txt", text)
+    end
+
+    def completed
+      Logger.info "appium.txt updated 👌"
+    end
+
+    # [caps]
+    # platformName = "iOS"
+    # deviceName = "iPhone Simulator"
+    # platformVersion = "7.1"
+    # app = "/Users/jarod/Library/Developer/Xcode/DerivedData/laterooms-fnlioqzgtpowdmezkwdzsyicgjiz/Build/Products/Debug-iphonesimulator/laterooms.app"
+    def file_text
+      text = "[caps]\n"
+      text << "platformName = \"#{platform_name}\"\n"
+      text << "deviceName = \"#{device_name}\"\n"
+      text << "platformVersion = \"#{platform_version}\"\n"
+      text << "app = \"#{app}\"\n"
+      Logger.debug "appium.text == #{text}"
+      text
+    end
+  end
+end

data/lib/cuesmash/command.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+module Cuesmash
+
+  #
+  # The main point of entry for all commands, Command parses command line arguments
+  # and decides what to do about them.
+  #
+  # @author [alexfish]
+  #
+  class Command
+
+    class << self
+
+      #
+      # Execute a command with some arguments
+      # then figure out what we're supposed to be doing with
+      # the arguments
+      #
+      # @param  *args [Array] An Array of arguments to play with
+      #
+      # @return [type] [description]
+      def execute(device:, os:, server:, tags:, scheme:, debug: false, format: nil, output: nil)
+
+        if debug
+          Logger.level = ::Logger::DEBUG
+          Logger.formatter = proc do |serverity, time, progname, msg|
+            "\n#{time}\t#{serverity}\t#{msg.rstrip}"
+          end
+        end
+
+        # Create new IosApp object
+        app = IosApp.new(file_name: scheme)
+        app_server = AppiumServer.new
+
+        # Compile the project
+        compile(scheme, app.tmp_dir) do
+          # Update the plist
+          # update_plist(scheme, app.app_path)
+          # Update the appium.txt file
+          create_appium_txt(app: app.app_path, device_name: device, platform_version: os)
+          # start the appium server
+          app_server.start_server
+          # Run the tests
+          run_tests(os, tags, format, output)
+          # Stop the Appium server
+          # app_server.stop_server
+        end
+
+        # clean up temp dir
+        Logger.info "Cleaning up tmp dir"
+        FileUtils.remove_entry app.tmp_dir
+      end
+
+      #
+      # Kick off a compile
+      # @param  scheme [String] The scheme to compile
+      # @param  app_dir [String] the directory where the .app file will be
+      # @param  &compiled [Block] Completion block
+      #
+      def compile(scheme, app_dir, &compiled)
+        compiler = Cuesmash::Compiler.new(scheme, app_dir)
+        compiler.compile do |complete|
+          yield
+        end
+      end
+
+      #
+      # Update the applications plist so that the application
+      # connects to sinatra
+      # @param  scheme [String] The scheme related to the application
+      #
+      def update_plist(scheme, app_path)
+        plist = Cuesmash::Plist.new(scheme, app_path)
+        plist.execute
+      end
+
+      #
+      # Run the cucumber tests, that's why we're here afterall
+      #
+      # @param  ios [String] The iOS version to test with
+      # @param  tags [Array] The cucumber tags to test with
+      # @param  format [String] The output format for the cucumber tests, Optional
+      # @param  output [String] The path to the output directory to output test reports to, Optional
+      def run_tests(ios, tags, format=nil, output=nil)
+        cucumber = Cuesmash::Cucumber.new(ios, tags)
+        cucumber.format = format if format
+        cucumber.output = output if output
+        cucumber.test
+      end
+
+      #
+      # Update appium.txt file with the directory of the build product
+      #
+      def create_appium_txt(platform_name: "iOS", device_name:, platform_version:, app:)
+        appium = AppiumText.new(platform_name: platform_name, device_name: device_name, platform_version: platform_version, app: app)
+        appium.execute
+      end
+    end
+  end
+end

data/lib/cuesmash/compiler.rb

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+module Cuesmash
+
+  #
+  # The calamsash compiler will compiles the Xcode project with the
+  # scheme it's told to compile with.
+  #
+  # @author [alexfish]
+  #
+  class Compiler
+    # include Logging
+
+    # Public: the Scheme the compiler is compiling
+    attr_accessor :scheme
+    attr_accessor :tmp_dir
+
+    def initialize(scheme, tmp_dir)
+      @scheme = scheme
+      @tmp_dir = tmp_dir
+    end
+
+    #
+    # The compiler's heart, executes the compiling with xcodebuild
+    #
+    #  @param &complete Compleition block
+    #
+    # Returns nothing because it completes with a complete block
+    def compile(&complete)
+      started
+      status = nil
+      output = ""
+
+      Open3.popen3 command do |stdin, out, err, wait_thr|
+        print "\n"
+        [out, err].each do |stream|
+          Thread.new do
+            until (line = stream.gets).nil? do
+              print "."
+              output << line
+            end
+          end
+        end
+        wait_thr.join
+        status = wait_thr.value.exitstatus
+      end
+
+      if status != 0
+        Logger.fatal "Compilation failed: #{output}"
+        # exit status
+        status
+      else
+        completed
+        complete.call(true) if complete
+      end
+    end
+
+    private
+
+    #
+    # Output a nice message for starting
+    #
+    def started
+      Logger.info "Compiling"
+    end
+
+    #
+    # Output a nice message for completing
+    #
+    def completed
+      Logger.info "Compiled 👌"
+    end
+
+    #
+    # Generate the string to be used as the xcode build command
+    # using the scheme ivar
+    #
+    # @return [String] The full xcode build command with args
+    def command
+      xcode_command = "xcodebuild #{workspace} -scheme #{@scheme} -sdk iphonesimulator CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO -derivedDataPath #{@tmp_dir}"
+      Logger.info "xcode_command == #{xcode_command}"
+      xcode_command
+    end
+
+    #
+    # Looks in the current directory for the workspace file and
+    # gets it's name if there is one
+    #
+    # @return [String] The name of the workspace file that was found along with the -workspace flag
+    def workspace
+      wp = Dir["*.xcworkspace"].first
+      if wp
+        flag = "-workspace #{wp}"
+        Logger.debug "workspace == #{wp}"
+        return flag
+      else
+        Logger.debug "no workspace found"
+        return wp
+      end
+    end
+  end
+end