datatrue_client 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f8e3b62d7ec68b9ea032ed95fcf9e5f69073b7d5
-  data.tar.gz: f104c8cb31a6481a9077c5a8a52a8640356167ce
+SHA256:
+  metadata.gz: e313cd838909047b0f150bea93e2a2af4c0349eeac86c23dd28c476ef0d7e3c9
+  data.tar.gz: e45b0fe798c67621b77d7ba28674817d671ab844880353d15d7f287d3354f671
 SHA512:
-  metadata.gz: f64f5366db9f2d766497febfe64dee3ca72d1c70c182b94c83527f5b9a3faf50698ce899a9821f9ac9fd6334b7df9ec9a814ce11f1b83e6b38dabe0d9d1946e0
-  data.tar.gz: 9ce97c8e0a21829b7d063416e5e9c559f32fa9f614a8afcb738cc6faa2f9f45a2cab4f5235e69f0405d7b2fc84521917742fd903fa3278efd67bb81035e2af30
+  metadata.gz: a746a8dc707b255ba318d37fe869368282e200b5d0c3695ce652ab9f8b4811411b0a9a0442a718c00003d11e9749856445ec8db4eab66898d4b220819a56210d
+  data.tar.gz: 9c73891d5c13bb9c56285a53faaece218dad4b5d1b2569fdd7a64b7218add9202ff344f0681deff0fe83038322745630032d05136b121ba5ca6fb0bd881f73f3

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/bundle

data/.ruby-version

