luffa 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a03176e4d52343fcd2cb6947dfb7e54da45fb29b
+  data.tar.gz: 11b02be320fc50a246f797b7e9fdffacbe99c721
+SHA512:
+  metadata.gz: 2093f3e95bdffe5167f906bb93cf07b419fe9888b43a4aee69031a88d8e56a6cf2073df6e8c224568bae0256227177d541616555b0c1c30703c23528026abe55
+  data.tar.gz: 8c7f2b41b7893c56ce72cbcfd77a2d303d487fef3ff651cb197104df00649476d34c6de2814c84446d293368cc623b6ac8cc038cc4df9d2002cf7f349ed68cab

data/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+## Contributing
+
+***All pull requests should be based off the `develop` branch.***
+
+The Calabash Toolchain uses git-flow.
+
+See these links for information about git-flow and git best practices.
+
+##### Git Flow Step-by-Step guide
+
+* https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow
+
+##### Git Best Practices
+
+* http://justinhileman.info/article/changing-history/
+
+##### git-flow command line tool
+
+We don't use the git-flow tools, but this is useful anyway.
+
+* http://danielkummer.github.io/git-flow-cheatsheet/
+
+## Start a Feature
+
+Start your work on a feature branch based off develop.
+
+```
+# If you don't already have the develop branch
+$ git fetch origin
+$ git co -t origin/develop
+
+# If you already have the develop branch
+$ git co develop
+$ git pull origin develop
+$ git co -b feature/my-new-feature
+
+# Publish your branch and make a pull-request on `develop`
+$ git push -u origin feature/my-new-feature
+```

data/LICENSE

