SimpliTest 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ecfccf93b0a513b8a7aa26beb13b76d25a5c3494
+  data.tar.gz: 5081822b7a8a6f3094e060babf7e9532e73183fc
+SHA512:
+  metadata.gz: 6d99ffdb0f8f822ac3a78cc6b8c9958d8a27495f5bfa6bcf71f29f09950e1e5a6d2c63206078bdeac8db0b5bf6d7cdcd99cf43aa9e4b03a9f7b3b9d8a054b304
+  data.tar.gz: d1b1730a4a306b084c6d75f5939cb18fd6bca7f19177ae3163c522d071129135b913cf49c700134f2c306909ac858b5d6512ff7a11635cf7e4d70af6a3b15ece

data/README.md

@@ -0,0 +1,22 @@
+# SimpliTest 
+SimpliTest was create by CGI Group Inc. members to accelerate the adoption of ATDD/BDD using Cucumber/Gherkin as the base framework. At it's core are many predefined step definitions backed by helper and utility methods.  Mainly focused on the web interfaces using Selenium, but not restricted to only web apps, your imagination is it's limitation.
+
+## Installation 
+
+	1) Install Ruby & DevKit: https://rubyinstaller.org/downloads/
+	
+	2) Build this Ruby gem
+			$ gem build SimpliTest.gemspec
+    		$ gem install SimpliTest
+
+	3) Use it
+		$SimpliTest new MyNewSimpliTestProject
+			or cd into an existing directory and run 
+		$SimpliTest init
+		
+		$SimpliTest run
+		$SimpliTest smoketest
+		
+
+
+

data/SimpliTest.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "SimpliTest"
+  spec.version       = SimpliTest::VERSION
+  spec.authors       = ["CGI Federal"]
+  spec.email         = ["SimpliTest@cgifederal.com"]
+  spec.description   = %q{Cucumber Websteps, Helpers and Executable for Web Test Automation }
+  spec.summary       = %q{This gem provides common web steps and command line executable for automated acceptance testing }
+  spec.homepage      = "https://github.com/CGIFederalInc/SimpliTest"
+  spec.license       = "MIT"
+
+  spec.files		 = Dir['lib/**/*'] + Dir['features/**/*'] + Dir['bin/*'] + ["SimpliTest.gemspec","README.md"] + Dir['test/**/*']
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.add_dependency "rubygems-update", "2.6.11"
+  spec.add_dependency "unf_ext", "0.0.7.2"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "sinatra", "~> 0"
+  spec.add_development_dependency "cucumber-sinatra", "~> 0"
+  spec.add_development_dependency "rake-notes", "~> 0"
+  spec.add_development_dependency "simplecov", "~> 0"
+  spec.add_development_dependency "aruba", "~> 0"
+  spec.add_development_dependency "hirb", "~> 0"
+  spec.add_development_dependency "geminabox", "~> 0"
+  spec.add_dependency "cucumber", "2.1.0"
+  spec.add_dependency "poltergeist", "1.7.0"
+  spec.add_dependency "capybara", "2.5.0"
+  spec.add_dependency "rspec", "3.3.0"
+  spec.add_dependency "selenium-webdriver", "3.2.1"
+  spec.add_dependency "launchy", "2.4.3"
+  spec.add_dependency "rake", "10.4.2"
+  spec.add_dependency 'parallel_tests', "1.9"
+  spec.add_dependency 'tiny_tds', "0.7"
+  spec.add_dependency 'rest-client', "~> 0"
+ spec.add_dependency "axe-matchers", "1.3.4"
+  end

data/bin/SimpliTest

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+## Run rake tasks and cucumber features
+## from SimpliTest once it's installed.
+#
+# Example:
+#
+#   SimpliTest init
+#   SimpliTest new ProjectName
+#   SimpliTest "document[html]"
+
+require 'SimpliTest/cli/main'
+pwd = Dir.pwd
+gem_dir = File.expand_path('..', File.dirname(__FILE__))
+command, *arguments = ARGV.dup
+$LOAD_PATH.unshift gem_dir
+options = {
+  :pwd => pwd,
+  :gem_dir => gem_dir,
+  :command => command,
+  :arguments => arguments
+}
+SimpliTest::Cli::Main.new(options).execute!

data/lib/SimpliTest.rb

@@ -0,0 +1,2 @@
+require "version"
+require "SimpliTest/config/configuration"

