hiptest-publisher 0.3.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6041db11a53b2b03c059cbf5c218ff27c1bed910
-  data.tar.gz: f85c857da7a25003978d8472426d618011374ad3
+  metadata.gz: d7e6e951a54117005ef23edde89a7b774c0e0406
+  data.tar.gz: 8ac2f19e6510ee971d2dcbeb3d3fb4944e97e8d8
 SHA512:
-  metadata.gz: 059501363e3923261d567275b66a15f30ecd741d9ef057bd1faf9d4eddf10ff57b89384a66d88ef77dce1947217d9a3b75d0de92f8173b4843434b4010f2970e
-  data.tar.gz: 5515d70df09c1f7c89c3aa040f999abfc251055bf8959838f336aff94683b396ebd36628082cbbdf237f9cc6c2639a62547b0c933fe8dfac82e10d29aa1e2251
+  metadata.gz: 8ecb02311bb95c630d339d286f664b6cfe373f038a2cabfd8637e41176a167b479ee9316f917fd75d5521853b2440e4affe8d162341584dc2851bd9f6e0407ad
+  data.tar.gz: fc29b7ef057e6b543bd122e1606d1210c638a6068559a7bf494a71a43446e5c9a5196b0f95991bee35acbb2f4ac2d6a36439cbd1a061f15adf6a652268a52420

data/README.md

@@ -34,7 +34,10 @@ This will create a Ruby tests suite. For the moment, we support the following la
 
  - Ruby (rspec / minitest)
  - Python (unittest)
- - Java (JUnit)
+ - Java (JUnit / TestNg)
+ - Robot Framework
+ - Selenium IDE
+ - Javascript (qUnit / Jasmine)
 
 You can specify the output language and framework in the command line, for example:
 
