shoot 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4331d59d5b33ac9a34a36c7274543815c9227959
-  data.tar.gz: 4d5a81d84d44a5ce417ff9e7947e4c28b3ba8b8f
+  metadata.gz: 675f708a7fe175d332fea879546b0b1f3da65b01
+  data.tar.gz: 6503def1d598f295ed6cd8c32c36cfb14bb5b786
 SHA512:
-  metadata.gz: f56bed5a01c1cc3a3cdc718be79ea17b210dc466f7b933def485766bb20f110ddff156e22efaa29f525c7828e27205886add3027f2233f67909f340aa7212477
-  data.tar.gz: 3ab3a44aa10da24e97b62414b63ca3a2e70a4bde8c87d87124b6b9d087eb02f067a4b8bea4ab93fa739398533735abf5c576b3efd1bdcb3c618618945835420c
+  metadata.gz: 50f3f4c3492cba7e62ed7cdd839bf126b3b2b05e5e1f8770e3e8af28380797ec4f9b67bbc65c5b363d863efd704b8f2bfd2502090e988226feccc8af3562ab66
+  data.tar.gz: a0ae49e4ce89ea9ccfc782e84a1974d30bd21b4bc8a2fa7ce21a33999b277fdaa37c4b18e32a8a8e2ad742f1a55698bc31eb8df55a1fdc337e51d55a8dfc4a13

data/Changelog.md