@@ -0,0 +1,204 @@
+Eclipse Public License - v 1.0
+
+THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
+LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM
+CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
+
+1. DEFINITIONS
+
+"Contribution" means:
+
+a) in the case of the initial Contributor, the initial code and documentation
+   distributed under this Agreement, and
+b) in the case of each subsequent Contributor:
+    i) changes to the Program, and
+   ii) additions to the Program;
+
+   where such changes and/or additions to the Program originate from and are
+   distributed by that particular Contributor. A Contribution 'originates'
+   from a Contributor if it was added to the Program by such Contributor
+   itself or anyone acting on such Contributor's behalf. Contributions do not
+   include additions to the Program which: (i) are separate modules of
+   software distributed in conjunction with the Program under their own
+   license agreement, and (ii) are not derivative works of the Program.
+
+"Contributor" means any person or entity that distributes the Program.
+
+"Licensed Patents" mean patent claims licensable by a Contributor which are
+necessarily infringed by the use or sale of its Contribution alone or when
+combined with the Program.
+
+"Program" means the Contributions distributed in accordance with this
+Agreement.
+
+"Recipient" means anyone who receives the Program under this Agreement,
+including all Contributors.
+
+2. GRANT OF RIGHTS
+  a) Subject to the terms of this Agreement, each Contributor hereby grants
+     Recipient a non-exclusive, worldwide, royalty-free copyright license to
+     reproduce, prepare derivative works of, publicly display, publicly
+     perform, distribute and sublicense the Contribution of such Contributor,
+     if any, and such derivative works, in source code and object code form.
+  b) Subject to the terms of this Agreement, each Contributor hereby grants
+     Recipient a non-exclusive, worldwide, royalty-free patent license under
+     Licensed Patents to make, use, sell, offer to sell, import and otherwise
+     transfer the Contribution of such Contributor, if any, in source code and
+     object code form. This patent license shall apply to the combination of
+     the Contribution and the Program if, at the time the Contribution is
+     added by the Contributor, such addition of the Contribution causes such
+     combination to be covered by the Licensed Patents. The patent license
+     shall not apply to any other combinations which include the Contribution.
+     No hardware per se is licensed hereunder.
+  c) Recipient understands that although each Contributor grants the licenses
+     to its Contributions set forth herein, no assurances are provided by any
+     Contributor that the Program does not infringe the patent or other
+     intellectual property rights of any other entity. Each Contributor
+     disclaims any liability to Recipient for claims brought by any other
+     entity based on infringement of intellectual property rights or
+     otherwise. As a condition to exercising the rights and licenses granted
+     hereunder, each Recipient hereby assumes sole responsibility to secure
+     any other intellectual property rights needed, if any. For example, if a
+     third party patent license is required to allow Recipient to distribute
+     the Program, it is Recipient's responsibility to acquire that license
+     before distributing the Program.
+  d) Each Contributor represents that to its knowledge it has sufficient
+     copyright rights in its Contribution, if any, to grant the copyright
+     license set forth in this Agreement.
+
+3. REQUIREMENTS
+
+A Contributor may choose to distribute the Program in object code form under
+its own license agreement, provided that:
+
+  a) it complies with the terms and conditions of this Agreement; and
+  b) its license agreement:
+      i) effectively disclaims on behalf of all Contributors all warranties
+         and conditions, express and implied, including warranties or
+         conditions of title and non-infringement, and implied warranties or
+         conditions of merchantability and fitness for a particular purpose;
+     ii) effectively excludes on behalf of all Contributors all liability for
+         damages, including direct, indirect, special, incidental and
+         consequential damages, such as lost profits;
+    iii) states that any provisions which differ from this Agreement are
+         offered by that Contributor alone and not by any other party; and
+     iv) states that source code for the Program is available from such
+         Contributor, and informs licensees how to obtain it in a reasonable
+         manner on or through a medium customarily used for software exchange.
+
+When the Program is made available in source code form:
+
+  a) it must be made available under this Agreement; and
+  b) a copy of this Agreement must be included with each copy of the Program.
+     Contributors may not remove or alter any copyright notices contained
+     within the Program.
+
+Each Contributor must identify itself as the originator of its Contribution,
+if
+any, in a manner that reasonably allows subsequent Recipients to identify the
+originator of the Contribution.
+
+4. COMMERCIAL DISTRIBUTION
+
+Commercial distributors of software may accept certain responsibilities with
+respect to end users, business partners and the like. While this license is
+intended to facilitate the commercial use of the Program, the Contributor who
+includes the Program in a commercial product offering should do so in a manner
+which does not create potential liability for other Contributors. Therefore,
+if a Contributor includes the Program in a commercial product offering, such
+Contributor ("Commercial Contributor") hereby agrees to defend and indemnify
+every other Contributor ("Indemnified Contributor") against any losses,
+damages and costs (collectively "Losses") arising from claims, lawsuits and
+other legal actions brought by a third party against the Indemnified
+Contributor to the extent caused by the acts or omissions of such Commercial
+Contributor in connection with its distribution of the Program in a commercial
+product offering. The obligations in this section do not apply to any claims
+or Losses relating to any actual or alleged intellectual property
+infringement. In order to qualify, an Indemnified Contributor must:
+a) promptly notify the Commercial Contributor in writing of such claim, and
+b) allow the Commercial Contributor to control, and cooperate with the
+Commercial Contributor in, the defense and any related settlement
+negotiations. The Indemnified Contributor may participate in any such claim at
+its own expense.
+
+For example, a Contributor might include the Program in a commercial product
+offering, Product X. That Contributor is then a Commercial Contributor. If
+that Commercial Contributor then makes performance claims, or offers
+warranties related to Product X, those performance claims and warranties are
+such Commercial Contributor's responsibility alone. Under this section, the
+Commercial Contributor would have to defend claims against the other
+Contributors related to those performance claims and warranties, and if a
+court requires any other Contributor to pay any damages as a result, the
+Commercial Contributor must pay those damages.
+
+5. NO WARRANTY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
+IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each
+Recipient is solely responsible for determining the appropriateness of using
+and distributing the Program and assumes all risks associated with its
+exercise of rights under this Agreement , including but not limited to the
+risks and costs of program errors, compliance with applicable laws, damage to
+or loss of data, programs or equipment, and unavailability or interruption of
+operations.
+
+6. DISCLAIMER OF LIABILITY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY
+CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION
+LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
+EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY
+OF SUCH DAMAGES.
+
+7. GENERAL
+
+If any provision of this Agreement is invalid or unenforceable under
+applicable law, it shall not affect the validity or enforceability of the
+remainder of the terms of this Agreement, and without further action by the
+parties hereto, such provision shall be reformed to the minimum extent
+necessary to make such provision valid and enforceable.
+
+If Recipient institutes patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Program itself
+(excluding combinations of the Program with other software or hardware)
+infringes such Recipient's patent(s), then such Recipient's rights granted
+under Section 2(b) shall terminate as of the date such litigation is filed.
+
+All Recipient's rights under this Agreement shall terminate if it fails to
+comply with any of the material terms or conditions of this Agreement and does
+not cure such failure in a reasonable period of time after becoming aware of
+such noncompliance. If all Recipient's rights under this Agreement terminate,
+Recipient agrees to cease use and distribution of the Program as soon as
+reasonably practicable. However, Recipient's obligations under this Agreement
+and any licenses granted by Recipient relating to the Program shall continue
+and survive.
+
+Everyone is permitted to copy and distribute copies of this Agreement, but in
+order to avoid inconsistency the Agreement is copyrighted and may only be
+modified in the following manner. The Agreement Steward reserves the right to
+publish new versions (including revisions) of this Agreement from time to
+time. No one other than the Agreement Steward has the right to modify this
+Agreement. The Eclipse Foundation is the initial Agreement Steward. The
+Eclipse Foundation may assign the responsibility to serve as the Agreement
+Steward to a suitable separate entity. Each new version of the Agreement will
+be given a distinguishing version number. The Program (including
+Contributions) may always be distributed subject to the version of the
+Agreement under which it was received. In addition, after a new version of the
+Agreement is published, Contributor may elect to distribute the Program
+(including its Contributions) under the new version. Except as expressly
+stated in Sections 2(a) and 2(b) above, Recipient receives no rights or
+licenses to the intellectual property of any Contributor under this Agreement,
+whether expressly, by implication, estoppel or otherwise. All rights in the
+Program not expressly granted under this Agreement are reserved.
+
+This Agreement is governed by the laws of the State of New York and the
+intellectual property laws of the United States of America. No party to this
+Agreement will bring a legal action under this Agreement more than one year
+after the cause of action arose. Each party waives its rights to a jury trial in
+any resulting litigation.
+

