rutl 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cc8b6905f9d8a505779925d3d85bca28fa334677a8c3c301eca6f960fd4795a
-  data.tar.gz: 841b286a1a36c99642495bd8a638cc68c361254f6a0a3a2c673ff0b155da634a
+  metadata.gz: '03966911ea3475762f121b4735aaee43a66af675c6b5baa255e329810c5fd890'
+  data.tar.gz: 4fbc7ec877d27b7daddae7f02c5b35396d9b6a5f59ffee90a5e4a29896627e1c
 SHA512:
-  metadata.gz: fec1a528ed212affc96add10a953bc5aabb76016f34d9efc9b676c5d7df4cc44a4695b9ce87a096ff882ae8ff845340385e88a25080584787ae0b9bc4668f8f6
-  data.tar.gz: 4c3aebb3e24f4dbbd5ac5260ea2a48a1a21a0513ec7288c51c2fa5e0261897bbece23f04cee0d0cf2f3560a9a3b53392cbb74b317dce47129f9a29a3ecfb1611
+  metadata.gz: 1cfe7eecf5fb7ab352d10408412835b827b7cb276959efeac9085a538d008bd8a829ad468b158135353b85c4a9277a6af9cab5eae200932667c10ce425c6e2e5
+  data.tar.gz: ab287a5457fd4b3fe81ed869b3316f3165c1f97fbd92c3af04c42a935366488911f5e0b51d335c6c89621817ada69d766eec157a00f8db0317d1f7271475d095

data/.circleci/config.yml

@@ -55,6 +55,7 @@ jobs:
       - run:
           name: run tests
           command: |
+            mkdir /tmp/screenshots
             mkdir /tmp/test-results
             TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
 
@@ -70,3 +71,4 @@ jobs:
       - store_artifacts:
           path: /tmp/test-results
           destination: test-results
+          

data/.gitignore

@@ -1,5 +1,5 @@
 /.bundle/
