ci_toolkit 1.5.16 → 1.5.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bd3020f481c44b5a3aa5338f2642db5ad6616ed580be930532182e83ef4f434
-  data.tar.gz: 5bddb92459c6e5e9219e5fb2ddaf5d9c07a62674396b776d37e6b0e3769ceb85
+  metadata.gz: 186f7a74ac19e0ff178758e757620f8c489bfbf0c93f815d999fd1eec6710344
+  data.tar.gz: fabfee8fc42a0d0dc016ca34ca1a24a43c9b620b525bf34429f935fb9830ed95
 SHA512:
-  metadata.gz: d45f01faa0ecd50030c092e9bbe373bdbf78c22c74c7f95d2f54ddc9448839683598b0445654d491e48a469dd73712b4898fdc9771d7f3da4d38d97a9d88b298
-  data.tar.gz: 3b75f18b57b521e91f235e4efe280c9c5ca77cbe968b08984eca33d16eb3d21a098495f4eef688b2806d1999eec0abe603f57700ca6178687f88400486bd08cb
+  metadata.gz: d45d3bfd1604ef09b32f56336b1917b8738fd2e6ebef06da5d29f82ff5b3f8f26e52dadf238d3aa552a13d9a746363d9e0256934efc66c479c3b648bcb1149b9
+  data.tar.gz: d9801923984198b34ec572e9b103079693c3f1701fd331453e66f6abb09e62f8ab0d59a6e25104d87921f4041471f86cfa4b4d2d50fc2ed7ab3f77921c233f86

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    ci_toolkit (1.5.16)
+    ci_toolkit (1.5.17)
       faraday
+      faraday-multipart
       faraday_middleware
       gitlab
       jwt
@@ -34,6 +35,8 @@ GEM
     faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
     faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)

data/lib/ci_toolkit/seetest_bot.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "gitlab"
+
+module CiToolkit
+  # Utility class that provides an instance of a Gitlab Client
+  class SeeTestBot
+    attr_reader :faraday_conn
+
+    # Provides a base url, an endpoint and an access token that can be used to
+    # interact with the SeeTest web service
+    class Credentials
+      attr_reader :base_url, :access_token
+
+      def initialize(
+        base_url = ENV["SEETEST_BASE_URL"],
+        access_token = ENV["SEETEST_ACCESS_TOKEN"]
+      )
+        @base_url = base_url
+        @access_token = access_token
+      end
+    end
+
+    def initialize(
+      credentials = CiToolkit::SeeTestBot::Credentials.new,
+      faraday_conn = Faraday.new(url: credentials.base_url) do |f|
+        f.request :authorization, "Bearer", credentials.access_token
+        f.request :multipart
+        f.request :url_encoded
+        f.adapter :net_http # A MUST for file upload to work with Faraday::Multipart::FilePart
+      end
+    )
+      @faraday_conn = faraday_conn
+    end
+  end
+end

