baleen 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8427ae101777b8e6bc365a2c18bb930a35fc3a8f
-  data.tar.gz: 15442644987967b6ef4452f66191bf532b10d0ab
+  metadata.gz: 2926ffd6301f080fb74885a2d760a53d5155bef7
+  data.tar.gz: 7ab9916383f64ee4fa05c409aeab5dd026b3dc79
 SHA512:
-  metadata.gz: e7928c5a13b2170be1715039f5cbc652d849d15309f49cd63c45885f668c463706f857d315b7f1edf51298cbaed2f98fef7c1843a0cb8493ed970bffc887751c
-  data.tar.gz: ce5cbce8080d073b8c08ec90783a55c936556c6a459ce710be3788b3d77c0a2a2947f24e7c494a762748195a3d98f2d952e5ed04145329c6eb1f37738d90d934
+  metadata.gz: 64ea677e359b427e402a1b061221063f24435c7805ff96ce12f3d308454ddbb96ecb8ced0184c0b334b51c13ad0e70b2c7a3d6ee5124f297381e9851d0b048d3
+  data.tar.gz: 7784401b71d0e19d4ef0ad49a72a7c73f509e110cd7b89cc4bd97778fe8d365f4363d238d0fb6b50ceb6c75feb1bd2a789f2bc5a30ee9cca77ce708a8cecb96c

data/README.md

@@ -2,22 +2,79 @@
 Baleen is a test runner powered by Docker and Celluloid::IO.
 Baleen allows you to run ruby standard tests such as Cucumber or Rspec in totally isolated environment and parallel.
 
-By using Baleen, you can run feature or spec in a dedicated linux container, so test will not affect the state of other tests.
+By using Baleen, you can tests in a dedicated linux container, so each test will not affect the state of other tests.
 Also, Baleen will speed up your tests since multiple containers run their tests in parallel.
 
 ## Requirement
-Linux machine with Docker installed
+* Linux machine with Docker installed
+* ruby-2.0.0 or later
 
 ## Installation
 
-TODO
+    gem install baleen
 
 ## Usage
+Baleen is server-client model. You need to run baleen-server which talks Docker API and baleen (client) to put your request to the server.
 
+#### Running Baleen server
+You can run baleen server with baleen-server command.
 
-Baleen is server-client model. You need to run baleen-server which talks Docker API to Docker and you can use baleen-client to put your request to the server like below.
+    $ baleen-server start
 
-    $ bundle exec baleen cucumber  --image kimh/baleen-poc --files features/ --work_dir /git/baleen/poc --before_command "source /etc/profile"
+baleen-server will take below options
+
+* --docker_host: specify url or ip of server where Docker server is running. Default: 127.0.0.1
+* --docker_port: specify port that Docker server is listening to. Default: 4243
+* --port: specify port that Baleen server is listening to. Default: 5533
+* --debug: you can specify this option to enable debug mode to print out debug message to console. No argument is required. Default: disabled
+
+#### Running Baleen client
+You can run baleen client with simply baleen command. baleen command will take one subcommand to specify which kind of test you want to run on baleen server. With v0.0,1. only cucucmber subcommand is available.
+
+    $ baleen cucumber --image kimh/baleen-poc --files features --work_dir /git/baleen/poc --before_command "source /etc/profile" --concurrency 6
+
+baleen command wil take below options
+
+* --port: specify port number of baleen server. Default: 5533
+* --image: specify the name of image that you want to use to run your tests. Mandatory option
+* --files: specify directory or file of tests that you want to run. Default is /features with v0.0.1
+* --work_dir: specify working directory. Default: ./
+* --before_command: specify commands that you want to execute before running your tests. Default: nil
+* --concurrency: specify number of containers that you want to run at the same time. Default: 2
+
+## Try Baleen with POC app
+If you pull kimh/baleen-poc image to your Docker, you can see how baleen works. In this example, you are running Docker at 192.168.0.1, baleen-server @192.168.0.2 that points to the Docker server, and baleen client to point to the baleen server.
+
+First, pull the image at Docker server
+
+    $ docker pull kimh/baleen-poc
+
+By pulling kimh/baleen-poc, you will have a container that has the latest baleen project, installed under /git.
+You need to run Docker with API enabled (Docker server listens 127.0.0.1 by default) by modifying /etc/init/docker.conf.
+
+    $ vi /etc/init/docker.conf
+
+    description     "Docker daemon"
+
+    start on filesystem or runlevel [2345]
+    stop on runlevel [!2345]
+
+    respawn
+
+    script
+       /usr/bin/docker -d -H=tcp://0.0.0.0:4243/ # Add this line
+       #/usr/bin/docker -d                       # and comment out this line
+    end script
+
+And restart your machine to apply the new configuration.
+
+Next, run baleen-server. Make sure you specify correct ip of the machine that is running Docker.
+
+    $ baleen-server --docker-host 192.168.0.1
+
+Finally, run baleen. Make sure to specify correct ip of the machine that is running baleen-server. Below command will run all features under /git/baleen/poc with three containers.
+
+    $ baleen cucumber --host 192.168.0.2 --image kimh/baleen-poc --work_dir /git/baleen/poc --before_command "export RAILS_ENV=test; source /etc/profile" --concurrency 3
     [Summary]
     Result: Pass
     Time: 0min 38sec
