cuesmash 0.1.7.1 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab02397923ae6bcc8a4d50e9669002b717e238cf
-  data.tar.gz: 49b186b927bff4dab83ac849d725638ff573b413
+  metadata.gz: 48e58bea94fd7f9c3530ae9d5e58b01c97be9fa8
+  data.tar.gz: e9b0af7c1164eb3421559e980670669cd5621c21
 SHA512:
-  metadata.gz: 16d9547be2c387b300fe344cec9f8e5208b0e69b94bce6ada59bbf1e44daa8d21c709d1e717a08d8d3bbdd928e723a902227855bc32161c190d4c05e84bf2bbe
-  data.tar.gz: ba1036e189318efedbdef926b43638a9e01fc83aa33d3561152505a7fdefd4022b6ec3ec65054974f45278f4f56104bb32ab68314336421f6c9d5fd8ad73e5c9
+  metadata.gz: 8b363d22b641435db75895ce121375df0c37741cbc3738c04cd1fa15b7ae400e69faf931d35a536ad02d41b49a7d02c826fb483bbd702ac84b392a01ce159e09
+  data.tar.gz: e476b772402fe0daee97cdcd25b8ba61d6f1c4c180d7afe360e25a7e0371b79cf600fc8183930bb037aa27ad1f3213c009b6ff29a02520a269626aacc63e211b

data/.cuesmash.yml

@@ -12,4 +12,7 @@ devices:
     [8.0]
 default:
   os: iPhone 5s
-  version: 8.0
+  version: 8.1
+  test_timeout: 120
+
+build_configuration: 'Debug'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cuesmash (0.1.7.1)
+    cuesmash (0.1.9)
       CFPropertyList (>= 2.2.8)
       rest-client (~> 1.7.2)
       thor (>= 0.19.1)
@@ -21,6 +21,7 @@ GEM
     columnize (0.8.9)
     debugger-linecache (1.2.0)
     diff-lcs (1.2.5)
+    docile (1.1.5)
     ffi (1.9.5)
     formatador (0.2.5)
     guard (2.6.1)
@@ -40,6 +41,7 @@ GEM
     lumberjack (1.0.9)
     method_source (0.8.2)
     mime-types (2.3)
+    multi_json (1.10.1)
     netrc (0.7.7)
     pry (0.10.1)
       coderay (~> 1.1.0)
@@ -64,6 +66,11 @@ GEM
     rspec-mocks (3.1.2)
       rspec-support (~> 3.1.0)
     rspec-support (3.1.1)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
     slop (3.6.0)
     thor (0.19.1)
     timers (4.0.1)
@@ -81,3 +88,4 @@ DEPENDENCIES
   pry (>= 0.10.1)
   rake (>= 10.3.2)
   rspec (>= 3.1.0)
+  simplecov (~> 0.9.0)

data/cuesmash.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "cuesmash"
-  spec.version       = "0.1.7.1"
+  spec.version       = "0.1.9"
   spec.authors       = ["Alex Fish", "Jarod McBride"]
   spec.email         = ["fish@ustwo.co.uk", "jarod@ustwo.com"]
   spec.description   = "A gift for Juan"
@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-rspec', '>= 4.3.1'
   spec.add_development_dependency 'pry', '>= 0.10.1'
   spec.add_development_dependency 'byebug', '>= 3.5.1'
+  spec.add_development_dependency 'simplecov', '~> 0.9.0'
 
   spec.add_runtime_dependency 'CFPropertyList', '>= 2.2.8'
   spec.add_runtime_dependency 'thor', '>= 0.19.1'

