friendly-cukes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db6ddae9ea54195c4c6260b03be4c51060a78467
+  data.tar.gz: b1e83e6e9d7e4c213087e1c5a67d66a423f6e44f
+SHA512:
+  metadata.gz: 9ec23fbd6531448bd92be3197e511b3cf335dfcaf497369be3e6f07111dd3ac7a4b96c1ef4dc525a791f3d6b730b38eac9c571c8ad5aa5e4dafe91ef64abbf11
+  data.tar.gz: 29e5270ecd67d4cdd371d5a6a0f8bd378c11b6fefd82c6ab611df29a1192930f8af997e1d503e9f88c6275bf91d8ad11c7a07be449c78d22e9653ffd2184e070

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/DETAILED_DESCRIPTION.md

@@ -0,0 +1,235 @@
+# Framework components detailed description
+
+## 1. config
+
+#### a. config.yml
+
+- holds the various users profiles and global environment values used in run
+- the dynamic profiles include both test and development
+- only the free profile (having in_use: ‘no’) will be used during run
+- we can have multiple parallel execution with these profiles by specifying the profile (i.e., box) name and we can have any number of profiles under each node
+
+		Ex: as given in cucumber.yml
+
+		desktop_dev_chrome – will take any free profile under any developmentx node (where x is the node number)
+		desktop_devboxx_chrome – will take any free profile only under dev_boxx
+
+- If you wish to run cukes in multiple parallel machines, then for each execution have different devboxX profiles and in each machine parallel execution can be made with the same profile
+
+- the number of parallel threads = number of profiles, if you are running cukes in dev environment in 3 parallel threads, then there should be atleast 3 profiles under devboxX node
+
+	config.yml node descriptions :
+
+		environment: node holds the execution level data used throughout the cukes run
+		logger_level: DEBUG       - custom logger level
+		default_page_wait: 60   - explicit page load wait time in seconds
+		default_element_wait: 60  - explicit element load wait time in seconds
+		datetime_pattern: '%d_%m_%Y-%H_%M_%S‘  - default datetime format
+		feature_id_prefix: '@rq_‘   - prefix for unique feature level tag name
+		scenario_id_prefix: '@tc_‘  - prefix for unique scenario level tag name
+		parallel_execution_count: 0  -  used internally for parallel executions count
+		no_of_parallel_threads: 1  - no of parallel executions
+		delay_between_parallel_threads: 60 seconds  - delay between each parallel execution
+		performance_report: 'no‘  - flag for including performance report
+		db_server: EHR2Aspire  - DB server which holds DB where execution performance data are stored
+		db_name: PerformanceReport  - DB that holds relations for storing performance data
+		db_user_name: dba  - user name for DB access
+		db_password: sql  - password for DB access
+
+####  b. cucumber.yml
+
+- holds the cucumber run profiles with custom settings
+- The default: profile is for desktop (app) - test (node) – chrome (browser)
+- The profiles denote the profile type (from config.yml), application type (desktop or mobile) and the browser (Chrome, IE or Firefox)
+- You can n number profiles provided you have the equivalent boxes in config.yml
+- Each profile includes node for custom reporting – the cucumber html report files uses the custom formatter (present in support/html_formatter.rb)
+
+## 2. features
+
+### a. desktop
+
+- holds the desktop web feature files
+- The feature files can be placed under any directory level under desktop
+- Each feature should have an unique feature tag name starting with the prefix given in environment/ feature_id_prefix node in config.yml
+
+		Ex: @rq_desktop_search
+
+- Each scenario should have an unique scenario tag name starting with the prefix given in environment/ scenario_id_prefix node in config.yml
+
+		Ex: @tc_01
+
+- The custom report log file created by cukes will have the name with the relative path of the feature file directory that is executed
+
+### b. mobile
+
+- holds the mobile web feature files
+- The feature files can be placed under any directory level under mobile
+- Rest of the things are the same for mobile as well
+
+## 3. library
+
+### a. app_init
+
+#### app_driver.rb
+
+- Requires the cukes support directory files for globalizing PageObjects under library
+
+###	b. app_utils
+
+#### data_file_names.rb
+
+- contains constants with value of the test data (yml) file names and these constants can be used throughout the cukes without including or requiring
+
+#### page_utils.rb
+
+- contains generic methods that defines page objects related manipulations, which can be used for both desktop and mobile app automation
+
+### c. generic
+
+#### app_logo_1.png
+
+- logo of cukes, that will be added in custom html report files
+
+#### create_log.rb
+
+- contains custom logger class methods
+- creates two or more log files – app_env.log holds the execution environment and run duration details and other log files are created with the name as relative path of the current running feature file directory and holds logging of the feature, scenarios and their steps with scenariosrun duration details
+
+#### custom_html_report.rb
+
+- contains custom html report  class methods
+- the custom report is extracted from the cucumber generated reports (html and json files). The custom html report will be placed in custom_report under current report directory under test_result directory
+- The report also merges html reports generated during parallel executions. If there are 3 parallel executions, then 3 report directories will be created and the custom_report  (holding the report for all 3 executions) will be present only in one of the report directory
+- The report_home.html holds the execution summary, which includes the pass-fail count of features, scenarios and steps. On click on the feature link opens another html page that holds the pass-fail count of the scenarios and steps with cukes logs
+
+#### datetime_library.rb
+
+- contains generic module methods for date-time manipulation
+
+#### file_library.rb
+
+- contains generic module methods for file related manipulations
+
+#### performance_report.rb
+
+- contains generic class methods for creating data for performance report
+- The execution duration details are extracted from the json report file and saved into Sybase database (with credentials from config.yml) as relations
+- SqlAnywhere is used as DB, the server and database name are provided in config.yml
+- the json report file holds the execution duration in nano seconds only at step level and hence the steps are iterated for scenario, feature and build level
+- each build is marked unique and holds reference to its corresponding features, scenarios and steps, which includes the counts of pass, fail, skip and net result
+- these data can be populated as a report for application performance analysis
+
+#### read_from_yml.rb
+
+- contains generic class methods for yml file manipulation
+- the methods includes all kinds of yml data node traversal
+- cukes uses yml file for test data storage
+
+## 4. object_repository
+
+### a. desktop
+
+- all desktop web page-object class files are placed under object_repository directory
+- all the library classes and modules are visible to page class files
+- you can also have multiple repository files
+
+### b. mobile
+
+- all mobile web page-object class files are placed under object_repository directory
+- all the library classes and modules are visible to page class files
+- you can also have multiple repository files
+
+## 5. page_objects
+
+### a. desktop
+
+- holds generic page object class methods that defines the actual script action (with the objects from object_repository) on desktop web browser
+- all library class methods and object_repository modules are visible to the page object classes defined here
+
+### b. desktop
+
+- holds generic page object class methods that defines the actual script action (with the objects from object_repository) on mobile web browser
+- all library class methods and object_repository modules are visible to page object classes defined here
+
+## 6. step_definitions
+
+### a. desktop
+
+- holds the step definition files for the features under desktop directory
+- the step definition files can be grouped under directories under desktop directory
+
+### b. mobile
+
+- holds the step definition files for the features under mobile directory
+- the step definition files can be grouped under directories under desktop directory
+
+## 7. support
+
+#### browser_settings.rb
+
+- contains generic module methods for browser related manipulations
+- holds browser object profiles for desktop browsers like chrome, internet explorer and firefox and mobile browsers like chrome (Android)  and safari (IOS)
+
+#### env.rb
+
+- holds require statements for including ruby library classes and modules and requires library and object_repository of cukes (for making cukes library files available to the entire framework)
+- contains constants definitions holding cucumber run command line arguments (environment) values
+- all global class and module declarations can be made here (using World)
+
+#### hooks.rb
+
+- holds the scenario hooks definitions that defines the feature/scenario/step pre and post actions
+- all profile values used by cukes are defined as constants
+- major stuffs like log file creation, browser/application launching, scenarios/steps pre and post action setup, custom and performance reports creation are done in this file
+
+#### html_formatter.rb
+
+- contains generic class methods for custom html report formatter
+- holds method definitions for embedding image, text, link or a file
+
+## 8. test_result
+
+for each execution an unique test report directory will be created with the name ‘test_report_<timestamp>’ under which by default the following exists
+
+#### app_env.log
+
+– holds the log for execution environment and duration details
+
+#### feature based custom log file
+
+– holds the log based on the currently running feature – there can n number of feature log files
+
+#### report_timestamp.html
+
+– cucumber generated html report file that holds the log for features, scenarios and steps
+
+#### report_timestamp.json
+
+– cucumber generated json report file that holds the log for features, scenarios and steps and the step level durations in nano seconds
+
+#### custom_report
+
+- custom_report – the directory holds custom html report files
+- report_home.html – holds the summary report of the execution
+
+## 9. Gemfile
+
+- holds the gem names with version used in cukes
+- if you wish to add/remove/update any gem or its version, then those changes can be made in this file and run bundle 	install to install the gems in your machine
+- for IDE (like RubyMine) no need to do bundle install, as it automatically does it when any change is made to this file
+- When bundle install is successful a file named Gemfile.lock will be created which holds the gems and its dependencies (kindly avoid updating gemfile.lock, make changes only to Gemfile)
+
+## 10. Rakefile.rb
+
+- all the rake tasks can be defined here
+- instead of typing a lengthy cucumber run command, it can be given as a rake task and can be invoked by rake <task_name>
+- the pre and post conditions can also be set here
+
+## 11. Code coverage
+
+- Cukes uses simplecov for code coverage
+- if you want to include code coverage into cukes,  then add CODE_COVERAGE=yes or true in cucumber run command
+- like, cucumber –p desktop_dev_chrome -t @tc_01 APP=GOOGLE CODE_COVERAGE=yes
+- it will create a directory coverage under cukes under which rcov/index.html report file holds the code coverage metric details, which covers all the files under cukes
+- it also creates json report files in the name .last_run.json – holds total coverage percent and resultset.json – holds individual files code coverage percent
+- the json report file will be used in code coverage integration with Jenkins

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gem "bundler"
+gem "cucumber", "1.3.15"
+gem "page-object", "1.0.2"
+gem "watir-webdriver", "0.6.10"
+gem "selenium-webdriver", ">= 2.43.0"
+gem "time_difference", "0.3.2"
+gem "data_magic", "0.19"
+gem "require_all", "1.3.2"
+gem "nokogiri", "1.6.3.1"
+gem "simplecov", "0.9.2"
+gem "dbi", "0.4.5"
+gem "dbd-sqlanywhere", "1.0.1"
+gem "appium_lib", "4.1.0"
+gem "rspec", "3.0.0"
+gem "rake", ">= 0.9.6"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,108 @@
+# Friendly-Cukes
+friendly-cukes is user friendly cucumber test automation framework created by tester for tester.
+It is a ruby-cucumber based generic automation framework for desktop and mobile web automation. It is built using Cucumber (1.3.15), page-object (1.0.2) and appium_lib (4.1.0). All you need is to install the gem and that's it, you have set with cucumber automation.
+
+#### Gem requirements
+The gem requires [Ruby (2.0.0)](https://www.ruby-lang.org/en/downloads/), [ChromeDriver.exe (v2.10.267521)](http://chromedriver.storage.googleapis.com/index.html), [IEDriverServer.exe (2.45.0.0)](http://selenium-release.storage.googleapis.com/index.html) and [Appium (1.3.4.1)](http://appium.io/downloads.html). As of now the framework is designed to work with the proposed software setup and tested only on Windows machine.
+
+1. Install friendly-cukes gem
+
+		gem install friendly-cukes
+
+2. Install generic cucumber framework
+
+		friendly-cukes --new test_app_name
+	where `test_app_name` is the test application name
+	This will install the generic cukes framework under `test_app_name` directory (type `friendly-cukes` for more options)
+
+3. Then type `cd test_app_name` and start with the cucumber automation.
+	By default the framework has some feature files for demo purpose.
+	The cucumber run command for the default feature files is created as rake task, Type `rake -T` and it will list three tasks. Run any of the task, like `rake desktop_google_search` and it will start the cucumber execution
+
+4. The cucumber run command will look like
+
+		$cucumber -p profile_name --tags tag1[,tag2,...] APP=app_name
+
+	where
+	* `profile_name` - is the cucumber profile name present in `cucumber.yml`
+	* `tags` - is the tag name for feature/scenario to be executed
+	* `app_name` - key name of the application (as of now I have used two different app;Google and Rubygems for demo purpose)
+
+	Example:
+
+		$cucumber -p desktop_dev_ff -t @tc_02 APP=RUBYGEMS
+
+	the above command runs scenario tag `@tc_02` (from `gem_search.feature`) with `desktop_dev_ff profile` (from `cucumber.yml`)
+
+5. For releasing unused profiles add `RESET_CONFIG_VALUES=yes` or `true` in the cucumber run command and it will release all the no-longer used profiles
+
+6. For adding code coverage report, add `CODE_COVERAGE=yes` or `true` in cucumber run command and it will create a `coverage` directory holding the code-coverage report files
+
+7. For mobile automation, use the profile (in `cucumber.yml`) prefixed with `mobile_`
+
+	Example:
+
+		$cucumber -p mobile_dev_chrome_device -t @tc_02 APP=RUBYGEMS
+
+	the above command will execute scenario with tag `@tc_02` in chrome in the device attached to the machine, provided the android and appium settings are correct and the `appium server` is up and running
+
+# TAF Features
+## Object Repository
+1. all web page-objects (web elements) are grouped into modules and are placed under `object_repository` directory
+
+2. the `page-object` repository modules can be encapsulated with any `PageObject` class files
+
+3. there can be multiple repository files
+
+4. the `page_objects` directory holds generic page object class methods that defines the actual script action (with the objects from `object_repository`) on web browser
+
+## Test data handling
+YML files are used as test data files for faster data access and these files are stored under `test_data` directory under feature file directory. The test data handling is done at two levels
+
+1. local :
+	the scenario specific test data file should be placed under the respective feature file directory and with the file name suffixed with the scenario ID
+
+2. global :
+	the global test data files should be placed under test_data directory under the root feature (`desktop` or `mobile`) directory and if no local test data file is present, then it takes the global data file as default
+
+## Dynamic profile and Parallel execution
+
+###	1. Dynamic profiles
+* the profile allocation for each execution ( on single or multiple machines) is done dynamically during the execution
+
+* based on the profile tags given in `cucumber.yml`, the free profiles are auto-assigned to the currently running execution
+
+* the profiles are configured in such a way that there can be `n` nodes and each node can have `m` profiles and hence the profile sample space is `n x m`
+
+###	2. Parallel execution
+* the parallel execution parameters are given in `config.yml` based on which the merging of custom html report files will be done
+
+* the profiles for each parallel execution is taken from `config.yml` dynamically
+
+## Custom Execution report
+
+for each execution an unique test report directory will be created with the name `test_report_<timestamp>` under which by default the following exists
+
+* `app_env.log` –> holds the log for execution environment and duration details
+
+* `feature based custom log file` –> holds the log based on the currently running feature – there can `n` number of feature log files
+
+* `report_<timestamp>.html` –> cucumber generated html report file that holds the log for features, scenarios and steps
+
+* `report_<timestamp>.json` –> cucumber generated json report file that holds the log for features, scenarios and steps and the step level durations in nano seconds
+
+* `custom_report` –> the directory holds merged custom html report files
+
+* `report_home.html` –> holds the summary report of the execution
+
+## Performance Report
+
+* the performance report component extracts the build details from cucumber generated json report files and stores in into `Syabse` database
+
+* the complete execution data for each build will be stored in the DB, which can be interpreted and populated as a performance report
+
+* the performance report can included or excluded based on the property value of performance_report in `config.yml`
+
+* this component is also available as a standalone application bundled with the `friendly-cukes` gem, type `build-extractor` and follow the commands
+
+* this will work only if `Syabse` database is configured in TAF and tables are created with TAF defined relationships

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/build-extractor

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'open-uri'
+require 'irb'
+require 'uri'
+require 'rubygems'
+require 'friendly/cukes'
+require 'friendly/build_extractor'
+
+hash_args = {}
+
+opts = OptionParser.new do |opts|
+  opts.banner = "Build-Extractor : a ruby-cucumber based exe that extracts cucumber execution data from json report files and stores them into Sybase DB"
+  opts.define_head "Usage : build-extractor <uri|path> [options]"
+  opts.separator ""
+  opts.separator "Examples :"
+  opts.separator "   build-extractor http://www.ruby-lang.org/"
+  opts.separator ""
+  opts.separator "The DataBase tables have to be created before running the below command. Refer gem documentation for DB setup and schema"
+  opts.separator "Syntax : build-extractor --generate --file '<json files directory>' --url '<DB connection url>' --host '<primary-key of HostData table>'"
+  opts.separator ""
+  opts.separator "Options :"
+
+  opts.on_tail("-v", "--version", "Show version") do
+    puts Friendly::Cukes::VersionInfo.new.version
+    exit
+  end
+
+  opts.on_tail("-?", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("-f", "--file FILE", "Directory path of json file(s), used along with --generate") do |file|
+    hash_args[:file] = file
+  end
+
+  opts.on_tail("-u", "--url URL", "Connection url for DataBase, used along with --generate") do |url|
+    hash_args[:url] = url
+  end
+
+  opts.on_tail("-h", "--host HOST", "Primary-Key (HostDataID) of HostData table; machine where the build is run, used along with --generate") do |host|
+    hash_args[:host] = host
+  end
+
+  opts.on_tail("-g", "--generate", "Generates the build data and saves into Sybase DataBase") do
+    puts "Extracts build data from cucumber generated json report files and save these data into Sybase database"
+    puts "provided the database tables are already created with internal mappings."
+    puts "Refer gem documentation for database setup and tables schema"
+  end
+end
+opts.parse!
+
+if !hash_args.empty?
+  err_msg = "Please provide all required command line options\nSyntax : build-extractor --generate --file '<json files directory path>' --url '<DB connection url>' --host '<primary-key of HostData table>'"
+  if !(hash_args.has_key?(:file)) || !(hash_args.has_key?(:url)) || !(hash_args.has_key?(:host))
+    raise err_msg
+  elsif (hash_args[:file].nil? || hash_args[:file].empty?) && (hash_args[:url].nil? || hash_args[:url].empty?) && (hash_args[:host].nil? || hash_args[:host].empty?)
+    raise err_msg
+  else
+    BuildExtractor.new(hash_args[:url], hash_args[:file], hash_args[:host]).save_build_data
+  end
+else
+  uri = ARGV.shift
+  if uri.to_s.strip.empty? && $stdin.tty?
+    puts opts
+    exit 1
+  end
+end