Module: Calabash::Cucumber::SimulatorHelper
- Defined in:
- lib/calabash-cucumber/launch/simulator_helper.rb
Defined Under Namespace
Classes: TimeoutErr
Constant Summary collapse
- DERIVED_DATA =
File.("~/Library/Developer/Xcode/DerivedData")
- DEFAULT_DERIVED_DATA_INFO =
File.("#{DERIVED_DATA}/*/info.plist")
- DEFAULT_SIM_WAIT =
30
- DEFAULT_SIM_RETRY =
2
Class Method Summary collapse
- .app_bundle_or_raise(path) ⇒ Object
- .derived_data_dir_for_project ⇒ Object
- .ensure_connectivity(app_bundle_path, sdk, version, args = nil) ⇒ Object
- .find_preferred_dir(sim_dirs) ⇒ Object
- .get_version ⇒ Object
- .ios_major_version ⇒ Object
- .ios_version ⇒ Object
- .launch(app_bundle_path, sdk, version, args = nil) ⇒ Object
- .ping_app ⇒ Object
- .project_dir ⇒ Object
- .relaunch(path, sdk = nil, version = 'iphone', args = nil) ⇒ Object
- .stop ⇒ Object
- .version_check(version) ⇒ Object
Class Method Details
.app_bundle_or_raise(path) ⇒ Object
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'lib/calabash-cucumber/launch/simulator_helper.rb', line 116 def self.app_bundle_or_raise(path) bundle_path = nil path = File.(path) if path if path and not File.directory?(path) puts "Unable to find .app bundle at #{path}. It should be an .app directory." dd_dir = derived_data_dir_for_project app_bundles = Dir.glob(File.join(dd_dir, "Build", "Products", "*", "*.app")) msg = "Try setting APP_BUNDLE_PATH in features/support/launch.rb to one of:\n\n" msg << app_bundles.join("\n") raise msg elsif path bundle_path = path else dd_dir = derived_data_dir_for_project sim_dirs = Dir.glob(File.join(dd_dir, "Build", "Products", "*-iphonesimulator", "*.app")) if sim_dirs.empty? msg = ["Unable to auto detect APP_BUNDLE_PATH."] msg << "Have you built your app for simulator?." msg << "Searched dir: #{dd_dir}/Build/Products" msg << "Please build your app from Xcode" msg << "You should build the -cal target." msg << "" msg << "Alternatively, specify APP_BUNDLE_PATH in features/support/launch.rb" msg << "This should point to the location of your built app linked with calabash.\n" raise msg.join("\n") end preferred_dir = find_preferred_dir(sim_dirs) if preferred_dir.nil? msg = ["Error... Unable to find APP_BUNDLE_PATH."] msg << "Cannot find a built app that is linked with calabash.framework" msg << "Please build your app from Xcode" msg << "You should build your calabash target." msg << "" msg << "Alternatively, specify APP_BUNDLE_PATH in features/support/launch.rb" msg << "This should point to the location of your built app linked with calabash.\n" raise msg.join("\n") end puts("-"*37) puts "Auto detected APP_BUNDLE_PATH:\n\n" puts "APP_BUNDLE_PATH=#{preferred_dir || sim_dirs[0]}\n\n" puts "Please verify!" puts "If this is wrong please set it as APP_BUNDLE_PATH in features/support/launch.rb\n" puts("-"*37) bundle_path = sim_dirs[0] end bundle_path end |
.derived_data_dir_for_project ⇒ Object
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/calabash-cucumber/launch/simulator_helper.rb', line 35 def self.derived_data_dir_for_project dir = project_dir xcode_workspace_name = '' info_plist = Dir.glob(DEFAULT_DERIVED_DATA_INFO).find { |plist_file| begin plist = CFPropertyList::List.new(:file => plist_file) hash = CFPropertyList.native_types(plist.value) ws_dir = File.dirname(hash['WorkspacePath']).downcase p_dir = dir.downcase if (p_dir.include? ws_dir) xcode_workspace_name = ws_dir.split('/').last end ws_dir == p_dir rescue false end } if not info_plist.nil? return File.dirname(info_plist) else res = Dir.glob("#{dir}/*.xcodeproj") if res.empty? raise "Unable to find *.xcodeproj in #{dir}" elsif res.count > 1 raise "Unable to found several *.xcodeproj in #{dir}: #{res}" end xcode_proj_name = res.first.split(".xcodeproj")[0] xcode_proj_name = File.basename(xcode_proj_name) build_dirs = Dir.glob("#{DERIVED_DATA}/*").find_all do |xc_proj| File.basename(xc_proj).start_with?(xcode_proj_name) end if (build_dirs.count == 0 && !xcode_workspace_name.empty?) # check for directory named "workspace-{deriveddirectoryrandomcharacters}" build_dirs = Dir.glob("#{DERIVED_DATA}/*").find_all do |xc_proj| File.basename(xc_proj).downcase.start_with?(xcode_workspace_name) end end if (build_dirs.count == 0) msg = ["Unable to find your built app."] msg << "This means that Calabash can't automatically launch iOS simulator." msg << "Searched in Xcode 4.x default: #{DEFAULT_DERIVED_DATA_INFO}" msg << "" msg << "To fix there are a couple of options:\n" msg << "Option 1) Make sure you are running this command from your project directory, " msg << "i.e., the directory containing your .xcodeproj file." msg << "In Xcode, build your calabash target for simulator." msg << "Check that your app can be found in\n #{File.("~/Library/Developer/Xcode/DerivedData")}" msg << "\n\nOption 2). In features/support/launch.rb set APP_BUNDLE_PATH to" msg << "the path where Xcode has built your Calabash target." msg << "Alternatively you can use the environment variable APP_BUNDLE_PATH.\n" raise msg.join("\n") elsif (build_dirs.count > 1) msg = ["Unable to auto detect APP_BUNDLE_PATH."] msg << "You have several projects with the same name: #{xcode_proj_name} in #{DERIVED_DATA}:\n" msg << build_dirs.join("\n") msg << "\nThis means that Calabash can't automatically launch iOS simulator." msg << "Searched in Xcode 4.x default: #{DEFAULT_DERIVED_DATA_INFO}" msg << "\nIn features/support/launch.rb set APP_BUNDLE_PATH to" msg << "the path where Xcode has built your Calabash target." msg << "Alternatively you can use the environment variable APP_BUNDLE_PATH.\n" raise msg.join("\n") else puts "Found potential build dir: #{build_dirs.first}" puts "Checking..." return build_dirs.first end end end |
.ensure_connectivity(app_bundle_path, sdk, version, args = nil) ⇒ Object
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/calabash-cucumber/launch/simulator_helper.rb', line 173 def self.ensure_connectivity(app_bundle_path, sdk, version, args = nil) begin max_retry_count = (ENV['MAX_CONNECT_RETRY'] || DEFAULT_SIM_RETRY).to_i timeout = (ENV['CONNECT_TIMEOUT'] || DEFAULT_SIM_WAIT).to_i retry_count = 0 connected = false puts "Waiting at most #{timeout} seconds for simulator (CONNECT_TIMEOUT)" puts "Retrying at most #{max_retry_count} times (MAX_CONNECT_RETRY)" until connected do raise "MAX_RETRIES" if retry_count == max_retry_count retry_count += 1 puts "(#{retry_count}.) Start Simulator #{sdk}, #{version}, for #{app_bundle_path}" begin Timeout::timeout(timeout, TimeoutErr) do simulator = launch(app_bundle_path, sdk, version, args) until connected begin connected = (ping_app == '405') if ENV['POST_START_BREAK'] puts "Environment var POST_START_BREAK is deprecated and should no longer be necessary." post_connect_sleep = (ENV['POST_START_BREAK'] || "2").to_f sleep(post_connect_sleep) unless post_connect_sleep <= 0 end if connected server_version = get_version if server_version p server_version unless version_check(server_version) msgs = ["You're running an older version of Calabash server with a newer client", "Client:#{Calabash::Cucumber::VERSION}", "Server:#{server_version}", "Minimum server version #{Calabash::Cucumber::FRAMEWORK_VERSION}", "Update recommended:", "https://github.com/calabash/calabash-ios/wiki/B1-Updating-your-Calabash-iOS-version" ] raise msgs.join("\n") end else connected = false end end rescue Exception => e ensure sleep 1 unless connected end end end rescue TimeoutErr => e puts "Timed out..." end end rescue e p e msg = "Unable to make connection to Calabash Server at #{ENV['DEVICE_ENDPOINT']|| "http://localhost:37265/"}\n" msg << "Make sure you've' linked correctly with calabash.framework and set Other Linker Flags.\n" msg << "Make sure you don't have a firewall blocking traffic to #{ENV['DEVICE_ENDPOINT']|| "http://localhost:37265/"}.\n" raise msg end end |
.find_preferred_dir(sim_dirs) ⇒ Object
166 167 168 169 170 171 |
# File 'lib/calabash-cucumber/launch/simulator_helper.rb', line 166 def self.find_preferred_dir(sim_dirs) sim_dirs.find do |d| out = `otool "#{File.(d)}"/* -o 2> /dev/null | grep CalabashServer` /CalabashServer/.match(out) end end |
.get_version ⇒ Object
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 |
# File 'lib/calabash-cucumber/launch/simulator_helper.rb', line 258 def self.get_version endpoint = ENV['DEVICE_ENDPOINT']|| "http://localhost:37265" endpoint += "/" unless endpoint.end_with? "/" url = URI.parse("#{endpoint}version") puts "Fetch version #{url}..." begin body = Net::HTTP.get_response(url).body res = JSON.parse(body) if res['iOS_version'] @ios_version = res['iOS_version'] end res rescue nil end end |
.ios_major_version ⇒ Object
283 284 285 286 287 288 |
# File 'lib/calabash-cucumber/launch/simulator_helper.rb', line 283 def self.ios_major_version v = ios_version if v v.split(".")[0] end end |
.ios_version ⇒ Object
276 277 278 279 280 281 |
# File 'lib/calabash-cucumber/launch/simulator_helper.rb', line 276 def self.ios_version unless @ios_version get_version end @ios_version end |
.launch(app_bundle_path, sdk, version, args = nil) ⇒ Object
235 236 237 238 239 240 |
# File 'lib/calabash-cucumber/launch/simulator_helper.rb', line 235 def self.launch(app_bundle_path, sdk, version, args = nil) simulator = SimLauncher::Simulator.new simulator.quit_simulator simulator.launch_ios_app(app_bundle_path, sdk, version) #, args wait for update to sim launcher simulator end |
.ping_app ⇒ Object
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/calabash-cucumber/launch/simulator_helper.rb', line 242 def self.ping_app url = URI.parse(ENV['DEVICE_ENDPOINT']|| "http://localhost:37265/") puts "Ping #{url}..." http = Net::HTTP.new(url.host, url.port) res = http.start do |sess| sess.request Net::HTTP::Get.new url.path end status = res.code begin http.finish if http and http.started? rescue end status end |
.project_dir ⇒ Object
112 113 114 |
# File 'lib/calabash-cucumber/launch/simulator_helper.rb', line 112 def self.project_dir File.(ENV['PROJECT_DIR'] || Dir.pwd) end |
.relaunch(path, sdk = nil, version = 'iphone', args = nil) ⇒ Object
22 23 24 25 26 27 |
# File 'lib/calabash-cucumber/launch/simulator_helper.rb', line 22 def self.relaunch(path, sdk = nil, version = 'iphone', args = nil) app_bundle_path = app_bundle_or_raise(path) ensure_connectivity(app_bundle_path, sdk, version, args) end |
.stop ⇒ Object
29 30 31 32 |
# File 'lib/calabash-cucumber/launch/simulator_helper.rb', line 29 def self.stop simulator = SimLauncher::Simulator.new simulator.quit_simulator end |
.version_check(version) ⇒ Object
290 291 292 293 |
# File 'lib/calabash-cucumber/launch/simulator_helper.rb', line 290 def self.version_check(version) server_version = version["version"] Calabash::Cucumber::FRAMEWORK_VERSION == server_version end |