data/lib/cuesmash/android_app.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+module Cuesmash
+
+  #
+  # Provides an object to get information about the ios app that is being built.
+  #
+  class AndroidApp < App
+
+    # app/build/outputs/apk/
+    attr_reader :app_dir
+
+    # Public: the full path including the built app i.e. ./app/build/outputs/apk/app-debug.apk"
+    attr_reader :app_path
+
+    # Public: the app name i.e. app-debug.apk
+    attr_reader :app_name
+
+    #
+    # Create a new App instance
+    #
+    # @param  project_name [String] the project name to be built.
+    # @param build_configuration [String] which build configuration to run i.e. Release, Debug
+    #
+    # @return [App] A app instance
+    def initialize(project_name:, build_configuration:)
+      @app_name = "#{project_name}-#{build_configuration}" << ".apk"
+
+      @app_dir = File.expand_path("./app/build/outputs/apk/")
+  
+      @app_path = "#{@app_dir}/" << "#{@app_name}"
+    end
+
+  end # class AndroidApp
+end # module Cuesmash

data/lib/cuesmash/android_appium_text.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+module Cuesmash
+
+  #
+  # Creates the appium.txt file that is needed by appium
+  #
+  # @author [jarod]
+  #
+  class AndroidAppiumText
+
+    attr_accessor :appium_avd
+    attr_accessor :appium_app
+    attr_accessor :appium_platform_name
+    attr_accessor :appium_new_command_timeout
+    attr_accessor :appium_text_for_file
+
+    # 
+    # [initialize description]
+    # @param platform_name: [type] [description]
+    # @param avd: [type] [description]
+    # @param app: [type] [description]
+    # @param new_command_timeout: 60 [type] [description]
+    # 
+    # @return [type] [description]
+    def initialize(platform_name:, avd:, app:, new_command_timeout: 60)
+      @appium_platform_name = platform_name
+      @appium_avd = avd
+      @appium_app = app
+      @appium_new_command_timeout = new_command_timeout
+    end
+
+    def execute
+      started
+      update
+      completed
+    end
+
+    private
+
+    def started
+      Logger.info "Updating appium.txt"
+    end
+
+    def update
+      @appium_text_for_file = file_text
+      IO.write("features/support/appium.txt", @appium_text_for_file)
+    end
+
+    def completed
+      Logger.info "appium.txt updated 👌"
+    end
+
+    # [caps]
+    # platformName = "Android"
+    # app = "/Users/admin/repos/android-bbd-sample/app/build/outputs/apk/app-debug.apk"
+    # newCommandTimeout = "130"
+    # avd = "Nexus_6_API_21"
+    def file_text
+      text = "[caps]\n"
+      text << "platformName = \"#{appium_platform_name}\"\n"
+      text << "deviceName = \"Android Emulator\"\n"
+      text << "avd = \"#{appium_avd}\"\n"
+      text << "app = \"#{appium_app}\"\n"
+      text << "newCommandTimeout = \"#{appium_new_command_timeout}\"\n"
+      Logger.debug "appium.text == #{text}"
+      text
+    end
+  end
+end

