ole-qa-framework 3.15.2 → 3.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42d0845744d038c733c59b1f29a621739cd4286f
-  data.tar.gz: e0e8cca617f90b63dd5a6d62423ebc72694d4766
+  metadata.gz: 4e9fa06f5b7abbb5cf40e06832452a6c43601bc5
+  data.tar.gz: 449a85fb5a93a20c259407f3cdf4aafc61e0fa53
 SHA512:
-  metadata.gz: cf1d41d0c8ab0a45eac7072549c7280f5bad7f40178cdfd7abb9e89d0791518dcccd1796e706b091cd8d47c76b821ab3e06231be31f75a135678c2dad3acdb65
-  data.tar.gz: f0fcebf75a9ec84a567a789f3db77c261f763ff52c2fdfd77e6df229107f4d053328ca9d982050eb500726aa0a87141f957a42f92a2c935fdab2a6625a8f68c7
+  metadata.gz: de5dc1234bf216be9631732e3cf07b53fd0b06bddf84f36ba21a25f427ff02cfd1f938b6ba00081aa39f9b2234caeba6fb1b58b7bb1deb894407651636bda2bb
+  data.tar.gz: 7220eabbaaf62b2ba61acc3d695fb24d296606f068c8278ea0a5b9d7cae2ecc2e3b73a1301f3c7b860dbf233de179f4103a88b8508fab14e47d2624ef786c044

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+### v3.16.0 - 2014/06/30
+
+* Headless gem sessions now persist across OLE_QA::Framework::Session instances
+    * Starting a new session with (:headless? => false) will stop Headless,
+      but not destroy the Headless session.
+    * Calling #quit on an OLE_QA::Framework::Session instance
+      will destroy the Headless session.
+    * Starting a new session with a pre-existing Watir Browser instance
+      will not start a new session, and will stop Headless if it is running.
+* Session is now in its own classfile
+* Created Headless spec to handle headless testing
+    * Removed headless tests from Session spec
+
 ### v3.15.2 - 2014/06/25
 
 * Rescue all exceptions in page wait_for_elements

data/lib/ole-qa-framework.rb

@@ -86,116 +86,6 @@ module OLE_QA
       attr_reader :explicit_wait, :doc_wait
     end
 
-    # Handle Browser Functions, Headless Session
-    #   Invoke with @ole = Session.new(opts)
-    #   Exit with @ole.quit
-    #
-    # Default options loaded from
-    #   config/options.yml
-    #
-    class Session
-
-      # OLE Installation Base URL
-      #   (e.g. http://ole.your-site.edu/)
-      attr_reader :url
-      # @deprecated Included for backwards compatibility.  Unnecessary after 1.0.0 unification (milestone m2-r13245).
-      alias :fs_url   :url
-      alias :base_url :url
-      alias :ls_url   :url
-
-      # OLE Document Store Installation Base URL
-      #   (e.g. http://docstore.ole.your-site.edu/)
-      attr_reader :docstore_url
-      alias :docstore :docstore_url
-
-      # Wait period (in seconds) used by OLE QAF Web Element functions
-      attr_accessor :explicit_wait
-
-      # The options with which this OLE_QA Framework Session was invoked
-      attr_reader :options
-
-      # Options hash keys:
-      #   :url => "http://tst.ole.kuali.org/"
-      #     (URL for OLE Installation)
-      #   :docstore_url => 'http://tst.docstore.ole.kuali.org/'
-      #     (URL for OLE DocStore Installation)
-      #   :headless? => true/false
-      #     (Use Headless gem to handle XVFB session)
-      #   :implicit_wait => NN
-      #     (Set Selenium Webdriver's default wait period)
-      #   :explicit_wait => NN
-      #     (Set the wait period used by Watir Webdriver and custom functions)
-      #   :doc_wait => NN
-      #     (Set the wait period for eDoc routing to complete)
-      #   :browser => watir_webdriver
-      #     (Where browser is a Watir WebDriver session)
-      #
-      # To configure the default options, edit
-      #   config/options.yml
-      #
-      def initialize( options={} )
-        options_defaults = YAML.load_file(OLE_QA::Framework::load_dir + '/../config/options.yml')
-        @options = options_defaults.merge(options)
-
-        # Start headless session if requested
-        if @options[:headless?]
-          @headless = Headless.new
-          @headless.start
-        end
-
-        # Set trailing slash on URLs for consistency if not set.
-        add_slash = ->(which) { which =~ /\/$/ ? which : which + '/' }
-
-        # Globalize options to accessors
-        @url            = add_slash.call(@options[:url])
-        @docstore_url   = add_slash.call(@options[:docstore_url])
-        @explicit_wait  = @options[:explicit_wait]
-        @doc_wait       = @options[:doc_wait]
-
-        # Pass explicit_wait to a module accessor for use with OLE_QA::Tools
-        OLE_QA::Framework.instance_variable_set(:@explicit_wait,@options[:explicit_wait])
-
-        # Pass doc_wait to a module accessor for use with OLE_QA::Tools
-        OLE_QA::Framework.instance_variable_set(:@doc_wait,@options[:doc_wait])
-
-        # Browser Start
-        if @options.has_key?(:browser) && @options[:browser].class == Watir::Browser
-          @browser = @options[:browser]
-        else
-          @browser = Watir::Browser.new :firefox
-          @browser.driver.manage.timeouts.implicit_wait = @options[:implicit_wait]
-        end
-
-        # Set cutomizable default timeout on Watir-Webdriver (v0.6.5+).
-        Watir.default_timeout = @explicit_wait
-      end
-
-      # Access Watir-Webdriver's browser session.
-      def browser
-        @browser
-      end
-
-      # Access Watir-Webdriver's Window Handling Method
-      def windows
-        @browser.windows
-      end
-
-      # Open a page via URL.  (Defaults to @base_url.)
-      def open(url = @url)
-        @browser.goto(url)
-      end
-
-      # Teardown the OLE QA Framework.
-      # - Exit the Selenium WebDriver browser session.
-      # - Exit the Headless (XVFB) session if necessary.
-      def quit
-        @browser.quit
-        if @options[:headless?] then
-          @headless.destroy
-        end
-      end
-    end
-
     # Define OLE_QA::Framework::Error.
     class Error < StandardError
     end

data/lib/ole_qa_framework/VERSION.rb

@@ -15,6 +15,6 @@
 module OLE_QA
   module Framework
     # The version number for this project.
-    VERSION = '3.15.2'
+    VERSION = '3.16.0'
   end
 end

data/lib/ole_qa_framework/session.rb

