puppet7 0.2.0.beta1

data/lib/puppet7/puppet_report.rb

@@ -0,0 +1,292 @@
+# coding: utf-8
+require "erb"
+require "puppet7/common"
+
+module Puppet7
+  def self.report
+    @report ||= Puppet7::PuppetReport.new
+  end
+  
+  class PuppetReport
+    include ERB::Util
+    
+    def initialize
+      @top_level = []
+      @current_example_group = nil
+      @cur_depth = 0
+      @max_depth = 0
+
+      @image_errors = {}
+      @js_errors = {}
+      @undefined_object = {}
+
+      # summary
+      @example_summary = {total: 0, passed: 0, failed: 0, pending: 0}
+      @test_summary = {total: 0, passed: 0, failed: 0, not_tested: 0, partial_passed: 0, automation_rate: 0, pass_rate: 0}
+      
+      # for print
+      @example_group_stack = []
+    end
+
+    
+    def write_report output
+      make_summary
+      output.write apply_template :puppet_report, binding
+    end
+
+    def start_example_group example_group
+      @cur_depth += 1
+
+      siblings = []
+      if @current_example_group
+        siblings.concat @current_example_group.example_groups.select{|exg| exg.description == example_group.description}
+      else
+        siblings.concat @top_level.select{|exg| exg.description == example_group.description}
+      end
+      
+      if siblings.empty?
+        ex_group = ExampleGroup.new(example_group, @current_example_group, @cur_depth)
+        @top_level << ex_group unless @current_example_group
+      else
+        ex_group = siblings.first
+      end
+      @current_example_group = ex_group
+      @max_depth = [@max_depth, @cur_depth].max
+    end
+
+    def end_example_group example_group
+      unless example_group.description == @current_example_group.description
+        raise "Nested Example Groups are something wrong!"
+      end
+      @current_example_group = @current_example_group.parent_group
+      @cur_depth -= 1
+    end
+
+    def add_example example
+      Example.new(example, @current_example_group)
+    end
+
+    def add_image_errors page_url, image_urls
+      @image_errors[page_url.to_sym] ||= []
+      @image_errors[page_url.to_sym].concat(image_urls)
+      @image_errors[page_url.to_sym].uniq!
+    end
+
+    def add_js_errors page_url, js_errors
+      js_errors.select! {|err| err[:url] and err[:line]}
+      return if js_errors.empty?
+      @js_errors[page_url.to_sym] ||= []
+      @js_errors[page_url.to_sym].concat(js_errors)
+      @js_errors[page_url.to_sym].uniq!
+    end
+
+    def add_undefined_object type, name
+      @undefined_object[type.to_sym] ||= []
+      @undefined_object[type.to_sym] << name
+      @undefined_object[type.to_sym].uniq!
+    end
+
+    private
+    def make_summary
+      leaf_ex_groups = @top_level.collect{|exg| exg.get_leaf_example_groups}.flatten
+      leaf_ex_groups.each do |exg|
+        @test_summary[:total] += 1
+        @test_summary[exg.status] +=1
+      end
+      
+      @test_summary[:automation_rate] =
+        (@test_summary[:total]-@test_summary[:not_tested]) * 100 / @test_summary[:total] if @test_summary[:total] > 0
+      @test_summary[:pass_rate] =
+        (@test_summary[:passed]) * 100 / (@test_summary[:total]-@test_summary[:not_tested]) if (@test_summary[:total]-@test_summary[:not_tested]) > 0
+      
+      @top_level.collect{|exg| exg.all_examples}.flatten.each do |ex|
+        @example_summary[:total] += 1
+        @example_summary[ex.status] += 1
+      end
+    end
+    
+    def example_group_result example_group
+      begin
+        @example_group_stack << example_group
+        apply_template :_example_group, binding
+      ensure
+        @example_group_stack.pop
+      end
+    end
+
+    def example_results
+      apply_template :_examples, binding
+    end
+
+    def apply_template template_name, _binding
+      template = ERB.new(read_template template_name)
+      template.result(_binding)
+    end
+
+    def read_template name
+      template_file = File.join(File.dirname(__FILE__), "report", "#{name}.erb")
+      if File.exist?(template_file)
+        File.read(template_file)
+      else
+        raise "Can't find the report template file : #{template_file}"
+      end
+    end
+  end
+
+  class ExampleGroup
+    attr_reader :description, :example_groups, :examples, :parent_group, :depth, :status, :no
+    @@no = 0
+    def self.no
+      @@no
+    end
+    def initialize example_group, parent_group, depth
+      @description = example_group.description
+      @example_groups = []
+      @examples = []
+      @parent_group = parent_group
+      @parent_group.example_groups << self if @parent_group
+      @depth = depth
+      @no = @@no += 1
+    end
+
+    def has_examples?
+      not @examples.empty?
+    end
+
+    def has_example_groups?
+      not @example_groups.empty?
+    end
+
+    def all_examples
+      examples = []
+      if has_example_groups?
+        @example_groups.each do |exg|
+          examples.concat exg.all_examples
+        end
+      else
+        examples.concat @examples
+      end
+      examples
+    end
+
+    def first?
+      if @parent_group
+        @parent_group.example_groups.first == self
+      else
+        true
+      end
+    end
+
+    def row_count
+      cnt = 0
+      @example_groups.each do |exg|
+        cnt += exg.row_count
+      end
+      [cnt, 1].max
+    end
+
+    def get_leaf_example_groups
+      if has_example_groups?
+        rv = []
+        @example_groups.each {|exg| rv.concat(exg.get_leaf_example_groups)}
+        rv
+      else
+        [self]
+      end
+    end
+    
+    def status
+      return @status if @status
+      if has_examples?
+        summary = {passed: 0, failed: 0, pending:0}
+        @examples.inject(summary) {|r, ex| summary[ex.status] += 1}
+        if summary[:passed] == @examples.length
+          @status = :passed
+        elsif summary[:failed]> 0
+          @status = :failed
+        elsif summary[:passed] > 0
+          @status = :partial_passed
+        else
+          @status = :not_tested
+        end
+      elsif has_example_groups?
+        summary = {passed: 0, failed: 0, not_tested:0, partial_passed:0}
+        @example_groups.inject(summary) {|r,exg| summary[exg.status] +=1 }
+        if summary[:passed] == @example_groups.length
+          @status = :passed
+        elsif summary[:failed] > 0
+          @status = :failed
+        elsif summary[:passed] + summary[:partial_passed] > 0
+          @status = :partial_passed
+        else
+          @status = :not_tested
+        end
+      else
+        @status = :not_tested
+      end
+      @status
+    end
+
+  end
+
+  class Example
+    attr_reader :description, :status, :pending_message, :parent_group, :no
+    @@no = 0
+    def self.no
+      @@no
+    end
+    
+    def initialize example, parent_group
+      @example = example
+      @description = example.description
+      @parent_group = parent_group
+      @parent_group.examples << self
+      @no = @@no += 1
+    end
+
+    def code_where
+      "in #{@example.metadata[:file_path]}:#{@example.metadata[:line_number]}"
+    end
+
+    def source_code
+      src_file = @example.metadata[:file_path]
+      line = @example.metadata[:line_number]
+      if File.file?(src_file)
+        lines = File.open(src_file).read.split("\n")
+        min = [0, line-1].max
+        unless lines[min].chomp.end_with?("do")
+          return "#{min+1}:#{lines[min]}"
+        end
+        indents = indent_cnt lines[min]
+        ln = min + 1
+        while indents != indent_cnt(lines[ln]) and ln < lines.length do
+          ln += 1
+        end
+        lines[min..ln].collect {|l| "#{min+=1}:" + l}.join("\n")
+      else
+        "# Couldn't get source code : #{src_file}"
+      end
+    end
+
+    def status
+      @example.metadata[:execution_result][:status].to_sym
+    end
+
+    def pending_message
+      @example.metadata[:execution_result][:pending_message]
+    end
+
+    def exception_message
+      @example.metadata[:execution_result][:exception]
+    end
+
+    private
+    def indent_cnt line
+      if line =~ /^(\s*)[^\s]/
+        $1.length
+      else
+        0
+      end
+    end
+  end
+end

