crash_monkey 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1979b40cce8bf2c1b770ade1732f143a3969c599
-  data.tar.gz: 3766534b86c538ad577e0623812c6361b0ee5d9c
+  metadata.gz: 07673a78ca873c7a0f2f098629e45c9ecb9da196
+  data.tar.gz: bf23e3a5e46db45f2cd196c42373b83e59a1af42
 SHA512:
-  metadata.gz: 465a9a9bac762efd27441a6a04e1bfdee24cb18019478d0c2af8a05d028d75fb969aa30a3fa19ca67677fea9876b416e4d518e96c3f9e102c6a6f5192665dee8
-  data.tar.gz: c0e4f55852c20b2508a3779f88d7e6404a06610da9a2954060f8d5fc95bd3f56ac97e89e9259d423f21c05142bda2c2b1e2d01737d4e496ea82c8564cf9d7bc6
+  metadata.gz: 51b20cd52dcfe73e770413ac3c14ea982686ff62d1dc0a72e560d7dfd2f3d1436c6a1e83dabe011ed661bc77514f9498efb61d79e529d59cb5bd4aa50a8e81dc
+  data.tar.gz: af03c958a562bc4367825cfd71f4c138834e1a38222e3a2941fae83543a760390743aaaa8ed5486b59fcc72efc14e36ef429057f78754485e50f30bbb7f7bbb5

data/README_jp.md

