netzke-testing 0.12.1 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7959dc180ff1c8a5e7bf0c05a1652a5a463c2fe6
-  data.tar.gz: d3e6da13e9ff90fe4f7053fc801b2fc2a308fcdf
+  metadata.gz: 9feeff744c3cbc74c198deb51319964fb2e0651e
+  data.tar.gz: 05ba7c189835a774953f40ff549cd353f2d83b40
 SHA512:
-  metadata.gz: eb6bee8567e697e89c86280ad59f8b9cacb3a64f61a822ace835e35306ceb2e1bb8d74136fb53e28d362780b4d8febc2405cc68db995dcd171d314be2f725600
-  data.tar.gz: a35272cec176a529f806cdbacb629d51836c359ead72adab188268f5b30fc739e6fc0daa7cf65d81ee9632064621496b1db75b4a9ffc4f2e9f863120690d07a6
+  metadata.gz: 232d64cd3173aa22ab57527cc4dc42d61c4cd4f1faafb7aebb0918ff265a19c2984c4a1b4f85bb223a7314c17a274ef88316cbe8054950d5fc5986801b2d1748
+  data.tar.gz: 36149aeed5a102ea7c4841bb67906e689303ca9b4a83feb867bfa354482740bfa76e824c68bda1f9fbc1841070f336050d32d3cf62d37719d08effc1a66633fe

data/Gemfile

@@ -1,3 +1,22 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'rails', '4.2.0'
+gem 'sqlite3'
+gem 'yard'
+gem 'rake'
+
+group :test do
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'capybara'
+  gem 'selenium-webdriver'
+end
+
+group :development, :test do
+  gem 'byebug'
+  gem 'web-console', '~> 2.0'
+  gem 'pry-rails'
+  gem 'netzke-core', github: 'netzke/netzke-core'
+end

data/README.md

@@ -1,4 +1,4 @@
-# Netzke Testing
+# Netzke Testing [![Gem Version](https://fury-badge.herokuapp.com/rb/netzke-testing.png)](http://badge.fury.io/rb/netzke-testing)
 
 This gem helps with development and testing of Netzke components. In parcticular, it helps you with:
 
