unobtainium 0.2.1 → 0.3.0

data/lib/unobtainium/{drivers/support → support}/util.rb

@@ -7,7 +7,9 @@
 # All rights reserved.
 #
 module Unobtainium
-  module Drivers
+  # @api private
+  # Contains support code
+  module Support
     ##
     # Utility code shared by driver implementations
     module Utility
@@ -17,20 +19,25 @@ module Unobtainium
       # where keys are the normalized label, and the value is an array of
       # aliases:
       #
+      # ```ruby
       #   LABELS = {
       #     foo: [:alias1, :alias2],
       #     bar: [],
       #   }.freeze
+      # ```
       #
       # Empty aliases means that there are no aliases for this label.
+      #
+      # @param label [String, Symbol] the driver label to normalize
       def normalize_label(label)
+        sym_label = label.to_sym
         self::LABELS.each do |normalized, aliases|
-          if label == normalized or aliases.include?(label)
+          if sym_label == normalized or aliases.include?(sym_label)
             return normalized
           end
         end
         return nil
       end
     end # module Utility
-  end # module Drivers
+  end # module Support
 end # module Unobtainium

data/lib/unobtainium/version.rb

@@ -7,5 +7,6 @@
 # All rights reserved.
 #
 module Unobtainium
-  VERSION = "0.2.1".freeze
+  # The current release version
+  VERSION = "0.3.0".freeze
 end

data/lib/unobtainium/world.rb

@@ -20,11 +20,12 @@ module Unobtainium
     ##
     # Modules can have class methods, too.
     module ClassMethods
-      # Configuration related
+      # Set the config file path.
       def config_file=(name)
         @config_file = name
       end
 
+      # @return [String] the config file path, defaulting to 'config/config.yml'
       def config_file
         return @config_file || "config/config.yml"
       end
@@ -32,7 +33,7 @@ module Unobtainium
     extend ClassMethods
 
     ##
-    # Return the global configuration, loaded from :config_file
+    # Return the global configuration, loaded from `World#config_file`
     def config
       return ::Unobtainium::Runtime.instance.store_with_if(:config) do
         ::Unobtainium::Config.load_config(::Unobtainium::World.config_file)
@@ -40,6 +41,8 @@ module Unobtainium
     end
 
     ##
+    # (see Driver#create)
+    #
     # Returns a driver instance with the given options. If no options are
     # provided, options from the global configuration are used.
     def driver(label = nil, options = nil)
@@ -67,7 +70,7 @@ module Unobtainium
 
       # The driver may modify the options; if so, we should let it do that
       # here. That way our key (below) is based on the expanded options.
-      label, options = ::Unobtainium::Driver.sanitize_options(label, options)
+      label, options, _ = ::Unobtainium::Driver.resolve_options(label, options)
 
       # Create a key for the label and options. This should always
       # return the same key for the same label and options.

