auto_test 0.1.9.8.7 → 1.0

data/README.md

@@ -1,6 +1,8 @@
 # AutoTest
 
-TODO: Write a gem description
+This Gem tests your application automatically. With some configuration it will login and logout, click links, fill in forms
+and find exceptions. After finding an exception it will reduce the path to this error and show you the reduced path in a
+firefox browser. 
 
 ## Installation
 
@@ -18,12 +20,11 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
 
 ## Contributing
 
-1. Fork it
+<!-- 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request -->

data/lib/authentication.rb

@@ -1,25 +1,32 @@
 require 'capybara/rspec'
 
 module AutoTest
+  # This module deals with all functions concerning authentication of users in the application
   module Authentication
     module_function
     
-    # initialize the @users array
+    # initialize the users array
     def init_users
       @users = []
       @db_users = [false, nil]
     end
-
-
+    
+    # initialize login data array
+    def init_login_data
+      @data = []
+    end
+    
+    # user function to set the logout path
     def set_logout_path(path)
       @logout = path
     end
     
+    # getter for logout path
     def get_logout_path
       @logout
     end
 
-    # set the attribute_names and fields that are needed to login
+    # user function to set the attribute_names and fields that are needed to login
     # the argument are two arrays, the first are the database names of the attribute
     # the second are the belonging field names
     def set_login_attribute_names(names, fields)
@@ -36,34 +43,34 @@ module AutoTest
       @login
     end
 
-    # set the login path
+    # user function to set the login path
     def set_login_path(path)
       @login = path
     end
-
+    
+    # user function to set the text of the login button
     def set_login_button(text)
       @login_button = text
     end
     
+    # get the login button
     def get_login_button
       @login_button
     end
     
-    def init_login_data
-      @data = []
-    end
-    
+    # get login data array
     def get_login_data
       @data
     end
     
+    # user function to set the login data
     def set_login_data(*data)
       data.each do |d|
         @data << d
       end
-      
     end
 
+    # user function to determine if users are read from db
     def get_users_from_db(user_class_name, bool)
       @users = user_class_name.find(:all)
       if bool then
@@ -73,35 +80,42 @@ module AutoTest
       end
     end
   
+    # user function to set login names
     def set_login_names(names)
       @names = names
     end
     
+    # get login names
     def get_login_names
       @names
     end
     
-    
+    # user function to set login fields
     def set_login_fields(fields)
       @fields = fields
     end
     
+    #get login fields
     def get_login_fields
       @fields
     end
     
+    # user function to set unique attribute name
     def set_unique_login_attribute_name(name)
       @unique_login = name
     end
     
+    # get unique attribute name
     def get_unique_login_attribute_name 
       @unique_login
     end
     
+    # get first element of db users, determine if users are read from db
     def use_db_users
       @db_users[0]
     end
     
+    # get second element of db users, the class of the user
     def user_class
       @db_users[1]
     end
@@ -124,20 +138,23 @@ module AutoTest
       return @users
     end
   
+    # set user data
     def set_user_data(value)
       @user_data = value
     end
     
+    # get user data
     def get_user_data
       @user_data
     end
   
-  
+    # logout a user
     def logout(session)
       begin
         hash = Hash.new
         hash["#{Test.get_sessions_array.index(session)}:#{session.current_path}"] = get_logout_path
         Test.add_to_action_path hash
+        # logout the user by visiting the logout path
         session.visit get_logout_path
         Page.check_for_error_code(session)
       rescue => e
@@ -161,6 +178,7 @@ module AutoTest
             end
           end  
         end
+        # fill in fields with user data, either from db or given by the tester
         if @db_users[0] then
           get_login_attributes.each do |field|            
             session.fill_in field[1], :with => user.send(field[0].to_sym)
@@ -171,8 +189,8 @@ module AutoTest
           end
         end
         session.click_button get_login_button
-        
         Page.check_for_error_code(session)
+      # save from exception if user object has changed
       rescue (ActiveRecord::RecordNotFound)
         Test.sessions(Test.get_sessions_array.index(session), "depth", Test.get_max_depth+1)
         Test.sessions(Test.get_sessions_array.index(session), "current_depth", Test.get_sessions(Test.get_sessions_array.index(session), "depth"))

data/lib/auto_test.rb