@@ -58,8 +115,6 @@ Baleen is server-client model. You need to run baleen-server which talks Docker
 
     ....snip.....
 
-
-
 ## Contributing
 
 1. Fork it
@@ -68,3 +123,5 @@ Baleen is server-client model. You need to run baleen-server which talks Docker
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+
+

data/bin/baleen-server

@@ -4,7 +4,7 @@ require "thor"
 require "baleen"
 
 def pid
-  pid = `ps ax | grep -E "baleen-server start|restart" | grep -v grep | awk '{print $1}'`
+  pid = `ps ax | grep -E "bin/baleen-server" | grep -v grep | awk '{print $1}'`
   pid.split("\n")
 end
 

data/lib/baleen/version.rb

@@ -1,3 +1,3 @@
 module Baleen
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/poc/features/step_definitions/fake_test_steps.rb

@@ -5,8 +5,8 @@ end
 Then /cpu intensive operation/ do
   t1 = Time.now
 
-  rep = 10000
-  n   = 10000
+  rep = 1000
+  n   = 1000
 
   x = Array.new(n, 0)
 

data/poc/features/t1.feature

@@ -2,11 +2,11 @@ Feature: t1
   Scenario: Benchmark for IO bound operation
     Then io intensive operation
 
-  #Scenario: Benchmark for CPU bound operation
-  #  Then cpu intensive operation
+  Scenario: Benchmark for CPU bound operation
+    Then cpu intensive operation
 
-  #Scenario: Benchmark for IO bound operation
-  #  Then io intensive operation
+  Scenario: Benchmark for IO bound operation
+    Then io intensive operation
 
-  #Scenario: Benchmark for CPU bound operation
-  #  Then cpu intensive operation
+  Scenario: Benchmark for CPU bound operation
+    Then cpu intensive operation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: baleen
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kim, Hirokuni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-13 00:00:00.000000000 Z
+date: 2013-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -217,8 +217,6 @@ files:
 - poc/db/migrate/20130914144710_create_ar_profiles.rb
 - poc/db/schema.rb
 - poc/db/seeds.rb
-- poc/features/cpu_bound.feature
-- poc/features/io_bound.feature
 - poc/features/step_definitions/fake_test_steps.rb
 - poc/features/support/env.rb
 - poc/features/support/ruby_prof_cucumber.rb

data/poc/features/cpu_bound.feature

@@ -1,3 +0,0 @@
-Feature: Benchmark CPU intensive feature
-  Scenario: Benchmark for CPU bound operation
-    Then cpu intensive operation

data/poc/features/io_bound.feature

@@ -1,3 +0,0 @@
-Feature: Benchmark IO intensive feature
-  Scenario: Benchmark for IO bound operation
-    Then io intensive operation