perfecto-reporting 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c14cf78770c56664872f436c7674f91a2fdd8928
-  data.tar.gz: b78096d61b8cb5836c58fb7fc4218e3368a2c355
+  metadata.gz: a114204836540cc29a9c2519876a42923876039c
+  data.tar.gz: ee18e96e0cab1a2718547ef5d75b34371711a8e8
 SHA512:
-  metadata.gz: 8cf6a92a5c9b2f071a8af8d27ca4a03f3c51e703273251f4147056fcf13c3d1bf631cbb24d3c65f3206de6b328d069bdfd940401845ff5349fe3fec83452bdf3
-  data.tar.gz: 62b9648ee4bb98bc9afb4c5c1bed1e20c89a2dc980e30d0bd4e5ac76302ffe0dac55b59ce471e065928ae784d99d565a1711b79159f905012f9fa4fc06137637
+  metadata.gz: c2495c4fcdf0790b9525abb3b7162e6316b7e0e6b608acb1f17fc3d99c215c333cea54ad4027dc1a26ac317631ddb4b4af74e21f0fcbb8f2678ae47c1163e1dc
+  data.tar.gz: e8546b4371f24f78f6d0761ccf690b1e63b4176228d1eefd5d52223081847fe4f335c6ac303299abd4cb7849bd269ecd9de78e2d82e2e65af1b8d9feb089df00

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2019 Perfecto
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,68 @@
+## Reporting SDK for Ruby Programming language 
+
+**Updates:**
+
+- 31/8 init repo
+- 1/9 Uploaded PerfectoReportingClient + reportingTests.
+- Added documentation (internal, not for the community).
+- 4/9 Added Connection/SsoTokenProducer (Look documentation for windows [certification errors](## Troubleshoot for windows certification error (OpenSSL::SSL::SSLError))). 
+- 5/9 Added gem (without httpclient) . 
+- 6/9 Gem without httpclient published.
+
+
+*Dependencies:*
+
+require reporting statement:  <br/>
+`require_relative '../gem/Perfecto-Reporting'`
+
+**Usage:**
+
+Initialize a new client:
+```Ruby
+def create_reporting_client
+    perfectoExecutionContext = PerfectoExecutionContext.new(PerfectoExecutionContextBuilder
+         .withProject(Project.new('Ruby Reporting', '0.1'))
+         .withJob(Job.new('Ruby Job' , 1))
+         .withContextTags('Context tag1', 'Context tag2', 'Context tag 3' ...... )
+         .withWebDriver(@driver)
+         .build)
+
+    @reporting_client = PerfectoReportiumClient.new(perfectoExecutionContext)
+  end
+```
+
+Test start command: 
+```Ruby
+@reporting_client.testStart(self.name, TestContext.new('Test tag 1', 'Test tag 2', 'Test tag 13' ...... ))
+```
+
+Test step command:
+```Ruby
+@reporting_client.testStep('Test step description')
+```
+
+Test stop command:<br/>
+**Note!** - in this case i'm using test instance in order to determine test condition (passed / failed)
+```Ruby
+if self.passed?
+    @reporting_client.testStop(TestResultSuccess.new)
+else
+    @reporting_client.testStop(TestResultFailure.new(@exception.message, @exception))
+end
+```
+
+**Running the tests:**
+test_setup.rb - this file define the test behavior (setup,teardown ...)<br/>
+test.rb - this is the test class inherent from PerfectoTestingBox which is in test_setup.rb file. 
+
+```
+ruby test.rb
+```
+
+## Troubleshoot for windows certification error (OpenSSL::SSL::SSLError)
+
+Download *cacert.pem* file from [here](https://curl.haxx.se/ca/cacert.pem) . 
+set enviorment variable using the following command in the command line: <br/>
+`set SSL_CERT_FILE=PATH_OF_FILE\cacert.pem`
+
+Note! Do not delete this file, it's required for certification.

data/lib/perfecto-reporting.rb

@@ -1,20 +1,20 @@
-# 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_relative './perfecto-reporting/client/PerfectoReportiumClient'
-require_relative './perfecto-reporting/client/ReportiumClientFactory'
-
-# Model classes
-require_relative 'perfecto-reporting/model/PerfectoExecutionContext'
-require_relative 'perfecto-reporting/model/Job'
-require_relative 'perfecto-reporting/model/Project'
-require_relative 'perfecto-reporting/model/CustomField'
-
-# Test classes
-require_relative 'perfecto-reporting/test/TestContext'
-require_relative 'perfecto-reporting/test/result/TestResultFactory'
+# 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_relative './perfecto-reporting/client/PerfectoReportiumClient'
+require_relative './perfecto-reporting/client/ReportiumClientFactory'
+
+# Model classes
+require_relative 'perfecto-reporting/model/PerfectoExecutionContext'
+require_relative 'perfecto-reporting/model/Job'
+require_relative 'perfecto-reporting/model/Project'
+require_relative 'perfecto-reporting/model/CustomField'
+
+# Test classes
+require_relative 'perfecto-reporting/test/TestContext'
+require_relative 'perfecto-reporting/test/result/TestResultFactory'

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

@@ -1,168 +1,168 @@
-require_relative '../model/PerfectoExecutionContext'
-require_relative '../exceptions/ReportiumException'
-require_relative 'constants'
-
-# PerfectoReportiumClient
-class PerfectoReportiumClient
-
-  attr_accessor :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
-	  params['jobBranch']= @perfectoExecutionContext.job.br_name
-    end
-
-    unless @perfectoExecutionContext.project.nil?
-      params['projectName'] = @perfectoExecutionContext.project.name
-      params['projectVersion'] = @perfectoExecutionContext.project.version
-    end
-
-    params['name'] = name
-	
-    params['tags'] = @perfectoExecutionContext.contextTags
-    unless context.testExecutionTags.nil?
-	 params['tags'] += context.testExecutionTags
-    end
-		 
-	# need to merge the CustomFields from the two levels of context
-	# the TestContext (in the "context" parameter) values overwrite the ExecutionContext
-    custom_flds = @perfectoExecutionContext.customFields
-    context.customFields.each do |key, value|
-	custom_flds[key] = value
-    end
-	
-    custom_json = custom_flds.map { |key, value| key + '=' + value }
-    # the format that script wants is: '[ "test=sample","tester=new_tester"]'
-    params['customFields'] = custom_json
-
-    executeScript($START_TEST_COMMAND, params)
-  end
-
-
-  # logging a logical test step.
-  #
-  # ### DEPRECATED ###
-  #
-  # description - step description, will be presented on reporting ui.
-  #
-  # returns - id of created step
-  #
-  # e.g. 'click on next button'
-  def testStep(description)
-    warn 'testStep method is deprecated, please use stepStart or stepEnd commands instead.'
-    executeScript($START_STEP_COMMAND, {:name => description})
-  end
-
-  # logging a logical test step start
-  #
-  # description - step description
-  def stepStart(description)
-    executeScript($START_STEP_COMMAND, {:name => description})
-  end
-
-  # logging a logical test step end
-  #
-  # message - a possible message to attach
-  def stepEnd(message=nil)
-    executeScript($END_STEP_COMMAND, {:message => message})
-  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)
-
-    params = {
-        :success => testResult.isSuccessful
-    }
-
-    if !testResult.isSuccessful
-      params['failureDescription'] = testResult.message
-      params['failureReason'] = testResult.failureReason
-    end
-
-    executeScript($END_TEST_COMMAND, params)
-    return true
-  end
-
-  def testStop(testResult, context)
-
-    params = {
-        :success => testResult.isSuccessful
-    }
-
-    if !testResult.isSuccessful
-      params['failureDescription'] = testResult.message
-      params['failureReason'] = testResult.failureReason
-    end
-
-    unless context.testExecutionTags.nil?
-	 params['tags'] = context.testExecutionTags
-    end
-
-    custom_json = context.customFields.map { |key, value| key + '=' + value }
-    # the format that script wants is: '[ "test=sample","tester=new_tester"]'
-    params['customFields'] = custom_json
-    
-    executeScript($END_TEST_COMMAND, params)
-    return true
-  end
-  
-  
-  # log a new assertion
-  #
-  # message - a message to be attached to the assertion
-  # status - true / false value
-  def reportiumAssert(message, status)
-    params = {
-        :message => message,
-        :status => status
-    }
-    executeScript($ASSERT_COMMAND, params)
-  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
+require_relative '../model/PerfectoExecutionContext'
+require_relative '../exceptions/ReportiumException'
+require_relative 'constants'
+
+# PerfectoReportiumClient
+class PerfectoReportiumClient
+
+  attr_accessor :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
+	  params['jobBranch']= @perfectoExecutionContext.job.br_name
+    end
+
+    unless @perfectoExecutionContext.project.nil?
+      params['projectName'] = @perfectoExecutionContext.project.name
+      params['projectVersion'] = @perfectoExecutionContext.project.version
+    end
+
+    params['name'] = name
+	
+    params['tags'] = @perfectoExecutionContext.contextTags
+    unless context.testExecutionTags.nil?
+	 params['tags'] += context.testExecutionTags
+    end
+		 
+	# need to merge the CustomFields from the two levels of context
+	# the TestContext (in the "context" parameter) values overwrite the ExecutionContext
+    custom_flds = @perfectoExecutionContext.customFields
+    context.customFields.each do |key, value|
+	custom_flds[key] = value
+    end
+	
+    custom_json = custom_flds.map { |key, value| key + '=' + value }
+    # the format that script wants is: '[ "test=sample","tester=new_tester"]'
+    params['customFields'] = custom_json
+
+    executeScript($START_TEST_COMMAND, params)
+  end
+
+
+  # logging a logical test step.
+  #
+  # ### DEPRECATED ###
+  #
+  # description - step description, will be presented on reporting ui.
+  #
+  # returns - id of created step
+  #
+  # e.g. 'click on next button'
+  def testStep(description)
+    warn 'testStep method is deprecated, please use stepStart or stepEnd commands instead.'
+    executeScript($START_STEP_COMMAND, {:name => description})
+  end
+
+  # logging a logical test step start
+  #
+  # description - step description
+  def stepStart(description)
+    executeScript($START_STEP_COMMAND, {:name => description})
+  end
+
+  # logging a logical test step end
+  #
+  # message - a possible message to attach
+  def stepEnd(message=nil)
+    executeScript($END_STEP_COMMAND, {:message => message})
+  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)
+
+    params = {
+        :success => testResult.isSuccessful
+    }
+
+    if !testResult.isSuccessful
+      params['failureDescription'] = testResult.message
+      params['failureReason'] = testResult.failureReason
+    end
+
+    executeScript($END_TEST_COMMAND, params)
+    return true
+  end
+
+  def testStop(testResult, context)
+
+    params = {
+        :success => testResult.isSuccessful
+    }
+
+    if !testResult.isSuccessful
+      params['failureDescription'] = testResult.message
+      params['failureReason'] = testResult.failureReason
+    end
+
+    unless context.testExecutionTags.nil?
+	 params['tags'] = context.testExecutionTags
+    end
+
+    custom_json = context.customFields.map { |key, value| key + '=' + value }
+    # the format that script wants is: '[ "test=sample","tester=new_tester"]'
+    params['customFields'] = custom_json
+    
+    executeScript($END_TEST_COMMAND, params)
+    return true
+  end
+  
+  
+  # log a new assertion
+  #
+  # message - a message to be attached to the assertion
+  # status - true / false value
+  def reportiumAssert(message, status)
+    params = {
+        :message => message,
+        :status => status
+    }
+    executeScript($ASSERT_COMMAND, params)
+  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