-/.gem
+/*.gem
 /.yardoc
 /debug.log
 /Gemfile.lock

data/README.md

@@ -158,13 +158,22 @@ To use it:
     require 'rutl/rspec/rutl_matchers'
 ```
 
+### Auto-screenshotting
+
+If you have RUTL::SCREENSHOTS or ENV['SCREENSHOTS'] set to a directory, RUTL
+will automatically take screenshots on page transitions.
+If you're using RSpec, they'll be automatically named something based on the
+RSpec description with an auto-incrementing number.
+If you're not using RSpec, that's not terribly useful but you can always have
+your tests screenshot anyway, just less magic.
 
 ## Roadmap
 Coming up soon in almost no order:
+* Handle error pages/partials.
+* Auto-screenshot on errors. Error destinations. Navigation errors. Unexpected exceptions?
 * A test framework should have better tests.
-* Put more info in this readme.
-* Take screenshots.
 * Diff screenshots. Make this smart so we don't have to be experts.
+* Put more info in this readme.
 * Move bugs and would-be features to Github Issues instead of this readme and scattered through the code.
 * Make the framework make it easier to spot bugs in pages. Focus on exception-handling?
 * The webdriver gem should already include InternetExplorerDriver. Maybe run tests on AppVeyor.
@@ -177,6 +186,7 @@ Coming up soon in almost no order:
   * Same with iPhone.
     * Same Cordoba test app?
 * Documentation. RDoc?
+* Auto-screenshot support frameworks other than RSpec.
 * Others?
 * Spidering page object maker. Or selector checker/fixer?
 * Possibly pair the null browser with auto-generated pages for ______?

data/lib/rutl.rb

@@ -10,4 +10,12 @@ module RUTL
   # or set ENV['RUTL_PAGES']
   # or Browser intialize will raise.
   PAGES = nil
+
+  # If this RUTL::SCREENSHOT_DIR or ENV['SCREENSHOT_DIR']
+  # or Browser initialize is set, we take screenshots.
+  SCREENSHOTS = nil
+
+  # This one is for diffing against.
+  # RUTL::KNOWN_GOOD_SCREENSHOTS
+  REFERENCE_SCREENSHOTS = nil
 end

data/lib/rutl/interface/base_interface.rb

@@ -1,5 +1,5 @@
 require 'rutl/utilities'
-
+require 'rutl/screencam'
 #
 # I might need to consider renaming these.
 # The *interface classes lie between Browser and the webdriver-level classes.
@@ -8,15 +8,21 @@ class BaseInterface
   include Utilities
 
   attr_accessor :driver
+  attr_reader :camera
   attr_accessor :pages
 
   def initialize
     raise 'Child interface class must set @driver.' if @driver.nil?
+    # base_name avoids collisions when unning the same tests with
+    # different browsers.
+    name = self.class.to_s .sub('Interface', '')
+    @camera = ScreenCam.new(@driver, base_name: name)
   end
 
   def goto(page)
     raise 'expect Page class' unless page.ancestors.include?(BasePage)
     find_page(page).go_to_here
+    @camera.screenshot
   end
 
   def current_page

data/lib/rutl/interface/elements/click_to_change_state_mixin.rb

@@ -5,10 +5,14 @@
 #
 module ClickToChangeStateMixin
   def click
+    # Screenshot before clicking. Is this really necessary?
+    @context.interface.camera.screenshot
     this_css.click
-
-    # TODO: Is this part of the instance-stamping problem???
     # returns the page it found
-    @context.interface.wait_for_transition(@context.destinations)
+    result = @context.interface.wait_for_transition(@context.destinations)
+    # And after clicking and going to new state. This seems more needed
+    # because we want to see where we went.
+    @context.interface.camera.screenshot
+    result
   end
 end

data/lib/rutl/screencam.rb

@@ -0,0 +1,71 @@
+require 'fileutils'
+#
+# class to take photos of the screen (and diff them?)
+#
+class ScreenCam
+  def guard
+    # When running headless, Selenium seems not to drop screenshots.
+    # So that makes this safe in places like Travis.
+    #
+    # We still need to guard against NullDriver or we'll to to screencap
+    # it when we're running head-fully.
+    #
+    # Will there be others?
+    @driver.is_a? NullDriver
+  end
+
+  def initialize(driver, base_name: '')
+    @counter = 0
+    @driver = driver
+    return if guard
+    @base_name = base_name
+    @dir = File.join(RUTL::SCREENSHOTS, base_name)
+    FileUtils.mkdir_p @dir
+  end
+
+  def shoot(path = nil)
+    return if guard
+    # Magic path is used for all auto-screenshots.
+    name = path || magic_path
+
+    FileUtils.mkdir_p @dir
+    file = File.join(@dir, pathify(name))
+    @driver.save_screenshot(file)
+  end
+  alias screenshot shoot
+
+  def clean_dir(dir)
+    FileUtils.rm_rf dir
+    FileUtils.mkdir_p dir
+  end
+
+  def counter
+    @counter += 1
+    # In the unlikely even that we have > 9 screenshots in a test case,
+    # format the counter to be two digits, zero padded.
+    format('%02d', @counter)
+  end
+
+  def magic_path
+    if defined? RSpec
+      RSpec.current_example.metadata[:full_description].to_s
+    else
+      # TODO: The behavior for non-RSpec users is ugly and broken.
+      # Each new test case will start taking numbered "auto-screenshot" pngs.
+      # And the next test case will overwrite them. Even if they didn't
+      # overwrite, I don't know how to correllate tests w/ scrrenshots. I'm
+      # leaving this broken for now.
+      # You can still tell it to take your own named screenshots whenever you
+      # like, of course.
+      'auto-screenshot'
+    end
+  end
+
+  def pathify(path)
+    # Replace any of these with an underscore:
+    # space, octothorpe, slash, backslash, colon, period
+    name = path.gsub(%r{[ \#\/\\\:\.]}, '_')
+    # Also insert a counter and make sure we end with .png.
+    name.sub(/.png$/, '') + '_' + counter + '.png'
+  end
+end

data/lib/rutl/version.rb

@@ -1,3 +1,3 @@
 module RUTL
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/rutl.gemspec

@@ -27,15 +27,32 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  # These are *some* webdriver-related dependencies. They don't include
+  # brwosers. Or anything for non-browssr testing. Or image diffing code.
+  # Maybe all browser stuff should be its own sub-gem.
+  spec.add_dependency 'selenium-webdriver', '~> 3.12'
+  # webdrivers gem can pull down these webdrivers: chromedriver, geckodriver,
+  # IEDriverServer and MicrosoftWebDriver. It does not install the browser.
+  #
+  # CitcleCI can't use this to install webdrivers.
+  # Works locally and with Travis.
+  spec.add_dependency 'webdrivers', '~> 3.0'
+
+  # Dependencies for development only.
   spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'coveralls', '~> 0.8'
-  spec.add_development_dependency 'drewcoo-cops', '~> 0.1'
   spec.add_development_dependency 'gem-release', '~> 1.0'
   spec.add_development_dependency 'rake', '~> 12.3'
+
+  # Code coverage service.
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+
+  # RSpec is used to test the RUTL. It might not be the test engine chosen
+  # by the person using RUTL.
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec_junit_formatter', '~> 0.3'
+
+  # Linting with RuboCop
+  spec.add_development_dependency 'drewcoo-cops', '~> 0.1'
   spec.add_development_dependency 'rubocop', '~> 0.55'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.25'
-  spec.add_development_dependency 'selenium-webdriver', '~> 3.12'
-  spec.add_development_dependency 'webdrivers', '~> 3.0'
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: rutl
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Drew Cooper
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-05 00:00:00.000000000 Z
+date: 2018-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
+        version: '3.12'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: webdrivers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
+        version: '3.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: drewcoo-cops
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: gem-release
   requirement: !ruby/object:Gem::Requirement
@@ -81,89 +81,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.55'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.55'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: drewcoo-cops
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: selenium-webdriver
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0.55'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0.55'
 - !ruby/object:Gem::Dependency
-  name: webdrivers
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.25'
 description: This is a UI library under construction at the moment.
 email:
 - drewcoo@gmail.com
@@ -204,6 +204,7 @@ files:
 - lib/rutl/interface/elements/text.rb
 - lib/rutl/interface/firefox_interface.rb
 - lib/rutl/interface/null_interface.rb
+- lib/rutl/screencam.rb
 - lib/rutl/utilities.rb
 - lib/rutl/version.rb
 - rutl.gemspec