data/README.md

@@ -0,0 +1,7 @@
+| master  | develop | [versioning](VERSIONING.md) | [license](LICENSE) | [contributing](CONTRIBUTING.md)|
+|---------|---------|-----------------------------|--------------------|--------------------------------|
+|[![Build Status](https://travis-ci.org/calabash/luffa.svg?branch=master)](https://travis-ci.org/calabash/luffa)| [![Build Status](https://travis-ci.org/calabash/luffa.svg?branch=develop)](https://travis-ci.org/calabash/luffa)| [![GitHub version](https://badge.fury.io/gh/calabash%2Fluffa.svg)](http://badge.fury.io/gh/calabash%2Fluffa) |[![License](https://img.shields.io/badge/licence-Eclipse-blue.svg)](http://opensource.org/licenses/EPL-1.0) | [![Contributing](https://img.shields.io/badge/contrib-gitflow-orange.svg)](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow/)|
+
+## Calabash Luffa
+
+A gem to help test the Calabash Toolchain.

data/VERSIONING.md

@@ -0,0 +1,16 @@
+## Versioning
+
+Calabash tries very hard to comply with Semantic Versioning [1] rules.
+
+However, the semantic versioning spec is incompatible with RubyGem's patterns for pre-release gems.
+  
+> "But returning to the practical: No release version of SemVer is compatible with Rubygems." - _David Kellum_ [2]
+
+Calabash version numbers will be in this form:
+
+```
+<major>.<minor>.<patch>[.pre<N>]
+```
+
+- [1] http://semver.org/
+- [2] http://gravitext.com/2012/07/22/versioning.html

data/bin/luffa

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require 'luffa/cli/cli'
+
+begin
+  Luffa::CLI.start
+  exit 0
+rescue Luffa::ValidationError, Thor::RequiredArgumentMissingError, Thor::UndefinedCommandError => e
+  puts e.message
+  exit 64
+rescue Thor::Error => e
+  puts e.message
+  if ENV['DEBUG'] == '1'
+    puts e.backtrace.join("\n") if e.backtrace
+    p e.class
+  end
+  exit 70
+end

data/lib/luffa.rb

@@ -0,0 +1,12 @@
+require 'luffa/environment'
+require 'luffa/patches/awesome_print'
+require 'luffa/patches/kernel'
+require 'luffa/logging'
+require 'luffa/version'
+require 'luffa/unix_command'
+require 'luffa/with_debugging'
+require 'luffa/retry'
+require 'luffa/gem'
+require 'luffa/ios/xcode'
+require 'luffa/ios/simulator'
+require 'luffa/ios/ideviceinstaller'

data/lib/luffa/cli/cli.rb

@@ -0,0 +1,65 @@
+require 'thor'
+require 'luffa'
+
+trap 'SIGINT' do
+  puts 'Exiting'
+  exit 10
+end
+
+module Luffa
+
+  class ValidationError < Thor::InvocationError
+  end
+
+  class CLI < Thor
+    include Thor::Actions
+
+    def self.exit_on_failure?
+      true
+    end
+
+    desc 'version', 'Prints version of the luffa gem'
+    def version
+      puts Luffa::VERSION
+    end
+
+    desc 'authorize', 'Runs instruments authorization scripts - will only run on travis-ci'
+    def authorize
+      this_dir = File.dirname(__FILE__)
+      relative_path = File.join(this_dir, '..', '..', '..', 'script', 'ci')
+      plist_path = File.expand_path(relative_path)
+
+      analysis_plist = "#{plist_path}/com.apple.dt.instruments.process.analysis.plist"
+      kill_plist = "#{plist_path}/com.apple.dt.instruments.process.kill.plist"
+
+      analysis_domain = 'com.apple.dt.instruments.process.analysis'
+      analysis_args = ['security', 'authorizationdb', 'write', analysis_domain]
+
+      kill_domain = 'com.apple.dt.instruments.process.kill'
+      kill_args = ['security', 'authorizationdb', 'write', kill_domain]
+
+      if Luffa::Environment.travis_ci?
+        cmd = "sudo #{analysis_args.join(' ')} < \"#{analysis_plist}\""
+        options = {
+              :pass_msg => 'Wrote analysis.plist',
+              :fail_msg => 'Could not write analysis.plist',
+              :exit_on_nonzero_status => false
+        }
+        analysis_code = Luffa.unix_command(cmd, options)
+
+        cmd = "sudo #{kill_args.join(' ')} < \"#{kill_plist}\""
+        options = {
+              :pass_msg => 'Wrote kill.plist',
+              :fail_msg => 'Could not write kill.plist',
+              :exit_on_nonzero_status => false
+        }
+
+        kill_code = Luffa.unix_command(cmd, options)
+        analysis_code == 0 && kill_code == 0
+      else
+        puts "Skipping 'security authorizationdb write' because it requires sudo"
+        true
+      end
+    end
+  end
+end

data/lib/luffa/environment.rb

@@ -0,0 +1,31 @@
+module Luffa
+  module Environment
+    def self.travis_ci?
+      value = ENV['TRAVIS']
+      !value.nil? && value != ''
+    end
+
+    def self.jenkins_ci?
+      value = ENV['JENKINS_HOME']
+      !value.nil? && value != ''
+    end
+
+    def self.ci?
+      self.travis_ci? || self.jenkins_ci?
+    end
+
+    def self.developer_dir
+      value = ENV['DEVELOPER_DIR']
+      if value && value != ''
+        value
+      else
+        nil
+      end
+    end
+
+    # Returns true if debugging is enabled.
+    def self.debug?
+      ENV['DEBUG'] == '1'
+    end
+  end
+end

data/lib/luffa/gem.rb

@@ -0,0 +1,35 @@
+module Luffa
+  class Gem
+
+    def self.update_rubygems(unix_command_opts={})
+      default_opts = {:pass_msg => 'Updated rubygems',
+                      :fail_msg => 'Could not update rubygems'}
+
+      Luffa.unix_command('gem update --system',
+                         default_opts.merge(unix_command_opts))
+    end
+
+    def self.uninstall_gem(gem_name, unix_command_opts={})
+      default_opts = {:pass_msg => "Uninstalled '#{gem_name}'",
+                      :fail_msg => "Could not uninstall '#{gem_name}'"}
+      Luffa.unix_command("gem uninstall -Vax --force --no-abort-on-dependent #{gem_name}",
+                         default_opts.merge(unix_command_opts))
+    end
+
+    def self.install_gem(gem_name, opts={})
+      default_opts = {:prerelease => false,
+                      :no_document => true,
+                      :pass_msg => "Installed '#{gem_name}'",
+                      :fail_msg => "Could not install '#{gem_name}'"}
+
+      merged_opts = default_opts.merge(opts)
+
+      pre = merged_opts[:prerelease] ? '--pre' : ''
+      no_document = merged_opts[:no_document] ? '--no-document' : ''
+
+      Luffa.unix_command("gem install #{no_document} #{gem_name} #{pre}",
+                         merged_opts)
+    end
+
+  end
+end

data/lib/luffa/ios/ideviceinstaller.rb

@@ -0,0 +1,116 @@
+require 'retriable'
+
+module Luffa
+  class IDeviceInstaller
+
+    attr_reader :ipa
+    attr_reader :bundle_id
+
+    def initialize(ipa, bundle_id)
+      @ipa = ipa
+      @bundle_id = bundle_id
+    end
+
+    def bin_path
+      @bin_path ||= `which ideviceinstaller`.chomp!
+    end
+
+    def ideviceinstaller_available?
+      path = bin_path
+      path and File.exist? bin_path
+    end
+
+    def install(udid, cmd)
+      case cmd
+        when :install_internal
+          ipa
+          Retriable.retriable do
+            uninstall udid
+          end
+          Retriable.retriable do
+            install_internal udid
+          end
+        when :uninstall
+          Retriable.retriable do
+            uninstall udid
+          end
+        else
+          cmds = [:install_internal, :uninstall]
+          raise ArgumentError, "expected '#{cmd}' to be one of '#{cmds}'"
+      end
+    end
+
+    def bundle_installed?(udid)
+      cmd = "#{bin_path} --udid #{udid} --list-apps"
+      Luffa.log_unix_cmd(cmd) if Luffa::Environment.debug?
+
+      Open3.popen3(cmd) do  |_, stdout,  stderr, _|
+        err = stderr.read.strip
+        Luffa.log_fail(err) if err && err != ''
+
+        out = stdout.read.strip
+        out.strip.split(/\s/).include? bundle_id
+      end
+    end
+
+    def install_internal(udid)
+      return true if bundle_installed? udid
+
+      cmd = "#{bin_path} --udid #{udid} --install #{ipa}"
+      Luffa.log_unix_cmd(cmd) if Luffa::Environment.debug?
+
+      Open3.popen3(cmd) do  |_, _,  stderr, _|
+        err = stderr.read.strip
+        Luffa.log_fail(err) if err && err != ''
+      end
+
+      unless bundle_installed? udid
+        raise "could not install '#{ipa}' on '#{udid}' with '#{bundle_id}'"
+      end
+      true
+    end
+
+    def uninstall(udid)
+      return true unless bundle_installed? udid
+
+      cmd = "#{bin_path} -udid #{udid} --uninstall #{bundle_id}"
+      Luffa.log_unix_cmd(cmd) if Luffa::Environment.debug?
+
+      Open3.popen3(cmd) do  |_, _,  stderr, _|
+        err = stderr.read.strip
+        Luffa.log_fail(err) if err && err != ''
+      end
+
+      if bundle_installed? udid
+        raise "could not uninstall '#{bundle_id}' on '#{udid}'"
+      end
+      true
+    end
+
+    def idevice_id_bin_path
+      @idevice_id_bin_path ||= `which idevice_id`.chomp!
+    end
+
+    def idevice_id_available?
+      path = idevice_id_bin_path
+      path and File.exist? path
+    end
+
+    def physical_devices_for_testing(xcode_tools)
+      # Xcode 6 + iOS 8 - devices on the same network, whether development or
+      # not, appear when calling $ xcrun instruments -s devices. For the
+      # purposes of testing, we will only try to connect to devices that are
+      # connected via USB.
+      @physical_devices_for_testing ||= lambda {
+        devices = xcode_tools.instruments(:devices)
+        if idevice_id_available?
+          white_list = `#{idevice_id_bin_path} -l`.strip.split("\n")
+          devices.select { | device | white_list.include?(device.udid) }
+        else
+          devices
+        end
+      }.call
+    end
+
+  end
+end