@@ -75,6 +75,20 @@ code](https://github.com/netzke/netzke-testing/tree/master/app/assets/javascript
 implemented helpers (TODO: document them). Also, refer to other Netzke gems source code (like netzke-core and
 netzke-basepack) to see examples using the helpers.
 
+## Adding custom spec helpers
+
+You may add (or require, by means of Sprockets) additional helpers in `app/assets/javascripts/netzke/testing.js`, which will be included in the testing template *after* the helpers provided by netzke-testing. For example:
+
+    // in app/assets/javascripts/netzke/testing.js
+    //= require_tree ./testing
+
+    # in app/assets/javascripts/netzke/testing/grid.js.coffee
+    Ext.apply window,
+      enableColumnFilter: (column, value) ->
+      # ...
+
+After this the `enableColumnFilter` helper will be available in your Mocha specs.
+
 ## Testing with selenium webdriver
 
 Generate the `netzke_mocha_spec.rb` file that will automatically run the specs that follow a certain naming convention:
@@ -105,10 +119,44 @@ helper provided by the `netzke_testing` gem. Here's an example (in `spec/user_gr
 
 The `run_mocha_spec` here will run a Mocha spec from `spec/grid_with_destructive_button.js.coffee`.
 
-You can explicitely specify a component to run the spec on (in order to override the convention):
+You can explicitely specify a component to run the spec on:
 
     run_mocha_spec 'grid_with_destructive_button', component: 'UserGrid'
 
+To investigate the problem in case of a failing Mocha spec, set `stop_on_error` to `true` (this will keep the browser open on the failed spec):
+
+    run_mocha_spec 'grid_with_destructive_button', stop_on_error: true
+
+(in this case you'll have to terminate the specs by pressing `ctrl+c`)
+
+## Setting timeout for longer running JS specs
+
+Netzke-testing by default assumes that your specs do not take longer than 5 seconds, and mark them failed if they do. If your spec are as complex as taking longer than that, you can increase this value in an initializer, e.g.:
+
+    # in config/initializers/netzke.rb
+    Netzke::Testing.setup do |config|
+      config.js_timeout = 10 # seconds
+    end
+
+You could also set this in `spec_helper.rb` like this:
+
+    Netzke::Testing.js_timeout = 10
+
+However, keep in mind, that this won't have effect on running specs manually in the browser (by specifying the `spec` URL parameter, as shown above). For this case, you may provide the `timeout` URL paramter (takes precedence over `Netzke::Testing.js_timeout`):
+
+    http://localhost:3000/netzke/components/UserGrid?spec=user_grid&timeout=10
+
+## Asynchronous helpers
+
+Asynchronous helpers like `wait` can either call the provided callback function, or (if none was provided) return a promise, so you can do:
+
+    wait().
+    .then ->
+      doSomething()
+      wait()
+    .then
+      doSomeMore()
+
 ## Requirements
 
 * Ruby >= 2.0.0

data/app/assets/javascripts/netzke/testing/helpers/actions.js.coffee

@@ -6,16 +6,22 @@ Ext.Ajax.on 'requestcomplete', ->
   Netzke.ajaxCount -= 1
 
 Ext.apply window,
+  # Waits for all AJAX activity to stop, then calls the optional callback. If no callback was specified, returns a
+  # promise. The first argument can be a number of milliseconds to wait before starting to listen to the AJAX activity
+  # (handy when some Ext method implement a fixed delay before doing something, like triggering a column filter after it
+  # was set).
+  #
   # Examples:
   #
   #   wait ->
   #     afterAllAjaxActivityIsStopped()
   #
-  #   wait 2000, ->
-  #     afterTwoSeconds()
+  #   wait 200, ->
+  #     waitsAtLeast200MsBeforeCallingThis()
+  #
+  #   wait().then -> doSomething()
   wait: () ->
-    if typeof arguments[0] == 'function'
-      callback = arguments[0]
+    waitInCycle = (callback) ->
       i = 0
       id = setInterval ->
         i += 1
@@ -26,12 +32,35 @@ Ext.apply window,
         # this way we ensure another 20ms cycle before we issue a callback
         i = 100 if Netzke.ajaxCount == 0
       , 200
-    else
-      delay = arguments[0]
-      callback = arguments[1]
-      setInterval ->
-        callback.call()
-      , delay
+
+    # wait ->
+    #   callbackAsParameter()
+    if typeof arguments[0] == 'function'
+      return waitInCycle arguments[0]
+
+    if Ext.isNumber(arguments[0])
+
+      # wait 50, ->
+      #   waitAtLeast50Seconds()
+      if Ext.isFunction(arguments[1])
+        delay = arguments[0]
+        callback = arguments[1]
+        setInterval ->
+          waitInCycle(resolve)
+        , delay
+        return null
+
+      # wait(50).then ->
+      #   waitAtLeast50ThenResolve()
+      else
+        console.log("1", 1)
+        delay = arguments[0]
+        return new Promise (resolve, reject) ->
+          setInterval ->
+            waitInCycle(resolve)
+          , delay
+
+    return new Promise (resolve, reject) -> waitInCycle resolve
 
   click: (cmp) ->
     if Ext.isString(cmp)

data/app/assets/javascripts/netzke/testing/helpers/expectations.js.coffee

@@ -10,6 +10,10 @@ Ext.apply window,
     throw cmp + " not found" if Ext.isString(cmp)
     expect(cmp.isDisabled()).to.be(true)
 
+  expectEnabled: (cmp) ->
+    throw cmp + " not found" if Ext.isString(cmp)
+    expect(cmp.isDisabled()).to.be(false)
+
   expectInvisibleBodyOf: (cmp) ->
     throw cmp + " not found" if Ext.isString(cmp)
     expect(cmp.body.isVisible()).to.be false

data/app/assets/javascripts/netzke/testing/helpers/grid.js.coffee

@@ -1,9 +1,16 @@
 Ext.apply window,
-  grid: (title) ->
-    if title
-      Ext.ComponentQuery.query('grid[title="'+title+'"]')[0]
+  grid: (value, lookup) ->
+    # default to query by title for backwards compatibility
+    lookup = lookup || 'title'
+    if value && lookup == 'title'
+      Ext.ComponentQuery.query('grid[title="'+value+'"]')[0] ||
+      Ext.ComponentQuery.query('treepanel[title="'+value+'"]')[0]
+    else if value && lookup == 'name'
+      Ext.ComponentQuery.query('grid[name="'+value+'"]')[0] ||
+      Ext.ComponentQuery.query('treepanel[name="'+value+'"]')[0]
     else
-      Ext.ComponentQuery.query('grid{isVisible(true)}')[0]
+      Ext.ComponentQuery.query('grid{isVisible(true)}')[0] ||
+      Ext.ComponentQuery.query('treepanel{isVisible(true)}')[0]
 
   expandRowCombo: (field, params) ->
     g = g || this.grid()
@@ -36,11 +43,17 @@ Ext.apply window,
       record.set(key, value)
 
   selectAssociation: (attr, value, callback) ->
-    expandRowCombo attr
-    wait ->
-      select value, in: combobox(attr)
-      # wait ->
-      callback.call()
+    action = (cb) ->
+      expandRowCombo attr
+      wait ->
+        select value, in: combobox(attr)
+        cb()
+
+    if callback
+      action(callback)
+    else
+      new Promise (resolve, reject) ->
+        action(resolve)
 
   valuesInColumn: (name, params) ->
     params ?= {}
@@ -51,6 +64,16 @@ Ext.apply window,
       out.push(if assocValue then assocValue else r.get(name))
     out
 
+  # Example:
+  # valueInCell 'author__name', 2
+  valueInCell: (column, row, params) ->
+    params ?= {}
+    grid = params.in || this.grid()
+    r = grid.getStore().getAt(row)
+
+    assocValue = r.get('meta').associationValues[column]
+    if assocValue then assocValue else r.get(column)
+
   selectAllRows: (params) ->
     params ?= {}
     grid = params.in || this.grid()
@@ -76,6 +99,7 @@ Ext.apply window,
         cell.innerHTML
     )
 
+  # Examples:
   # selectLastRow()
   # selectLastRow in: grid('Book')
   selectLastRow: (params) ->
@@ -83,6 +107,7 @@ Ext.apply window,
     grid = params.in || this.grid()
     grid.getSelectionModel().select(grid.getStore().last())
 
+  # Examples:
   # selectFirstRow()
   # selectFirstRow in: grid('Book')
   selectFirstRow: (params) ->
@@ -90,6 +115,14 @@ Ext.apply window,
     grid = params.in || this.grid()
     grid.getSelectionModel().select(grid.getStore().first())
 
+  # Examples:
+  # selectRow 5
+  # selectRow 5, in: grid('Book')
+  selectRow: (n, params) ->
+    params ?= {}
+    grid = params.in || this.grid()
+    grid.getSelectionModel().select(n)
+
   # Example:
   # editLastRow {title: 'Foo', exemplars: 10}
   editLastRow: ->

data/app/assets/javascripts/netzke/testing.js

@@ -0,0 +1 @@
+// placeholder

data/app/views/layouts/netzke/testing.html.erb

@@ -2,20 +2,24 @@
 <html>
 <head>
   <title>Netzke Testing</title>
-  <%= csrf_meta_tag %>
   <%= load_netzke(minified: false) %>
 
   <% if params[:spec] %>
+    <%# dependencies %>
     <%= javascript_include_tag "netzke/testing/expect/expect.js" %>
     <%= javascript_include_tag "netzke/testing/mocha/mocha.js" %>
     <%= stylesheet_link_tag "netzke/testing/mocha/mocha.css" %>
+
+    <%# mocha config %>
     <script>
       mocha.setup('bdd');
-      mocha.setup({ignoreLeaks: true, slow: 500, timeout: 5000});
+      mocha.setup({ignoreLeaks: true, slow: 500, timeout: <%= (params[:timeout].to_i || Netzke::Testing.js_timeout) * 1000 %>});
       Ext.onReady(function(){
         Netzke.mochaRunner = mocha.run(function(){Netzke.mochaDone = true;});
       });
     </script>
+
+    <%# netzke-testing helpers %>
     <% if !params["no-helpers"] %>
       <%= javascript_include_tag "netzke/testing/helpers/actions" %>
       <%= javascript_include_tag "netzke/testing/helpers/queries" %>
@@ -24,10 +28,10 @@
       <%= javascript_include_tag "netzke/testing/helpers/form" %>
     <% end %>
 
-    <% for path in Netzke::Testing.custom_js %>
-      <%= javascript_include_tag path %>
-    <% end %>
+    <%# custom JS (e.g. additional helpers) %>
+    <%= javascript_include_tag "netzke/testing" %>
 
+    <%# actual spec %>
     <%= javascript_include_tag "/netzke/specs/#{params[:spec]}" %>
   <% end %>
 

data/config/routes.rb

@@ -1,6 +1,4 @@
 Rails.application.routes.draw do
-  # get "netzke_testing/components/:component", controller: :netzke_testing, action: :components
-  # get "netzke_testing/specs"
   if Rails.env.test? || Rails.env.development?
     get 'netzke/components/:class' => 'netzke/testing#components', as: :netzke_components
     get 'netzke/specs/*name' => 'netzke/testing#specs', as: :netzke_specs

data/lib/netzke/testing/engine.rb

@@ -3,6 +3,7 @@ module Netzke
     class Engine < ::Rails::Engine
       config.before_initialize do |app|
         Rails.application.config.assets.precompile += %w(netzke/testing/**/*.*)
+        Rails.application.config.assets.precompile += %w(netzke/testing.js)
       end
     end
   end

data/lib/netzke/testing/helpers.rb

@@ -7,13 +7,12 @@ module Netzke::Testing::Helpers
 
     visit url
 
-    # Wait while the test is running
-    wait_for_javascript
+    wait_for_javascript(options[:stop_on_error])
 
-    assert_mocha_results
+    assert_mocha_results(options[:stop_on_error])
   end
 
-  def wait_for_javascript
+  def wait_for_javascript(stop_on_error = false)
     start = Time.now
     loop do
       page.execute_script("return Netzke.mochaDone;") ? break : sleep(0.1)
@@ -23,13 +22,11 @@ module Netzke::Testing::Helpers
     end
 
   rescue Selenium::WebDriver::Error::JavascriptError => e
-    # give some time for visual examination of the problem
-    # sleep 5
-
+    sleep 1.year if stop_on_error
     raise e
   end
 
-  def assert_mocha_results
+  def assert_mocha_results(stop_on_error = false)
     result = page.execute_script(<<-JS)
       var runner = Netzke.mochaRunner;
       var errors = [];
@@ -43,14 +40,14 @@ module Netzke::Testing::Helpers
     JS
 
     if !result["success"]
-      # give some time for visual examination of the problem
-      # sleep 500
+      sleep 1.year if stop_on_error
 
       errors = result["errors"].each_with_index.map do |(title, error), i|
         "#{i+1}) #{title}\n#{error}\n\n"
       end
 
       raise "Failures:\n#{errors.join}"
+      raise "Test failed: #{result["test"]}\n#{result["error"]}"
     end
   end
 end

data/lib/netzke/testing/version.rb

@@ -1,5 +1,5 @@
 module Netzke
   module Testing
-    VERSION = "0.12.1"
+    VERSION = "0.12.2"
   end
 end

data/lib/netzke/testing.rb

@@ -15,6 +15,10 @@ module Netzke
     mattr_accessor :custom_js
     @@custom_js = []
 
+    # Timeout (seconds) for JS spec execution
+    mattr_accessor :js_timeout
+    @@js_timeout = 5
+
     def self.rspec_init(rspec_config)
       @@spec_root = Pathname.new(caller.first).join("../..")
       rspec_config.include(Netzke::Testing::Helpers)

data/netzke-testing.gemspec

@@ -18,12 +18,4 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "coffee-script"
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rails", "~> 4.2.0"
-  spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency 'capybara'
-  spec.add_development_dependency 'selenium-webdriver'
-  spec.add_development_dependency "rspec-rails"
-  spec.add_development_dependency 'netzke-core', '~> 0.12.0'
 end

data/spec/rails_app/config/application.rb

@@ -6,7 +6,7 @@ require 'rails/all'
 # you've limited to :test, :development, or :production.
 Bundler.require(*Rails.groups)
 
-require 'netzke-core'
+$LOAD_PATH.unshift(File.expand_path("../../../../lib", __FILE__))
 require 'netzke-testing'
 
 module RailsApp

data/spec/rails_app/config/boot.rb

@@ -1,5 +1,4 @@
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
 require 'bundler/setup' # Set up gems listed in the Gemfile.
 
 $LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/rails_app/config/initializers/netzke_testing.rb

@@ -1,4 +1,3 @@
 Netzke::Testing.setup do |config|
-  config.custom_js = ['custom.js']
   config.spec_root = File.expand_path("../../../../..", __FILE__)
 end