@@ -0,0 +1,21 @@
+# 2.0.0
+
+- Adds interactive mode (`shoot -i`);
+- Increases performance by using curb (based on BrowserStack's docs);
+- Activate and deactivate accepts a list of ids (instead of 1 or a range);
+- Adds time elapsed for each test and for the whole suite;
+- Adds update command to download all browsers again (`shoot update`);
+- Allow to execute a whole folder (`shoot scenario folder/`);
+
+# 1.1.0
+
+- Allows to take shots inside methods, with the `shoot` method;
+- Changes the folder structure it saves screenshots. Now it is `.screenshots/BROWSER/CLASS/METHOD/SHOT.png`, where SHOT is the param passed to shoot, or `finish` – taken in the end of the method – or `failed`, taken when the method fails (it helps debugging);
+- Improves a lot the visual output of executions;
+
+# 1.0.0
+
+- Adds `test` command, allowing to run all scenarios locally against phantomjs (poltergeist);
+- Adds minimally decent error treatment: if something fails doesn't stop all execution, only specific test;
+- Adds `open` command, to open all screenshots (Mac only);
+- Adds version commands (`version`, `-v` or `--v`);

data/lib/shoot/cli.rb

@@ -1,6 +1,6 @@
 require 'thor'
 require 'json'
-require 'colorize'
+require 'highline/import'
 
 module Shoot
   class CLI < Thor
@@ -8,12 +8,42 @@ module Shoot
     FileUtils::mkdir_p '.screenshots'
     BROWSERS_PATH = '.screenshots/.browsers.json'
     map %w[--version -v] => :version
+    map %w[--interactive -i] => :interactive
 
     desc 'version, --version, -v', 'Shoot version'
     def version
       puts Shoot::VERSION
     end
 
+    desc 'interactive, --interactive, -i', 'Activate one platform, based on ID or interval'
+    def interactive
+      @exit = false
+
+      available_commands = {
+        active:         ->(_)     { active },
+        activate:       ->(params){ activate(*params.split(" ")) },
+        deactivate:     ->(params){ deactivate(*params.split(" ")) },
+        deactivate_all: ->(_)     { deactivate_all },
+        list:           ->(params){ list(params) },
+        open:           ->(_)     { open },
+        test:           ->(params){ test(params) },
+        scenario:       ->(params){ scenario(params) },
+        update:         ->(_)     { update },
+        exit:           ->(_)     { @exit = true }
+      }
+
+      while ! @exit
+        choose do |menu|
+          menu.layout = :menu_only
+          menu.shell  = true
+
+          available_commands.each do |command_name, command_action|
+            menu.choice(command_name, desc(command_name)){|_, details| command_action.call(details) }
+          end
+        end
+      end
+    end
+
     desc 'open', 'Opens all screenshots taken'
     def open
       open_all_screenshots
@@ -29,31 +59,37 @@ module Shoot
       table _active
     end
 
-    desc 'scenario', 'Runs the given scenario on all active platforms or one platform, based on ID'
-    def scenario(file, id = nil)
-      runners = id ? [json[id.to_i]] : _active
-      runners.each {|config| run file, config }
+    desc 'scenario', 'Runs the given scenario or all files in a directory on all active platforms'
+    def scenario(path)
+      files = File.directory?(path) ? Dir.glob("#{path}/*.rb") : [path]
+
+      elapsed_time do
+        _active.each do |config|
+          files.each do |file|
+            run file, config
+          end
+        end
+        print set_color("\nAll tests finished", :blue)
+      end
     end
 
     desc 'test', 'Runs the given scenario or all files in a directory on a local phantomjs'
     def test(path)
       files = File.directory?(path) ? Dir.glob("#{path}/*.rb") : [path]
-      files.each{|file| run file }
+      elapsed_time do
+        files.each{|file| run file, nil }
+        print set_color("\nAll tests finished", :blue)
+      end
     end
 
-    desc 'activate', 'Activate one platform, based on ID or interval'
-    def activate(from_id, to_id = from_id)
-      ids = (from_id.to_i..to_id.to_i).to_a
-      ids.each { |id| json[id]['active'] = true }
-      save_json
-      table json[from_id.to_i - 2, ids.size + 4]
+    desc 'activate ID', 'Activate platforms, based on IDs'
+    def activate(*ids)
+      _activate(ids)
     end
 
-    desc 'deactivate', 'Deactivate one platform, based on ID'
-    def deactivate(id)
-      json[id.to_i]['active'] = false
-      save_json
-      table json[id.to_i - 2, 5]
+    desc 'deactivate', 'Deactivate platforms, based on IDs'
+    def deactivate(*ids)
+      _deactivate(ids)
     end
 
     desc 'deactivate_all', 'Deactivate all the platforms'
@@ -64,25 +100,60 @@ module Shoot
       save_json
     end
 
+    desc 'update', 'Update browser list (WARNING: will override active browsers)'
+    def update
+      update_json
+      list
+    end
+
     no_commands do
+      def elapsed_time
+        require 'benchmark'
+
+        elapsed_time = Benchmark.measure do
+          yield
+        end
+        print set_color "  (#{elapsed_time.real.to_i}s)\n", :blue
+      end
+
+      def desc(command)
+        CLI.commands[command.to_s].description rescue nil
+      end
+
+      def _activate(ids)
+        return puts "No ids provided, e.g. 'activate 123'" if ids.empty?
+        ids.map!(&:to_i)
+        ids.each { |id| json[id]['active'] = true }
+        save_json
+        table json.select{|item| ids.include?(item['id']) }
+      end
+
+      def _deactivate(ids)
+        return puts "No ids provided, e.g. 'deactivate 123'" if ids.empty?
+        ids.map!(&:to_i)
+        ids.each { |id| json[id]['active'] = false }
+        save_json
+        table json.select{|item| ids.include?(item['id']) }
+      end
+
       def open_all_screenshots
         `open #{Dir.glob(".screenshots/**/*.png").join(" ")}`
       end
 
-      def run(file, config=nil)
+      def run(file, config = nil)
         klass = get_const_from_file(file)
         instance = klass.new(config)
         puts set_color instance.platform_name, :white, :bold
         klass.instance_methods(false).each do |method|
           print set_color "  ➥ #{klass}##{method} ... ", :white, :bold
+          error = nil
 
-          ok, error = instance.run(method)
-          if ok
-            print set_color "OK\n", :green
-          else
-            print set_color "FAILED\n", :red
-            puts set_color "    ⚠ #{error}", :red
+          elapsed_time do
+            ok, error = instance.run(method)
+
+            print ok ? set_color("OK", :green) : set_color("FAILED", :red)
           end
+          puts set_color "    ⚠ #{error}", :red if error
         end
         instance.ok
       end
@@ -110,15 +181,19 @@ module Shoot
 
       def to_row(p)
         [
-          p['id'].to_s.colorize(p['active'] ? :green : :red),
+          set_color(p['id'].to_s, p['active'] ? :green : :red),
           "#{p['os']} #{p['os_version']}",
           "#{p['browser']} #{p['browser_version']}",
           p['device']
         ]
       end
 
+      def update_json
+        File.write(BROWSERS_PATH, JSON.dump(fetch_json_and_prepare))
+      end
+
       def json
-        File.write(BROWSERS_PATH, JSON.dump(fetch_json_and_prepare)) unless File.exist?(BROWSERS_PATH)
+        update_json unless File.exist?(BROWSERS_PATH)
         @json ||= JSON.parse(File.read(BROWSERS_PATH))
       end
 

data/lib/shoot/scenario.rb

@@ -2,6 +2,25 @@ require 'selenium-webdriver'
 require 'capybara'
 require 'timeout'
 
+require 'selenium/webdriver/remote/http/curb'
+
+module Selenium
+  module WebDriver
+    module Remote
+      class Bridge
+        attr_accessor :http_curb
+        def http
+          unless @http_curb
+            @http_curb = Http::Curb.new
+            @http_curb.server_url = @http.send(:server_url)
+          end
+          @http_curb
+        end
+      end # Bridge
+    end # Remote
+  end # WebDriver
+end # Selenium
+
 class Shoot::Scenario
   URL = sprintf 'http://%s:%s@hub.browserstack.com/wd/hub',
                 ENV['BROWSERSTACK_USER'],

data/lib/shoot/version.rb

@@ -1,3 +1,3 @@
 module Shoot
-  VERSION = "1.1.0"
+  VERSION = "2.0.0"
 end

data/shoot.gemspec

@@ -25,7 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "selenium-webdriver", "~> 2"
   spec.add_dependency "capybara", "~> 2"
   spec.add_dependency "thor", "~> 0.19"
-  spec.add_dependency "colorize", "~> 0.7"
   spec.add_dependency "rest-client", "~> 1.7"
   spec.add_dependency "poltergeist", "~> 1.6"
+  spec.add_dependency "highline", "~> 1.7"
+  spec.add_dependency "curb", "~> 0.8.8"
 end

data/spec/cli_spec.rb

@@ -89,8 +89,9 @@ describe 'Shoot::CLI' do
 
     it 'runs scenario' do
       cli.scenario('foo.rb')
-      expect(cli).to have_received(:run)
+      expect(cli).to have_received(:run).with("foo.rb", "foo")
     end
+
   end
 
   describe 'test' do
@@ -101,7 +102,7 @@ describe 'Shoot::CLI' do
 
       it 'runs scenario' do
         cli.test('foo.rb')
-        expect(cli).to have_received(:run).with("foo.rb")
+        expect(cli).to have_received(:run).with("foo.rb", nil)
       end
     end
 
@@ -114,8 +115,8 @@ describe 'Shoot::CLI' do
 
       it 'runs scenario' do
         cli.test('foo')
-        expect(cli).to have_received(:run).with("foo/bar.rb")
-        expect(cli).to have_received(:run).with("foo/baz.rb")
+        expect(cli).to have_received(:run).with("foo/bar.rb", nil)
+        expect(cli).to have_received(:run).with("foo/baz.rb", nil)
       end
     end
   end
@@ -126,15 +127,15 @@ describe 'Shoot::CLI' do
         def initialize(config); end
         def method; end
       end
-
-      allow_any_instance_of(Foo).to receive(:run)
+      allow_any_instance_of(Foo).to receive(:run).and_return([true, ""])
+      allow_any_instance_of(Foo).to receive(:platform_name)
       expect_any_instance_of(Foo).to receive(:ok)
 
       allow(cli).to receive(:get_const_from_file).with("foo.rb").and_return(Foo)
     end
 
     it 'runs scenario' do
-      cli.run('foo.rb', foo: :bar)
+      cli.run('foo.rb', {foo: :bar})
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shoot
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Juan Lulkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2015-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,21 +95,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.19'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -123,19 +137,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: poltergeist
+  name: curb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.8.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.8.8
 description: A helper to take shots on BrowserStack. Run the shoot binary for more
   info.
 email:
@@ -146,6 +160,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- Changelog.md
 - Gemfile
 - LICENSE
 - LICENSE.txt