uicov 0.0.1

data/lib/uicov/coverage/transition_data.rb

@@ -0,0 +1,18 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  class TransitionData < MemberData
+    def self.get_key(transition_name, to)
+      "#{transition_name}(#{to})"
+    end
+
+    def initialize(transition_name, to)
+      @name = transition_name
+      @to = to
+      @display_name = self.class.get_key @name, @to
+      @hits = 0
+    end
+  end
+end

data/lib/uicov/coverage/types.rb

@@ -0,0 +1,13 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  class CoverageDataType
+    COVERAGE = :COVERAGE  # Gathered coverage
+    TEMPLATE = :TEMPLATE  # Coverage template
+    FULL = :FULL          # Merged template and coverage data
+    UNKNOWN = :UNKNOWN    # Unknown (set by default)
+  end
+end
+

data/lib/uicov/coverage_data.rb

@@ -0,0 +1,72 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  class CoverageData
+    def screens
+      @screens ||= {}
+    end
+
+    def transitions
+      @transitions ||= {}
+    end
+
+    def str_puml(msg=nil, nl=1)
+      @str_puml ||= ""
+      unless msg.nil?
+        @str_puml << "#{msg}" + "\n" * nl
+      end
+      return @str_puml
+    end
+
+    def add_screen(name)
+      screens[name.to_sym] = ScreenInfo.new
+    end
+
+    def hit_screen(name)
+      name = name.to_sym
+      info = screens.fetch(name, ScreenInfo.new(true))
+      screens[name] = info.hit
+    end
+
+    def add_transition(from, to, name)
+      transitions[TransitionInfo.key(from, to, name)] = TransitionInfo.new
+    end
+
+    def hit_transition(from, to, name)
+      key = TransitionInfo.key(from, to, name)
+      info = transitions.fetch(key, TransitionInfo.new(true))
+      transitions[key] = info.hit
+    end
+
+    def to_puml(file_name=nil)
+      str_puml '@startuml'
+      str_puml SKIN_PARAMS, 0
+      str_puml LEGEND if Opts::Puml[:add_legend]
+
+      screens.each_pair do |screen_name, screen_info|
+        stereotype = ''
+        stereotype = "<<#{Opts::Puml[:covered_class_stereotype]}>>" if screen_info.covered?
+        stereotype = "<<#{Opts::Puml[:missed_class_stereotype]}>>" if screen_info.missed?
+        str_puml "state #{screen_name}#{stereotype}"
+        mm = transitions.map{|pair| pair if pair[0][0] == screen_name}.compact.each do |transition, transition_info|
+          #str_puml transition
+          str_puml "#{transition[0]} --> #{transition[1]} : #{transition[2]}"
+          #str_puml "#{transition}"
+        end
+
+        str_puml ''
+      end
+
+      str_puml '@enduml'
+
+      if file_name.nil?
+        return str_puml
+      else
+        Log.unknown "Storing results in file #{File.expand_path(file_name)}"
+        File.open(file_name, 'w') {|f| f.write str_puml}
+      end
+    end
+  end
+end

data/lib/uicov/coverage_info.rb

@@ -0,0 +1,27 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  class CoverageInfo
+    attr_reader :hits
+
+    def initialize(missed = false)
+      @hits = 0
+      @missed = missed
+    end
+
+    def missed?
+      @missed
+    end
+
+    def covered?
+      0 < hits
+    end
+
+    def hit
+      @hits = hits.succ
+      return self
+    end
+  end
+end

data/lib/uicov/main.rb