data/lib/cuesmash/android_command.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+require 'cuesmash/android_appium_text'
+
+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 AndroidCommand
+
+    #
+    # Execute a command with some arguments
+    # then figure out what we're supposed to be doing with
+    # the arguments
+    # 
+    # @param avd: [type] [description]
+    # @param server: [type] [description]
+    # @param tags: [type] [description]
+    # @param debug: false [type] [description]
+    # @param format: nil [type] [description]
+    # @param output: nil [type] [description]
+    # @param app: [type] [description]
+    # @param profile: [type] [description]
+    # @param quiet: false [type] [description]
+    # @param timeout: [type] [description]
+    # 
+    # @return [type] [description]
+    def self.execute(avd:, server:, tags:, debug: false, format: nil, output: nil, app:, profile:, quiet: false, timeout:)
+
+      if debug
+        Logger.level = ::Logger::DEBUG
+        Logger.formatter = proc do |serverity, time, progname, msg|
+          "\n#{time}\t#{serverity}\t#{msg.rstrip}"
+        end
+      end
+
+      # Update the appium.txt file
+      create_appium_txt(app: app.app_path, timeout: timeout, avd: avd)
+
+      # start the appium server
+      app_server = AppiumServer.new
+      app_server.start_server
+
+      # Run the tests
+      run_tests(tags: tags, profile: profile, format: format, output: output, quiet: quiet)
+
+      # Stop the Appium server
+      # app_server.stop_server
+
+    end # execute
+
+    #
+    # Run the cucumber tests, that's why we're here afterall
+    #
+    # @param tags [Array] The cucumber tags to test with
+    # @param profile [String] cucumber profile to use
+    # @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
+    # @param quiet [Boolean] quiet flag for cucumber
+    #
+    def self.run_tests(tags:, profile:, format: nil, output: nil, quiet: false)
+      cucumber = Cuesmash::Cucumber.new(tags, profile, quiet)
+      cucumber.format = format if format
+      cucumber.output = output if output
+      cucumber.test
+    end
+
+    #
+    # Update appium.txt file with the directory of the build product
+    #
+    # @param platform_name [String] default 'iOS' name of platform to test on (Android or iOS)
+    # @param device_name [String] deviceName = "iPhone Simulator"
+    # @param platform_version [String] platformVersion = "7.1"
+    # @param app [String] path to built .app file
+    # @param timeout [String] time in seconds to set the newCommandTimeout to.
+    #
+    def self.create_appium_txt(platform_name: "Android", app:, timeout:, avd:)
+      appium = Cuesmash::AndroidAppiumText.new(platform_name: platform_name, avd: avd, app: app, new_command_timeout: timeout)
+      appium.execute
+    end
+  end # class Command
+end # module Cuesmash

data/lib/cuesmash/android_compiler.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+module Cuesmash
+
+  #
+  # iOS Specific compiler
+  # 
+  class AndroidCompiler < Compiler
+
+    OUTPUT_PATH = "app/build/outputs/apk"
+
+    def initialize
+    end
+
+    #
+    # Generate the string to be used as the gradle build command
+    # using the scheme ivar
+    #
+    # @return [String] The full gradle build command with args
+    def command
+      gradle_command = './gradlew assemble'
+
+      Logger.info "gradle_command == #{gradle_command}"
+      gradle_command
+    end # command
+  end # class AndroidCompiler
+end # module Cuesmash

data/lib/cuesmash/androidapp.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+module Cuesmash
+
+  #
+  # Provides an object to get information about the ios app that is being built.
+  #
+  class AndroidApp < App
+
+    # app/build/outputs/apk/
+    attr_reader :app_dir
+
+    # Public: the full path including the built app i.e. ./app/build/outputs/apk/app-debug.apk"
+    attr_reader :app_path
+
+    # Public: the app name i.e. app-debug.apk
+    attr_reader :app_name
+
+    #
+    # Create a new App instance
+    #
+    # @param  project_name [String] the project name to be built.
+    # @param build_configuration [String] which build configuration to run i.e. Release, Debug
+    #
+    # @return [App] A app instance
+    def initialize(project_name:, build_configuration:)
+      @app_name = "#{project_name}-#{build_configuration}" << ".apk"
+
+      @app_dir = File.expand_path("./app/build/outputs/apk/")
+  
+      @app_path = "#{@app_dir}/" << "#{@app_name}"
+    end
+
+  end # class AndroidApp
+end # module Cuesmash

data/lib/cuesmash/app.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+module Cuesmash
+
+  #
+  # Provides an object to get information about the ios app that is being built
+  #
+  class App
+
+    # Public: the xcode Derived Data temp directory
+    attr_reader :tmp_dir
+
+    #
+    # Create a new App instance
+    #
+    # @return [App] A app instance
+    def initialize()
+      @tmp_dir = Dir.mktmpdir(file_name)
+    end
+  end
+end

data/lib/cuesmash/appium_text.rb

@@ -14,6 +14,8 @@ module Cuesmash
     attr_accessor :app
     attr_accessor :platform_name
     attr_accessor :device_name
+    attr_accessor :new_command_timeout
+    attr_accessor :appium_text_for_file
 
     #
     # Create a new appium_text instance. These params are based off the appium.txt
@@ -25,11 +27,12 @@ module Cuesmash
     # @param  app [String] path to built .app file
     #
     # @return [AppiumText] A appiumtext instance