data/lib/puppet7/report/_example_group.erb

@@ -0,0 +1,24 @@
+<%# coding: utf-8%>
+<% exgroup = @example_group_stack.last %>
+<%unless exgroup.first? and exgroup.depth != 1%>
+  <tr>
+  <%end%>
+  <% (@max_depth - exgroup.depth).times do %>
+    <td class="<%=exgroup.status%>_result"> &nbsp; </td>
+  <%end unless exgroup.has_example_groups?%>
+  <td rowspan="<%=exgroup.row_count%>" class="<%=exgroup.status%>_result">
+    <%=h(exgroup.description)%>
+  <% if exgroup.has_example_groups? %>
+    </td>
+    <%# print sub example group %>
+    <% exgroup.example_groups.each do |ex_group|%>
+      <%=example_group_result(ex_group)%>
+    <%end%>
+  <%else%>
+    <%# print examples%>
+    <%=example_results%>
+    </td>
+  <%end%>
+  <%unless exgroup.has_example_groups? and exgroup.depth != 1%>
+  </tr>
+<%end%>

data/lib/puppet7/report/_examples.erb

@@ -0,0 +1,22 @@
+<%# coding: utf-8%>
+<% exgroup = @example_group_stack.last %>
+<table class="examples_table">
+  <% exgroup.examples.each do |ex| %>
+    <tr>
+      <td class="<%=ex.status%>">
+        # <%=h(ex.description)%>
+        <%if ex.status == :pending %>
+          (PENDING: <%=h ex.pending_message%>)
+        <%end%>
+        <span class="view_script_btn" id="viewbutton<%=ex.no%>"></span>
+        <div class="test_script" id="testscript<%=ex.no%>" style="display:<%= ex.status == :failed ? "":"none"%>">
+          <code class="code_where">
+            <%=h ex.code_where%>
+            <pre><%=h ex.exception_message%></pre>
+          </code>
+          <pre class="source_code"><%=h ex.source_code%></pre>
+        </div>
+      </td>
+    </tr>
+  <% end %>
+</table>