@@ -0,0 +1,53 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  def self.patterns_override(target, &blk)
+    case target
+      when :log
+        LogPatterns.class_exec &blk
+      else
+        Log.fatal "Unknown target '#{target}' in pattern file '#{caller[0]}'"
+    end
+  end
+
+  class Main
+    COMMANDS = {
+      gentpl: 'Generate coverage template file',
+      gather: 'Gather coverage information from log file',
+      report: 'Generate coverage report',
+      merge: 'Merge coverage files',
+    }
+
+    COMMANDS.keys.each { |k| require_relative "commands/#{k}" }
+
+    def self.do_command(args)
+      if args.empty?
+        usage "Command is not specified"
+      else
+        cmd_name = args[0]
+        usage "Wrong command '#{cmd_name}'" unless COMMANDS.keys.include? cmd_name.to_sym
+        class_type = UICov.const_get cmd_name.capitalize
+        class_type.new.do_job args[1..-1]
+      end
+    end
+
+    def self.usage(err_msg)
+      msg = %Q^
+        \rERROR: #{err_msg}\n
+        \rUsage:
+        \r\t#{$0} command [command_arguments]\n
+        \rCommands are:
+        #{COMMANDS.inject([]){|a, e| a << "\r\t#{e[0]}\t- #{e[1]}"; a}.join("\n")}
+        
+        \rTo see command usage run:
+        \r\t#{$0} command\n
+        \rFor instance:
+        \r\t#{$0} gather\n
+      ^
+      Log.fatal msg
+    end
+  end
+end
+

data/lib/uicov/opts.rb

@@ -0,0 +1,28 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  class Opts
+    Patterns = {
+        :current_screen => nil,
+        :transition => nil,
+        :transition_from => 2,
+        :transition_to => 3,
+        :transition_name => 1,
+        :model_screen => /^state\s+([^ ]+)$/,
+        :model_transition => /^([^ ]+)\s+([-]+\>)\s+([^ ]+)\s+:\s+([^ ]+)$/,
+    }
+
+    Files = {
+        :log => nil,
+        :model => nil,
+    }
+
+    Puml = {
+        :add_legend => true,
+        :missed_class_stereotype => 'Missed',
+        :covered_class_stereotype => 'Covered',
+    }
+  end
+end

data/lib/uicov/ruby_patches.rb