-    def initialize(platform_name:, device_name:, platform_version:, app:)
+    def initialize(platform_name:, device_name:, platform_version: nil, app:, new_command_timeout: 60)
       @platform_name = platform_name
       @device_name = device_name
       @platform_version = platform_version
       @app = app
+      @new_command_timeout = new_command_timeout
     end
 
     def execute
@@ -38,7 +41,6 @@ module Cuesmash
       completed
     end
 
-
     private
 
     def started
@@ -46,8 +48,8 @@ module Cuesmash
     end
 
     def update
-      text = file_text
-      IO.write("features/support/appium.txt", text)
+      @appium_text_for_file = file_text
+      IO.write("features/support/appium.txt", @appium_text_for_file)
     end
 
     def completed
@@ -63,8 +65,9 @@ module Cuesmash
       text = "[caps]\n"
       text << "platformName = \"#{platform_name}\"\n"
       text << "deviceName = \"#{device_name}\"\n"
-      text << "platformVersion = \"#{platform_version}\"\n"
+      text << "platformVersion = \"#{platform_version}\"\n" unless platform_version == nil
       text << "app = \"#{app}\"\n"
+      text << "newCommandTimeout = \"#{new_command_timeout}\"\n"
       Logger.debug "appium.text == #{text}"
       text
     end

data/lib/cuesmash/command.rb

@@ -30,9 +30,10 @@ module Cuesmash
       # @param app [IosApp Object]
       # @param profile [String]
       # @param quiet [String]
+      # @param timeout [String] newCommandTimeout for appium in seconds
       #
       # @return [type] [description]
-      def execute(device:, os:, server:, tags:, scheme:, debug: false, format: nil, output: nil, travis: nil, app:, profile:, quiet: false)
+      def execute(device:, os:, server:, tags:, scheme:, debug: false, format: nil, output: nil, travis: nil, app:, profile:, quiet: false, timeout:)
 
         if debug
           Logger.level = ::Logger::DEBUG
@@ -45,14 +46,14 @@ module Cuesmash
         # update_plist(scheme, app.app_path)
 
         # Update the appium.txt file
-        create_appium_txt(app: app.app_path, device_name: device, platform_version: os)
+        create_appium_txt(app: app.app_path, device_name: device, platform_version: os, timeout: timeout)
 
         # start the appium server
         app_server = AppiumServer.new
         app_server.start_server
 
         # Run the tests
-        run_tests(ios: os, tags: tags, profile: profile, format: format, output: output, quiet: quiet)
+        run_tests(tags: tags, profile: profile, format: format, output: output, quiet: quiet)
 
         # Stop the Appium server
         # app_server.stop_server
@@ -81,8 +82,8 @@ module Cuesmash
       # @param output [String] The path to the output directory to output test reports to, Optional
       # @param quiet [Boolean] quiet flag for cucumber
       #
-      def run_tests(ios:, tags:, profile:, format: nil, output: nil, quiet: false)
-        cucumber = Cuesmash::Cucumber.new(ios, tags, profile, quiet)
+      def run_tests(tags:, profile:, format: nil, output: nil, quiet: false)
+        cucumber = Cuesmash::Cucumber.new(tags, profile, quiet)
         cucumber.format = format if format
         cucumber.output = output if output
         cucumber.test
@@ -95,11 +96,12 @@ module Cuesmash
       # @param device_name [String] deviceName = "iPhone Simulator"
       # @param platform_version [String] platformVersion = "7.1"
       # @param app [String] path to built .app file
+      # @param timeout [String] time in seconds to set the newCommandTimeout to.
       #
-      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)
+      def create_appium_txt(platform_name: "iOS", device_name:, platform_version:, app:, timeout:)
+        appium = AppiumText.new(platform_name: platform_name, device_name: device_name, platform_version: platform_version, app: app, new_command_timeout: timeout)
         appium.execute
       end
-    end
-  end
-end
+    end # self
+  end # class Command
+end # module Cuesmash