data/lib/SimpliTest/cli/main.rb

@@ -0,0 +1,305 @@
+require 'SimpliTest'
+require 'SimpliTest/config/directory_paths'
+require 'SimpliTest/helpers/project_setup'
+require 'SimpliTest/helpers/data_validation'
+#TODO: Clean this up with OptionsParser
+module SimpliTest
+  module Cli
+    ## Command Line Interface to the SimpliTest Suite
+    class Main
+      extend ProjectSetupHelpers
+      class << self
+        def execute(args)
+          new(args).execute!
+        end
+
+        def new(opts={})
+          initialize(opts)
+        end
+
+        def initialize(argv, stdin=STDIN, stdout=STDOUT, stderr=STDERR, kernel=Kernel)
+          opts, @stdin, @stdout, @stderr, @kernel = argv, stdin, stdout, stderr, kernel
+          @command = opts[:command].respond_to?(:downcase) ? opts[:command].downcase : opts[:command]
+          @arguments = opts[:arguments]
+          @arguments = @arguments.reject{|arg| (arg.to_s.empty? rescue true) } unless @arguments.is_a?(Array)
+          @pwd = opts[:pwd]
+          @gem_dir = opts[:gem_dir]
+          @environment = ENV['ENVIRONMENT']
+          @valid_commands = %w[create_update_task
+                               document
+                               document[csv]
+                               document[html]
+                               focustest
+                               generate_npp_plugin
+                               generate_registries
+                               help
+                               init
+                               new
+                               parallel
+                               run
+                               run_feature
+                               sauce
+                               setup
+                               smoketest
+                               testinstall
+                               testproject
+                               update
+                               validate_service
+                               -v
+                               version
+          ]
+          self
+        end
+
+        def execute!
+          case @command
+          when 'create_update_task'
+            create_update_task
+          when 'generate_npp_plugin'
+            generate_npp_plugin
+          when 'generate_registries'
+            generate_registries
+          when 'help'
+            puts help_text
+          when 'init'
+            initialize_project_in
+          when 'new'
+            create_new_project
+          when 'parallel'
+             run_in_parallel
+          when 'run'
+            run_as_cucumber
+          when 'run_feature'
+            run_feature
+          when 'setup'
+            setup_SimpliTest
+          when 'smoketest'
+            perform_smoke_test
+          when 'testinstall'
+            run_as_rake
+          when 'testproject'
+            testproject
+          when 'update'
+            `gem update SimpliTest`
+          when 'validate_service'
+            validate_service
+          when '-v', 'version'
+            puts "SimpliTest: v#{SimpliTest::VERSION}"
+          when '',nil
+            alert(framework_correctly_installed_message)
+          else
+            if @valid_commands.include?(@command)
+              alert "This feature has been deprecated. Please see the documentation folder in your project for help"
+            else
+              alert "You entered an invalid command"
+            end
+            @kernel.exit(0)
+          end
+        end
+=begin
+*********************************************-------------------****************************************************************************
+********************************************| CUCUMBER COMMANDS |***************************************************************************
+*********************************************-------------------****************************************************************************
+=end
+
+
+        def run_as_cucumber(args = @arguments.dup, verify_file_exists=false)
+          if verify_file_exists
+            unless File.exists? args.first
+              alert "#{args.first} File was Not Found. Could not run tests"
+              raise "FileNotFoundError"
+            end
+          end
+          @project_path ||= project_path_for(@pwd)
+          runtime = prepare_runtime
+          run_dir = @project_path
+          Dir.chdir(run_dir)
+          Cucumber::Cli::Main.new(args).execute!(runtime)
+        end
+
+        def run_in_parallel
+          raise "Parallelization is not supported on Windows" if windows?
+          begin
+            `parallel_cucumber features`
+          rescue Exception => e
+            message = "There was a problem running tests in parallel"
+            alert message
+            puts e.message
+          end
+        end
+
+        def prepare_runtime
+          require 'cucumber'
+          runtime = Cucumber::Runtime.new
+          runtime.load_programming_language('rb')
+          runtime
+        end
+
+        def perform_smoke_test
+          @project_path ||= project_path_for(@pwd)
+          smoke_test = File.join(@project_path, 'features', 'specifications', 'SmokeTest')
+          run_as_cucumber([smoke_test], true)
+        end
+
+        def perform_focus_test
+          focus_path = File.join(project_path_for(@pwd), 'features', 'specifications', 'Focus')
+          run_as_cucumber([focus_path], true)
+        end
+
+        def testproject
+          #TODO: Write a utility that verifies project configuration. See list below:
+          #YAML errors in config files
+          #Missing Files
+          #Access to Gem Step definitions
+          #Basically anything the user can break by changing something in the test project
+          @project_path ||= project_path_for(@pwd)
+          Dir.chdir @project_path
+          begin
+            `cucumber --dry-run`
+            alert('Finished checking the project. If you do not see any errors on the command prompt..you are good to go')
+          rescue Exception => e
+            message = "It seems that your project directory is corrupted \n It maybe possible for you to simply generate a new project and copy your test cases over. "
+            alert(message)
+            puts e.message
+          end
+
+        end
+
+        def run_feature
+          feature = @arguments.first
+          feature = File.exists?(feature) ? feature : File.join(project_path_for(@pwd), 'features', 'specifications', feature)
+          run_as_cucumber([feature], true)
+        end
+=begin
+*********************************************-------------------****************************************************************************
+********************************************| CUCUMBER COMMANDS |***************************************************************************
+*********************************************-------------------****************************************************************************
+=end
+
+=begin
+*********************************************-------------------****************************************************************************
+********************************************|    PROJECT SETUP  |***************************************************************************
+*********************************************-------------------****************************************************************************
+=end
+
+        ## Invoked with SimpliTest new <project name>
+        ## Creates a new example project with the <project name> with sample test cases and documentation
+        def create_new_project
+          if user_consents?
+            unless project_exists_in?(@pwd)
+              new_dir_name = @arguments.join(' ')
+              new_dir_path = (File.join(@pwd, new_dir_name))
+              make_directory(new_dir_path)
+              initialize_project_in(new_dir_path, true)
+            else
+              alert "You cant create a project inside an existing project!"
+            end
+          else
+            alert abort_message
+          end
+        end
+        ## Invoked inside a directory with SimpliTest init
+        ## Creates a new SimpliTest project within the current directory
+        # @param target_directory
+        # @param user_has_consented (true if user types or clicks yes)
+        def initialize_project_in(target_directory=@pwd, user_has_consented=false)
+          if (user_has_consented|| user_consents?)
+            if (project_exists_in?(target_directory))
+              alert directory_exists_message
+            else
+              project_template_dir = template_path_to 'NewSimpliTestProject'
+              FileUtils.cp_r(Dir[File.join(project_template_dir, '*')], target_directory)
+              alert("Successfully Initialized Project!")
+            end
+          else
+            alert abort_message
+          end
+        end
+
+=begin
+*********************************************-------------------****************************************************************************
+********************************************|    PROJECT SETUP  |***************************************************************************
+*********************************************-------------------****************************************************************************
+=end
+
+
+
+=begin
+*********************************************-------------------****************************************************************************
+********************************************|  DATA VALIDATION  |***************************************************************************
+*********************************************-------------------****************************************************************************
+=end
+
+        def validate_service
+          args = @arguments.dup
+          load_db_options
+          if args.empty?
+            validate_all_services
+          else
+            args.each do |service_name|
+              validate_service_by_name(service_name)
+            end
+          end
+        end
+
+        def load_db_options
+          require 'tiny_tds'
+          require 'csv'
+          extend DataValidationHelpers
+          @project_path ||= project_path_for(@pwd)
+          database_config = File.join(@project_path, 'features', 'support', 'config', 'database.yml')
+          options = YAML.load(File.read(database_config))
+          @db = TinyTds::Client.new(options)
+        end
+
+        def validate_all_services
+          services_dir_glob_pattern = File.join(@project_path, 'data', '*', File::SEPARATOR)
+          services = Dir.glob(services_dir_glob_pattern).collect{|k| k.split(File::SEPARATOR).last}
+          services.each do |service|
+            puts "Running Test for: #{service}"
+            validate_service_by_name service
+          end
+        end
+
+        def validate_service_by_name(name)
+          service_config_dir = File.join(@project_path, 'data', name)
+          variables_file = File.join(service_config_dir, 'variables.csv')
+          variables_csv = CSV.read(variables_file, :headers => true)
+          variables_hash = variables_csv.reject{|r| r.empty?}.map {|r| r.to_hash }
+          variables_hash.each do |set|
+            validate_service_against(@db, service_config_dir, set)
+          end
+        end
+
+=begin
+*********************************************-------------------****************************************************************************
+********************************************|  DATA VALIDATION  |***************************************************************************
+*********************************************-------------------****************************************************************************
+=end
+
+
+
+
+
+        def run_as_rake(from_dir=@pwd)
+          require 'rake'
+          require 'pp'
+          Dir.chdir(@gem_dir) # We'll load rakefile from the gem's dir.
+          Rake.application.init
+          Rake.application.load_rakefile
+          Dir.chdir(from_dir)
+          Rake.application.invoke_task(@command)
+        end
+
+        def help_text
+          #TODO: Write a man page
+          'You have been helped!!'
+        end
+
+
+      end #end self << class. Any methods below this are instance methods
+    end#end Main
+  end#end Cli
+end#end SimpliTest
+
+

data/lib/SimpliTest/config/configuration.rb

@@ -0,0 +1,107 @@
+require "yaml"
+require 'SimpliTest/config/directory_paths'
+# Loads configuration from satelite projects
+module SimpliTest
+  @config = {
+    :support_directory => nil,
+    :environments_file => nil,
+    :pages_file => nil,
+    :selectors_file => nil,
+    :settings_file => nil,
+    :environments => nil,
+    :pages => nil,
+    :selectors => nil,
+    :settings => nil,
+    :environment => nil
+  }
+  @valid_config_keys = @config.keys
+
+  class << self
+
+    #TODO: Improve the documentation below
+=begin
+****************************************************************
+                Load Order/ Dependencies
+****************************************************************
+
+          ********TEST PROJECTS****************
+          In Test Projects, first load this file
+          Then set any config variables
+          Then load the environments file in the @config_dir
+          The environments file loads the steps directory
+          Steps Directory is self sufficient (no external files need to be loaded)
+          **************************************
+
+          ********BIN STUBS*********************
+          The gem has one bin stub: SimpliTest 
+          This simply executes a method in the Main class with @cli_directory
+          The Main class in the cli dir requires @helpers_dir and @tasks_dir
+          ***************************************
+
+          ********RAKE TASKS*********************
+          Some cli commands execute rake tasks in the @tasks_dir
+          @tasks_dir requires @helpers_dir
+          ***************************************
+
+*****************************************************************
+=end
+
+    def configure(opts={})
+      opts.each {|k,v| @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
+      load_configuration
+    end
+
+    def default_path_for(key)
+      File.join(@config[:support_directory], 'config', "#{key.to_s}.yml")
+    end
+
+    def read_from(path_to_file)
+      begin
+        YAML::load(IO.read(path_to_file))
+      rescue Errno::ENOENT
+        alert ("Expected to find #{path_to_file} but did not find it.")
+      rescue Psych::SyntaxError
+        alert "#{path_to_file} YAML file contains invalid syntax. Please correct it"
+      end
+    end
+
+    def config
+      @config
+    end
+
+    def load_configuration
+      begin
+        @config[:environments] = read_from(@config[:environments_file] || default_path_for(:environments))
+        @config[:pages] = read_from(@config[:pages_file] || default_path_for(:pages))
+        @config[:selectors] = read_from(@config[:selectors_file] || default_path_for(:selectors))
+        @config[:settings] = read_from(@config[:settings_file] || default_path_for(:settings))
+        @config[:environment] = ENV['ENVIRONMENT'] || @config[:settings]['DEFAULT_ENVIRONMENT'] || @config[:settings][:environments].values.first
+        @valid_config_keys = @config.keys
+      rescue Exception => e
+        alert "There was a problem reading one of the required configuration files\n" + e.message
+      end
+    end
+
+    def driver
+      ENV['SimpliTest_DRIVER'] || @config[:settings]['DRIVER'] || 'selenium'
+    end
+
+    def driver=(name)
+      @config[:driver]=name
+    end
+
+    def mode
+      @config[:settings]['MODE'] || 'REGULAR'
+    end
+
+    def screen_size
+      ENV['SCREEN_SIZE'] || @config[:settings]['SCREEN_SIZE'] || 'Desktop'
+    end
+
+    def wait_for_page_load
+      @config[:settings]['WAIT_FOR_PAGE_LOAD'].to_i rescue 0
+    end
+
+  end #end self << class all methods below this are instance methods
+
+end