@@ -9,7 +9,7 @@ def logger
   Rails.logger
 end
 
-
+# Main module
 module AutoTest
     include Page
     include Error
@@ -28,8 +28,6 @@ module AutoTest
        yield(configuration)
     end    
      
-     
-    
     class Configuration
       def initialize        
         Test.initialize_test
@@ -39,11 +37,12 @@ module AutoTest
         DatabaseCleaner.clean
       end
       
+      # define all user functions
+      
       def use_fixtures(bool)  
         Test.use_fixtures(bool)
       end
       
-      
       def fixtures(*fixtures)
         Test.fixtures(fixtures)
       end

data/lib/auto_test/railtie.rb

@@ -1,6 +1,7 @@
 require 'auto_test'
 require 'rails'
 module AutoTest
+  # make the tasks to start auto_test available in the application
   class Railtie < Rails::Railtie
     rake_tasks do
       require 'tasks/auto_test.rb'

data/lib/auto_test/version.rb

@@ -1,3 +1,3 @@
 module AutoTest
-  VERSION = "0.1.9.8.7"
+  VERSION = "1.0"
 end

data/lib/dsl.rb

@@ -20,6 +20,7 @@ module AutoTest
       Test.set_max_depth(value)
     end
     
+    # set the unique attribute name of the user
     def set_unique_login_attribute_name(name)
       Authentication.set_unique_login_attribute_name(name)
     end
@@ -37,6 +38,7 @@ module AutoTest
       Authentication.set_login_data(*data)
     end
     
+    # determine wether users can be read from db or not
     def get_users_from_db(user_class_name, bool)
       Authentication.get_users_from_db(user_class_name, bool)
     end
@@ -47,19 +49,23 @@ module AutoTest
       Test.set_object_dependency(child, parent, attribute_name)
     end
     
+    # set the number of sessions used to test the app
     def set_number_of_sessions(number)
       Test.set_number_of_sessions(number)
     end
     
+    # set the maxium number of links one session can click in a row before
+    # the next session continues
     def set_max_number_of_session_links(no)
       Test.set_max_number_of_session_links(no)
     end
 
-
+    # set, if there´s no authentication in the application
     def set_no_auth
       Test.set_no_auth
     end
     
+    # set the text of the login button
     def set_login_button(text)
       Authentication.set_login_button(text)
     end
@@ -77,14 +83,17 @@ module AutoTest
       Authentication.set_login_names(names)
     end
     
+    # set the path to logout
     def set_logout_path(path)
       Authentication.set_logout_path(path)
     end
     
+    # determine if the test is supposed to stop when the first error is found
     def stop_at_first_error(stop_at_first_error) 
       Test.stop_at_first_error(stop_at_first_error) 
     end
     
+    # set the number of test runs
     def set_number_of_test_runs(number)
       Test.set_number_of_test_runs(number)
     end

data/lib/error.rb

@@ -1,8 +1,11 @@
 require 'capybara/rspec'
 
 module AutoTest
+  
+  # This module deals with all functions concerning errors
   module Error
     module_function
+    
     # increment the errorcount in the first field of the array, 
     # add error messages 
     def inc_error(value)
@@ -15,6 +18,8 @@ module AutoTest
       end
     end
     
+    # print the error on the console
+    # just the message of the exception, no backtrace
     def print_errors
       if get_error > 0 then
         if get_error == 1 then
@@ -33,14 +38,17 @@ module AutoTest
       end
     end
     
+    # get the error count
     def get_error
       @error[0]
     end
-
+    
+    # get error message
     def get_error_messages
       @error[1..@error.size-1]
     end
     
+    # init error count with 0
     def init_error
       @error = [0]
     end

data/lib/page.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 require 'capybara/rspec'
-
+# get a random time
 class Time
   def self.random
     year = Time.now.year
@@ -11,6 +11,7 @@ class Time
 end
 
 module AutoTest
+  # This module deals with the interaction on the page like clicking links and filling in forms
   module Page    
     module_function
 
@@ -22,6 +23,7 @@ module AutoTest
           if Test.get_sessions(i,"depth") <= Test.get_max_depth then
             if Test.get_sessions(i,"iteration") <= Test.get_sessions(i,"iterations") then
               begin
