magicspec 0.0.1

data/lib/magicspec/generators/magicspec/config/override.rb

@@ -0,0 +1,351 @@
+require 'rspec'
+require 'rspec/core/formatters/base_text_formatter'
+require 'rspec/core/formatters/html_printer'
+require 'gmail'
+require 'sys/uname'
+include Sys
+
+#https://github.com/GICodeWarrior/threaded-rspec
+
+module RSpec
+  module Core
+    module Formatters
+      class HtmlPrinter
+        def print_html_start
+          @output.puts YALE_HTML_HEADER
+          @output.puts YALE_REPORT_HEADER
+        end
+
+        def print_summary( was_dry_run, duration, example_count, failure_count, pending_count )
+          # TODO - kill dry_run?
+          if was_dry_run
+            totals = "This was a dry-run"
+          else
+            totals =  "#{example_count} example#{'s' unless example_count == 1}, "
+            totals << "#{failure_count} failure#{'s' unless failure_count == 1}"
+            totals << ", #{pending_count} pending" if pending_count > 0
+          end
+
+          formatted_duration = sprintf("%.5f", duration)
+
+          @output.puts "<script type=\"text/javascript\">document.getElementById('duration').innerHTML = \"Finished in <strong>#{formatted_duration} seconds</strong>\";</script>"
+          @output.puts "<script type=\"text/javascript\">document.getElementById('totals').innerHTML = \"#{totals}\";</script>"
+          @output.puts "<script type=\"text/javascript\">document.getElementById('browser').innerHTML = \"#{Uname.sysname}\";</script>"
+          @output.puts "<script type=\"text/javascript\">localStorage.g=JSON.stringify([['Pass',#{example_count}],['Fail',#{failure_count}],['Pending',#{pending_count}]])</script>"
+          @output.puts "</div>"
+          @output.puts "</div>"
+          @output.puts "</body>"
+          @output.puts "</html>"
+
+          gmail = Gmail.new("yaleqa@gmail.com","")
+          gmail.deliver do
+            to "dan.franko@yale.edu"
+            subject "Test is complete!"
+            html_part do
+              content_type 'text/html; charset=UTF-8'
+              body "<p>Done!</p>"
+            end
+            #add_file "/path/to/some_image.jpg"
+          end
+        end
+
+        YALE_REPORT_HEADER = <<-EOF
+<div class="rspec-report container">
+<div id="rspec-header">
+  <div id="label">
+    <h1>Yale Automation Report</h1>
+  </div>
+
+  <div id="display-filters">
+    <input id="passed_checkbox"  name="passed_checkbox"  type="checkbox" checked="checked" onchange="apply_filters()" value="1" /> <label for="passed_checkbox">Passed</label>
+    <input id="failed_checkbox"  name="failed_checkbox"  type="checkbox" checked="checked" onchange="apply_filters()" value="2" /> <label for="failed_checkbox">Failed</label>
+    <input id="pending_checkbox" name="pending_checkbox" type="checkbox" checked="checked" onchange="apply_filters()" value="3" /> <label for="pending_checkbox">Pending</label>
+  </div>
+
+  <div id="summary">
+    <p id="totals">&#160;</p>
+    <p id="duration">&#160;</p>
+  </div>
+  <div id="chart">
+    <div id="container" style="min-width: 200px; height: 200px; margin: 0 auto"></div>
+    <script>
+    $(function () {
+    var chart;
+    
+    $(document).ready(function () {
+      
+      // Build the chart
+        $('#container').highcharts({
+            chart: {
+                plotBackgroundColor: null,
+                plotBorderWidth: null,
+                plotShadow: false
+            },
+            title: {
+                text: 'Test Results'
+            },
+            tooltip: {
+              pointFormat: '{series.name}: <b>{point.percentage:.1f}%</b>'
+            },
+            plotOptions: {
+                pie: {
+                    allowPointSelect: true,
+                    cursor: 'pointer',
+                    dataLabels: {
+                        enabled: false
+                    },
+                    showInLegend: true
+                }
+            },
+            series: [{
+                type: 'pie',
+                name: 'Browser share',
+                data: JSON.parse(localStorage.g)
+            }]
+        });
+    });
+    
+});
+</script>
+  </div>
+  <div id="deets">
+  <table class="table table-bordered table-condensed table-responsive">
+    <tr>
+      <td>Browser</td>
+      <td id="browser"></td>
+    </tr>
+    <tr>
+      <td>OS</td>
+      <td id="OS">Mac</td>
+    </tr>
+    <tr>
+      <td>Date</td>
+      <td id="Date">#{Time.now.to_s}</td>
+    </tr>
+    <tr>
+      <td>Time</td>
+      <td id="Time">12 PM</td>
+    </tr>
+    </table>
+  </div>
+</div>
+<div class="results">
+EOF
+
+
+        YALE_GLOBAL_STYLES = <<-EOF
+#rspec-header {
+  background: #65C400; color: #fff; height: 250px;
+  margin: 10px 10px 10px 10px;
+  position: relative;
+}
+
+.rspec-report h1 {
+  margin: 0px 10px 0px 10px;
+  padding: 10px;
+  font-family: "Lucida Grande", Helvetica, sans-serif;
+  font-size: 1.8em;
+  position: absolute;
+}
+
+#deets {
+  float:left;
+  margin: 60px 10px 0px 20px;
+  position: absolute;
+}
+
+#chart {
+  float:right;
+  margin: 10px 10px 0px 60px;
+}
+
+#label {
+  float:left;
+}
+
+#display-filters {
+    font-family: "Lucida Grande",Helvetica,sans-serif;
+    position: absolute;
+    bottom: 0;
+    left: 20px;
+}
+
+#summary {
+  float:right;
+  padding: 5px 10px;
+  font-family: "Lucida Grande", Helvetica, sans-serif;
+  text-align: right;
+}
+
+#summary p {
+  margin: 0 0 0 2px;
+}
+
+#summary #totals {
+  font-size: 1.2em;
+}
+
+.example_group {
+  margin: 0 10px 5px;
+  background: #fff;
+}
+
+dl {
+  margin: 0; padding: 0 0 5px;
+  font: normal 11px "Lucida Grande", Helvetica, sans-serif;
+}
+
+dt {
+  padding: 3px;
+  background: #65C400;
+  color: #fff;
+  font-weight: bold;
+}
+
+dd {
+  margin: 5px 0 5px 5px;
+  padding: 3px 3px 3px 18px;
+}
+
+dd .duration {
+  padding-left: 5px;
+  text-align: right;
+  right: 0px;
+  float:right;
+}
+
+dd.example.passed {
+  border-left: 5px solid #65C400;
+  border-bottom: 1px solid #65C400;
+  background: #DBFFB4; color: #3D7700;
+}
+
+dd.example.not_implemented {
+  border-left: 5px solid #FAF834;
+  border-bottom: 1px solid #FAF834;
+  background: #FCFB98; color: #131313;
+}
+
+dd.example.pending_fixed {
+  border-left: 5px solid #0000C2;
+  border-bottom: 1px solid #0000C2;
+  color: #0000C2; background: #D3FBFF;
+}
+
+dd.example.failed {
+  border-left: 5px solid #C20000;
+  border-bottom: 1px solid #C20000;
+  color: #C20000; background: #FFFBD3;
+}
+
+
+dt.not_implemented {
+  color: #000000; background: #FAF834;
+}
+
+dt.pending_fixed {
+  color: #FFFFFF; background: #C40D0D;
+}
+
+dt.failed {
+  color: #FFFFFF; background: #C40D0D;
+}
+
+
+#rspec-header.not_implemented {
+  color: #000000; background: #FAF834;
+}
+
+#rspec-header.pending_fixed {
+  color: #FFFFFF; background: #C40D0D;
+}
+
+#rspec-header.failed {
+  color: #FFFFFF; background: #C40D0D;
+}
+
+
+.backtrace {
+  color: #000;
+  font-size: 12px;
+}
+
+a {
+  color: #BE5C00;
+}
+
+/* Ruby code, style similar to vibrant ink */
+.ruby {
+  font-size: 12px;
+  font-family: monospace;
+  color: white;
+  background-color: black;
+  padding: 0.1em 0 0.2em 0;
+}
+
+.ruby .keyword { color: #FF6600; }
+.ruby .constant { color: #339999; }
+.ruby .attribute { color: white; }
+.ruby .global { color: white; }
+.ruby .module { color: white; }
+.ruby .class { color: white; }
+.ruby .string { color: #66FF00; }
+.ruby .ident { color: white; }
+.ruby .method { color: #FFCC00; }
+.ruby .number { color: white; }
+.ruby .char { color: white; }
+.ruby .comment { color: #9933CC; }
+.ruby .symbol { color: white; }
+.ruby .regex { color: #44B4CC; }
+.ruby .punct { color: white; }
+.ruby .escape { color: white; }
+.ruby .interp { color: white; }
+.ruby .expr { color: white; }
+
+.ruby .offending { background-color: gray; }
+.ruby .linenum {
+  width: 75px;
+  padding: 0.1em 1em 0.2em 0;
+  color: #000000;
+  background-color: #FFFBD3;
+}
+EOF
+
+
+        YALE_HTML_HEADER = <<-EOF
+<!DOCTYPE html>
+<html lang='en'>
+<head>
+  <title>RSpec results</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" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <script src='http://code.jquery.com/jquery-1.10.1.min.js'></script>"
+  <script src="//netdna.bootstrapcdn.com/bootstrap/3.0.0/js/bootstrap.min.js"></script>
+  <link href="//netdna.bootstrapcdn.com/bootstrap/3.0.0/css/bootstrap.min.css" rel="stylesheet">
+  <script src='http://code.highcharts.com/highcharts.js'></script>
+  <style type="text/css">
+  body {
+    margin: 0;
+    padding: 0;
+    background: #fff;
+    font-size: 80%;
+  }
+  </style>
+  <script type="text/javascript">
+    // <![CDATA[
+#{GLOBAL_SCRIPTS}
+    // ]]>
+  </script>
+  <style type="text/css">
+#{YALE_GLOBAL_STYLES}
+  </style>
+</head>
+<body>
+EOF
+
+      end
+    end
+  end
+end

data/lib/magicspec/magicspec_config.rb

@@ -0,0 +1,21 @@
+require 'yaml'
+require 'magicspec/errors'
+require 'ostruct'
+
+module Magicspec
+	class Config
+		attr_reader :hash_content, :content
+		
+		def initialize filepath
+			@f ||= filepath if valid?(filepath)
+			File.open(@f) {|handle| @hash_content = YAML.load(handle)}
+			@content = OpenStruct.new(@hash_content)
+		end
+		
+		def valid?(filepath)
+			raise ConfigFileMissingError unless File.exists?(filepath)
+			true
+		end
+
+	end
+end #Magicspec

data/lib/magicspec/magicspec_initializer.rb

@@ -0,0 +1,33 @@
+module Magicspec
+	class Initializer
+		def initialize root, app_name
+			@root ||= root
+			@app_name ||= app_name
+			
+			@pages_path = File.join(@root, 'app', 'pages')
+      $:.unshift(@pages_path)
+			
+			load_config
+			load_all_pages
+			generate_pathes
+		end
+		
+		def load_all_pages
+			Dir.glob(File.join @pages_path, '**', '*.rb').select { |p| p =~ /page\.rb$/ }.each do |page|
+				puts "#{page}" if $debug
+				require "#{page}"
+			end #each
+		end
+
+		def load_config
+			# hard code config file name here
+			@config_file = File.join @root, 'config', 'config.yml'
+			$config = Config.new(@config_file).content  
+		end
+
+		def generate_pathes
+			$root = @root
+			$pages = @pages_path
+		end
+	end
+end #Magicspec

data/lib/magicspec/page_override.rb

@@ -0,0 +1,5 @@
+module PageObject
+    def turn_to kls
+      kls.new(@browser)
+    end
+end

data/lib/magicspec/templates/browser_spec_template.rb.tt

@@ -0,0 +1,22 @@
+#encoding: utf-8
+require File.expand_path 'app/spec/spec_helper'
+
+$browsers.each do |b|
+  describe "The template using the '#{b}' browser",:template do
+    before(:all) do
+      @browser = initBrowser(b,:platform => :VISTA)
+      @yale_page = YalePage.new(@browser)
+      @yale_page.goto
+    end
+
+    it 'will always fail' do
+      expect(false).to be_true
+    end
+
+    it 'is pending'
+
+    after(:all) do
+    	@browser.close rescue nil
+    end
+  end
+end

data/lib/magicspec/templates/mobile_template.rb.tt

@@ -0,0 +1,15 @@
+#encoding: utf-8
+require File.expand_path 'app/spec/spec_helper'
+
+describe "The mobile template",:template do
+  before(:all) do
+    # Do something to set things up
+  end
+  
+  after(:all) do
+    # Do something to tear things down
+  end
+
+  it 'will do something with a mobile device(s)'
+
+end

data/lib/magicspec/templates/plain_template.rb.tt

@@ -0,0 +1,22 @@
+#encoding: utf-8
+require File.expand_path 'app/spec/spec_helper'
+
+describe "The vanilla template",:template do
+  before(:all) do
+    # Do something to set things up
+  end
+  
+  after(:all) do
+    # Do something to tear things down
+  end
+
+  it 'will always fail' do
+    expect(false).to be_true
+  end
+
+  it 'will always pass' do
+    expect(pass).to be_true
+  end
+
+  it 'is pending'
+end

data/lib/magicspec/templates/template_page.rb.tt

@@ -0,0 +1,11 @@
+#encoding: utf-8
+
+class <%= @name.capitalize%>Page
+  include PageObject
+  button(:goButton,:value => "Go")
+  
+  def doSomething
+    self.goButton
+    turn_to AnotherPage
+  end
+end

data/lib/magicspec/templates/web_service_template.rb.tt

@@ -0,0 +1,18 @@
+require 'active_support/core_ext/hash/conversions'
+require File.expand_path 'app/specs/spec_helper'
+
+describe "Template tests",:template do
+  before(:all) do
+    client = Savon.client(wsdl: "http://www.webservicex.net/stockquote.asmx?WSDL",
+    #:basic_auth => [$config["user"]["name"], $config["user"]["password"]],
+    :log_level => :error)
+  
+    response = client.call(:get_quote, message: { symbol: "Goog"})
+    # Create a hash out of the response
+    @hashedResponse = Hash.from_xml(response.to_hash[:get_quote_response][:get_quote_result])
+  end
+  
+  it 'returns the symbol' do
+    expect(@hashedResponse["StockQuotes"]["Stock"]["Symbol"]).to eq "GOOG"
+  end
+end

data/lib/magicspec/watir_browser.rb

@@ -0,0 +1,7 @@
+module Watir
+  class Browser
+    def factory
+      puts "This be the factory yo."
+    end
+  end
+end

data/lib/magicspec.rb

@@ -0,0 +1,8 @@
+require 'active_support/all' # need be replaced, only required string of active support 
+require 'watir-webdriver'
+require 'page-object'
+require 'magicspec/ext/string'
+require 'magicspec/magicspec_config'
+require 'magicspec/magicspec_initializer'
+require 'magicspec/page_override'
+require 'magicspec/watir_browser'

data/magicspec.gemspec

@@ -0,0 +1,120 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "magicspec"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["easonhan,dmfranko"]
+  s.date = "2013-12-18"
+  s.description = "A test framework using watir-webdriver rspec and page-object"
+  s.email = "dan.franko@yale.edu"
+  s.executables = ["magicspec"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".project",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc",
+    "Rakefile",
+    "bin/magicspec",
+    "magicspec.gemspec",
+    "lib/magicspec.rb",
+    "lib/magicspec/cli.rb",
+    "lib/magicspec/errors.rb",
+    "lib/magicspec/ext/string.rb",
+    "lib/magicspec/generators/magicspec/.rspec",
+    "lib/magicspec/generators/magicspec/app/matchers/.empty_directory",
+    "lib/magicspec/generators/magicspec/app/pages/yale/yale_page.rb.tt",
+    "lib/magicspec/generators/magicspec/app/pages/yale/yale_search_result_page.rb.tt",
+    "lib/magicspec/generators/magicspec/app/reports/.empty_directory",
+    "lib/magicspec/generators/magicspec/app/reports/screenshots/.empty_directory",
+    "lib/magicspec/generators/magicspec/app/spec/shared/login.rb",
+    "lib/magicspec/generators/magicspec/app/spec/spec_helper.rb.tt",
+    "lib/magicspec/generators/magicspec/app/spec/support/formatters/dry_run_formatter.rb",
+    "lib/magicspec/generators/magicspec/app/spec/support/formatters/html_override.rb",
+    "lib/magicspec/generators/magicspec/app/spec/support/formatters/magicspec_formatter.rb",
+    "lib/magicspec/generators/magicspec/app/spec/support/matchers/custom_matcher.rb",
+    "lib/magicspec/generators/magicspec/app/spec/support/matchers/email_matcher.rb",
+    "lib/magicspec/generators/magicspec/app/spec/support/matchers/file_matcher.rb",
+    "lib/magicspec/generators/magicspec/app/spec/yale/yale_example_spec.rb",
+    "lib/magicspec/generators/magicspec/app/test_data/baidu.yml",
+    "lib/magicspec/generators/magicspec/app/test_data/login_user.yml",
+    "lib/magicspec/generators/magicspec/bin/console",
+    "lib/magicspec/generators/magicspec/bin/console.bat",
+    "lib/magicspec/generators/magicspec/bin/setup.rb.tt",
+    "lib/magicspec/generators/magicspec/config/config.yml",
+    "lib/magicspec/generators/magicspec/config/magicspec_formatter.rb",
+    "lib/magicspec/generators/magicspec/config/override.rb",
+    "lib/magicspec/magicspec_config.rb",
+    "lib/magicspec/magicspec_initializer.rb",
+    "lib/magicspec/page_override.rb",
+    "lib/magicspec/watir_browser.rb",
+    "lib/magicspec/templates/browser_spec_template.rb.tt",
+    "lib/magicspec/templates/mobile_template.rb.tt",
+    "lib/magicspec/templates/plain_template.rb.tt",
+    "lib/magicspec/templates/template_page.rb.tt",
+    "lib/magicspec/templates/web_service_template.rb.tt",
+    "spec/app/pages/components/footer.rb",
+    "spec/app/pages/components/sub/sub_footer.rb",
+    "spec/app/pages/module1/module1_page.rb",
+    "spec/app/pages/module1/sub_test_page.rb",
+    "spec/app/pages/test_navigator.rb",
+    "spec/app/pages/test_page.rb",
+    "spec/config/config.yml",
+    "spec/config/wrong_config.yml",
+    "spec/magicspec_config_spec.rb",
+    "spec/lazy_initializer_spec.rb",
+    "spec/lazy_navigator_spec.rb",
+    "spec/lazy_page_spec.rb",
+    "spec/pages/components/footer.rb",
+    "spec/pages/test_page.rb",
+    "spec/spec_helper.rb",
+    "spec/string_spec.rb"
+  ]
+  s.homepage = "https://github.com/dmfranko/magic_spec"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.3"
+  s.summary = "A simple web automation test framework"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<page-object>, [">= 0"])
+      s.add_runtime_dependency(%q<thor>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<page-object>, [">= 0"])
+      s.add_development_dependency(%q<thor>, [">= 0"])
+    else
+      s.add_dependency(%q<page-object>, [">= 0"])
+      s.add_dependency(%q<thor>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<page-object>, [">= 0"])
+      s.add_dependency(%q<thor>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<page-object>, [">= 0"])
+    s.add_dependency(%q<thor>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<page-object>, [">= 0"])
+    s.add_dependency(%q<thor>, [">= 0"])
+  end
+end
+

data/spec/app/pages/components/footer.rb

@@ -0,0 +1,3 @@
+puts 'required files in components' if $debug
+module Footer
+end

data/spec/app/pages/components/sub/sub_footer.rb

@@ -0,0 +1,3 @@
+puts 'required files in sub footer' if $debug
+module SubFooter
+end

data/spec/app/pages/module1/module1_page.rb

@@ -0,0 +1,6 @@
+puts 'required files in module1' if $debug
+class Module1Page < Lazyman::Page
+end
+
+class CustomModule1Page < Lazyman::Page
+end

data/spec/app/pages/module1/sub_test_page.rb

@@ -0,0 +1,4 @@
+puts 'required files in sub test page' if $debug
+class SubTestPage < TestPage
+end
+

data/spec/app/pages/test_navigator.rb

@@ -0,0 +1,4 @@
+puts 'required app navigator' if $debug
+class TestNavigator < Lazyman::Navigator
+end
+

data/spec/app/pages/test_page.rb

@@ -0,0 +1,4 @@
+puts 'required app pages' if $debug
+class TestPage < Lazyman::Page
+end
+

data/spec/config/config.yml

@@ -0,0 +1,3 @@
+---
+host: www.example.com
+