@@ -0,0 +1 @@
+2.5.5

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Lens10 Pty Ltd
+Copyright (c) 2020 Source of True Pty Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -4,6 +4,19 @@ DataTrue is a SaaS platform to audit, monitor and validate tags, dataLayers and
 
 This ruby client allows you to trigger DataTrue tests from a Continuous Integration tool such as [Jenkins](https://jenkins.io/), [Teamcity](https://www.jetbrains.com/teamcity/), [Travis CI](https://travis-ci.org/), [Codeship](https://codeship.com/) and others.  If you’re practicing Continuous Delivery, it can be used to trigger a test of your application as soon as changes are released.
 
+## Table of Contents
+
+- [DataTrue API client](#datatrue-api-client)
+  - [Table of Contents](#table-of-contents)
+  - [Usage](#usage)
+    - [Command-line usage](#command-line-usage)
+      - [Environment variables](#environment-variables)
+    - [Usage in a Ruby application](#usage-in-a-ruby-application)
+  - [Support](#support)
+  - [Contributing](#contributing)
+    - [Development](#development)
+  - [License](#license)
+
 ## Usage
 
 You will need a DataTrue account ([free sign-up](https://datatrue.com/?utm_source=github&utm_medium=listing&utm_campaign=API_Client)) to use this gem.  To get your API key go to the [Accounts page](https://datatrue.com/accounts/?utm_source=github&utm_medium=listing&utm_campaign=API_Client), select your account and click on "Generate API Key".
@@ -12,7 +25,9 @@ The next steps assume you have a test suite created in DataTrue.  Read our [Know
 
 Install the gem on the system you want to trigger your tests from:
 
-    $ gem install datatrue_client
+```bash
+$ gem install datatrue_client
+```
 
 Alternatively, if you want to include the client as part of your ruby application, you can add this line to your Gemfile:
 
@@ -22,10 +37,10 @@ gem 'datatrue_client', :group => [:test, :development]
 
 ### Command-line usage
 
-Use the [DataTrue API wizard](https://datatrue.com/?utm_source=github&utm_medium=listing&utm_campaign=API_Client) to select your test(s) or test suite along with other options.  Paste the command-line in your terminal to see it in action; e.g.:
+Use the following CLI syntax to select your test(s) or test suite along with other options.
 
-```
-datatrue_client run 1539 -a rtTlaqucG9RrTg1G2L1O0u -t suite \
+```bash
+$ datatrue_client run 1539 -a rtTlaqucG9RrTg1G2L1O0u -t suite \
     -v HOSTNAME=datatrue.com,GTMID=GTM-ABCXYZ \
     -e 543,544
 
@@ -38,11 +53,12 @@ datatrue_client: test_run_id=52454 finished result=passed.
 ```
 
 The exit status of the application will change according to test results:
-* `0`: test run successful, result=passed.
-* `1`: test run successful, result=failed.
-* `-1`: generic test run error. See output detail.
-* `-2`: authentication or authorisation error.  Check your API key and test identifiers.
-* `-3`: quota exceeded.  You have used-up all your subscription allowance for this period.
+
+- `0`: test run successful, result=passed.
+- `1`: test run successful, result=failed.
+- `-1`: generic test run error. See output detail.
+- `-2`: authentication or authorisation error.  Check your API key and test identifiers.
+- `-3`: quota exceeded.  You have used-up all your subscription allowance for this period.
 
 If you want to ignore the exit status, use the shell's `||` operator; e.g.: `datatrue_client [options] || true`.  This will ensure that the exit status is always `0`.
 
@@ -50,15 +66,15 @@ If you want to ignore the exit status, use the shell's `||` operator; e.g.: `dat
 
 _Commands_:
 
-* `run`: triggers a new run of tests or a test suite and waits for it to finish.
+- `run`: triggers a new run of tests or a test suite and waits for it to finish.
 
 ```text
 datatrue_client run <suite_id | test_id_1,test_id_2,...> -a <api_key>
     [-t | --type=suite|test] [-v | --variables foo=bar,thunder=flash]
-    [-e | --email-users '1,2,3...'] [-o | --output [filename]] [-s | --silent]
+    [-e | --email-users '1,2,3...'] [-s | --silent]
 ```
 
-* `trigger`: triggers a new run of tests or a test suite and exits immediately.
+- `trigger`: triggers a new run of tests or a test suite and exits immediately.
 
 ```text
 datatrue_client trigger <suite_id | test_id_1,test_id_2,...> -a <api_key>
@@ -68,93 +84,92 @@ datatrue_client trigger <suite_id | test_id_1,test_id_2,...> -a <api_key>
 
 _Options_:
 
-* `-a` or `--api-key`: The DataTrue API key. Overrides the API key provided as an environment variable.
-* `-t` or `--type`: The type of test to be run. Valid options are `test` or `suite`.
-* `-v` or `--variables`: Variables provided to the test. These can be used to change behaviour of your test, provide credentials and more.
-* `-e` or `--email-users`: Comma-separated list of user identifiers who will receive an email with the test results.
-* `-o` or `--output`: write the test results as a JUnit XML report that can be used to integrate DataTrue test results with other test tools (e.g. Jenkins).  If no filename is provided the client will create a `<job_id>.xml`.
-* `-s` or `--silent`: suppress all application output.
+- `-a` or `--api-key`: The DataTrue API key. Overrides the API key provided as an environment variable.
+- `-t` or `--type`: The type of test to be run. Valid options are `test` or `suite`.
+- `-v` or `--variables`: Variables provided to the test. These can be used to change behaviour of your test, provide credentials and more.
+- `-e` or `--email-users`: Comma-separated list of user identifiers who will receive an email with the test results.
+- `-s` or `--silent`: Suppress all application output.
+- `-h` or `--help`: Show help message.
+
+_Specific options for run_:
+
+- `--timeout`: Time to wait before the run finishes.
 
 #### Environment variables
 
-* `DATATRUE_API_KEY`: your DataTrue API key.  The `-a` option takes precedence.
+- `DATATRUE_API_KEY`: your DataTrue API key.  The `-a` option takes precedence.
 
 ### Usage in a Ruby application
 
 Trigger a test run:
 
-```
-  test_run = DatatrueClient::TestRun.new({
-    host: 'localhost:3000',
-    scheme: 'http',
-    api_key: '_AHQZRHZ3kD0kpa0Al-SJg',  # please remember to generate your own key on datatrue.com
-
-    test_run: {
-      test_class: 'TestScenario',
-      test_id: 1
-    },
-    variables: {
-      key: value
-    },
-
-    polling_interval: 2,  # in seconds, 2 by default
-    polling_timeout: 120  # in seconds, 60 by default
-  })
+```ruby
+test_run = DatatrueClient::TestRun.new({
+  host: 'localhost:3000',
+  scheme: 'http',
+  api_key: '_AHQZRHZ3kD0kpa0Al-SJg',  # please remember to generate your own key on datatrue.com
+
+  test_run: {
+    test_class: 'TestScenario',
+    test_id: 1
+  },
+  variables: {
+    key: value
+  },
+
+  polling_interval: 2,  # in seconds, 2 by default
+  polling_timeout: 120  # in seconds, 60 by default
+})
 ```
 
 Query progress:
 
-```
-  test_run.query_progress
-
-  # returns the progress hash
-  #
-  # {
-  #   time: 1463359905,
-  #   status: "working",
-  #   uuid: "a1f7868b1db44d38c16585ce37e4ac3f",
-  #   num: 4,
-  #   total: 5,
-  #   progress: {
-  #     percentage: 80,
-  #     tests: [
-  #       {
-  #         id: 1,
-  #         name: "Test name",
-  #         state: "running",
-  #         steps_completed: 4,
-  #         steps: [
-  #           {
-  #             name: "Step name",
-  #             running: false,
-  #             pending: false,
-  #             error: nil,
-  #             tags: [
-  #               { name: "Tag name', enabled: true, valid: true },
-  #               ...
-  #             ]
-  #           },
-  #           ...
-  #         ]
-  #       },
-  #       ...
-  #     ]
-  #   }
-  # }
+```ruby
+test_run.query_progress
+
+# returns the progress hash
+#
+# {
+#   time: 1463359905,
+#   status: "running",
+#   uuid: "a1f7868b1db44d38c16585ce37e4ac3f",
+#   num: 4,
+#   total: 5,
+#   progress: {
+#     percentage: 80,
+#     steps_total: 4,
+#     tests: [
+#       {
+#         id: 1,
+#         name: "Test name",
+#         state: "running",
+#         actions_completed: 4,
+#         actions_total: 5,
+#         steps: [
+#           {
+#             name: "Step name",
+#             running: false,
+#             pending: false,
+#             error: nil,
+#             tags: [
+#               { name: "Tag name', enabled: true, valid: true },
+#               ...
+#             ]
+#           },
+#           ...
+#         ]
+#       },
+#       ...
+#     ]
+#   }
+# }
 ```
 
 Poll progress (blocks until the run is finished or timed out):
 
-  `test_run.poll_progress`
-
-### Jenkins Integration
-
-The DataTrue client can output test results in the [JUnit  format](https://github.com/windyroad/JUnit-Schema/blob/master/JUnit.xsd) which can then be parsed by the [Jenkins JUnit plugin](https://wiki.jenkins-ci.org/display/JENKINS/JUnit+Plugin) and incorporated into your test results.
-
-Here's an example of what the results look like in Jenkins v1.6.
-
-<img src="documentation/jenkins_datatrue_test_result_summary.png?raw=true" alt="DataTrue test result summary in Jenkins" height="400"/>
-
+```ruby
+test_run.poll_progress
+```
 
 ## Support
 
@@ -164,8 +179,7 @@ If you believe you have found a bug, please [reach-out using the support website
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Lens10/datatrue_client.
-
+Bug reports and pull requests are welcome on GitHub at <https://github.com/datatrue-analytics/datatrue-api-client>.
 
 ### Development
 
@@ -173,7 +187,6 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/exe/datatrue_client

@@ -93,18 +93,6 @@ def datatrue_print(message)
   puts "datatrue_client: #{message}"
 end
 
-def process_result(details)
-  if details[:status] == 'completed'
-    if details[:progress]['tests'].all? { |result| ['success', 'validated'].include? result['state'] }
-      status = 'passed'
-    else
-      status = 'failed'
-    end
-  else
-    status = details[:status]
-  end
-end
-
 begin
   options = parse(ARGV)
   command = ARGV.shift
@@ -124,15 +112,6 @@ begin
     exit
   end
 
-  datatrue_print_progress = Proc.new do |progress, details|
-    datatrue_print %{
-    test_run_id=#{details[:options]['test_run_id']}
-    step=#{details[:num]}
-    total_steps=#{details[:total]}
-    result=#{process_result(details)}
-    }.gsub(/\s+/, ' ').strip
-  end
-
   test_run = DatatrueClient::TestRun.new({
     host: options.host,
     scheme: options.scheme,
@@ -150,8 +129,12 @@ begin
   datatrue_print "job=#{test_run.job_id} created for test=\"#{test_run.title}\"" unless options.silent
 
   if command == 'run'
+    datatrue_print_progress = Proc.new do |progress, details|
+      datatrue_print(DatatrueClient::TestRun.build_progress_message(details))
+    end
+
     res = test_run.poll_progress(options.silent ? nil : datatrue_print_progress)
-    process_result(res) == 'passed' ? exit : exit(1)
+    DatatrueClient::TestRun.get_progress_status(res) == 'passed' ? exit : exit(1)
   else
     exit
   end

data/lib/datatrue_client/test_run.rb

@@ -5,6 +5,53 @@ module DatatrueClient
   class QuotaExceeded < StandardError; end
 
   class TestRun
+    class << self
+      # @param details [Hash] The progress details hash. See CI API doc for the shape.
+      # @return [String]
+      def get_progress_status(details)
+        if details[:status] == 'completed'
+          if details[:progress]['tests'].all? { |result| ['success', 'validated'].include? result['state'] }
+            status = 'passed'
+          else
+            status = 'failed'
+          end
+        else
+          status = details[:status]
+        end
+      end
+
+      # @param details [Hash] The progress details hash. See CI API doc for the shape.
+      # @return [String]
+      def build_progress_message(details)
+        status = get_progress_status(details)
+        tests = details.dig(:progress, 'tests') || []
+        steps = tests.map { |test| test['steps'] }.compact.flatten
+        total_steps = details.dig(:progress, 'steps_total')
+        current_step_index = steps.index { |step| step['running'] }
+
+        if current_step_index
+          # read step and crawled pages details
+          step = steps[current_step_index]
+          is_coverage_step = step['actions_total'] > 1
+          coverage_step_details = " (#{step['actions_completed']}/#{step['actions_total']} pages)"
+
+          message = %{
+            test_run_id=#{details[:options]['test_run_id']}
+            step=#{current_step_index + 1}#{is_coverage_step ? coverage_step_details : ''}
+            total_steps=#{total_steps}
+            result=#{status}
+          }
+        else
+          message = %{
+            test_run_id=#{details[:options]['test_run_id']}
+            result=#{status}
+          }
+        end
+
+        message.gsub(/\s+/, ' ').strip
+      end
+    end
+
     attr_reader :job_id, :title, :progress
     attr_accessor :polling_timeout, :polling_interval
 

data/lib/datatrue_client/version.rb

@@ -1,3 +1,3 @@
 module DatatrueClient
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,103 +1,103 @@
 --- !ruby/object:Gem::Specification
 name: datatrue_client
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Ziyu Wang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.2
 description: This ruby client allows you to trigger DataTrue tests from a Continuous
@@ -111,9 +111,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -137,17 +138,17 @@ 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.0.14.1
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for DataTrue REST API.