@@ -0,0 +1,183 @@
+#  Copyright 2005-2014 The Kuali Foundation
+#
+#  Licensed under the Educational Community License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at:
+#
+#    http://www.opensource.org/licenses/ecl2.php
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+module OLE_QA::Framework
+
+  # Handle Browser Functions, Headless Session
+  #   Invoke with @ole = Session.new(opts)
+  #   Exit with @ole.quit
+  #
+  # Default options loaded from
+  #   config/options.yml
+  #
+  class Session
+
+    # Eigenclass setup to lock different instances to the same Headless session.
+    class << self
+      # Return the current Headless session.
+      attr_accessor :headless_session
+
+      # Is Headless started?
+      def is_headless?
+        @is_headless
+      end
+
+      # Start a new Headless session.
+      def start_headless
+        @headless_session ||= Headless.new
+        unless self.is_headless? then
+          @is_headless      = true
+          @headless_session.start
+        end
+      end
+
+      # Stop the headless session.
+      def stop_headless
+        if self.is_headless? then
+          @headless_session.stop
+          @is_headless = false
+        else
+          raise OLE_QA::Framework::Error,"Headless is not running."
+        end
+      end
+
+      # Quit the headless session entirely.
+      def quit_headless
+        @headless_session.destroy if self.is_headless?
+      end
+    end
+
+    @headless_session = nil
+    @is_headless      = false
+
+    # OLE Installation Base URL
+    #   (e.g. http://ole.your-site.edu/)
+    attr_reader :url
+    # @deprecated Included for backwards compatibility.  Unnecessary after 1.0.0 unification (milestone m2-r13245).
+    alias :fs_url   :url
+    alias :base_url :url
+    alias :ls_url   :url
+
+    # OLE Document Store Installation Base URL
+    #   (e.g. http://docstore.ole.your-site.edu/)
+    attr_reader :docstore_url
+    alias :docstore :docstore_url
+
+    # Wait period (in seconds) used by OLE QAF Web Element functions
+    attr_accessor :explicit_wait
+
+    # The options with which this OLE_QA Framework Session was invoked
+    attr_reader :options
+
+    # Options hash keys:
+    #   :url => "http://tst.ole.kuali.org/"
+    #     (URL for OLE Installation)
+    #   :docstore_url => 'http://tst.docstore.ole.kuali.org/'
+    #     (URL for OLE DocStore Installation)
+    #   :headless? => true/false
+    #     (Use Headless gem to handle XVFB session)
+    #   :implicit_wait => NN
+    #     (Set Selenium Webdriver's default wait period)
+    #   :explicit_wait => NN
+    #     (Set the wait period used by Watir Webdriver and custom functions)
+    #   :doc_wait => NN
+    #     (Set the wait period for eDoc routing to complete)
+    #   :browser => watir_webdriver
+    #     (Where browser is a Watir WebDriver session)
+    #
+    # To configure the default options, edit
+    #   config/options.yml
+    #
+    def initialize( options={} )
+      options_defaults = YAML.load_file(OLE_QA::Framework::load_dir + '/../config/options.yml')
+      @options = options_defaults.merge(options)
+
+      # Set local variable if @options[:browser] is given a Watir::Browser session.
+      browser_given = @options.has_key?(:browser) && @options[:browser].is_a?(Watir::Browser)
+
+      # Use Headless if requested.
+      if @options[:headless?] && ! browser_given
+        self.class.start_headless
+      else
+        self.class.stop_headless if self.is_headless?
+      end
+
+      # Set trailing slash on URLs for consistency if not set.
+      add_slash = ->(which) { which =~ /\/$/ ? which : which + '/' }
+
+      # Globalize options to accessors
+      @url            = add_slash.call(@options[:url])
+      @docstore_url   = add_slash.call(@options[:docstore_url])
+      @explicit_wait  = @options[:explicit_wait]
+      @doc_wait       = @options[:doc_wait]
+
+      # Pass explicit_wait to a module accessor for use with OLE_QA::Tools
+      OLE_QA::Framework.instance_variable_set(:@explicit_wait,@options[:explicit_wait])
+
+      # Pass doc_wait to a module accessor for use with OLE_QA::Tools
+      OLE_QA::Framework.instance_variable_set(:@doc_wait,@options[:doc_wait])
+
+      # Browser Start
+      if browser_given
+        @browser = @options[:browser]
+      else
+        @browser = Watir::Browser.new :firefox
+        @browser.driver.manage.timeouts.implicit_wait = @options[:implicit_wait]
+      end
+
+      # Set cutomizable default timeout on Watir-Webdriver (v0.6.5+).
+      Watir.default_timeout = @explicit_wait
+    end
+
+    # Access the Headless session class-level instance variable.
+    def headless_session
+      self.class.headless_session
+    end
+
+    # Return whether Headless is running.
+    def is_headless?
+      self.class.is_headless?
+    end
+
+    # Access Watir-Webdriver's browser session.
+    def browser
+      @browser
+    end
+
+    # Access Watir-Webdriver's Window Handling Method
+    def windows
+      @browser.windows
+    end
+
+    # Open a page via URL.  (Defaults to @base_url.)
+    def open(url = @url)
+      @browser.goto(url)
+    end
+
+    # Exit the browser only, stop the Headless (XVFB) session, but don't destroy it entirely.
+    def close
+      @browser.quit
+    end
+
+    # Teardown the OLE QA Framework.
+    # - Exit the Selenium WebDriver browser session.
+    # - Exit the Headless (XVFB) session if necessary.
+    def quit
+      @browser.quit
+      if self.is_headless? then
+        self.class.quit_headless
+      end
+    end
+  end
+end

data/spec/common/headless_spec.rb

