auto_test 0.1.9.8.7 → 1.0

data/lib/spec/requests/simulation_spec.rb

@@ -5,14 +5,16 @@ require 'auto_test'
 
 describe "Application" do
   describe "auto_test" do
-
+    # load the fixtures
     if AutoTest::Test.use_fixtures? then
       fixtures(*AutoTest::Test.get_fixtures)
     end
     it "simulates the error" do
+      # load test data
       load "#{Rails.root}/db/test_seeds.rb"
       sessions_array = []
       puts "Firefox is getting started..."
+      # get the path to simulate
       begin
         paths = File.new("#{Rails.root}/log/new_path.log", "r")
       rescue
@@ -22,24 +24,30 @@ describe "Application" do
       sessions = search_sessions
       number_of_sessions = sessions.size
       user = Array.new(AutoTest::Test.get_number_of_sessions.to_i)
+      # start right number of firefox browsers
       for i in 0..number_of_sessions-1 do
         browser = Watir::Browser.new :ff
         sessions_array[sessions[i]] = browser
       end
+      
       while line = paths.gets do
+        # parse the path
         if !line.chop!.end_with? "ID" then
           hash = Hash.new
           a = line.gsub!(/[{}\"]/,'').split(/\=\>/)
           session = sessions_array[a[0].split(":").first.to_i]
           session_index = sessions_array.index(session)
           session.windows.first.use
+          # login
           if a[0].split(":").second == AutoTest::Authentication.get_login_path then
             session.goto home + AutoTest::Authentication.get_login_path
             hash["#{a[0]}"] = a[1]
             login(session, user[session_index].class.find(user[session_index].id))
+          # logout
           elsif a[1] == AutoTest::Authentication.get_logout_path then
             hash["#{a[0]}"] = AutoTest::Authentication.get_logout_path
             session.goto home + AutoTest::Authentication.get_logout_path
+          # fill in form  
           elsif a[1][0] == "[" then
             texts = []
             inputs = a[1][1,a[1].size-2].split(/,/)
@@ -58,23 +66,30 @@ describe "Application" do
                 session.text_field(:name => inputs[i].strip).set inputs[i+1].strip
               end
               i = i + 2
+              # wait 2 seconds, so the user can follow the simulation
+              sleep 2
             end
             hash["#{a[0]}"] = texts
+            # click submit button
             session.button(:type => "submit").click
           else
+            #  find and click link
             link = a[1].split(/\+\+\+/)
             href = link[0]
             text = link[1]
             session.a(:href => href, :text => text).flash
             session.a(:href => href, :text => text).click
             begin
+              # if a javascript alert pops up, accept it
               session.driver.switch_to.alert.accept
             rescue
             end
             hash["#{a[0]}"] = a[1]
           end
+          # wait 2 seconds, so the user can follow the simulation
           sleep 2
         else
+          # get the right user
           line_parts = line.split(":")
           session_index = line_parts[0].to_i
           id = line_parts[1].to_i
@@ -90,13 +105,16 @@ describe "Application" do
   end
 end
 
+# login a user in a certain browser
 def login(browser, user)
   if AutoTest::Authentication.use_db_users then
+    # if data read from db, fill in forms
     AutoTest::Authentication.get_login_attributes.each do |field|
       browser.text_field(:id => field[1]).set user.send(field[0].to_sym) 
     end
     sleep 1
   else
+    # if data given by tester, fill these in
     index = AutoTest::Authentication.get_login_names.index(AutoTest::Authentication.get_unique_login_attribute_name)  
     user_data = nil
     user.class.find(:all).each do |u|
@@ -114,6 +132,7 @@ def login(browser, user)
   browser.button(:type => 'submit').click
 end
 
+# get the session ids from the path
 def search_sessions
   begin
     path_to_search = File.new("#{Rails.root}/log/new_path.log", "r")

data/lib/tasks/auto_test.rb

@@ -4,7 +4,7 @@ path = %x(gem which auto_test)
 path = path[0..path.size-15]
 
 namespace :auto_test do
-  desc "starting the test"
+  desc "Starting the test"
   task :test do
     puts "Running auto_test..."    
     sh "rspec '#{path}/spec/requests/auto_spec.rb' -o '#{path}/../log/rspec.txt'"
@@ -15,7 +15,7 @@ namespace :auto_test do
     Rake::Task["auto_test:error_calc"].invoke
   end
 
-  desc "calculating the errors"
+  desc "Calculating the errors"
   task :error_calc do
     err = File.read("#{Rails.root}/log/errors.log")
     if err.to_i > 0 then
@@ -51,7 +51,7 @@ namespace :auto_test do
   end
 
 
-  desc 'stopping rails'
+  desc 'Stopping rails server'
   task :stop do
     begin
       pid_file = 'tmp/pids/server.pid'

data/lib/test.rb

@@ -1,6 +1,7 @@
 module AutoTest
   module Test   
     module_function
+    
     # initialize all variables
     def initialize_test
       Error.init_error
@@ -20,6 +21,9 @@ module AutoTest
       init_number_of_test_runs
     end
     
+    ###############################################################
+    ### initializers 
+    
     def init_links
       @@links = []
     end
@@ -27,22 +31,6 @@ module AutoTest
     def init_fixtures
       @@use_fixtures = false
     end
-  
-    def use_fixtures?
-      @@use_fixtures
-    end
-    
-    def fixtures(*fixtures)
-      @@fixtures = fixtures
-    end
-    
-    def get_fixtures
-      @@fixtures
-    end
-    
-    def use_fixtures(bool)
-      @@use_fixtures = bool
-    end
     
     def init_number_of_test_runs
       @@runs = 1
@@ -85,9 +73,49 @@ module AutoTest
     def init_inputs
      @@inputs = Hash.new
     end
-     
     
+    def init_sessions
+      @sessions = Hash.new
+    end
+    
+    def init_hash_sessions(key, value)
+      @sessions["#{key}"] = value
+    end
+        
+    def init_sessions_array 
+      @sessions_array = []
+    end
+    
+    def init_ready
+      @ready = Array.new(Test.get_number_of_sessions)
+    end
+    
+
+    ###############################################################
+    
+    # getter for use fixtures
+    def use_fixtures?
+      @@use_fixtures
+    end
+    
+    # set the fixtures to be used
+    def fixtures(*fixtures)
+      @@fixtures = fixtures
+    end
+    
+    # get the fixtures
+    def get_fixtures
+      @@fixtures
+    end
+    
+    # determine if fixtures should be used
+    def use_fixtures(bool)
+      @@use_fixtures = bool
+    end
+    
+    # check the invariants
     def check_invariants
+      # check always present invariant
       get_always_present.each do |present|
         if present[0].find(:first, :conditions => "#{present[1]} = '#{present[2]}'") == nil then
           if stop_at_first_error? then stop! end
@@ -99,6 +127,7 @@ module AutoTest
           Error.inc_error(message)   
         end
       end
+      # check object dependency invariant
       get_object_dependencies.each do |dependency|
         children = dependency[0].find(:all)
         children.each do |child|
@@ -117,26 +146,32 @@ module AutoTest
       end
     end
     
+    # user function to set number of test runs
     def set_number_of_test_runs(number)
       @@runs = number
     end
 
+    # get number of test runs
     def get_number_of_test_runs
       @@runs 
     end
-
+    
+    # user function ti stop at first error
     def stop_at_first_error(stop_at_first_error) 
       @@stop_at_first_error = stop_at_first_error
     end
 
+    # get stop at first error
     def stop_at_first_error?
       @@stop_at_first_error
     end
 
+    # has the test to be stopped?
     def stop?
       @@stop
     end
     
+    # stop the test
     def stop!
       @@stop = true
     end
@@ -146,24 +181,27 @@ module AutoTest
       @@depth = @@depth + 1
     end
 
+    # get depth
     def get_depth
       @@depth
     end
-
+    
+    # user function to set the maximum depth
     def set_max_depth(value)
       @@max_depth = value
     end
 
+    # get max depth
     def get_max_depth
       @@max_depth
     end
 
-
     # get object dependencies
     def get_object_dependencies
       @@dependencies 
     end
 
+    # user function to set invariant for object dependency
     # for all objects of class child, there has to be one object of class parent
     # attribute_name is the column that joins the two tables
     def set_object_dependency(child, parent, attribute_name)
@@ -176,95 +214,113 @@ module AutoTest
       @@inputs.store(input, values)
     end
     
+    # get inputs
     def get_inputs
       @@inputs
     end
     
+    # user function to set the number of sessions used to test the app
     def set_number_of_sessions(number)
       @@number_of_sessions = number
     end
     
+    # get number of sessions
     def get_number_of_sessions
       @@number_of_sessions
     end
-
+    
+    # user function to set the invariant 'always present'
     # add an array of the classname, key and value of the object to be checked every cycle
     def always_present(class_name, key, value)
       @@always_present << [class_name, key, value]
     end
 
+    # get invariant always present
     def get_always_present
       @@always_present
     end
 
+    # get the links to exclude from the test
     def get_links_to_exclude
       @@links
     end
 
-    # list of links that will not be clicked during the test
+    # user function to set the list of links that will not be clicked during the test
     def links_to_exclude(*links)
       @@links = links
     end
         
+    # setter for paths
     def paths=(value)
       @paths = value
     end
     
+    # getter for paths
     def paths
       @paths
     end
   
+    # getter for iterations
     def iterations
       @iterations
     end
     
+    # setter for iterations
     def iterations=(value)
       @iterations = value
     end
     
+    # getter for link counter
     def link_counter
       @link_counter 
     end
+    
+    # setter for link counter
     def link_counter=(value)
       @link_counter = value
     end
     
+    # setter for run
     def run=(value)
       @run = value
     end
     
+    # getter for run
     def run
       @run
     end
     
+    # getter for action path
     def action_path
       @@action_paths
     end
     
+    # getter for no authentication
     def no_auth
       @@no_auth
     end
     
+    # user function to determine that the application has no authentification
     def set_no_auth
       @@no_auth = true
     end
-         
+     
+    # method to add an element to the action path
     def add_to_action_path(hash)
       @@action_paths << hash
     end
     
+    # getter for number of users logged in during the test
     def users_logged_in
       @users_logged_in
     end
     
-    def init_ready
-      @ready = Array.new(Test.get_number_of_sessions)
-    end
-    
+    # set one session to be finished in this round of the test
     def ready(i)
       @ready[i-1] = true
     end
     
+    # see if all sessions are ready
     def ready?
       count = 0
       for i in 0..@ready.size-1 do
@@ -279,42 +335,39 @@ module AutoTest
       end
     end
     
-    def init_sessions
-      @sessions = Hash.new
-    end
-    
-    def init_hash_sessions(key, value)
-      @sessions["#{key}"] = value
-    end
-    
+    # set variables for a session
     def sessions(index, key, value)
       @sessions["#{index}"]["#{key}"] = value
     end
     
+    # get variables for a session
     def get_sessions(i, key)
       @sessions["#{i}"]["#{key}"]
     end
     
+    # getter for sessions array
     def get_sessions_array
       @sessions_array
     end
     
-    def init_sessions_array 
-      @sessions_array = []
-    end
-    
+   
+    # method to add a session
     def add_to_sessions_array(session)
       @sessions_array << session
     end
     
+    # setter for users logged in
     def users_logged_in=(value)
       @users_logged_in = value
     end
     
+    # user function to set the maximum number of links a session may click before the
+    # next session continues
     def set_max_number_of_session_links(no)
       @@no_session_links = no
     end
     
+    # getter fo maximum number of session links
     def get_max_number_of_session_links
       @@no_session_links
     end