data/spec/port_scanner_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+require_relative '../lib/unobtainium/support/port_scanner'
+
+describe ::Unobtainium::Support::PortScanner do
+  let(:tester) { Class.new { extend ::Unobtainium::Support::PortScanner } }
+
+  # This Socket#connect mock finds port 1234 or 4321 open
+  def connect_mock(_, addr)
+    port, = Socket.unpack_sockaddr_in(addr)
+    if port == 1234 or port == 4321
+      return 0
+    end
+    raise Errno::ECONNREFUSED
+  end
+
+  describe "port_open?" do
+    it "detects an open port correctly" do
+      allow_any_instance_of(Socket).to receive(:connect).and_return(0)
+      expect(tester.port_open?('localhost', 1234)).to be_truthy
+    end
+
+    it "detects a closed port correctly" do
+      allow_any_instance_of(Socket).to receive(:connect).and_raise(
+          Errno::ECONNREFUSED)
+      expect(tester.port_open?('localhost', 1234)).to be_falsy
+    end
+
+    it "handles a single domain parameter" do
+      allow_any_instance_of(Socket).to receive(:connect).and_raise(
+          Errno::ECONNREFUSED)
+      expect(tester.port_open?('localhost', 1234, :INET)).to be_falsy
+    end
+
+    it "handles many domain parameters" do
+      allow_any_instance_of(Socket).to receive(:connect).and_raise(
+          Errno::ECONNREFUSED)
+      expect(tester.port_open?('localhost', 1234, [:INET, :INET6])).to be_falsy
+    end
+
+    it "rejects bad domain parameters" do
+      expect do
+        tester.port_open?('localhost', 1234, :FOO)
+      end.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "scan" do
+    it "aborts on bad parameters" do
+      expect { tester.scan }.to raise_error(ArgumentError)
+      expect { tester.scan('localhost') }.to raise_error(ArgumentError)
+      expect { tester.scan('localhost', "foo") }.to raise_error(ArgumentError)
+      expect { tester.scan('localhost', :sym) }.to raise_error(ArgumentError)
+    end
+
+    it "finds an open port in a range" do
+      allow_any_instance_of(Socket).to receive(:connect) do |sock, addr|
+        connect_mock(sock, addr)
+      end
+
+      expect(tester.scan('localhost', 1230..1240)).to eql [1234]
+    end
+
+    it "finds an open port in an array" do
+      allow_any_instance_of(Socket).to receive(:connect) do |sock, addr|
+        connect_mock(sock, addr)
+      end
+
+      expect(tester.scan('localhost', [1233, 1234, 1235])).to eql [1234]
+    end
+
+    it "doesn't find an open port in a range" do
+      allow_any_instance_of(Socket).to receive(:connect) do |sock, addr|
+        connect_mock(sock, addr)
+      end
+
+      expect(tester.scan('localhost', 1240..1250)).to eql []
+    end
+
+    it "doesn't find an open port in an array" do
+      allow_any_instance_of(Socket).to receive(:connect) do |sock, addr|
+        connect_mock(sock, addr)
+      end
+
+      expect(tester.scan('localhost', [1230, 1231])).to eql []
+    end
+
+    it "finds an open port in mixed arguments" do
+      allow_any_instance_of(Socket).to receive(:connect) do |sock, addr|
+        connect_mock(sock, addr)
+      end
+
+      # Match in first argument
+      expect(tester.scan('localhost', 1234, [1, 2], 3..4)).to eql [1234]
+      expect(tester.scan('localhost', 1230..1240, 3, [1, 2])).to eql [1234]
+      expect(tester.scan('localhost', [1, 1234], 3..4, 5)).to eql [1234]
+
+      # Match in second argument
+      expect(tester.scan('localhost', 1, [1, 1234], 3..4)).to eql [1234]
+      expect(tester.scan('localhost', 1..2, 1234, [1, 2])).to eql [1234]
+      expect(tester.scan('localhost', [1, 2], 1230..1240, 5)).to eql [1234]
+    end
+
+    it "can abort after the first find" do
+      allow_any_instance_of(Socket).to receive(:connect) do |sock, addr|
+        connect_mock(sock, addr)
+      end
+
+      expect(tester.scan('localhost', 1230..4330, amount: :first)).to eql [1234]
+    end
+
+    it "can scan for closed/available ports" do
+      allow_any_instance_of(Socket).to receive(:connect) do |sock, addr|
+        connect_mock(sock, addr)
+      end
+
+      expect(tester.scan('localhost', 1233..1234, for: :closed)).to eql [1233]
+    end
+
+    it "rejects bad amounts" do
+      expect do
+        tester.scan('localhost', 1230..4330, amount: :foo)
+      end.to raise_error(ArgumentError)
+    end
+
+    it "rejects bad for" do
+      expect do
+        tester.scan('localhost', 1230..4330, for: :foo)
+      end.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/runner_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+require_relative '../lib/unobtainium/support/runner'
+
+describe ::Unobtainium::Support::Runner do
+  it "refuses to initialize without ID" do
+    expect do
+      ::Unobtainium::Support::Runner.new
+    end.to raise_error(ArgumentError)
+  end
+
+  it "refuses to initialize without command" do
+    expect do
+      ::Unobtainium::Support::Runner.new("foo")
+    end.to raise_error(ArgumentError)
+  end
+
+  it "runs a shell command" do
+    runner = ::Unobtainium::Support::Runner.new("foo", %w(ls -l))
+    expect(runner.pid).to be_nil
+    runner.start
+    expect(runner.pid).not_to be_nil
+    expect(runner.pid).to be > 0
+    runner.wait
+    expect(runner.pid).to be_nil
+  end
+
+  it "captures output" do
+    runner = ::Unobtainium::Support::Runner.new("foo", %w(ls -l))
+    runner.start
+    runner.wait
+    expect(runner.stdout).not_to be_nil
+    expect(runner.stderr).not_to be_nil
+
+    # Read stdout
+    out = runner.stdout.read
+    expect(out).not_to be_empty
+  end
+
+  it "can be killed" do
+    runner = ::Unobtainium::Support::Runner.new("foo", %w(sleep 30))
+    runner.start
+    expect(runner.pid).not_to be_nil
+    runner.kill
+    expect(runner.pid).to be_nil
+  end
+
+  it "verifies #signal arguments" do
+    runner = ::Unobtainium::Support::Runner.new("foo", %w(sleep 30))
+    expect { runner.signal("KILL", scope: :foo) }.to raise_error(RuntimeError)
+    runner.start
+    expect { runner.signal("KILL", scope: :foo) }.to raise_error(ArgumentError)
+    runner.signal("KILL", scope: :self)
+  end
+
+  it "errors for invalid commands" do
+    runner = ::Unobtainium::Support::Runner.new("foo", "no_shell_command")
+    expect { runner.start }.to raise_error(Errno::ENOENT)
+  end
+
+  it "refuses to run the command twice without ending it first" do
+    runner = ::Unobtainium::Support::Runner.new("foo", %w(ls -l))
+    expect { runner.start }.not_to raise_error(RuntimeError)
+    expect { runner.start }.to raise_error(RuntimeError)
+    runner.wait
+  end
+end

