perfecto-reporting 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a8d8e76e6f37480eee7f5300238d7b60249d20b
+  data.tar.gz: 7bec1c7b3b3c8f29ad827427d91513e05292ef85
+SHA512:
+  metadata.gz: 4c711244a1a30c4ed13311ba801c46dca95d8b64453c4b26c344126bf4fd2a0df70a3f5e18964b2137e21d8852b9020328cfefbb8e70b2473a7ee8f93cdebf5e
+  data.tar.gz: 1828afc5cc6990974260f51e4b2584760b6eb01180ffd97626cd0b08ef9e24e7e6452a27f1f639a181e702b6140200255021cc2ee84c9208b20e3971640b817a

data/lib/perfecto-reporting.rb

@@ -0,0 +1,18 @@
+# perfecto-reporting Gem
+#
+# For more information about the gem read the documentation file.
+# For support check out our community at : www.community.perfectomobile.com
+#
+# MIT License
+
+# Client classes
+require 'perfecto-reporting/client/PerfectoReportiumClient'
+
+# Model classes
+require 'perfecto-reporting/model/PerfectoExecutionContext'
+require 'perfecto-reporting/model/Job'
+require 'perfecto-reporting/model/Project'
+
+# Test classes
+require 'perfecto-reporting/test/TestContext'
+require 'perfecto-reporting/test/result/TestResultFactory'

data/lib/perfecto-reporting/client/PerfectoReportiumClient.rb

@@ -0,0 +1,111 @@
+
+require_relative '../model/PerfectoExecutionContext'
+require_relative '../exceptions/ReportiumException'
+
+# PerfectoReportiumClient
+class PerfectoReportiumClient
+
+  # Test Commands
+  START_TEST_COMMAND = 'mobile:test:start';
+  TEST_STEP_COMMAND = 'mobile:test:step';
+  END_TEST_COMMAND = 'mobile:test:end';
+
+  attr_accessor :currentTestId, :perfectoExecutionContext
+
+  def initialize(perfectoExecutionContext)
+    @perfectoExecutionContext = perfectoExecutionContext
+  end
+
+  # creates a new test execution
+  #
+  # name - test name
+  # context - test context instance
+  #
+  # returns - id of created test
+  def testStart(name, context) 
+    params = {}
+
+    unless @perfectoExecutionContext.job.nil?
+      params['jobName'] = @perfectoExecutionContext.job.name
+      params['jobNumber'] = @perfectoExecutionContext.job.number
+    end
+
+    unless @perfectoExecutionContext.project.nil?
+      params['projectName'] = @perfectoExecutionContext.job.name
+      params['projectVersion'] = @perfectoExecutionContext.project.version
+    end
+
+    params['name'] = name
+    params['tags'] = @perfectoExecutionContext.contextTags + context.testExecutionTags
+
+    @currentTestId = executeScript(START_TEST_COMMAND, params)
+    return @currentTestId
+  end
+  
+
+
+  # logging a logical test step.
+  #
+  # description - step description, will be presented on reporting ui.
+  #
+  # returns - id of created step
+  #
+  # e.g. 'click on next button'
+  def testStep(description)
+    params = {:name => description}
+    return executeScript(TEST_STEP_COMMAND, params)
+  end
+
+
+  # Indicates that the test has stopped and its execution status.
+  #
+  # testResult - testResult instance
+  #
+  # returns - false if the method failed due to existing conditions such as a previous call to testStart that failed,
+  # otherwise return true 
+  def testStop(testResult)
+    if @currentTestId.to_s == ''
+      return false
+    end
+    
+    params = {
+      :success => testResult.isSuccessful
+    }
+      
+    if !testResult.isSuccessful
+      params['failureDescription'] = testResult.message
+    end
+
+    executeScript(END_TEST_COMMAND, params)
+    return true 
+  end
+  
+
+  # Returns the URL to the created online report in Perfecto's reporting solution.
+  #
+  # name - test name
+  # The report is based on all tests that match the current execution context, and is not
+  # limited to a single functional test execution.
+  #
+  # returns - URL to the created online report
+  #
+  # raise exception if driver has no capabilities variable
+  def getReportUrl()
+    url = nil
+    webdriver = @perfectoExecutionContext.webdriver
+
+    begin
+      url = webdriver.capabilities['testGridReportUrl']
+    rescue Exception => e
+      raise ReportiumException.new e.message
+    end
+
+    return url
+  end
+
+  def executeScript(script, params)
+    webdriver = @perfectoExecutionContext.webdriver
+    return webdriver.execute_script(script, params)
+  end
+
+end