data/lib/cuesmash/compiler.rb

@@ -6,20 +6,15 @@ 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
-    attr_accessor :build_configuration
 
-    def initialize(scheme, tmp_dir, build_configuration)
+    def initialize(scheme, tmp_dir)
       @scheme = scheme
       @tmp_dir = tmp_dir
-      @build_configuration = build_configuration
     end
 
     #
@@ -44,7 +39,7 @@ module Cuesmash
       end
 
       if status != 0
-        Logger.fatal "Compilation failed: #{output}"
+        # Logger.fatal "Compilation failed: #{output}"
         exit status
         status
       else
@@ -67,35 +62,5 @@ module Cuesmash
     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}"
-      xcode_command = "set -o pipefail && xcodebuild #{workspace} -scheme #{@scheme} -derivedDataPath #{@tmp_dir} -configuration #{@build_configuration} OBJROOT=#{@tmp_dir} SYMROOT=#{@tmp_dir} -sdk iphonesimulator build | bundle exec xcpretty -c"
-
-      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
+  end # class compiler
+end # module cuesmash

data/lib/cuesmash/cucumber.rb

@@ -30,8 +30,7 @@ module Cuesmash
     # @param profile [String] the cucumber profile to use for the tests
     # @param quiet [Boolean]
     #
-    def initialize(ios, tags, profile, quiet)
-      @ios = ios
+    def initialize(tags, profile, quiet)
       @tags = tags
       @profile = profile
       @quiet = quiet

data/lib/cuesmash/ios_app.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require 'cuesmash/app'
+
+module Cuesmash
+
+  #
+  # Provides an object to get information about the ios app that is being built.
+  #
+  class IosApp < App
+
+    # Public: the path to the dir containing the built app i.e. /tmp/MyAppQWERQW/Build/Products/Debug-iphonesimulator/
+    attr_reader :app_dir
+
+    # Public: the full path including the built app i.e. /tmp/MyAppQWERQW/Build/Products/Debug-iphonesimulator/MyApp.app"
+    attr_reader :app_path
+
+    # Public: the app name i.e. MyApp.app
+    attr_reader :app_name
+
+    # Public: the xcode Derived Data temp directory
+    attr_reader :tmp_dir
+
+    #
+    # Create a new App instance
+    #
+    # @param  file_name [String] The usually is the scheme of the xcode project
+    # @param build_configuration [String] which iOS build configuration to run i.e. Release, Debug
+    #
+    # @return [App] A app instance
+    def initialize(file_name:, build_configuration:)
+      @app_name = "#{file_name}" << ".app"
+      @tmp_dir = Dir.mktmpdir(file_name)
+      @build_configuration = build_configuration
+
+      @app_dir = "#{@tmp_dir}" << "/#{@build_configuration}-iphonesimulator/"
+  
+      @app_path = "#{@app_dir}" << "#{@app_name}"
+    end
+  end # class IosApp
+end # module Cuesmash

data/lib/cuesmash/ios_compiler.rb

@@ -0,0 +1,49 @@
+# coding: utf-8
+
+module Cuesmash
+
+  #
+  # iOS Specific compiler
+  # 
+  class IosCompiler < Compiler
+
+    attr_accessor :scheme
+    attr_accessor :tmp_dir
+    attr_accessor :build_configuration
+
+    def initialize(scheme, tmp_dir, build_configuration)
+      @scheme = scheme
+      @tmp_dir = tmp_dir
+      @build_configuration = build_configuration
+    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 = "set -o pipefail && xcodebuild #{workspace} -scheme #{@scheme} -derivedDataPath #{@tmp_dir} -configuration #{@build_configuration} OBJROOT=#{@tmp_dir} SYMROOT=#{@tmp_dir} -sdk iphonesimulator build | bundle exec xcpretty -c"
+
+      Logger.info "xcode_command == #{xcode_command}"
+      xcode_command
+    end # command
+
+    #
+    # 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 # workspace
+  end # class IosCompiler
+end # module Cuesmash