@@ -0,0 +1,63 @@
+#  Copyright 2005-2014 The Kuali Foundation
+#
+#  Licensed under the Educational Community License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at:
+#
+#    http://www.opensource.org/licenses/ecl2.php
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+require 'rspec'
+require 'spec_helper'
+
+describe 'A Headless session' do
+
+  before :all do
+    @ole = OLE_QA::Framework::Session.new(:headless? => true)
+  end
+
+  after :all do
+    @ole.quit
+  end
+
+  it 'should be available in an instance method' do
+    expect(@ole.headless_session).to be_an_instance_of(Headless)
+  end
+
+  it 'should be available in a class method' do
+    expect(OLE_QA::Framework::Session.headless_session).to eq(@ole.headless_session)
+  end
+
+  it 'should show as started on an instance' do
+    expect(@ole.is_headless?).to be_true
+  end
+
+  it 'should show as started on the class' do
+    expect(OLE_QA::Framework::Session.is_headless?).to be_true
+  end
+
+  it 'should keep running if a new Headless session is requested' do
+    original_session = @ole.headless_session.inspect
+    @ole = OLE_QA::Framework::Session.new(:headless? => true)
+    expect(original_session).to eq(@ole.headless_session.inspect)
+  end
+
+  it 'should stop if a new non-Headless session is requested' do
+    ole = OLE_QA::Framework::Session.new(:headless? => false)
+    ole.close
+    expect(ole.is_headless?).to be_false
+  end
+
+  it 'will not be used with a pre-existing Watir session' do
+    browser = Watir::Browser.new
+    ole = OLE_QA::Framework::Session.new(:browser => browser)
+    ole.close
+    expect(ole.is_headless?).to be_false
+  end
+
+end

data/spec/common/session_spec.rb

@@ -19,23 +19,19 @@ describe 'An OLE QA Framework Session' do
 
   before :all do
     @ole          = OLE_QA::Framework::Session.new(:headless? => false)
-    @headless_ole = OLE_QA::Framework::Session.new(:headless? => true)
+    @browser      = Watir::Browser.new :firefox
+    @ole_alt      = OLE_QA::Framework::Session.new(:browser => @browser)
   end
 
   after :all do
     @ole.quit unless @ole.nil?
-    @headless_ole.quit unless @ole.nil?
+    @browser.quit unless @browser.nil?
+    @ole_alt.quit unless @ole_alt.nil?
   end
 
   context 'should start' do
     it 'normally' do
       expect(@ole).to be_an(OLE_QA::Framework::Session)
-      expect(@ole.options[:headless?]).to be_false
-    end
-
-    it 'headlessly' do
-      expect(@headless_ole).to be_an(OLE_QA::Framework::Session)
-      expect(@headless_ole.options[:headless?]).to be_true
     end
 
     it 'with a URL reader attribute' do
@@ -46,11 +42,8 @@ describe 'An OLE QA Framework Session' do
       expect(@ole.docstore_url).to be_a(String)
     end
 
-    it 'should accept a predefined Watir-Webdriver session' do
-      browser = Watir::Browser.new :firefox
-      ole = OLE_QA::Framework::Session.new(:browser => browser)
-      expect(ole.browser).to eq(browser)
-      browser.quit
+    it 'with a predefined Watir-Webdriver session' do
+      expect(@ole_alt.browser).to eq(@browser)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ole-qa-framework
 version: !ruby/object:Gem::Version
-  version: 3.15.2
+  version: 3.16.0
 platform: ruby
 authors:
 - Jain Waldrip
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-25 00:00:00.000000000 Z
+date: 2014-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -135,6 +135,7 @@ files:
 - lib/ole-qa-framework.rb
 - lib/ole_qa_framework/COMPATIBILITY.rb
 - lib/ole_qa_framework/VERSION.rb
+- lib/ole_qa_framework/session.rb
 - lib/olefs/common/e_doc.rb
 - lib/olefs/common/lookup.rb
 - lib/olefs/common/purap_document.rb
@@ -212,6 +213,7 @@ files:
 - ole-qa-framework.gemspec
 - spec/common/browser_spec.rb
 - spec/common/data_object_spec.rb
+- spec/common/headless_spec.rb
 - spec/common/line_object_spec.rb
 - spec/common/page_spec.rb
 - spec/common/session_spec.rb
@@ -250,6 +252,7 @@ summary: Kuali Open Library Environment
 test_files:
 - spec/common/browser_spec.rb
 - spec/common/data_object_spec.rb
+- spec/common/headless_spec.rb
 - spec/common/line_object_spec.rb
 - spec/common/page_spec.rb
 - spec/common/session_spec.rb