uicov 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5c6a7f053f39807b5f5ab5da31b18117ce0c718
+  data.tar.gz: 9fce20843493441f4d8aad9f06899fdbf1879f3f
+SHA512:
+  metadata.gz: 255f4841e978db2715df5d7f563562abeee17ee5dcab15e54498264b4016f270419b2af657b395dd257c4cad153703a1bc1283cfb708aa6f2cd5eab734d4c21e
+  data.tar.gz: efede2b63b4a16cde4182e790ef43b547337501c14a467a35bb2b9033fdc4f0e10510df8095e9a609c433fd577ec7070a66fee3ec072a42f33e7967ed063742b

data/.gitignore

@@ -0,0 +1,6 @@
+log*.txt
+*.log
+log*.puml
+*~
+*.swp
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in uicov.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    uicov (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  rake (~> 10.0)
+  uicov!
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Alexey Lyanguzov
+
+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,42 @@
+# Uicov
+UICov is a tool to calculate coverage of automated tests made with Selenium WebDriver, Calabash, Appium or other tools.
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/uicov`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'uicov'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install uicov
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/uicov.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "uicov"
+
+# 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/setup

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

data/bin/uicov

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'uicov'
+
+UICov::Main.do_command ARGV
+

data/lib/uicov.rb

@@ -0,0 +1,33 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+require 'logger'
+require 'pp'
+require 'yaml'
+
+module UICov
+  GEM_HOME = File.expand_path("#{File.dirname(__FILE__)}/..")
+  $LOAD_PATH.unshift GEM_HOME
+  require 'lib/uicov/consts'
+
+  def self.gather_coverage(opts={})
+    UICoverage.new.gather_coverage(opts)
+  end
+
+end
+###########################
+# E N T R Y   P O I N T
+############################
+if __FILE__ == $0
+  opts = {
+      :log => 'logPM.txt',
+      :model => "#{UICov::GEM_TESTS_DATA_DIR}/model1.puml",
+      :current_screen => /\s+<==\s+([^ ]+)\s+is set as current screen/,
+      :transition => /Transition '([^ ]+)'.*from '([^ ]+)'.*to '([^ ]+)'/
+  }
+  cov = UICov.gather_coverage(opts)
+  cov.to_puml('log.puml')
+  pp cov
+end
+

data/lib/uicov/commands/command.rb

@@ -0,0 +1,23 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  class Command
+    COMMAND_PREFIX = "#{$0} #{ARGV[0]}"
+    def do_job(args)
+      Log.fatal "Method #{__method__} is not overridden in class #{self.class.name}"
+    end
+
+    def usage(err_msg='', cmd_usage_info='')
+      msg = %Q^
+        \rERROR: #{err_msg}\n
+        \rUsage:
+        \r\t#{COMMAND_PREFIX} #{cmd_usage_info} 
+      ^
+
+      Log.fatal msg
+    end
+  end
+end
+

data/lib/uicov/commands/gather.rb

@@ -0,0 +1,171 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+$default_screen = :DefaultScreen
+
+module UICov
+  class LogPatterns
+    class << self
+      attr_accessor :current_screen, :transition, :action, :check, :element
+
+      alias :set_current_screen :current_screen=
+      alias :set_transition :transition=
+      alias :set_action :action=
+      alias :set_check :check=
+      alias :set_element :element=
+    end
+  end
+
+  LogPatterns.current_screen = /Set ([^ ]+) as current screen/
+  LogPatterns.transition = /Transition ([^ ]+) from ([^ ]+) to ([^ ]+)/
+  LogPatterns.action = /Action '([^ ]+)' is done on screen ([^ ]+)/
+  LogPatterns.check = /Check '([^ ]+)' is done on screen ([^ ]+)/
+  LogPatterns.element = /(?:Click on| Type text .* in) '([^ ]+)' element/
+
+  class Gather < Command
+    DEFAULT_FILENAME = 'coverage.uic'
+    OPTIONS = {
+      '--coverage-file=FILE' => "File to store coverage info [default is '#{DEFAULT_FILENAME}']",
+      '--pattern-file=FILE' => 'Path to pattern file to override default patterns',
+      # '--no-transitions' => 'Do not gather transitions coverage',
+      # '--no-actions    ' => 'Do not gather actions coverage',
+      # '--no-checks     ' => 'Do not gather checks coverage',
+      # '--no-elements   ' => 'Do not gather elements coverage'
+    }
+    USAGE_INFO = %Q^[options] file1.log [file2.log ... fileN.log]
+      \n\rWhere options are:
+      #{OPTIONS.inject([]){|a, e| a << "\r\t#{e[0]}\t- #{e[1]}"; a}.join("\n")}
+    ^
+
+    def initialize
+      @coverage_file = DEFAULT_FILENAME
+    end
+
+    def do_job(args)
+      usage 'Missed log file', USAGE_INFO if args.empty?
+      @cd = CovData.new
+      log_files = process_args args
+      parse_logs log_files
+      @cd.set_processing_date
+      @cd.type = CoverageDataType::COVERAGE
+      @cd.save(@coverage_file)
+    end
+
+    private
+    def process_args(args)
+      coverage_file_option = args.grep(/--coverage-file=.*/)[0]
+      if coverage_file_option
+        @coverage_file = File.expand_path coverage_file_option.gsub(/.*=(.+)/, '\1')
+        args.delete_if { |e| e == coverage_file_option }
+      end
+      pattern_file_option = args.grep(/--pattern-file=.*/)[0]
+      if pattern_file_option
+        @pattern_file = File.expand_path pattern_file_option.gsub(/.*=(.+)/, '\1')
+        Log.fatal "File #{@pattern_file} does not exist" unless File.exist? @pattern_file
+        load @pattern_file
+        args.delete_if { |e| e == pattern_file_option }
+      end
+      return args
+    end
+
+    def parse_logs(log_files)
+      Log.debug "Will parse log files #{log_files}"
+      log_files.each { |lf| parse lf }
+    end
+
+    def parse(log)
+      log_file = File.expand_path log
+
+      LogPatterns.instance_variables.each { |e| Log.debug "#{e}=#{LogPatterns.instance_variable_get e}" }
+
+      File.open(log_file) do |f|
+        begin
+          current_screen = $default_screen
+          expected_current_screen = nil
+          last_transition = nil
+          cur_screen_data = nil
+          while (line = f.readline.chomp)
+            case line
+              when LogPatterns.current_screen
+                name = $~[1] # $~ - is MatchData of the latest regexp match
+                current_screen = name
+                cur_screen_data = @cd.add_covered_screen name
+
+              when LogPatterns.transition
+                name, from, to = $~[1..3]
+                unless current_screen == from
+                  Log.error %Q^
+                    Transition #{name} is done from screen #{from} but current screen is #{current_screen}
+                    Found in log #{log_file} at line #{f.lineno}
+                  ^
+                end
+                if cur_screen_data.nil?
+                  Log.error %Q^
+                    Wrong model: Transition #{name} is done from unknown screen.
+                    Found in log #{log_file} at line #{f.lineno}
+                            ^
+                else
+                  expected_current_screen = to
+                  last_transition = name
+                  cur_screen_data.add_covered_transition name, to
+                end
+
+              when LogPatterns.action
+                name, screen = $~[1..2]
+                unless current_screen == screen
+                  Log.error %Q^
+                    Action #{name} is done on screen #{screen} but current screen is #{current_screen}
+                    Found in log #{log_file} at line #{f.lineno}
+                  ^
+                end
+                if cur_screen_data.nil?
+                  Log.error %Q^
+                    Wrong model: Action #{name} is done on unknown screen.
+                    Found in log #{log_file} at line #{f.lineno}
+                            ^
+                else
+                  cur_screen_data.add_covered_action name
+                end
+
+              when LogPatterns.check
+                name, screen = $~[1..2]
+                unless current_screen == screen
+                  Log.error %Q^
+                    Check #{name} is done on screen #{screen} but current screen is #{current_screen}
+                    Found in log #{log_file} at line #{f.lineno}
+                  ^
+                end
+                if cur_screen_data.nil?
+                  Log.error %Q^
+                    Wrong model: Action #{name} is done on unknown screen.
+                    Found in log #{log_file} at line #{f.lineno}
+                            ^
+                else
+                  cur_screen_data.add_covered_check name
+                end
+
+              when LogPatterns.element
+                name = $~[1]
+                if cur_screen_data.nil?
+                  Log.error %Q^
+                    Wrong model: Action #{name} is done on unknown screen.
+                    Found in log #{log_file} at line #{f.lineno}
+                            ^
+                else
+                  cur_screen_data.add_covered_element name
+                end
+
+              else
+                # Log.debug "No match: '#{line}'"
+            end
+          end
+        rescue EOFError => err
+          # it's ok
+        end
+      end
+      @cd.add_input_file log_file, File.mtime(log_file).strftime('%F %R:%S.%3N')
+    end
+  end
+end
+

data/lib/uicov/commands/gentpl.rb

@@ -0,0 +1,129 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  class ModelPatterns
+    class << self
+      attr_accessor :current_screen_start, :current_screen_end, :transition, :action, :check, :element
+    end
+  end
+
+  ModelPatterns.current_screen_start = /\s*class\s+([^ ]+)\{\s*/
+  ModelPatterns.current_screen_end = /\s*}\s*/
+  ModelPatterns.transition = /\s*Transition\s+([^ ]+)\s*\((\s*[^ ]+\s*)\)\s*/
+  ModelPatterns.action = /\s*Action\s+([^ ]+)\s*/
+  ModelPatterns.check = /\s*Check\s+([^ ]+)\s*/
+  ModelPatterns.element = /\s*Element\s+([^ ]+)\s*/
+
+  class Gentpl < Command
+    DEFAULT_FILENAME = 'template.uic'
+    OPTIONS = {
+      '--template-file=FILE' => "File to store coverage template [default is '#{DEFAULT_FILENAME}']",
+      # '--puml=DIR      ' => 'Folder where Plant UML model files are',
+      # '--no-transitions' => 'Do not include transitions templates',
+      # '--no-actions    ' => 'Do not include actions templates',
+      # '--no-checks     ' => 'Do not include checks templates',
+      # '--no-elements   ' => 'Do not include elements templates'
+    }
+    USAGE_INFO = %Q^[options] model-file1.puml [model-file2.puml ... model-fileN.puml]
+      \n\rWhere options are:
+      #{OPTIONS.inject([]){|a, e| a << "\r\t#{e[0]}\t- #{e[1]}"; a}.join("\n")}
+    ^
+    #   or
+    #   \r\t#{COMMAND_PREFIX} [options] --puml=DIR
+
+    def initialize
+      @template_file = DEFAULT_FILENAME
+    end
+
+    def do_job(args)
+      @cd = CovData.new
+      model_files = process_args args
+      usage 'Missed model file', USAGE_INFO if model_files.empty?
+      parse_models model_files
+      @cd.set_processing_date
+      @cd.type = CoverageDataType::TEMPLATE
+      @cd.save(@template_file)
+    end
+
+    private
+
+    def process_args(args)
+      template_file_option = args.grep(/--template-file=.*/)[0]
+      if template_file_option
+        @template_file = File.expand_path template_file_option.gsub(/.*=(.+)/, '\1')
+        args.delete_if { |e| e == template_file_option }
+      end
+      return args
+    end
+
+    def parse_models(model_files)
+      Log.debug "Will parse model files #{model_files}"
+      model_files.each { |lf| parse lf }
+    end
+
+    def parse(model)
+      model_file = File.expand_path model
+      File.open(model_file) do |f|
+        begin
+          current_screen = $default_screen
+          curr_screen_data = nil
+          while (line = f.readline.chomp)
+            case line
+              when ModelPatterns.current_screen_start
+                name = $~[1] # $~ - is MatchData of the latest regexp match
+                current_screen = name
+                cur_screen_data = @cd.add_screen name
+
+              when ModelPatterns.current_screen_end
+                current_screen = nil
+
+              when ModelPatterns.transition
+                name, to = $~[1..2]
+                if current_screen.nil?
+                  Log.error %Q^
+                    Wrong model: Transition #{name} is done from unknown screen.
+                    Found in model #{model_file} at line #{f.lineno}
+                            ^
+                end
+                cur_screen_data.add_transition name, to
+
+              when ModelPatterns.action
+                name = $~[1]
+                if current_screen.nil?
+                  Log.error %Q^
+                    Wrong model: Action #{name} is done on unknown screen.
+                    Found in model #{model_file} at line #{f.lineno}
+                            ^
+                end
+                cur_screen_data.add_action name
+
+              when ModelPatterns.check
+                name = $~[1]
+                if current_screen.nil?
+                  Log.error %Q^
+                    Wrong model: Action #{name} is done on unknown screen.
+                    Found in model #{model_file} at line #{f.lineno}
+                            ^
+                end
+                cur_screen_data.add_check name
+
+              when ModelPatterns.element
+                name = $~[1]
+                cur_screen_data.add_element name
+
+              else
+                #d line
+            end
+          end
+        rescue EOFError => err
+          # it's ok
+        end
+      end
+      @cd.add_input_file model_file, File.mtime(model_file).strftime('%F %R:%S.%3N')
+    end
+
+  end
+end
+