+                # Login
                 if Test.get_sessions(i, "current_depth") == 0 && !Test.no_auth then 
                   Authentication.login(Test.get_sessions(i,"user"),session)  
                   Test.check_invariants
@@ -30,6 +32,7 @@ module AutoTest
                   session.visit "/"
                 end
                 if (Test.get_sessions(i,"current_depth") < Test.get_sessions(i,"depth")) then
+                  # get the links of the page and delete the ones the tester specified
                   links = all_links(session)
                   handle_excluded_links(links)
                   if !links.empty? then
@@ -38,13 +41,17 @@ module AutoTest
                     paths = Test.get_sessions(i,"paths")
                     paths[path] = links.size
                     Test.sessions(i, "paths", paths)
+                    # choose a random link
                     random_link = links[rand(links.size)]
+                    # check for javascript
                     if random_link[:href] != "#" then
                       hash = Hash.new
                       hash["#{i}:#{path}"] = random_link[:href]+"+++"+random_link.text
                       Test.add_to_action_path hash
                     end
+                    # click the link
                     random_link.click
+                    # update the console output
                     STDOUT.write("\r#{Test.run}. run: \t#{Test.link_counter} links clicked, \t#{Test.users_logged_in} users logged in, \t#{Error.get_error} Errors")
                     Test.link_counter = Test.link_counter + 1
                     Test.check_invariants
@@ -55,19 +62,23 @@ module AutoTest
                 else
                   links = all_links(session)
                   handle_excluded_links(links)
+                  # calculate new iterations number
                   if !links.empty? then 
                     Test.sessions(i,"iterations", 0)
                     Test.get_sessions(i,"paths").each do |key, value|
                       Test.sessions(i,"iterations", Test.get_sessions(i, "iterations") + value)
                     end
                   end
+                  # logouz
                   if !Test.no_auth then
                     Authentication.logout(session)
                   end
+                  # new initialization of session variables
                   Test.sessions(i, "current_depth", 0)
                   Test.sessions(i, "paths", Hash.new)
                   Test.sessions(i, "iteration", Test.get_sessions(i, "iteration") + 1)
                 end
+              # rescue from exceptions, process the error
               rescue => e                
                 if Test.stop_at_first_error? then Test.stop! end
                 message = e.message.to_s + "   :" + e.backtrace.first.to_s
@@ -76,6 +87,7 @@ module AutoTest
                 
               end                                       
             else
+              # new initialization of session variables             
               Test.sessions(i, "iteration", 0)
               Test.sessions(i, "iterations", 0)
               Test.sessions(i, "depth", Test.get_sessions(i, "depth") + 1)
@@ -86,6 +98,7 @@ module AutoTest
               Test.users_logged_in = Test.users_logged_in + 1
             end
             if !Test.no_auth then
+              # get new random user for next round
               Test.sessions(i, "current_user", Test.get_sessions(i,"current_user")+1)
               user = Authentication.get_users[rand(Authentication.get_users.size)]
               Test.sessions(i, "user", user)
@@ -113,9 +126,11 @@ module AutoTest
       button = all_submits(session)[rand(all_submits(session).size)]
       selects = all_selects(session)
       texts = []
+      # handle select fields first
       selects.each do |s|
         select_option(s[:id], texts, session)
       end  
+      # handle other input types
       inputs.each do |i|
         case i[:type]
           when "email" then 
@@ -147,6 +162,7 @@ module AutoTest
         end
         text = ""
       end  
+      # check for values given by the tester and set these
       inputs_to_set = Test.get_inputs
       if !inputs_to_set.empty? then
         inputs.each do |i|
@@ -163,7 +179,6 @@ module AutoTest
       Test.add_to_action_path hash
       session.click_button button.value
       Test.link_counter = Test.link_counter + 1
-      
       check_for_error_code(session)
     end
 

data/lib/spec/requests/auto_spec.rb

@@ -10,12 +10,15 @@ require 'test_starter'
 describe "Application" do
   
   describe "auto_test" do
+    # load fixtures
     if AutoTest::Test.use_fixtures? then
       fixtures(*AutoTest::Test.get_fixtures)
     end
     it "does test the application automatically" do
+      # load test data
       load "#{Rails.root}/db/test_seeds.rb"
       t = TestStarter.new
+      # start the test
       t.test      
     end
   end