data/lib/perfecto-reporting/exceptions/ReportiumException.rb

@@ -0,0 +1,12 @@
+
+# Instance denoting customized reporting exception
+class ReportiumException < StandardError
+
+  # Create new instance
+  #
+  # msg - new message to be attached to the exception
+  def initialize msg
+    super(msg)
+  end
+
+end

data/lib/perfecto-reporting/model/Job.rb

@@ -0,0 +1,16 @@
+
+# Job 
+# Defines a job which runs the test / group of tests
+# 
+# This can be used in order to locate specific job in reporting ui
+class Job
+
+  attr_accessor :name, :number
+
+  # initialize a new job instance
+  def initialize name, number
+    @name = name
+    @number = number
+  end
+
+end

data/lib/perfecto-reporting/model/PerfectoExecutionContext.rb

@@ -0,0 +1,95 @@
+require_relative '../exceptions/ReportiumException'
+
+# PerfectoExecutionContext
+#
+# This class define execution for MCM-based clients.
+#
+# Creating instance of this class possible only with PerfectoExecutionContextBuilder instance.
+class PerfectoExecutionContext
+
+  attr_accessor :job, :project, :webdriver, :contextTags
+
+  # create new instance
+  #
+  # perfectoExecutionContextBuilder - 
+  # raise ReportiumException if driver not given. 
+  def initialize (perfectoExecutionContextBuilder)
+
+    # execution is not possible without webdriver.
+    if perfectoExecutionContextBuilder.webdriver.nil?
+      raise ReportiumException.new('Missing required webdriver argument.')
+    end
+
+    @job = perfectoExecutionContextBuilder.job
+    @project = perfectoExecutionContextBuilder.project
+    @webdriver = perfectoExecutionContextBuilder.webdriver
+    @contextTags = perfectoExecutionContextBuilder.contextTags
+
+  end
+
+  # PerfectoExecutionContext
+  #
+  # This class used to create PerfectoExecutionContext instance
+  #
+  # example:
+  # perfectoExecutionContext::perfectoExecutionContextBuilder
+  # .withJob("job name" , job number )
+  # .withProject("project name" , project version)
+  # .withWebDriver(driver)
+  # .build()
+  class PerfectoExecutionContextBuilder
+
+    @@job = nil
+    @@project = nil
+    @@webdriver = nil
+    @@contextTags = nil
+
+    # define a job
+    def self.withJob job
+      @@job = job
+      return self
+    end
+
+    # define a project
+    def self.withProject project
+      @@project = project
+      return self
+    end
+
+    # define webdriver
+    def self.withWebDriver webdriver
+      @@webdriver = webdriver
+      return self
+    end
+
+    # define contextTags
+    def self.withContextTags *args
+      @@contextTags = args
+      return self
+    end
+
+    # building a new builder instance
+    def self.build
+      return self.new
+    end
+
+    def job
+      @@job
+    end
+
+    def project
+      @@project
+    end
+
+    def contextTags
+      @@contextTags
+    end
+
+    def webdriver
+      @@webdriver
+    end
+
+  end
+
+end
+

data/lib/perfecto-reporting/model/Project.rb

@@ -0,0 +1,18 @@
+# Project
+# This class defines a Project
+#
+# Tests with same projects can be filtered within reporting ui.
+class Project
+
+  attr_accessor :name, :version
+
+  # initialize new project instance
+  #
+  # name - the new project's name
+  # version - the project's version
+  def initialize name, version
+    @name = name
+    @version = version
+  end
+
+end

