ndr_dev_support 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b2f915258a3f3f168328b951e3eeb994ee319ba
-  data.tar.gz: 645d0844ed7125193c2796f79d5a4cf33c1dec70
+  metadata.gz: bbf173d8ddfa7d10cb31833d230906bdcc958ba2
+  data.tar.gz: 02683547d2431fb1fb989fd5be52fdfb798b5224
 SHA512:
-  metadata.gz: fac14a11fb811aae9b2c0e03c8027efb985eaa68f65f9575543f2c72cb629a119ed371d869e747af519183f0001cf038e3bb00afe461295aaaec320f48b63513
-  data.tar.gz: 46318f642050c869aab20e2d6b02ac902e82a5ade663142b9db0eeb86427231ac7d99124d33b321ce9265464eecb1e99cb998eca14c8c352763af5318fc5d40c
+  metadata.gz: ebb19d580b52f1aeaa43ca959e29b617d5236c39336bab47f1170ef48683d36ad6d1f478c0d7fe5deeaf5ab9c72bbead8866e00a6c8f0664867105eaca577879
+  data.tar.gz: 4d9bafe9f324abb580db296b3801fd93c7f814f7420f3f661438280c584701b623ad5131f615a4112f87f09defbc823e2e0312407f134033653e3c451fbff98e

data/.travis.yml

@@ -1,4 +1,11 @@
 language: ruby
+
 rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.11.2
+  - 2.2.5
+  - 2.3.1
+
+sudo: false
+
+cache: bundler
+
+before_script: "bundle update"

data/README.md

@@ -11,7 +11,7 @@ providing:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ndr_dev_support', group: :development
+gem 'ndr_dev_support', group: [:development, :test]
 ```
 
 And then execute:
@@ -64,6 +64,24 @@ To add development support tasks to your project, add this line to your applicat
 require 'ndr_dev_support/tasks'
 ```
 