@@ -42,6 +45,7 @@ You can specify the output language and framework in the command line, for examp
 hiptest-publisher --token=<YOUR TOKEN> --language=ruby --framework=minitest
 ```
 
+When publishing, you'll notice that a file called ``actionwords_signature.yaml``. Store this file in your code repository, it will be used to [handle updates of the action word](docs/upgrading_actionwords.md).
 
 For more information on the available options, use the following command:
 

data/bin/hiptest-publisher

@@ -8,4 +8,4 @@ end
 
 require 'hiptest-publisher'
 
-Hiptest::Publisher.new(ARGV).export
+Hiptest::Publisher.new(ARGV).run

data/lib/hiptest-publisher.rb

@@ -1,4 +1,5 @@
 require 'colorize'
+require 'yaml'
 
 require 'hiptest-publisher/string'
 require 'hiptest-publisher/utils'
@@ -7,12 +8,16 @@ require 'hiptest-publisher/xml_parser'
 require 'hiptest-publisher/parent_adder'
 require 'hiptest-publisher/parameter_type_adder'
 require 'hiptest-publisher/call_arguments_adder'
+require 'hiptest-publisher/signature_exporter'
+require 'hiptest-publisher/signature_differ'
 
 module Hiptest
   class Publisher
     def initialize(args)
       @options = OptionsParser.parse(args)
+    end
 
+    def run
       unless @options.push.nil? || @options.push.empty?
         post_results
         return
@@ -22,6 +27,18 @@ module Hiptest
       return if xml.nil?
 
       @project = get_project(xml)
+
+      if @options.actionwords_signature
+        export_actionword_signature
+        return
+      end
+
+      if @options.actionwords_diff || @options.aw_deleted|| @options.aw_created|| @options.aw_renamed|| @options.aw_signature_changed
+        show_actionwords_diff
+        return
+      end
+
+      export
     end
 
     def fetch_xml_file
@@ -44,12 +61,12 @@ module Hiptest
       return parser.build_project
     end
 
-    def write_node_to_file(path, node, context, message)
+    def write_to_file(path, message)
       status_message = "#{message}: #{path}"
       begin
         show_status_message status_message
         File.open(path, 'w') do |file|
-          file.write(Hiptest::Renderer.render(node, @options.language, context))
+          file.write(yield)
         end
 
         show_status_message status_message, :success
@@ -59,6 +76,12 @@ module Hiptest
       end
     end
 
+    def write_node_to_file(path, node, context, message)
+      write_to_file(path, message) do
+        Hiptest::Renderer.render(node, @options.language, context)
+      end
+    end
+
     def export_tests
       if @options.split_scenarios
         @project.children[:tests].children[:tests].each do |test|
@@ -108,6 +131,94 @@ module Hiptest
         @language_config.actionword_render_context,
         "Exporting actionwords"
       )
+      export_actionword_signature
+    end
+
+    def export_actionword_signature
+      write_to_file(
+        "#{@options.output_directory}/actionwords_signature.yaml",
+        "Exporting actionword signature"
+      ) { Hiptest::SignatureExporter.export_actionwords(@project).to_yaml }
+    end
+
+    def show_actionwords_diff
+      begin
+        show_status_message("Loading previous definition")
+        old = YAML.load_file("#{@options.output_directory}/actionwords_signature.yaml")
+        show_status_message("Loading previous definition", :success)
+      rescue Exception => err
+        show_status_message("Loading previous definition", :failure)
+        trace_exception(err) if @options.verbose
+      end
+
+      @language_config = LanguageConfigParser.new(@options)
+      Hiptest::Nodes::ParentAdder.add(@project)
+      Hiptest::Nodes::ParameterTypeAdder.add(@project)
+      Hiptest::DefaultArgumentAdder.add(@project)
+
+      current = Hiptest::SignatureExporter.export_actionwords(@project, true)
+      diff =  Hiptest::SignatureDiffer.diff( old, current)
+
+      if @options.aw_deleted
+        return if diff[:deleted].nil?
+
+        diff[:deleted].map {|deleted|
+          puts @language_config.name_action_word(deleted[:name])
+        }
+        return
+      end
+
+      if @options.aw_created
+        return if diff[:created].nil?
+        diff[:created].map {|created|
+          puts Hiptest::Renderer.render(created[:node], @options.language, @language_config.actionword_render_context)
+          puts ""
+        }
+        return
+      end
+
+      if @options.aw_renamed
+        return if diff[:renamed].nil?
+
+        diff[:renamed].map {|renamed|
+          puts "#{@language_config.name_action_word(renamed[:name])}\t#{@language_config.name_action_word(renamed[:new_name])}"
+        }
+        return
+      end
+
+      if @options.aw_signature_changed
+        return if diff[:signature_changed].nil?
+
+        diff[:signature_changed].map {|signature_changed|
+          puts Hiptest::Renderer.render(signature_changed[:node], @options.language, @language_config.actionword_render_context)
+          puts ""
+        }
+        return
+      end
+
+      unless diff[:deleted].nil?
+        puts "#{diff[:deleted].length} action words deleted:"
+        puts diff[:deleted].map {|d| "- #{d[:name]}"}.join("\n")
+        puts ""
+      end
+
+      unless diff[:created].nil?
+        puts "#{diff[:created].length} action words created:"
+        puts diff[:created].map {|c| "- #{c[:name]}"}.join("\n")
+        puts ""
+      end
+
+      unless diff[:renamed].nil?
+        puts "#{diff[:renamed].length} action words renamed:"
+        puts diff[:renamed].map {|r| "- #{r[:name]} => #{r[:new_name]}"}.join("\n")
+        puts ""
+      end
+
+      unless diff[:signature_changed].nil?
+        puts "#{diff[:signature_changed].length} action words which signature changed:"
+        puts diff[:signature_changed].map {|c| "- #{c[:name]}"}.join("\n")
+        puts ""
+      end
     end
 
     def export

data/lib/hiptest-publisher/nodes.rb

@@ -241,6 +241,11 @@ module Hiptest
     end
 
     class Actionword < Item
+      def initialize(name, tags = [], parameters = [], body = [], uid = nil)
+        super(name, tags, parameters, body)
+        @children[:uid] = uid
+      end
+
       def must_be_implemented?
         @children[:body].empty? || @children[:body].map {|step| step.class}.compact.include?(Hiptest::Nodes::Step)
       end

data/lib/hiptest-publisher/options_parser.rb

@@ -82,6 +82,12 @@ class OptionsParser
       Option.new(nil, 'scenario-tags=TAGS', '', String, "Filter scenarios by tags", :filter_tags),
       Option.new(nil, 'tests-only', false, nil, "Export only the tests", :tests_only),
       Option.new(nil, 'actionwords-only', false, nil, "Export only the actionwords", :actionwords_only),
+      Option.new(nil, 'actionwords-signature', false, nil, "Export actionword signature", :actionwords_signature),
+      Option.new(nil, 'show-actionwords-diff', false, nil, "Show actionwords diff since last update (summary)", :actionwords_diff),
+      Option.new(nil, 'show-actionwords-deleted', false, nil, "Output signature of deleted action words", :aw_deleted),
+      Option.new(nil, 'show-actionwords-created', false, nil, "Output code for new action words", :aw_created),
+      Option.new(nil, 'show-actionwords-renamed', false, nil, "Output signatures of renamed action words", :aw_renamed),
+      Option.new(nil, 'show-actionwords-signature-changed', false, nil, "Output signatures of action words for which signature changed", :aw_signature_changed),
       Option.new(nil, 'split-scenarios', false, nil, "Export each scenario in a single file", :split_scenarios),
       Option.new(nil, 'leafless-export', false, nil, "Use only last level action word", :leafless_export),
       Option.new('s', 'site=SITE', 'https://hiptest.net', String, "Site to fetch from", :site),
@@ -210,6 +216,10 @@ class LanguageConfigParser
     make_context('actionwords')
   end
 
+  def name_action_word(name)
+    name.send(@config['actionwords']['naming_convention'])
+  end
+
   private
   def make_context group
     context = {

data/lib/hiptest-publisher/signature_differ.rb

@@ -0,0 +1,64 @@
+module Hiptest
+  class SignatureDiffer
+    def self.diff(old, current)
+      SignatureDiffer.new(old, current).compute_diff
+    end
+
+    def initialize(old, current)
+      @old = old
+      @current = current
+    end
+
+    def compute_diff
+      @old_uid = map_by_uid(@old)
+      @current_uid = map_by_uid(@current)
+
+      compute_created
+      compute_deleted
+      compute_renamed
+      compute_signature_changed
+
+      diff = {}
+      diff[:created] = @created unless @created.empty?
+      diff[:deleted] = @deleted unless @deleted.empty?
+      diff[:renamed] = @renamed unless @renamed.empty?
+      diff[:signature_changed] = @signature_changed unless @signature_changed.empty?
+
+      diff
+    end
+
+    private
+
+    def compute_created
+      @created_uids = @current_uid.keys - @old_uid.keys
+      @created = @created_uids.map {|uid| {name: @current_uid[uid]['name'], node: @current_uid[uid]['node']}}
+    end
+
+    def compute_deleted
+      @deleted_uids = @old_uid.keys - @current_uid.keys
+      @deleted = @deleted_uids.map {|uid| {name: @old_uid[uid]['name']}}
+    end
+
+    def compute_renamed
+      @renamed = @current_uid.map do |uid, aw|
+        next if @created_uids.include?(uid) || @deleted_uids.include?(uid)
+        next if @old_uid[uid]['name'] == aw['name']
+
+        {name: @old_uid[uid]['name'], new_name: aw['name'], node: aw['node']}
+      end.compact
+    end
+
+    def compute_signature_changed
+      @signature_changed = @current_uid.map do |uid, aw|
+        next if @created_uids.include?(uid) || @deleted_uids.include?(uid)
+        next if @old_uid[uid]['parameters'] == aw['parameters']
+
+        {name: aw['name'], node: aw['node']}
+      end.compact
+    end
+
+    def map_by_uid(actionwords)
+      Hash[actionwords.collect { |aw| [aw['uid'], aw] }]
+    end
+  end
+end

data/lib/hiptest-publisher/signature_exporter.rb

@@ -0,0 +1,36 @@
+require 'yaml'
+
+module Hiptest
+  class SignatureExporter
+    def self.export_actionwords(project, export_nodes = false)
+      exporter = SignatureExporter.new
+      exporter.export_actionwords(project.children[:actionwords], export_nodes)
+    end
+
+    def export_actionwords(aws, export_nodes = false)
+      aws.children[:actionwords].map {|aw| export_actionword(aw, export_nodes)}
+    end
+
+    def export_item(item, export_node = false)
+      hash = {
+        'name' => item.children[:name],
+        'uid' => item.children[:uid],
+        'parameters' => export_parameters(item)
+      }
+      hash['node'] = item if export_node
+      hash
+    end
+    alias :export_actionword :export_item
+    alias :export_scenario :export_item
+
+    def export_parameters(item)
+      item.children[:parameters].map {|p| export_parameter(p)}
+    end
+
+    def export_parameter(parameter)
+      {
+        'name' => parameter.children[:name]
+      }
+    end
+  end
+end

data/lib/hiptest-publisher/xml_parser.rb

@@ -183,9 +183,18 @@ module Hiptest
         css_first_content(actionword, '> name'),
         build_tags(actionword),
         build_parameters(actionword),
-        build_steps(actionword))
+        build_steps(actionword),
+        css_first_content(actionword, '> uid'))
+    end
+
+    def build_actionwordSnapshot(actionword)
+      Hiptest::Nodes::Actionword.new(
+        css_first_content(actionword, '> name'),
+        build_tags(actionword),
+        build_parameters(actionword),
+        build_steps(actionword),
+        css_first_content(actionword, '> actionwordUid'))
     end
-    alias :build_actionwordSnapshot :build_actionword
 
     def build_scenario(scenario)
       Hiptest::Nodes::Scenario.new(

data/lib/templates/java/output_config

@@ -5,7 +5,7 @@ class_name_convention = 'camelize'
 indentation = "    "
 call_prefix = 'actionwords'
 
-
 [actionwords]
 filename = 'Actionwords.java'
 indentation = "    "
+naming_convention = 'camelize_lower'

data/lib/templates/javascript/actionwords.hbs

@@ -1,4 +1,4 @@
 var Actionwords = {{#curly}}{{#indent}}{{#join rendered_children.actionwords ","}}
 {{{this}}}{{/join}}
 {{/indent}}
-{{/curly}}
+{{/curly}};

data/lib/templates/javascript/jasmine/output_config

@@ -5,3 +5,4 @@ call_prefix = 'actionwords'
 
 [actionwords]
 filename = 'actionwords.js'
+naming_convention = 'camelize_lower'

data/lib/templates/javascript/output_config

@@ -5,3 +5,4 @@ call_prefix = 'actionwords'
 
 [actionwords]
 filename = 'actionwords.js'
+naming_convention = 'camelize_lower'

data/lib/templates/python/output_config

@@ -7,3 +7,4 @@ indentation = "    "
 [actionwords]
 filename = 'actionwords.py'
 indentation = "    "
+naming_convention = 'underscore'

data/lib/templates/robotframework/output_config

@@ -6,3 +6,4 @@ indentation = "\t"
 [actionwords]
 filename = 'keywords.txt'
 indentation = "\t"
+naming_convention = 'underscore'

data/lib/templates/ruby/minitest/output_config

@@ -4,3 +4,4 @@ scenario_filename = '%s_test.rb'
 
 [actionwords]
 filename = 'actionwords.rb'
+naming_convention = 'underscore'

data/lib/templates/ruby/output_config

@@ -4,3 +4,4 @@ scenario_filename = '%s_spec.rb'
 
 [actionwords]
 filename = 'actionwords.rb'
+naming_convention = 'underscore'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hiptest-publisher
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.0
 platform: ruby
 authors:
 - Hiptest R&D
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-03 00:00:00.000000000 Z
+date: 2015-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -253,6 +253,8 @@ files:
 - lib/hiptest-publisher/parent_adder.rb
 - lib/hiptest-publisher/render_context_maker.rb
 - lib/hiptest-publisher/renderer.rb
+- lib/hiptest-publisher/signature_differ.rb
+- lib/hiptest-publisher/signature_exporter.rb
 - lib/hiptest-publisher/string.rb
 - lib/hiptest-publisher/utils.rb
 - lib/hiptest-publisher/xml_parser.rb