iu-test-factory 0.5.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f3ea4ae667f09f498f06cc42c864ce19f6b58889d06773003f6c7fff485df5c7
+  data.tar.gz: 9b17a101a1912e39c194bb2b1f1308b1829ebf23353d4f717654bb1eeb4b496b
+SHA512:
+  metadata.gz: b246c41552684f183328d2727480118eb01959ee62105e1ba2d6bdd1b2af0167edc0f5a880b10e7126458dc7930cee83cee0364a66a015f0bcddc1014abd2015
+  data.tar.gz: '009c47f65b12af13855013d6db260c90bd5705947399028ca6aec55f3ac4cd3ac07f9b972a258dbd902663913ec41e18151936989682637e7fe89548de8b03a0'

data/COPYING

@@ -0,0 +1 @@
+LICENSE

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gem 'watir', '>=6.0.0'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    test-factory (0.5.4)
+      watir (>= 6.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    childprocess (0.8.0)
+      ffi (~> 1.0, >= 1.0.11)
+    ffi (1.9.18)
+    rubyzip (1.2.1)
+    selenium-webdriver (3.7.0)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.0)
+    watir (6.9.0)
+      selenium-webdriver (~> 3.4, >= 3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  test-factory!
+  watir (>= 6.0.0)
+
+BUNDLED WITH
+   1.15.4

data/LICENSE

@@ -0,0 +1,68 @@
+Apache License, Version 2.0
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,241 @@
+IU's TestFactory Gem
+=========================
+
+Overview
+--------
+
+This gem contains the basic framework for [dryly](http://en.wikipedia.org/wiki/Don%27t_repeat_yourself) creating test scripts for the web site that needs testing.
+
+Use it to abstract away from the underlying [Watir](http://www.watir.com) code and create your own [DSL](http://en.wikipedia.org/wiki/Domain_specific_language).
+
+With TestFactory you have the ability to...
+
+1. Easily instantiate page classes (described below) in a consistent and readable manner
+2. Concisely describe elements on a page, keeping it DRY by avoiding repetition of element
+   identifiers that may (will) change
+3. Provide higher-level methods that use customizable (and default) data, along with the
+   page classes and elements, to perform user-oriented--i.e., behavioral--functions
+   with minimal lines of code
+
+Tremendous thanks is due to [Alister Scott](http://watirmelon.com), whose [custom page object code](https://github.com/alisterscott/wmf-custom-page-object) for the Wikimedia Foundation provided the inspiration for this gem.
+
+Summary
+-------
+
+Using the TestFactory properly involves three distinct steps:
+
+1. Creating page classes that contain references to the elements on your web page. For this
+   you use the PageFactory class. Working on page classes requires that you have a strong
+   command of Watir and basic skills with Ruby.
+2. Creating "data objects" that utilize your page classes and elements to build methods that
+   perform user-oriented tasks. For this you use the DataFactory module. Working on data
+   objects requires you have good familiarity with Watir and strong Ruby skills.
+3. Creating test scenarios using your favorite test framework (like Cucumber or Rspec) and
+   your data objects. The methods in the Foundry class are useful here. Working at this
+   level requires only basic skills with Ruby and Watir, but a strong command of your DSL
+   (the thing you're building with TestFactory).
+
+These three steps can all be accomplished by a single person. However, ideally, they should be done by three or four people, as the design philosophy of TestFactory allows for specialization:
+
+ - A Watir specialist works on defining page elements and actions inside of page classes
+ - A Ruby specialist uses the output of the Watir specialist to build the data objects and their helper methods, creating the DSL for the project
+ - A non-programmer--say, a business analyst or a manual tester with domain expertise--writes test scenarios, in English
+ - A more junior automation engineer translates the English into Ruby code, via the DSL created by the Ruby specialist (if you're using Cucumber, these would be your step definitions)
+
+How to Start
+------------
+
+First install the gem, of course.
+
+    gem install test-factory
+
+Now you'll want to start building your own page classes, using the methods in TestFactory as your tool chest.
+
+Please note that the following example is *very* simplified and contrived, to keep every step as compartmentalized as possible. Once you've read through this, it is strongly recommended that you visit an actual repository that is using the test factory.
+
+[Here](https://github.com/aheward/sambal-cle) is one such.
+
+Begin by creating a BasePage class. This class should have PageFactory as its superclass and define sets of class elements that are generally common across the pages of your site.
+
+```ruby
+require 'test-factory'
+
+class BasePage < PageFactory
+
+  class << self
+
+    def header_elements
+      element(:main_menu_link) { |b| b.link(title: "Main Menu") }
+      element(:logout) { |b| b.button(value: "Logout") }
+      element(:administration_link) { |b| b.link(title: "Administration") }
+
+      action(:main_menu) { |p| p.main_menu_link.click }
+      action(:provide_feedback) { |b| b.link(title: "Provide Feedback").click }
+      action(:administration) { |p| p.administration_link.click }
+    end
+  end
+end
+
+```
+
+Next, you create classes for the individual pages in your web site. These classes should have BasePage as their superclass, and should declare any of the relevant methods defined in the BasePage class.
+
+```ruby
+class Home < BasePage
+
+  # This allows the header elements to be defined once
+  # in the BasePage class and then reused throughout your web pages...
+  header_elements
+
+  expected_element :title # When the Home class is instantiated (using the Foundry),
+                          # the script will ensure that the :title element is present
+                          # on the page before the script continues
+
+  # Now you define elements that are specific to your Home page...
+  element(:title) { |b| b.h3(id: "title") }
+  # and on and on...
+
+end
+```
+
+Once you've got a bunch of classes set up for your site's various pages, you're going to want to create "data objects" to represent what goes into those pages. For this, you'll use the superclass DataFactory. Your data classes should follow this basic structure:
+
+```ruby
+class YourDataObject < DataFactory
+
+  # Define all the things you need to test about your data object.
+  # These are some example attributes...
+  attr_accessor :title, :id, :link, :status, :description
+
+  # Your data object has to know about Watir's browser object, so it's passed to it here, along
+  # with a hash containing all the attributes you want the data object to have
+  def initialize(browser, opts={})
+    @browser = browser
+
+    # Put any attributes here that you don't want to always have to define explicitly...
+    defaults = {
+      :title=>"My Data Title",
+      :description=>"My Data's Description"
+      # ...
+    }
+
+    # The set_options line combines the defaults
+    # with any options you passed explicitly in opts,
+    # then turns all the contents of the options
+    # Hash into YourDataObject's class instance variables
+    set_options(defaults.merge(opts))
+
+    requires :id # This line allows you to specify any class instance variables that must
+                 # be explicitly defined for the data object
+  end
+
+  # Now define a bunch of methods that are relevant to your data object.
+  # In general these methods will follow the CRUD design pattern
+
+  def create
+    # Your code here...
+  end
+
+  def view
+    # Your code here...
+  end
+
+  def edit opts={}
+    # Your code here...
+    update_options(opts) # This updates all your class instance variables
+                         # with any new values specified by the opts Hash.
+  end
+
+  def remove
+    # Your code here...
+  end
+
+end
+```
+
+Now you have your basic infrastructure in place, and you can start writing your test cases using these classes.
+
+```ruby
+include Foundry # Gives you access to the methods that instantiate your Page and Data classes
+
+# First, make the data object you're going to use for testing...
+@my_thing = make YourDataObject :id=>"identifier", :description=>"It's lovely."
+
+# Now, create the data in your site...
+@my_thing.create
+
+on MyPage do |page|
+  page.title.set "Bla bla"
+  # Very contrived example. TestFactory was made to be test-framework-agnostic. You should be using your favorite verification framework here:
+  page.description==@my_thing.description ? puts "Passed" : puts "Failed"
+end
+```
+
+Design Pattern
+--------------
+
+The TestFactory was written assuming the following guiding principles. Any code that does not
+follow them probably [smells](http://en.wikipedia.org/wiki/Code_smell), and should be refactored.
+
+*  Page Classes contain methods relating to interactions with page elements only--meaning
+   the getting or setting of values, or the clicking of links or buttons. Any more
+   complicated page interactions are handled in the Data Object classes, or in the test
+   step definitions.
+*  Data Objects represent definable data structure entities in the system being tested.
+   As data, they fit into the [CRUD Model](http://en.wikipedia.org/wiki/Create,_read,_update_and_delete)
+   and thus have methods that correspond to those basic functions.
+*  Data Objects have a single method for each of the CRUD functions, and additional
+   custom methods are avoided, unless there are _compelling_ arguments for their inclusion in the class.
+*  When a Data Object is executing its `edit` method, first the data in the
+   system under test is updated, then the data object's instance variables
+   are updated--using DataFactory's `set_options`.
+*  Site navigation is handled using conditional methods (meaning they only navigate if
+   necessary) inside the Data Object--and preferably inside the data object's CRUD methods
+   themselves--unless there are specific reasons to explicitly navigate in a step
+   definition. This keeps step definitions from being unnecessarily cluttered.
+*  Specifying non-default test variables for data objects is done using key/value hash
+   pairs that are parameters of the data object's CRUD methods. It is _not_
+   done by explicitly assigning values to the instance variables. Examples:
+
+```ruby
+# During object creation, following the name of the class
+@data_object = make DataObject, :attrib1 => "Custom Value 1", :attrib2 => "Custom Value 2" # etc...
+
+# When an object is edited (using Ruby v1.9.3's Hash syntax is optional)
+@data_object.edit attrib1: "Updated Value 1", attrib2: "Updated Value 2"
+
+# This is frowned upon because it can easily lead to
+# the data object and the data in the test site being
+# out of sync, leading to a false negative test result:
+@data_object.attrib1="Another Value"
+
+```
+
+*  Except in very rare cases, updates to a data object's instance variables should be handled *only* by the `set_options` method, *not* explicitly.
+
+```ruby
+# This is good
+def edit opts={}
+  #...
+  page.element.fit opts[:value]
+  #...
+  update_options(opts)
+end
+
+# This is not good
+def edit opts={}
+  #...
+  page.element.fit opts[:value]
+  #...
+  @value=opts[:value] unless @value==opts[:value]
+end
+```
+
+*  The setting of random values for select lists in a data object is determined by passing
+   the string '::random::' in the instance variable, or as the value in the key/value pair
+   passed in an `#edit` method's `opts` parameter. The `#create` and `#edit` methods will
+   handle the necessary logic. The purpose is to prevent the need for custom randomizing
+   CRUD methods in the data object.
+*  See the gem_ext.rb file's discussion of the Watir `#fit` method for additional
+   design pattern rules to follow (If you're reading this on rubydoc.info then click the Watir module link)
+*  Please make an effort to follow the [Ruby Style Guidelines](http://www.caliban.org/ruby/rubyguide.shtml#style).

data/iu-test-factory.gemspec

@@ -0,0 +1,13 @@
+spec = Gem::Specification.new do |s|
+  s.name = 'iu-test-factory'
+  s.version = '0.5.4.2'
+  s.summary = %q{framework for creating automated testing scripts}
+  s.description = %q{This gem provides a set of modules and methods to help quickly and DRYly create a test automation framework using Ruby and Watir.}
+  s.files = Dir.glob("**/**/**")
+  s.test_files = Dir.glob("test/*test_rb")
+  s.authors = ['Abraham Heward']
+  s.email = %w{aheward@rsmart.com}
+  s.homepage = 'https://github.iu.edu/iu-uits-es'
+  s.add_dependency 'watir', '>= 6.0.0'
+  s.required_ruby_version = '>= 2.0.0'
+end

data/lib/test-factory.rb

@@ -0,0 +1,18 @@
+# Copyright 2012-2014 The rSmart Group, Inc.
+
+# Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0
+
+# 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 'watir'
+require 'forwardable'
+%w{foundry.rb data_factory.rb}.each { |f| require "#{File.dirname(__FILE__)}/test-factory/#{f}" }
+Dir["#{File.dirname(__FILE__)}/test-factory/*.rb"].each {|f| require f }

data/lib/test-factory/collections_factory.rb

@@ -0,0 +1,67 @@
+# Copyright 2012-2014 The rSmart Group, Inc.
+
+# Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0
+
+# 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.
+#
+# =================
+# CollectionsFactory
+# =================
+#
+# Use this as the superclass for your data object collection classes.
+class CollectionsFactory < Array
+
+  def initialize(browser)
+    @browser=browser
+  end
+
+  # Defines the class of objects contained in the collection
+  #
+  def self.contains klass
+
+    # Creates a method called "add" that will create the specified data
+    # object and then add it as an item in the collection.
+    #
+    # Note that it's assumed that the target data object will have a
+    # create method defined. If not, this will not work properly.
+    define_method 'add' do |opts={}|
+      element = klass.new @browser, opts
+      element.create
+      self << element
+    end
+
+  end
+
+  # Makes a "deep copy" of the Collection. See the #data_object_copy
+  # method description in the DataObject class for more information.
+  #
+  def copy
+    new_collection = self.class.new(@browser)
+    self.each do |item|
+      new_collection << item.data_object_copy
+    end
+    new_collection
+  end
+
+  # Used in conjunction with the Parent object containing
+  # the collection.
+  #
+  # The parent sends updated information to the collection(s)
+  # using #notify_collections
+  #
+  def notify_members *updates
+    self.each { |member| member.update_from_parent *updates }
+  end
+
+end
+
+# Just an alias class name.
+class CollectionFactory < CollectionsFactory; end