data/lib/perfecto-reporting/test/TestContext.rb

@@ -0,0 +1,14 @@
+# TestContext
+#
+# TestContext tags will be presented in reporting ui.
+# This tags attached to each test execution.
+class TestContext
+
+  attr_accessor :testExecutionTags
+
+  # Create TestContext instance
+  def initialize *args
+    @testExecutionTags = args
+  end
+
+end

data/lib/perfecto-reporting/test/result/TestResult.rb

@@ -0,0 +1,14 @@
+# Test result
+#
+# This class define a basic TestResult instance structure
+class TestResult
+
+	def isSuccessful
+		raise 'Not Implemented Method'
+	end
+
+	def status
+		raise 'Not Implemented Method'
+	end
+
+end

data/lib/perfecto-reporting/test/result/TestResultFactory.rb

@@ -0,0 +1,26 @@
+require_relative 'TestResultSuccess'
+require_relative 'TestResultFailure'
+
+# TestResultFactory
+#
+# Generates a new test result instance.
+class TestResultFactory
+
+  # create a successful test execution result
+  #
+  # return - instance denoting a successful test execution
+  def self.createSuccess
+    return TestResultSuccess.new
+  end
+
+  # Creates a failed test execution result
+  #
+  # reason - string representation of the reason for the test failure
+  # error - the exception caused the failure
+  #
+  # return - instance denoting a failed test execution
+  def self.createFailure reason, error
+    return TestResultFailure.new(reason, error)
+  end
+
+end

data/lib/perfecto-reporting/test/result/TestResultFailure.rb

@@ -0,0 +1,32 @@
+require_relative 'TestResult'
+
+# TestResultFailure
+#
+# Define a failure test result.
+class TestResultFailure < TestResult
+
+  attr_accessor :message
+
+  @@status = 'FAILED'
+
+  # Create a new instance
+  #
+  # reason - string representation of the failure reason
+  # error - exception caused to the failure
+  def initialize(reason, error)
+    if error.is_a? Exception
+      @message = reason + '. Stack Trace:' + error.backtrace.to_s
+    else
+      @message = reason
+    end
+  end
+
+  def isSuccessful
+    return false
+  end
+
+  def status
+    @@status
+  end
+
+end

data/lib/perfecto-reporting/test/result/TestResultSuccess.rb

@@ -0,0 +1,18 @@
+require_relative 'TestResult'
+
+# TestResultSuccess
+#
+# Define a successful test result
+class TestResultSuccess < TestResult 
+
+  @@status = 'PASSED' 
+
+  def isSuccessful
+    return true
+  end
+
+  def status
+    @@status
+  end
+
+end

data/lib/perfecto-reporting/version.rb

@@ -0,0 +1,7 @@
+# Modified by Perfecto Mobile Ltd.
+
+module Reporting
+  module Perfecto
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: perfecto-reporting
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- perfecto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.53'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.53.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.53'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.53.0
+description: reporting sdk for ruby
+email: daniela@perfectomobile.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/perfecto-reporting.rb
+- lib/perfecto-reporting/client/PerfectoReportiumClient.rb
+- lib/perfecto-reporting/exceptions/ReportiumException.rb
+- lib/perfecto-reporting/model/Job.rb
+- lib/perfecto-reporting/model/PerfectoExecutionContext.rb
+- lib/perfecto-reporting/model/Project.rb
+- lib/perfecto-reporting/test/TestContext.rb
+- lib/perfecto-reporting/test/result/TestResult.rb
+- lib/perfecto-reporting/test/result/TestResultFactory.rb
+- lib/perfecto-reporting/test/result/TestResultFailure.rb
+- lib/perfecto-reporting/test/result/TestResultSuccess.rb
+- lib/perfecto-reporting/version.rb
+homepage: http://rubygems.org/gems/Perfecto-Reporting
+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.5.1
+signing_key: 
+specification_version: 4
+summary: perfecto reporting sdk
+test_files: []