data/spec/utility_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require_relative '../lib/unobtainium/support/util'
+
+class Tester
+  LABELS = {
+    noalias: [],
+    aliases: [:foo, :bar],
+    conflict: [:bar]
+  }.freeze
+
+  extend ::Unobtainium::Support::Utility
+end # class Tester
+
+describe ::Unobtainium::Support::Utility do
+  it "returns nil for a lable that can't be matched" do
+    expect(Tester.normalize_label("nomatch")).to be_nil
+    expect(Tester.normalize_label(:nomatch)).to be_nil
+  end
+
+  it "normalizes a string label" do
+    expect(Tester.normalize_label("noalias")).to eql :noalias
+  end
+
+  it "normalizes an alias" do
+    expect(Tester.normalize_label("foo")).to eql :aliases
+  end
+
+  it "returns the first match on alias conflicts" do
+    expect(Tester.normalize_label("bar")).to eql :aliases
+  end
+end

data/unobtainium.gemspec

@@ -39,13 +39,21 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0'
 
-  spec.requirements  = "Either or all of 'selenium-webdriver', 'appium_lib'"
+  spec.requirements  = "Either or all of 'selenium-webdriver', 'appium_lib', "\
+                       "'phantomjs'"
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rubocop", "~> 0.39"
   spec.add_development_dependency "rake", "~> 11.1"
   spec.add_development_dependency "rspec", "~> 3.4"
   spec.add_development_dependency "simplecov", "~> 0.11"
+  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "appium_lib"
+  spec.add_development_dependency "selenium-webdriver"
+  spec.add_development_dependency "phantomjs"
+  spec.add_development_dependency "cucumber"
+
+  spec.add_dependency "sys-proctable", "~> 1.0"
 end
 # rubocop:enable Style/SpaceAroundOperators
 # rubocop:enable Style/UnneededPercentQ, Style/ExtraSpacing

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unobtainium
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Jens Finkhaeuser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2016-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: appium_lib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: phantomjs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sys-proctable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: "\n    Unobtainium wraps Selenium and Appium in a simple driver abstraction
   so that\n    test code can more easily cover desktop browsers, mobile browsers and
   mobile\n    apps.\n\n    Some additional useful functionality for the maintenance
@@ -99,23 +183,23 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- cuke/.gitignore
-- cuke/Gemfile
-- cuke/Gemfile.lock
-- cuke/README.md
-- cuke/config/config.yml
-- cuke/features/step_definitions/steps.rb
-- cuke/features/support/env.rb
-- cuke/features/world.feature
+- config/config.yml
+- docs/CONFIGURATION.md
+- features/step_definitions/steps.rb
+- features/support/env.rb
+- features/world.feature
 - lib/unobtainium.rb
 - lib/unobtainium/config.rb
 - lib/unobtainium/driver.rb
 - lib/unobtainium/drivers/appium.rb
+- lib/unobtainium/drivers/phantom.rb
 - lib/unobtainium/drivers/selenium.rb
-- lib/unobtainium/drivers/support/util.rb
 - lib/unobtainium/pathed_hash.rb
 - lib/unobtainium/recursive_merge.rb
 - lib/unobtainium/runtime.rb
+- lib/unobtainium/support/port_scanner.rb
+- lib/unobtainium/support/runner.rb
+- lib/unobtainium/support/util.rb
 - lib/unobtainium/version.rb
 - lib/unobtainium/world.rb
 - spec/config_spec.rb
@@ -134,8 +218,11 @@ files:
 - spec/driver_spec.rb
 - spec/mock_driver.rb
 - spec/pathed_hash_spec.rb
+- spec/port_scanner_spec.rb
+- spec/runner_spec.rb
 - spec/runtime_spec.rb
 - spec/spec_helper.rb
+- spec/utility_spec.rb
 - spec/world_spec.rb
 - unobtainium.gemspec
 homepage: https://github.com/jfinkhaeuser/unobtainium
@@ -157,13 +244,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- Either or all of 'selenium-webdriver', 'appium_lib'
+- Either or all of 'selenium-webdriver', 'appium_lib', 'phantomjs'
 rubyforge_project: 
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: 'Obtain the unobtainable: test code covering multiple platforms'
 test_files:
+- features/step_definitions/steps.rb
+- features/support/env.rb
+- features/world.feature
 - spec/config_spec.rb
 - spec/data/array.yaml
 - spec/data/arraymerge-local.yaml
@@ -180,7 +270,10 @@ test_files:
 - spec/driver_spec.rb
 - spec/mock_driver.rb
 - spec/pathed_hash_spec.rb
+- spec/port_scanner_spec.rb
+- spec/runner_spec.rb
 - spec/runtime_spec.rb
 - spec/spec_helper.rb
+- spec/utility_spec.rb
 - spec/world_spec.rb
 has_rdoc: