Ifd_Automation 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cc94f4832155a4ce2de60236786252fb0611811
-  data.tar.gz: d6371731b9672dceb75f793681ccd080a389d2b8
+  metadata.gz: df8498418e7065e4ddcc12961d6142d0d5f5c80c
+  data.tar.gz: 6f32532b72cf8c054e8a00413d0dd464e0215d03
 SHA512:
-  metadata.gz: 33926b1736f3c9ffcaf8ce35a9255968be88791de40c1a3c8a513810fd84c761c07a0fa471baac4ed565ce937364b6a26bd30a02f3cac650e70ffe3ebb381bbb
-  data.tar.gz: b6b21e2e045f1f9308fbf8c90ce70b8449e9d806a16324bb01020020cf328c23bd97911b322e587cfb550e6102a9d908aa56d411e182494acb7d43eb8496fc9b
+  metadata.gz: 0d8d6b66e566c2510a54338e7a796c9d059c0d03a9a708b41dcdf31a12e513a3b175ad190bbf55d4524c8f7f04f55e0244633224c4fd6d78b5e4677459195e76
+  data.tar.gz: 1590841f166adde9f93e4d4ab5f7117255ead493d9a847fc68822c5f4c2a3d333ad7b482a34fd465981297f44ea7bb8c40e8da1108ed6b7364d5c8514a338020

data/bin/Ifd_Automation

@@ -1,25 +1,44 @@
 #!/usr/bin/env ruby 
-
 require_relative 'helper.rb'
 require_relative 'generate.rb'
+require_relative 'documentation_generator.rb'
 require 'Ifd_Automation/version'
 
 @features_dir = File.join(FileUtils.pwd, "project")
 @source_dir = File.join(File.dirname(__FILE__), '..', 'project')
 
-if (ARGV.length == 0)
-  print_usage
-else
-	cmd = ARGV.shift
-
-	if cmd == "help"
-  		print_help
-	elsif cmd == "gen"
-  		ifd_automation_scaffold
-	elsif cmd == "version"
-		puts Ifd::Automation::VERSION
-  	else
-  		print_usage
-	end
+search_string = ARGV.shift
+case search_string
+  when /version/
+    puts IfdAutomation::VERSION
+  when /gen/
+    ifd_automation_scaffold
+  when /ls/
+    ORDERED_KINDS = %w[Given When Then]
+    heading = 'All Ifd_Automation steps'
+
+# collect
+    steps_glob = File.expand_path('../../lib/Ifd_Automation/*_steps.rb', __FILE__)
+    step_names = `cat #{steps_glob}`.split($/).select { |line| line =~ /^\s*(Given|When|Then)/ }
+
+# format
+#     step_names.map! do |step|
+      # DocumentationGenerator::StepDefinition.try_and_parse(step)
+      # p step
+    # end
+
+# sort
+#     step_names = step_names.sort_by do |step|
+#       step =~ /^(\w+)(.*)/
+#       [ORDERED_KINDS.index($1), $2]
+#     end
+
+# Output
+    puts "\e[4;34m\n# #{heading}\e[0m" # blue underline
+    puts step_names
+  else
+    print_help
 end
 
+
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "Ifd_Automation"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/documentation_generator.rb

@@ -0,0 +1,119 @@
+module DocumentationGenerator
+
+  module CommentExtractor
+    def parse_and_format_comment(comment)
+      comment.gsub!(/.*coding:.*UTF-8.*/, '')
+      comment.strip!
+      comment_lines = comment.split("\n").take_while { |line| line =~ /^\s*#/ }
+      comment_lines && comment_lines.join("\n").gsub(/^\s*# ?/, '')
+    end
+  end
+
+  class StepDefinition
+
+    extend CommentExtractor
+
+    def initialize(definition, comment = nil)
+      @definition = definition
+      @comment = comment
+    end
+
+    def self.try_and_parse(code)
+      definition = code[/^\s*((When|Then|Given|AfterStep).*)do/, 1]
+      return unless definition
+      comment = parse_and_format_comment(code)
+      return if comment =~ /\bnodoc\b/
+      new(definition.strip, comment)
+    end
+
+    def format
+      <<-TEXT
+* **#{format_definition}**
+
+#{@comment.gsub(/^/, '  ')}
+      TEXT
+    end
+
+    def format_definition
+      if @definition =~ /AfterStep/
+        @definition[/@\w*/]
+      else
+        capture_groups = %w[([^\"]*) ([^"]*) (.*) (.*?) [^"]+ ([^\"]+) ([^']*) ([^/]*) (.+) (.*[^:])]
+        capture_groups.map! &Regexp.method(:escape)
+
+        @definition.
+          gsub('/^', '').
+          gsub('$/', '').
+          gsub(' ?', ' ').
+          gsub('(?:|I )', 'I ').
+          gsub('?:', '').
+          gsub(Regexp.new(capture_groups.join '|'), '...').
+          gsub(/\\\//, '/')
+      end
+    end
+  end
+
+  class StepDefinitionFile
+    
+    FILE_COMMENT_END = 'FILE_COMMENT_END'
+
+    include CommentExtractor
+
+    def initialize(filename)
+      @filename = filename
+      @code = File.read(filename)
+      @steps = []
+      extract_comment
+      add_steps
+    end
+
+    def extract_comment
+      if @code.include?(FILE_COMMENT_END)
+        file_comment = @code.split(FILE_COMMENT_END).first
+        @comment = parse_and_format_comment(file_comment)
+      end
+    end
+
+    def add_steps
+      @code.split("\n\n").each do |block|
+        step = StepDefinition.try_and_parse(block)
+        if step
+          @steps << step
+        end
+      end
+    end
+
+    def format
+      <<-TEXT
+### #{format_filename}
+
+#{@comment}
+
+#{format_steps}
+      TEXT
+    end
+
+    def format_filename
+      @filename.split('/').last
+    end
+
+    def format_steps
+      @steps.collect { |step| step.format }.join("\n\n")
+    end
+  end
+
+  class StepDefinitionsDirectory
+    def initialize(directory)
+      @step_definition_files = []
+      Dir["#{directory}/*.rb"].to_a.sort.each do |filename|
+        next if filename =~ /all_steps/
+        @step_definition_files << StepDefinitionFile.new(filename)
+      end
+    end
+
+    def format
+      @step_definition_files.collect { |step_definition_file| step_definition_file.format }.join("\n\n")
+    end
+  end
+
+end

data/bin/helper.rb

@@ -8,33 +8,36 @@ def msg(title, &block)
   puts "-"*10 + "-------" + "-"*10 + "\n"
 end
 
-def print_usage
-  puts <<EOF
-  
-  Usage: Ifd_Automation <command-name> [parameters] [options]
-  
-  <command-name> can be one of
-    help
-      prints more detailed help information.
-    gen
-      generate a features folder structure.
-    version
-      prints the gem version
-
-  <options> can be 
-     -v, --verbose   Turns on verbose logging
-EOF
-end
+# def print_usage
+#   puts <<EOF
+#
+#   Usage: Ifd_Automation <command-name> [parameters] [options]
+#
+#   <command-name> can be one of
+#     help
+#       prints more detailed help information.
+#     gen
+#       generate a features folder structure.
+#     version
+#       prints the gem version
+#     ls
+#       list all steps name of Ifd Automation framework
+#   <options> can be
+#      -v, --verbose   Turns on verbose logging
+# EOF
+# end
 
 def print_help
   puts <<EOF
-  
+  Author: Anh Pham
+
   Usage: Ifd_Automation <command-name> [parameters] [options]
-  
+
   <command-name> can be one of
     help
     gen
     version
+    ls
 
     Commands:
       help : prints more detailed help information.
@@ -45,6 +48,8 @@ def print_help
 
       version : prints the gem version
 
+      ls: list all steps name of Ifd Automation framework
+
   <Options>
       -v, --verbose  Turns on verbose logging
 EOF

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/Ifd_Automation.rb

@@ -1 +1,2 @@
-Dir[File.dirname(__FILE__) + '/Ifd_Automation/*.rb'].each { |file| require file }
+require "Ifd_Automation/version"
+Dir[File.dirname(__FILE__) + '/Ifd_Automation/*.rb'].each { |file| require file }

data/lib/Ifd_Automation/all_steps.rb

@@ -0,0 +1,8 @@
+# coding: UTF-8
+
+Dir[File.join(File.dirname(__FILE__), '*_steps.rb')].each do |f|
+  name = File.basename(f, '.rb')
+  unless name == 'all_steps'
+    require "Ifd_Automation/#{name}"
+  end
+end

data/lib/Ifd_Automation/database_steps.rb

@@ -0,0 +1,106 @@
+require_relative 'required_libs'
+
+Given /^I create connection to database with:$/ do |params|
+  unless params.hashes.empty?
+    @connection = Connection.new(params.hashes[0])
+    p "Connect to database successfully!" if @connection
+  end
+end
+
+# Example
+# When I run multiple sql script:
+#                    """
+#   delete from autofeatures where id=10;
+#   delete from autofeatures where id=11;
+#   """
+And /^I run multiple sql script:$/ do |raw_data|
+  raw_data.strip!
+  script = raw_data.split(/\n/)
+  script.each do |row|
+    begin
+      sql = "#{row}"
+      @result = @connection.connection().execute(sql)
+    rescue Exception => e
+      raise e.message
+    end
+  end
+end
+
+When /^I run sql script from previous step$/ do
+  unless @file_data.nil?
+    begin
+      @file_data.each_line do |line|
+        if line.nil? || line =~ /^\s*\n*--/
+          puts "\nSQL: " + line;
+          next
+        end
+        line = line.strip();
+        # line = line[0..-2];
+        p line
+        @result = @connection.connection().execute(line)
+        sleep 1
+      end
+
+    rescue Exception => e
+      raise e.message
+    end
+  end
+end
+
+# Example
+# When I run sql script "select * from users where email=stored='id'"
+And /^I run sql script "(.*)"$/ do |sql|
+  script = check_match_url sql
+  begin
+    @result = @connection.connection().execute(script)
+  rescue Exception => e
+    raise e.message
+  end
+end
+
+Then /^Show me the result of SQL statement$/ do
+  unless @result.nil?
+    @result.each(:as => :hash) do |row|
+      puts row
+    end
+  end
+end
+
+# Example
+# Then the result of SQL statement should be:
+#                                             """
+#   {"name": "quoc anh", "email": "anhpq.info@gmail.com"}
+#   """
+Then /^the result of SQL statement should be:$/ do |json|
+  expected = JSON.parse(json)
+  @result.each(:as => :hash) do |row|
+    IFD_Assertion.assert_string_equal(row, expected)
+  end
+end
+
+# Example
+# Then the result of SQL statement should have "email" with value "anhpq.info@gmail.com"
+Then /^the result of SQL statement should have "(.*)" with value "(.*)"$/ do |json_path, value|
+  @result.each(:as => :hash) do |row|
+    results = JsonPath.new(json_path).on(row).to_a.map(&:to_s)
+    IFD_Assertion.assert_string_equal(results[0], value)
+  end
+end
+
+When /^I store "(.*)" as "(.*)"$/ do |json_path, place_holder|
+  if @result.nil?
+    raise 'No record found, a request need to be made first before you can store data'
+  end
+  @stored = {} if @stored.nil?
+  @result.each(:as => :hash) do |row|
+    @stored[%/#{place_holder}/] = row[%/#{json_path}/]
+
+  end
+end
+
+# def resolve_script script
+#   unless @stored.nil?
+#     @stored.each { |key, value| script = script.gsub /\{#{key}\}/, %/'#{value}'/ }
+#   end
+#   script
+# end

data/lib/Ifd_Automation/email_steps.rb

@@ -1,91 +1,76 @@
-require 'mail'
-require_relative 'methods/required_files'
-# Before do
-#   ActionMailer::Base.deliveries.clear
-# end
-
-Then /^I send the email to "(.*)" with subject is "(.*)" and email body in "(.*)" file$/ do |to_address, subject, file|
-  data_file = File.read($test_data_dir + file)
-  filepath = ($test_data_dir + file)
-  body_email = data_file.force_encoding('UTF-8').encode('UTF-16', :invalid => :replace, :replace => "'").encode('UTF-8')
-  if File.exist?(filepath)
-    IFD_Email.send_email(to_address, subject, body_email)
-  end
-end
-Then /^I send the email to "(.*)" with subject is "(.*)" and email body "(.*)"$/ do |to_address, subject, email_body|
-  email_body = email_body.force_encoding('UTF-8').encode('UTF-16', :invalid => :replace, :replace => "'").encode('UTF-8')
-  IFD_Email.send_email(to_address, subject, email_body)
-end
+require 'action_mailer'
+require_relative 'required_libs'
+# Example:
+#
+#       Then I send an email with:
+#        """
+#         From: from@example.com
+#         Reply-To: reply-to@example.com
+#         To: anh.pham@infodation.vn
+#         Subject: SUBJECT
+#         Attachments: globalData.yml
 
-Then /^I should receive the email from "(.*)" with subject "(.*)"$/ do |email_from, email_subject|
-  sleep 5
-  emails = Mail.find(:what => :last, :count => 1)
-  if emails.instance_of? Mail::Message
-    # puts emails.from[0].to_s
-    IFD_Assertion.assert_string_equal(email_from, emails.from[0].to_s)
-    IFD_Assertion.assert_string_equal(email_subject, emails.subject)
-  else
-    raise "WARNING: *** No new Email is found"
-  end
-end
+#         BODY
+#         """
+#
+Then /^I send an e?mail with:$/ do |raw_data|
+  patiently do
+    raw_data.strip!
+    header, body = raw_data.split(/\n\n/, 2) # 2: maximum number of fields
+    conditions = {}
+    header.split("\n").each do |row|
+      if row.lstrip.chop.match(/^[a-z\-]+:/i)
+        key, value = row.split(":", 2)
+        conditions[key.gsub(' ','').underscore.to_sym] = value.gsub(' ','')
 
-Then /^I should receive the mail from "(.*)" with Email content has following value:$/ do |email_from, email_content|
-  sleep 5
-  emails = Mail.find(:what => :last, :count => 1)
-  if emails.instance_of? Mail::Message
-    IFD_Assertion.assert_string_equal(email_from, emails.from[0].to_s)
-    email_content.raw[0].each do |line|
-      assert(true) if emails.body.should include(line.strip)
+      end
     end
-  else
-    raise "WARNING: *** No new Email is found"
+   conditions[:body] = body if body
+    filepath = ($test_data_dir + conditions[:attachments] if conditions[:attachments])
+    IFD_Email.send_email(conditions[:to], conditions[:subject], conditions[:body],filepath)
   end
 end
 
-Then /^I should receive the mail from "(.*)" with subject "(.*)" and Email content has following value:$/ do |email_from,email_subject, email_content|
-  sleep 5
-  emails = Mail.find(:what => :last, :count => 1)
-  if emails.instance_of? Mail::Message
-    IFD_Assertion.assert_string_equal(email_from, emails.from[0].to_s)
-    IFD_Assertion.assert_string_equal(email_subject, emails.subject)
-    email_content.raw[0].each do |line|
-      assert(true) if emails.body.should include(line.strip)
+# Example:
+#
+#       Then I should receive an email with:
+#        """
+#         From: from@example.com
+#         Reply-To: reply-to@example.com
+#         To: anh.pham@infodation.vn
+#         Subject: SUBJECT
+#         Attachments: globalData.yml
+
+#         BODY
+#         """
+#
+
+Then /^I should receive an e?mail with:$/ do |raw_data|
+  patiently do
+    raw_data.strip!
+    header, body = raw_data.split(/\n\n/, 2) # 2: maximum number of fields
+    conditions = {}
+    header.split("\n").each do |row|
+      if row.lstrip.chop.match(/^[a-z\-]+:/i)
+        key, value = row.split(":", 2)
+        conditions[key.gsub(' ','').underscore.to_sym] = value.gsub(' ','')
+
+      end
+    end
+    conditions[:body] = body.squeeze(' ').strip if body
+    sleep 5
+    emails = Mail.find(:what => :last, :count => 1)
+    
+    if emails.instance_of? Mail::Message
+      IFD_Assertion.assert_string_equal(conditions[:from], emails.from[0].to_s)
+      IFD_Assertion.assert_string_equal(conditions[:subject], emails.subject)
+      IFD_Assertion.assert_string_contain(conditions[:body], emails.body)
+      emails.attachments.each do |attachment|
+        IFD_Assertion.assert_string_equal(conditions[:attachments], attachment.filename)
+      end if conditions[:attachments]
+    else
+      raise "WARNING: *** No new Email is found"
     end
-  else
-    raise "WARNING: *** No new Email is found"
   end
 end
-#
-# Then /^I send the email to "(.*)" with subject is "(.*)" and email body template in "(.*)" file and following conditions:$/ do |to_address, subject, file, data_table|
-#   data_file = File.read($test_data_dir + file)
-#   filepath = ($test_data_dir + file)
-#   body_email = data_file.force_encoding('UTF-8').encode('UTF-16', :invalid => :replace, :replace => "'").encode('UTF-8')
-#   if File.exist?(filepath)
-#     raw_data = JSON.parse(JSON.generate(data_table))
-#     header = raw_data[0]
-#     value = raw_data[1]
-#     $test = String.new
-#     $i = 0
-#     body_email.each_line do |lines|
-#       header.zip(value).each do |headers, values|
-#         group1, group2, group3= lines.match(/(^.*)(:)(.*)/i).try(:captures)
-#         if headers == group1 && group1.size > 0
-#           $new_value = lines.gsub(group3, " #{values}")
-#           $test += "#{$new_value}"
-#           $i = 1
-#           break
-#         elsif headers == "taaknummer"
-#           $new_value = lines.gsub("[TASKID]", " #{values}")
-#           $test += "#{$new_value}"
-#           $i = 1
-#         else
-#           $i = 0
-#         end
-#       end
-#       if $i == 0
-#         $test += "#{lines}"
-#       end
-#     end
-#     IFD_Email.send_email(to_address, subject, $test)
-#   end
-# end
+