@@ -0,0 +1,189 @@
+CrashMonkey
+===========
+
+[English](README.md)
+
+概要
+----
+
+iOSのアプリケーションをモンキーテスト（ランダムな操作をひたすら行う）するためのツールです。
+動作イメージはこの[デモ動画](http://youtu.be/y5PZGVbLHtI)を御覧ください。
+iPhone Simulatorの操作にはUIAutomationを使っていて、ベースとして[ui-auto-monkey](https://github.com/jonathanpenn/ui-auto-monkey)を使わせて頂きました。
+
+
+動作環境
+-------
+
+以下の環境でのみ確認してあります。
+
+* Max OS X 10.8.4
+* Xcode 4.6.3(Build version 4H1503)
+* Ruby 1.8.7-p371
+
+Rubyについては、1.9系, 2.0系でも動くと思います。
+
+
+CrashMonkeyの特徴
+---------------
+
+### 良い点
+
+* アプリのプロジェクト自体に変更を加えなくても実行することができます
+* 実行時間や実行回数を指定できます
+* 実行結果をScreenshotと操作履歴のHTMLとしてみることができます
+* 実行時のConsoleLogや、Crash時のCrashレポートもみることができます
+* JenkinsなどのCIツールとの連携も容易です
+
+### 制限
+
+* iPhone Simulator でしか実行できません
+* 別のアプリ(Safariなど）に遷移してしまうと、テストが継続できません（検知してその回を終了します）
+* 適切な文字入力(ID/PASS等)とか猿だとできないような難しい操作ができません
+
+
+Install
+--------
+
+```
+gem install crash_monkey --no-ri --no-rdoc
+```
+
+使いかた
+------
+
+```
+crash_monkey -a <APP_NAME or APP_PATH>
+```
+
+`-a`でアプリの名前かPATHを指定します。
+
+#### 例
+
+```
+crash_monkey -a MyAwesomeApp.app                               # (1)
+crash_monkey -a build/Debug-iphonesimulator/MyAwesomeApp.app   # (2)
+crash_monkey -a ~/Library/Developer/Xcode/DerivedData/MyAwesomeApp-ffumcy/Build/Products/Debug-iphonesimulator/MyAwesomeApp.app # (3)
+```
+
+* (1) の指定方法では、iPhone Simulatorにインストールされているアプリで名前が一致するものを実行します。同名のものが複数ある場合は更新時刻が一番新しいものを使います
+* (2)(3) の指定方法では、PATHにあるアプリを実行します。ただし、iPhone Simulator用にビルドされたものじゃないと使えないので注意して下さい。
+	* Dir名に **iphonesimulator** と入っているものが大抵そうです
+
+
+
+
+### Options
+
+```
+% crash_monkey
+Usage: crash_monkey [options]
+    -a app_name                      Target Application(Required)
+    -n run_count                     How many times monkeys run(default: 2)
+    -d result_dir                    Where to output result(default: ./crash_monkey_result)
+    -t time_limit_sec                Time limit of running(default: 100 sec)
+    -c config_path                   Configuration JSON Path
+    -e extend_javascript_path        Extend Uiautomation Javascript for such Login scripts
+        --show-config                Show Current Configuration JSON
+        --list-app                   Show List of Installed Apps in iOS Simulator
+        --reset-iPhone-Simulator     Reset iPhone Simulator
+```
+
+
+#### -n
+Monkey Testを実行する回数を指定します。
+
+#### -d
+結果を出力するDirを指定します。
+
+#### -t
+1回のテストのTimeoutを秒で指定します。
+
+#### -c
+UIAutomationの実行時に使うJSON形式のConfigファイルを指定します。雛形については `--show-config`オプションで取得してください。
+
+#### -e
+UIAutomation用の拡張JavaScriptファイルを指定します。
+Loginなどに使うことができます。 ([example](https://gist.github.com/jollychang/8972186))
+
+
+#### --show-config
+UIAutomationの実行時に使うConfigファイルをJSON形式で出力します。変更したい場合は、一度ファイルに保存してから変更し、 `-c` で指定してください。
+
+#### --list-app
+
+iPhone Simulatorにインストールされているアプリの名前の一覧を表示します。
+
+#### --reset-iPhone-Simulator
+
+iPhone Simulatorをリセットします。
+
+Jenkinsとの連携
+--------------
+
+CrashMonkeyはコマンドラインから起動するので、JenkinsなどのCIツールと連携するのは難しくないですが、いくつか注意点を挙げておきます。
+
+### UIAutomation の 確認ダイアログがでる
+
+そのMacで初めてCrashMonkeyを実行する場合、Instruments(UIAutomation)が確認ダイアログを表示してパスワードの入力が求められることがあります。
+
+この場合パスワードを入力しないと実行できませんが、少なくとも以下の対処をしておけば良いです。
+
+* Jenkins実行ユーザがAdmin権限を持っている
+* Jenkins Slaveを動かしている場合
+
+	```
+	javaws http://<SERVER>/computer/<NodeName>/slave-agent.jnlp
+	```
+  というようなXを使った起動方法にしておく
+* Jenkinsからの実行時に、一度ダイアログが出るので、正しいパスワードを入力する
+
+
+違う条件でも動くかもしれませんが、上記のようにしておけばダイアログが出なくなります。
+
+ssh でログインしてこの状態になったときに、CUI上でユーザ名とパスワードを聞かれることがあります。
+ここで正しく入力しても動かなかいことがありますので注意が必要です。
+
+
+トラブルシューティング
+-------------------
+
+### xcode-select が設定されていないケース
+
+
+#### 現象
+```
+% crash_monkey -a MyGoodApp.app
+.....
+Run: ["instruments", "-l", "100000", "-t", ........... ]
+xcode-select: Error: No Xcode folder is set. Run xcode-select -switch <xcode_folder_path> to set the path to the Xcode folder.
+.....
+```
+
+#### 対処
+
+xcode-select で XcodeのInstall Pathを指定して下さい。
+
+例）
+
+```
+sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer
+```
+
+
+Contributing to CrashMonkey
+---------------------
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+----------
+
+Copyright (c) 2013 Ken Morishita. See LICENSE.txt for
+further details.
+

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/crash_monkey.gemspec

@@ -2,36 +2,38 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: crash_monkey 0.3.1 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = %q{crash_monkey}
-  version_path = File.join(File.dirname(__FILE__), "VERSION")
-  s.version = File.read(version_path)
+  s.name = "crash_monkey"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
   s.authors = ["Ken Morishita"]
-  s.date = %q{2014-03-28}
-  s.default_executable = %q{crash_monkey}
-  s.description = %q{This is a Monkey Test Tool using UIAutomation.}
-  s.email = %q{mokemokechicken@gmail.com}
+  s.date = "2016-10-04"
+  s.description = "This is a Monkey Test Tool using UIAutomation."
+  s.email = "mokemokechicken@gmail.com"
   s.executables = ["crash_monkey"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md",
-    "README.rdoc"
+    "README.rdoc",
+    "README_jp.md"
   ]
   s.files = [
     ".document",
     ".rspec",
     "Gemfile",
-    "Gemfile.lock",
     "LICENSE.txt",
     "README.md",
     "README.rdoc",
+    "README_jp.md",
     "Rakefile",
     "VERSION",
     "bin/crash_monkey",
     "crash_monkey.gemspec",
+    "example_config.json",
     "lib/bootstrap/css/bootstrap-responsive.css",
     "lib/bootstrap/css/bootstrap-responsive.min.css",
     "lib/bootstrap/css/bootstrap.css",
@@ -53,14 +55,13 @@ Gem::Specification.new do |s|
     "lib/ui-auto-monkey/UIAutoMonkey.js",
     "spec/spec_helper.rb"
   ]
-  s.homepage = %q{https://github.com/mokemokechicken/CrashMonkey}
+  s.homepage = "https://github.com/mokemokechicken/CrashMonkey"
   s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{Monkey Test For iOS Application}
+  s.rubygems_version = "2.4.5.1"
+  s.summary = "Monkey Test For iOS Application"
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<erubis>, [">= 2.7.0"])
@@ -69,7 +70,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0.8.2"])
     else
       s.add_dependency(%q<erubis>, [">= 2.7.0"])
       s.add_dependency(%q<json>, [">= 1.7.0"])
@@ -77,11 +78,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
-      if RUBY_VERSION > '1.9' then
-        s.add_dependency(%q<simplecov>, [">= 0"])
-      else
-        s.add_dependency(%q<rcov>, [">= 0"])
-      end
+      s.add_dependency(%q<simplecov>, [">= 0.8.2"])
     end
   else
     s.add_dependency(%q<erubis>, [">= 2.7.0"])
@@ -90,7 +87,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, ["> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
-    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0.8.2"])
   end
 end
 

data/example_config.json

@@ -0,0 +1,22 @@
+{
+    "numberOfEvents": 100,
+    "delayBetweenEvents": 0.05,
+
+    "eventWeights": {
+        "tap": 500,
+        "drag": 1,
+        "flick": 1,
+        "orientation": 1,
+        "clickVolumeUp": 1,
+        "clickVolumeDown": 1,
+        "pinchClose": 10,
+        "pinchOpen": 10,
+        "shake": 1
+    },
+
+    "touchProbability": {
+        "multipleTaps": 0.05,
+        "multipleTouches": 0.05,
+        "longPress": 0.05
+    }
+}

data/lib/crash_monkey/monkey_runner.rb

@@ -165,7 +165,7 @@ module UIAutoMonkey
     end
 
     def find_apps(app)
-      `"ls" -dt #{ENV['HOME']}/Library/Developer/Xcode/DerivedData/*/Build/Products/*/#{app}`.strip.split(/\n/)
+      `"ls" -dt #{ENV['HOME']}/Library/Developer/Xcode/DerivedData/*/Build/Products/*/'#{app}'`.strip.split(/\n/)
     end
 
     def devices
@@ -220,7 +220,7 @@ module UIAutoMonkey
     end
 
     def crash_report_list
-      `ls -t #{crash_report_dir}/#{app_name}_*.crash`.strip.split(/\n/)
+      `ls -t #{crash_report_dir}/'#{app_name}'_*.crash`.strip.split(/\n/)
     end
 
     def grep_syslog

data/lib/crash_monkey/templates/config.json

@@ -10,7 +10,7 @@
         "orientation": 1,
         "clickVolumeUp": 1,
         "clickVolumeDown": 1,
-        "lock": 3,
+        "lock": 0,
         "pinchClose": 50,
         "pinchOpen": 50,
         "shake": 1,

data/lib/ui-auto-monkey/UIAutoMonkey.js

@@ -1,3 +1,4 @@
+
 // Copyright (c) 2013 Jonathan Penn (http://cocoamanifest.net/)
 
 // Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -45,7 +46,8 @@ function UIAutoMonkey() {
 			lock: 0,
 			pinchClose: 10,
 			pinchOpen: 10,
-			shake: 1
+			shake: 1,
+			deactivate: 0
 		},
 
 		// Probability that touch events will have these different properties
@@ -153,7 +155,11 @@ UIAutoMonkey.prototype.allEvents = {
 
 	shake: function() {
 		this.target().shake();
-	}
+	},
+
+    deactivate: function() {
+        this.target().deactivateAppForDuration(Math.random() * 3);
+    }
 };
 
 // --- --- --- ---
@@ -176,6 +182,10 @@ UIAutoMonkey.prototype.triggerRandomEvent = function() {
 	var name = this.chooseEventName();
 	// Find the event method based on the name of the event
 	var event = this.allEvents[name];
+	if (!event) {
+		UIALogger.logMessage("Attempted to " + name)
+		throw new Error("Attempted to fire an undefined event '" + name + "'!")
+	}
 	event.apply(this);
 };
 

metadata

@@ -1,113 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: crash_monkey
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Ken Morishita
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.7.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.12'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.4
 - !ruby/object:Gem::Dependency
-  name: rcov
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.2
 description: This is a Monkey Test Tool using UIAutomation.
 email: mokemokechicken@gmail.com
 executables:
@@ -117,18 +117,20 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 - README.rdoc
+- README_jp.md
 files:
-- .document
-- .rspec
+- ".document"
+- ".rspec"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - README.rdoc
+- README_jp.md
 - Rakefile
 - VERSION
 - bin/crash_monkey
 - crash_monkey.gemspec
+- example_config.json
 - lib/bootstrap/css/bootstrap-responsive.css
 - lib/bootstrap/css/bootstrap-responsive.min.css
 - lib/bootstrap/css/bootstrap.css
@@ -159,18 +161,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Monkey Test For iOS Application
 test_files: []

data/Gemfile.lock

@@ -1,70 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    addressable (2.3.6)
-    builder (3.2.2)
-    diff-lcs (1.1.3)
-    docile (1.1.5)
-    erubis (2.7.0)
-    faraday (0.8.9)
-      multipart-post (~> 1.2.0)
-    git (1.2.8)
-    github_api (0.10.1)
-      addressable
-      faraday (~> 0.8.1)
-      hashie (>= 1.2)
-      multi_json (~> 1.4)
-      nokogiri (~> 1.5.2)
-      oauth2
-    hashie (3.3.1)
-    highline (1.6.21)
-    jeweler (1.8.8)
-      builder
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      github_api (= 0.10.1)
-      highline (>= 1.6.15)
-      nokogiri (= 1.5.10)
-      rake
-      rdoc
-    json (1.8.1)
-    jwt (1.0.0)
-    multi_json (1.10.1)
-    multi_xml (0.5.5)
-    multipart-post (1.2.0)
-    nokogiri (1.5.10)
-    oauth2 (1.0.0)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (~> 1.2)
-    rack (1.5.2)
-    rake (10.3.2)
-    rdoc (3.12.2)
-      json (~> 1.4)
-    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)
-    simplecov (0.9.1)
-      docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (> 1.0.0)
-  erubis (>= 2.7.0)
-  jeweler (~> 1.8.4)
-  json (>= 1.7.0)
-  rdoc (~> 3.12)
-  rspec (~> 2.8.0)
-  simplecov (>= 0.8.2)