data/lib/puppet7/report/puppet_report.erb

@@ -0,0 +1,187 @@
+<%# codnig: utf-8%>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html
+  PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <title>Checklist & Test Result</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta http-equiv="Expires" content="-1" />
+    <meta http-equiv="Pragma" content="no-cache" />
+    <style type="text/css">
+      * {margin:0;padding:0;font-size:9pt;}
+      h1 {font-size: 2em; font-weight:bold; font-family:serif}
+      h2 {font-size: 1.5em; font-weight:bold; font-family:serif; color: red}
+      #header {margin: 1em;}
+      #content {margin: 1em;}
+      #control {}
+      #test_result {}
+      #footer {margin: 1em;text-align: right}
+      #summary {margin: 0.5em 1em;}
+
+      .cont {color:#0033FF}
+
+      .question {color: #FF3300; font-style:italic;font-weight: bold;}
+      .confirm {color: #0033FF; font-style:italic;font-weight: bold;}
+      .show_tc {color: #888; font-style:italic;}
+
+      .pending {background-color: #FFFF99; color:black;font-size: 0.9em;}
+      .passed {background-color: #ddFFaa; color:black;font-size: 0.9em;}
+      .failed {background-color: #FFaa99; color:black;font-size: 0.9em;}
+
+      .summary {font-weight: bold; color:black; padding: 2px;line-height: 1.5em;}
+
+      .passed_result {background-color: #ddFFaa; }
+      .failed_result {background-color: #FFaa99; }
+      .partial_passed_result {background-color: #FFFFDD; }
+      .not_tested_result {background-color: #EDEDED; }
+
+      .passed_text {color: #33aa33; }
+      .failed_text {color: #FF3300; }
+      .pending_text {color: #444444;}
+
+      .view_script_btn {color: #337; font-style: italic; cursor: pointer}
+      .code_where {display: block;background-color:#ace;color:#337; padding: 3px;margin-top:3px;}
+      .source_code {background-color:black;color:#aaa;padding: 3px;margin-bottom:-4px;}
+
+      table {width:100%; border-collapse:collapse;cellspacing:0; cellpadding:0;padding:0;margin:0;}
+      th {border:1px solid gray; padding: 3px 1em; font-weight:bold; background-color:#AAA}
+      td {border:1px solid gray; padding: 3px 1em;}
+
+      td.exgrp_title {padding: 3px 1.5em;  border-bottom:0;}
+      td.exgrp_detail {border-top:0;width: 10px;text-align:center; font-size:0.9em;}
+      td.exgrp_child {width: 10px; border:0;}
+      td.ex_result {padding:3px; }
+      td.ex_desc {padding: 3px 10px;background-color: #FDFDFD}
+
+      table.examples_table {
+        margin: 3px 0 -4px 0;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="header">
+      <h1>Checklist &amp; Test Result</h1>
+    </div>
+    <div id="content">
+      <div id="control"></div>
+      <div id="test_result">
+        <div id="summary">
+          <span class="summary">Automation rate: <%=@test_summary[:automation_rate]%> %</span>
+          <span class="summary">Pass rate: <%=@test_summary[:pass_rate]%> %</span>
+          <br/>
+          <span class="summary">Checklist Total: <%=@test_summary[:total]%> </span> (
+          <span class="summary passed_result"> Passed:<%=@test_summary[:passed]%> </span>
+          <span class="summary failed_result"> Failed:<%=@test_summary[:failed]%> </span>
+          <span class="summary partial_passed_result"> Partial passed:<%=@test_summary[:partial_passed]%> </span>
+          <span class="summary not_tested_result"> Not Tested:<%=@test_summary[:not_tested]%> </span> )
+          <br/>
+          <span class="summary">Example Total: <%=@example_summary[:total]%> </span> (
+          <span class="summary passed"> Passed:<%=@example_summary[:passed]%> </span>
+          <span class="summary failed"> Failed:<%=@example_summary[:failed]%> </span>
+          <span class="summary pending"> Pending:<%=@example_summary[:pending]%> </span>)
+        </div>
+        <table>
+          <tr><!--# Table Header -->
+            <%@max_depth.times do |i| %><th>LEVEL<%=i%></th><%end%>
+          </tr>
+          <%@top_level.each do |ex_group|%>
+            <%=example_group_result(ex_group)%>
+          <%end%>
+        </table>
+      </div>
+      <div class="etc_errors">
+        <%unless @undefined_object.empty? %>
+          <h2> Undefined Page Objects </h2>
+          <table>
+            <tr>
+              <th>Type</th><th>Undefined object and property</th>
+            </tr>
+            <%@undefined_object.each do |type, names|%>
+              <tr>
+                <td><%=h type%></td>
+                <td><%=h names.join("<br/>")%></td>
+              </tr>
+            <%end%>
+          </table>
+        <%end%>
+      </div>
+      <div class="etc_errors">
+        <%unless @image_errors.empty? %>
+          <h2> Loading Image Errors </h2>
+          <table>
+            <tr>
+              <th>Page URL</th><th>Image URLs</th>
+            </tr>
+            <%@image_errors.each do |page, images|%>
+              <tr>
+                <td><%=h page%></td>
+                <td><%=h images.join("<br/>")%></td>
+              </tr>
+            <%end%>
+          </table>
+        <%end%>
+      </div>
+      <div class="etc_errors">
+        <%unless @js_errors.empty? %>
+          <h2> Javascript Errors </h2>
+          <table>
+            <tr>
+              <th>Page URL</th><th>Error message</th>
+            </tr>
+            <%@js_errors.each do |page, errors|%>
+              <tr>
+                <td><%=h page%></td>
+                <td><%=errors.collect{|e| h "#{e['msg']} : file:#{e['url']}(#{e['line']})"}.join("<br/>")%></td>
+              </tr>
+            <%end%>
+          </table>
+        <%end%>
+      </div>
+    </div>
+
+    <div id="footer">Powered by <strong>puppet7</strong>. made by yunsang.choi@nhn.com</div>
+
+    <script type="text/javascript">
+      var exg_cnt = <%=ExampleGroup.no%>;
+      var ex_cnt = <%=Example.no%>;
+      
+      for(var i=1; i <= ex_cnt; i++) {
+        var content = document.getElementById('testscript'+i);
+        if(content == null) continue ;
+        var btn = document.getElementById('viewbutton'+i);
+        if(content.style.display == "none") {
+          btn.innerHTML = "[show script]";
+          btn.onclick = get_show_script_func(i, true);
+        } else {
+          btn.innerHTML = "[hide script]";
+          btn.onclick = get_show_script_func(i, false);
+        }
+      }
+
+      function get_show_script_func(no, view) {
+        return function(){show_script(no, view);}
+      }
+
+      function show_script(no, view) {
+        if(no > ex_cnt) {alert(no);}
+        if(view == null) view = true;
+        
+        var content = document.getElementById('testscript'+no);
+        var btn = document.getElementById('viewbutton'+no);
+
+        if (view) {
+          content.style.display = "";
+          btn.innerHTML = "[hide script]";
+          btn.onclick = get_show_script_func(no, false);
+        } else {
+          content.style.display = "none";
+          btn.innerHTML = "[show script]";
+          btn.onclick = get_show_script_func(no, true);
+        }
+      }
+      
+    </script>
+  </body>
+</html>

data/lib/puppet7/selenium_actions.rb

@@ -0,0 +1,20 @@
+# coding: utf-8
+
+require "selenium/client"
+require "json"
+
+module Puppet7
+  module SeleniumActions
+    def get_stored_var name
+      JSON.parse get_eval("storedVars.#{name}.toJSONString();")
+    end
+
+    def set_stored_var name, value
+      get_eval("storedVars.#{name} = #{JSON.generate([value])}[0];")
+    end
+  end
+end
+
+class Selenium::Client::Driver
+  include Puppet7::SeleniumActions
+end