@@ -0,0 +1,36 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+class Logger
+  class Formatter
+    MyFormat = "[%s] %s: %s: %s\n"
+    def call(severity, time, progname, msg)
+      @datetime_format ||= "%H:%M:%S.%5N"
+      MyFormat % [format_datetime(time), severity, progname, msg2str(msg)]
+    end
+  end
+
+  alias :_add :add
+  alias :_fatal :fatal
+  
+  def add(severity, message, progname, &blk)
+    progname_orig = self.progname
+    self.progname = get_caller
+    _add(severity, message, progname, &blk)
+    self.progname = progname_orig
+  end
+
+  def fatal(*args, &blk)
+    _fatal(*args, &blk)
+    exit 1
+  end
+
+  private
+  def get_caller(idx=2)
+    caller[idx].sub(/.*\//, '')
+  end
+
+  def add_count(severity) ; end # TODO count warnings and errors
+end
+

data/lib/uicov/screen_info.rb

@@ -0,0 +1,7 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  ScreenInfo = Class.new(CoverageInfo)
+end

data/lib/uicov/transition_info.rb

@@ -0,0 +1,11 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  class TransitionInfo < CoverageInfo
+    def self.key(from, to, name)
+      [from.to_sym, to.to_sym, name.to_sym]
+    end
+  end
+end

data/lib/uicov/ui_coverage.rb

@@ -0,0 +1,91 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  class UICoverage
+    def cov_data
+      @cd ||= CoverageData.new
+    end
+
+    def init(opts={})
+#      if PATTERN_FILE.nil? or !File.exists?(PATTERN_FILE)
+#        usage "Patterns file is not provided or it's absent by path: '#{PATTERN_FILE}'"
+#      end
+      input_log = (Opts::Files[:log] = opts[:log])
+      if input_log.nil? or !File.exists?(input_log)
+        UICov.usage "Input log file is not provided or it's absent by path: '#{input_log}'"
+      end
+
+      model_file = (Opts::Files[:model] = opts[:model])
+      if model_file.nil? or !File.exists?(model_file)
+        Log.warn "\n\n\tModel file is not provided or it's absent by path: '#{model_file}'" +
+                     "\n\tYou won't be able to see uncovered metrics as well as all hits will be" +
+                     "reported not as 'covered' but as 'missed in model'\n"
+      end
+
+      Opts::Patterns.keys.each {|key| Opts::Patterns[key] = opts[key] unless opts[key].nil?}
+
+      #d "Using pattern file: #{PATTERN_FILE}"
+      #d "Unsing model file: #{MODEL_FILE}"
+      Log.debug "Parsing log file: #{Opts::Files[:log]}"
+      return self
+    end
+
+    def parse_model
+      model_file = Opts::Files[:model]
+      return if model_file.nil?
+
+      Log.debug "Loading model file: #{model_file}"
+
+      File.open(model_file).each do |line|
+        case line.chomp
+          when /^['@]/ # Do nothing
+          when /^\s*$/ # Do nothing
+          when Opts::Patterns[:model_screen]
+            name = $~[1] # $~ - is MatchData of the latest regexp match
+            cov_data.add_screen name
+          when Opts::Patterns[:model_transition]
+            from, to, name = $~[1], $~[3], $~[4]
+            cov_data.add_transition from, to, name
+            cov_data.add_screen from
+            cov_data.add_screen to
+          else
+            Log.warn "Unable to parse model line: #{line}"
+        end
+      end
+
+#    %w[HomeScreen CheckoutScreen OneMoreScreen].each do |name|
+#      cov_data.add_screen name
+#    end
+#    [%w[HomeScreen CheckoutScreen checkout], %w[CheckoutScreen OneMoreScreen one_more],
+#     %w[OneMoreScreen CheckoutScreen checkout], %w[HomeScreen OneMoreScreen more]].each do |from, to, name|
+#      cov_data.add_transition from, to, name
+#    end
+      return self
+    end
+
+    def parse_log
+      transition_indexes = %w[from to name].map{|e| Opts::Patterns["transition_#{e}".to_sym]}
+      File.open(Opts::Files[:log]).each do |line|
+        case line
+          when Opts::Patterns[:current_screen]
+            name = $~[1] # $~ - is MatchData of the latest regexp match
+            cov_data.hit_screen name
+          when Opts::Patterns[:transition]
+            from, to, name = transition_indexes.map{|i| $~[i]}
+            cov_data.hit_transition from, to, name
+          else
+            #d line
+        end
+      end
+    end
+
+    def gather_coverage(opts={})
+      init opts
+      parse_model
+      parse_log
+      return cov_data
+    end
+  end # of UICoverage class
+end

data/lib/uicov/version.rb

@@ -0,0 +1,7 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module Uicov
+  VERSION = "0.0.1"
+end

data/rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/test*.rb']
+end
+

data/uicov.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uicov/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'uicov'
+  spec.version       = Uicov::VERSION
+  spec.authors       = ['Alexey Lyanguzov']
+  spec.email         = ['budabum@gmail.com']
+
+  spec.summary       = %q{Tool to measure UI autotests coverage.}
+  spec.description   = %q{Tool is applicable for any autotest's language becuase it parses log files.}
+  spec.homepage      = 'https://github.com/budabum/uicov'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = 'http://RubyGems.org'
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: uicov
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexey Lyanguzov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Tool is applicable for any autotest's language becuase it parses log
+  files.
+email:
+- budabum@gmail.com
+executables:
+- console
+- setup
+- uicov
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- bin/console
+- bin/setup
+- bin/uicov
+- lib/uicov.rb
+- lib/uicov/commands/command.rb
+- lib/uicov/commands/gather.rb
+- lib/uicov/commands/gentpl.rb
+- lib/uicov/commands/merge.rb
+- lib/uicov/commands/report.rb
+- lib/uicov/consts.rb
+- lib/uicov/coverage/action_data.rb
+- lib/uicov/coverage/check_data.rb
+- lib/uicov/coverage/data.rb
+- lib/uicov/coverage/element_data.rb
+- lib/uicov/coverage/member_data.rb
+- lib/uicov/coverage/screen_data.rb
+- lib/uicov/coverage/transition_data.rb
+- lib/uicov/coverage/types.rb
+- lib/uicov/coverage_data.rb
+- lib/uicov/coverage_info.rb
+- lib/uicov/main.rb
+- lib/uicov/opts.rb
+- lib/uicov/ruby_patches.rb
+- lib/uicov/screen_info.rb
+- lib/uicov/transition_info.rb
+- lib/uicov/ui_coverage.rb
+- lib/uicov/version.rb
+- rakefile
+- uicov.gemspec
+homepage: https://github.com/budabum/uicov
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Tool to measure UI autotests coverage.
+test_files: []