+### Integration test environment
+
+ndr_dev_support bundles a configured Rails integration testing environment. It uses `capybara` and `poltergeist` to drive a PhantomJS headless browser, and includes all necessary configuration (e.g. connection sharing / transactional test support).
+
+If an integration test errors or fails, `capybara-screenshot` is used to automatically retrieve a full-height screenshot from PhantomJS, which is then stored in `tmp/`.
+
+Beyond standard Capybara testing DSL, ndr_dev_support bundles some additional functionality:
+
+* `clear_headless_session!` - causes PhantomJS to reset, simulating a browser restart.
+* `delete_all_cookies!` - causes PhantomJS to delete all cookies. Helpful for testing AJAX logouts.
+* `within_screenshot_compatible_window` – similar to `within_window`, but allows failure screenshots to be taken of the failing child window, rather than the spawning parent.
+
+To use, ensure `phantomjs` is installed, and add the following to your application's `test_helper.rb`
+
+```ruby
+require 'ndr_dev_support/integration_testing'
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -6,6 +6,8 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = false
+  t.warning = false
 end
 
 desc 'Run tests'

data/code_safety.yml

@@ -10,8 +10,8 @@ file safety:
     safe_revision: e1ead45a8d1fd525f3a39cc4a87e6c0338c6b879
   ".travis.yml":
     comments: 
-    reviewed_by: joshpencheon
-    safe_revision: 303ce774decdc5e19ce99051e4c94246313564d7
+    reviewed_by: josh.pencheon
+    safe_revision: 35fa869f068ca3250fee611147e49f40f0147d92
   CODE_OF_CONDUCT.md:
     comments: 
     reviewed_by: timgentry
@@ -26,12 +26,12 @@ file safety:
     safe_revision: c59a45986f8b6d087c8c21b1e889f31f7346da17
   README.md:
     comments: 
-    reviewed_by: joshpencheon
-    safe_revision: 13cdf4eec8ea311ea480a90a3ba325a386db94e0
+    reviewed_by: josh.pencheon
+    safe_revision: 88ac9269eb8f0b44c5920a946708e4715421bcad
   Rakefile:
     comments: 
-    reviewed_by: joshpencheon
-    safe_revision: c59a45986f8b6d087c8c21b1e889f31f7346da17
+    reviewed_by: josh.pencheon
+    safe_revision: a601dbd139132f50eb22b1c88d5eda14a465a7c2
   bin/console:
     comments: 
     reviewed_by: timgentry
@@ -44,6 +44,26 @@ file safety:
     comments: 
     reviewed_by: timgentry
     safe_revision: c59a45986f8b6d087c8c21b1e889f31f7346da17
+  lib/ndr_dev_support/integration_testing.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: 88ac9269eb8f0b44c5920a946708e4715421bcad
+  lib/ndr_dev_support/integration_testing/capybara.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: 88ac9269eb8f0b44c5920a946708e4715421bcad
+  lib/ndr_dev_support/integration_testing/connection_sharing.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: 88ac9269eb8f0b44c5920a946708e4715421bcad
+  lib/ndr_dev_support/integration_testing/poltergeist.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: 88ac9269eb8f0b44c5920a946708e4715421bcad
+  lib/ndr_dev_support/integration_testing/screenshot.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: 88ac9269eb8f0b44c5920a946708e4715421bcad
   lib/ndr_dev_support/rubocop/executor.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -67,20 +87,20 @@ file safety:
   lib/ndr_dev_support/version.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 3f4e55cee33c956405ab82e55b76914be0770577
+    safe_revision: cc35bc393f1e6b9eb3a93dfe4fa3a9aa90aacbec
   lib/tasks/audit_code.rake:
     comments: Identical to the version reviewed by josh.pencheon when contained within
       ndr_support
-    reviewed_by: timgentry
-    safe_revision: 0d56ba443b2cddca5ba2d96ea61ec6f2b898436d
+    reviewed_by: josh.pencheon
+    safe_revision: de404230921fed06cd1669fe673037f827e44610
   lib/tasks/rubocop.rake:
     comments: 
     reviewed_by: josh.pencheon
     safe_revision: 41cf1558f567928faaa1e670a36d941c03c78044
   ndr_dev_support.gemspec:
     comments: 
-    reviewed_by: joshpencheon
-    safe_revision: d61f29be0444859c092f4c0599cc48f5bea8f0ac
+    reviewed_by: josh.pencheon
+    safe_revision: 88ac9269eb8f0b44c5920a946708e4715421bcad
   test/ndr_dev_support_test.rb:
     comments: 
     reviewed_by: timgentry

data/lib/ndr_dev_support/integration_testing.rb

@@ -0,0 +1,4 @@
+require 'ndr_dev_support/integration_testing/capybara'
+require 'ndr_dev_support/integration_testing/connection_sharing'
+require 'ndr_dev_support/integration_testing/poltergeist'
+require 'ndr_dev_support/integration_testing/screenshot'

data/lib/ndr_dev_support/integration_testing/capybara.rb

@@ -0,0 +1,3 @@
+require 'capybara/rails'
+
+ActionDispatch::IntegrationTest.include(Capybara::DSL)

data/lib/ndr_dev_support/integration_testing/connection_sharing.rb

@@ -0,0 +1,28 @@
+module NdrDevSupport
+  module IntegrationTesting
+    # Capybara starts another rails application in a new thread
+    # to test against. For transactional fixtures to work, we need
+    # to share the database connection between threads.
+    #
+    # Derived from: https://gist.github.com/josevalim/470808
+    #
+    module ConnectionSharing
+      def self.prepended(base)
+        base.mattr_accessor :shared_connection
+
+        # Get a connection, and make it shareable:
+        base.shared_connection = base.connection
+
+        base.singleton_class.prepend(ClassMethods)
+      end
+
+      module ClassMethods
+        def connection
+          shared_connection || retrieve_connection
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.prepend(NdrDevSupport::IntegrationTesting::ConnectionSharing)

data/lib/ndr_dev_support/integration_testing/poltergeist.rb

@@ -0,0 +1,39 @@
+require 'capybara/poltergeist'
+
+module NdrDevSupport
+  module IntegrationTesting
+    module Poltergeist
+      # Additional testing DSL, for phantomjs-specific interactions.
+      module DSL
+        # Instruct phantomjs to clear its session:
+        def clear_headless_session!
+          page.driver.reset!
+        end
+
+        # Get phantomjs to delete all of the cookies
+        # for the current page without resetting:
+        def delete_all_cookies!
+          page.driver.cookies.each do |name, value|
+            page.driver.remove_cookie(name)
+          end
+        end
+      end
+    end
+  end
+end
+
+ActionDispatch::IntegrationTest.include(NdrDevSupport::IntegrationTesting::Poltergeist::DSL)
+
+# Register poltergeist as an available driver for capybara to use:
+Capybara.register_driver :poltergeist do |app|
+  options = { phantomjs_options: ['--proxy-type=none'], timeout: 60 }
+
+  # If Ruby warn level is high, switch on additional output.
+  options.merge!(debug: true, inspector: true) if $VERBOSE
+
+  Capybara::Poltergeist::Driver.new(app, options)
+end
+
+# ...and make it the default:
+Capybara.default_driver    = :poltergeist
+Capybara.javascript_driver = :poltergeist

data/lib/ndr_dev_support/integration_testing/screenshot.rb

@@ -0,0 +1,51 @@
+require 'capybara-screenshot'
+
+module NdrDevSupport
+  module IntegrationTesting
+    module Screenshot
+      # Allow integration tests to open screenshotable popup windows.
+      module DSL
+        delegate :within_screenshot_compatible_window, to: :page
+      end
+
+      # Adds variant of Capybara's #within_window method, that doesn't return
+      # to the preview window on an exception. This allows us to screenshot
+      # a popup automatically if a test errors/fails whilst it has focus.
+      module SessionExtensions
+        def within_screenshot_compatible_window(window_or_proc)
+          original = current_window
+
+          case window_or_proc
+          when Capybara::Window
+            switch_to_window(window_or_proc) unless original == window_or_proc
+          when Proc
+            switch_to_window { window_or_proc.call }
+          else
+            fail ArgumentError, 'Unsupported window type!'
+          end
+
+          scopes << nil
+          yield
+          @scopes.pop
+          switch_to_window(original)
+        end
+      end
+    end
+  end
+end
+
+if defined?(MiniTest)
+  require 'capybara-screenshot/minitest'
+  ActionDispatch::IntegrationTest.include(Capybara::Screenshot::MiniTestPlugin)
+else
+  require 'capybara-screenshot/testunit'
+end
+
+Capybara::Session.include(NdrDevSupport::IntegrationTesting::Screenshot::SessionExtensions)
+ActionDispatch::IntegrationTest.include(NdrDevSupport::IntegrationTesting::Screenshot::DSL)
+
+# Save screenshots to tmp/capybara/... on integration test error/failure:
+Capybara::Screenshot.register_driver(:poltergeist) do |driver, path|
+  # Take full-height screenshots, rather than just capturing the viewport:
+  driver.render(path, full: true)
+end

data/lib/ndr_dev_support/version.rb

@@ -2,5 +2,5 @@
 # This defines the NdrDevSupport version. If you change it, rebuild and commit the gem.
 # Use "rake build" to build the gem, see rake -T for all bundler rake tasks (and our own).
 module NdrDevSupport
-  VERSION = '1.1.3'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/lib/tasks/audit_code.rake

@@ -1,17 +1,18 @@
+require 'pathname'
+require 'yaml'
+
 SAFETY_FILE =
   if File.exist?('code_safety.yml')
-    'code_safety.yml'
+    Pathname.new('code_safety.yml').expand_path
   elsif defined?(Rails)
     Rails.root.join('config', 'code_safety.yml')
   else
-    'code_safety.yml'
+    Pathname.new('code_safety.yml').expand_path
   end
 
 # Temporary overrides to only audit external access files
 SAFETY_REPOS = [['/svn/era', '/svn/extra/era/external-access']]
 
-require 'yaml'
-
 # Parameter max_print is number of entries to print before truncating output
 # (negative value => print all)
 def audit_code_safety(max_print = 20, ignore_new = false, show_diffs = false, show_in_priority = false, user_name = 'usr')
@@ -50,7 +51,7 @@ def audit_code_safety(max_print = 20, ignore_new = false, show_diffs = false, sh
     puts "Checking for new files in #{safety_repo}"
     new_files = get_new_files(safety_repo)
     # Ignore subdirectories, and exclude code_safety.yml by default.
-    new_files.delete_if { |f| f =~ /[\/\\]$/ || f == SAFETY_FILE }
+    new_files.delete_if { |f| f =~ /[\/\\]$/ || Pathname.new(f).expand_path == SAFETY_FILE }
     new_files.each do |f|
       next if file_safety.key?(f)
       file_safety[f] = {
@@ -344,7 +345,7 @@ def print_repo_file_diffs(repolatest, repo, fname, user_name, safe_revision)
   cmd = nil
   case repository_type
   when 'git'
-    cmd = ['git', '--no-pager', 'diff', '-b', "#{safe_revision}..#{repolatest}", fname]
+    cmd = ['git', '--no-pager', 'diff', '--color', '-b', "#{safe_revision}..#{repolatest}", fname]
   when 'git-svn', 'svn'
     cmd = ['svn', 'diff', '-r', "#{safe_revision.to_i}:#{repolatest.to_i}", '-x', '-b', "#{repo}/#{fname}"]
   end
@@ -473,3 +474,4 @@ end
 
 # Prevent building of un-reviewed gems:
 task build: :'audit:ensure_safe'
+

data/ndr_dev_support.gemspec

@@ -18,10 +18,18 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.2'
+
+  # Rubocop dependencies:
   spec.add_dependency 'rubocop', '0.36.0'
   spec.add_dependency 'parser'
   spec.add_dependency 'rainbow'
 
+  # Integration test dependencies:
+  spec.add_dependency 'capybara'
+  spec.add_dependency 'capybara-screenshot'
+  spec.add_dependency 'poltergeist', '>= 1.8.0'
+
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'pry'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ndr_dev_support
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - NCRS Development Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-08 00:00:00.000000000 Z
+date: 2016-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -52,6 +52,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara-screenshot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +168,11 @@ files:
 - bin/setup
 - code_safety.yml
 - lib/ndr_dev_support.rb
+- lib/ndr_dev_support/integration_testing.rb
+- lib/ndr_dev_support/integration_testing/capybara.rb
+- lib/ndr_dev_support/integration_testing/connection_sharing.rb
+- lib/ndr_dev_support/integration_testing/poltergeist.rb
+- lib/ndr_dev_support/integration_testing/screenshot.rb
 - lib/ndr_dev_support/rubocop/executor.rb
 - lib/ndr_dev_support/rubocop/range_augmenter.rb
 - lib/ndr_dev_support/rubocop/range_finder.rb
@@ -147,7 +194,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -155,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.5
 signing_key: 
 specification_version: 4
 summary: NDR Developer Support library