data/lib/ci_toolkit/seetest_upload.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday/net_http"
+require "faraday/multipart"
+
+module CiToolkit
+  # Can be used to upload files to Seetest.
+  # See API doc for more info: https://docs.experitest.com/display/PM/How+To+Execute+Rest+API
+  # rubocop:disable Metrics/ClassLength
+  class SeeTestUpload
+    SUCCESS = "SUCCESS"
+    BAD_REQUEST = "BAD_REQUEST"
+    OKAY = "OK"
+    ERROR = "ERROR"
+
+    def initialize(
+      bot = CiToolkit::SeeTestBot.new
+    )
+      @bot = bot
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
+    def upload_file(
+      project_name:,
+      unique_name:,
+      full_path_to_file:,
+      content_type: "application/octet-stream"
+    )
+      uploaded = ""
+
+      response = faraday_upload(
+        project_name,
+        unique_name,
+        full_path_to_file,
+        content_type
+      )
+      response_obj = get_response_body(response.body)
+
+      # Application with unique name already exist. Replace it
+      if response_obj.status == SUCCESS && response_obj.data.created == "false"
+        uploaded = replace_existing_application(
+          response_obj.data.id,
+          project_name,
+          unique_name,
+          full_path_to_file,
+          content_type
+        )
+      elsif response_obj.status == ERROR && response_obj.data?.uniqueName.empty?
+        application_info_response = faraday_get_application_info(unique_name)
+        application_id = application_info_response[0].id
+        uploaded = replace_existing_application(
+          application_id,
+          project_name,
+          unique_name,
+          full_path_to_file,
+          content_type
+        )
+      else
+        uploaded = response_obj
+      end
+      uploaded.status
+    end
+    # rubocop:enable Metrics/AbcSize Metrics/MethodLength
+    # rubocop:enable Metrics/MethodLength
+
+    private
+
+    def replace_existing_application(
+      application_id,
+      project_name,
+      unique_name,
+      full_path_to_file,
+      content_type
+    )
+      faraday_delete_application(application_id)
+      faraday_upload_file_with_error_handling(project_name, unique_name, full_path_to_file, content_type)
+    end
+
+    def faraday_upload_file_with_error_handling(
+      project_name,
+      unique_name,
+      full_path_to_file,
+      content_type
+    )
+      response = faraday_upload(project_name, unique_name, full_path_to_file, content_type)
+
+      body_obj = get_response_body(response.body)
+      unless body_obj.status == SUCCESS && body_obj.data.created == "true"
+        raise StandardError, "Upload response from Seetest returned an error. Response body is: '#{response.body}'"
+      end
+
+      body_obj
+    end
+
+    def faraday_upload(
+      project_name,
+      unique_name,
+      full_path_to_file,
+      content_type
+    )
+      file = Faraday::Multipart::FilePart.new(full_path_to_file, content_type)
+      params = {
+        file: file,
+        uniqueName: unique_name,
+        project: project_name
+      }
+      @bot.faraday_conn.post("/api/v1/applications/new", params)
+    end
+
+    def faraday_get_application_info(unique_name)
+      params = { uniqueName: unique_name }
+      response = @bot.faraday_conn.get("/api/v1/applications", params)
+      response_obj = get_response_body(response.body)
+      if response_obj.empty?
+        raise StandardError,
+              "Get application info for uniqueName: #{unique_name} from Seetest returned an error. "\
+              "Response body is: '#{response.body}'"
+      end
+
+      response_obj
+    end
+
+    def faraday_delete_application(application_id)
+      response = @bot.faraday_conn.post("/api/v1/applications/#{application_id}/delete")
+
+      response_obj = get_response_body(response.body)
+
+      unless  response_obj.status == SUCCESS && response_obj.code == OKAY
+        raise StandardError,
+              "Delete application id: #{application_id} from Seetest returned an error. "\
+              "Response body is: '#{response.body}'"
+      end
+
+      response_obj
+    end
+
+    def get_response_body(response)
+      JSON.parse(response, object_class: OpenStruct)
+    end
+  end
+  # rubocop:enable Metrics/ClassLength
+end

data/lib/ci_toolkit.rb

@@ -10,6 +10,8 @@ require "ci_toolkit/github_pr"
 require "ci_toolkit/gitlab_bot"
 require "ci_toolkit/gitlab_pr"
 require "ci_toolkit/gitlab_release"
+require "ci_toolkit/seetest_bot"
+require "ci_toolkit/seetest_upload"
 require "ci_toolkit/dvcs_pr_factory"
 require "ci_toolkit/git"
 require "ci_toolkit/jira"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ci_toolkit
 version: !ruby/object:Gem::Version
-  version: 1.5.16
+  version: 1.5.17
 platform: ruby
 authors:
 - Gero Keller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-04 00:00:00.000000000 Z
+date: 2022-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: gitlab
   requirement: !ruby/object:Gem::Requirement
@@ -233,6 +247,8 @@ files:
 - lib/ci_toolkit/jira.rb
 - lib/ci_toolkit/pr_messenger.rb
 - lib/ci_toolkit/pr_messenger_text.rb
+- lib/ci_toolkit/seetest_bot.rb
+- lib/ci_toolkit/seetest_upload.rb
 - transform_coverage_data.rb
 homepage: https://github.com/crvshlab/ci_toolkit
 licenses: