fastlane-plugin-dynatrace 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d33abfce5cb589461d864dbb9dd94561b35d4c70079456144c2b15a71b23493
-  data.tar.gz: 41e48c8dc20f1258efd8ec0e0fa24768eba1b2ab344c103ec85abc4192c4f151
+  metadata.gz: 920b0c5553ebb02953f85441f6ab8a4bba712003435f354e3f11458c0c23f7f9
+  data.tar.gz: 64d293694d00bd694df462fbd5ee5e16ed12359c93e18817e9bf9fe8a92f9c5d
 SHA512:
-  metadata.gz: 335db4d66fedc928e82ed2aa3e1394ef0c6cea0010cd8d601417bbf4b55980e6ba654c9392edfd67aca67d67eceb98d09cc6092212af8ecf79e6039f904f0a0c
-  data.tar.gz: c4f8d63463b4edf3c5c50724784372f403d2d2ea35d7da7f3af4278631d0010a14a904bec8a0ceefcbdd4ddf41e1bf709557ca902a3f1e3cb4fa03070610719a
+  metadata.gz: 9be84816a06cf7df02d04d625c7b982e317a7b23a62f839de9cb1600c18ea08779c7f5d23d71de5cf802d507240c7826c61dd4daa07dd939f6e41cad9ad656ac
+  data.tar.gz: d452461f103ff34d7b290cd5a1bd3f4e988c01956779707cc5166572665101c817a3f880865d5ead209a547864b3a2e894875aa93e03cccdb4c3010748e560f4

data/README.md

@@ -100,7 +100,7 @@ The full documentation for this can be found on the [fastlane docs](https://docs
 
 You can generate a session by running `fastlane spaceauth -u user@email.com` on your machine and copy the output into an environment variable `FASTLANE_SESSION` on the target system (e.g. CI).
 
-###NOTE
+### NOTE
 - Session is only valid in the "region" you create it. If you CI is in a different geographical location the authentication might fail.
 
 - Generated sessions are valid up to one month. Apple's API doesn't specify details about that, so it will only be visible by a failing build.
@@ -108,6 +108,9 @@ You can generate a session by running `fastlane spaceauth -u user@email.com` on
 ## Example
 Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
 
+## Tests
+This plugin includes a set of RSpec unit tests, which can be executed by running ` bundle exec rspec spec`.
+
 ## Issues and Feedback
 For any other issues and feedback about this plugin, please submit it to this repository or contact [Dynatrace Support](https://support.dynatrace.com).
 

data/lib/fastlane/plugin/dynatrace/actions/dynatrace_action.rb

@@ -2,7 +2,9 @@ require 'fastlane/action'
 require 'net/http'
 require 'open-uri'
 require 'zip'
-require "fileutils"
+require 'fileutils'
+require 'os'
+require 'json'
 require_relative '../helper/dynatrace_helper'
 
 module Fastlane
@@ -26,64 +28,87 @@ module Fastlane
           UI.message "BundleID: #{bundleId}"
         end
 
+        if params[:os] == "android"
+          response = Helper::DynatraceHelper.put_android_symbols(params, bundleId)
+          case response.code
+            when '204'
+              UI.success "Successfully uploaded the mapping file (#{params[:symbolsfile]}) to Dynatrace."
+            when '400'
+              UI.user_error! "Failed to upload. The input is invalid."
+            when '401'
+              UI.user_error! "Invalid Dynatrace API token. See https://www.dynatrace.com/support/help/dynatrace-api/basics/dynatrace-api-authentication/#token-permissions and https://www.dynatrace.com/support/help/dynatrace-api/configuration-api/mobile-symbolication-api/"
+            when '413'
+              UI.user_error! "Failed to upload. The symbol file storage quota is exhausted. See https://www.dynatrace.com/support/help/shortlink/mobile-symbolication#manage-the-uploaded-symbol-files for more information."
+            else
+              message = JSON.parse(response.body)["error"]["message"]
+              if message.nil?
+                UI.user_error! "Symbol upload error (Response Code: #{response.code}). Please try again in a few minutes or contact the Dynatrace support (https://www.dynatrace.com/services-support/)." 
+              else
+                UI.user_error! "Symbol upload error (Response Code: #{response.code}). #{message}" 
+              end
+          end
+          return
+        elsif params[:os] != "ios"
+          UI.user_error! "Unsopported value os=#{params[:os]}"
+        end
+
+        # iOS workflow
         dtxDssClientPath = Helper::DynatraceHelper.get_dss_client(params)
 
         dsym_paths = []
         symbolFilesKey = "symbolsfile" # default to iOS
 
-        if params[:os] == "ios"
-          if params[:downloadDsyms] == true         
-            UI.message "Downloading dSYMs from App Store Connect"
-            startTime = Time.now
+        if !OS.mac?
+          UI.user_error! "A macOS machine is required to process iOS symbols."
+        end
 
-            UI.message "Checking AppFile for possible username/AppleID" 
-            username = CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)
-            if username
-              UI.message "Using #{username} from your AppFile" 
-            else
-              username = params[:username]
-              UI.message "Didn't find a username in AppFile, using passed username parameter: #{params[:username]}"
-            end
+        if params[:downloadDsyms] == true         
+          UI.message "Downloading dSYMs from App Store Connect"
+          startTime = Time.now
 
-            # it takes a couple of minutes until the new build is available through the API
-            #  -> retry until available
-            while params[:waitForDsymProcessing] and # wait is active
-                  !lane_context[SharedValues::DSYM_PATHS] and # has dsym path
-                  (Time.now - startTime) < params[:waitForDsymProcessingTimeout] # is in time
-
-              Actions::DownloadDsymsAction.run(wait_for_dsym_processing: params[:waitForDsymProcessing],
-                                              wait_timeout: (params[:waitForDsymProcessingTimeout] - (Time.now - startTime)).round(0), # remaining timeout
-                                              app_identifier: bundleId,
-                                              username: username,
-                                              version: params[:version],
-                                              build_number: params[:versionStr],
-                                              platform: :ios) # should be optional (Hint: it's not)
-
-              if !lane_context[SharedValues::DSYM_PATHS] and (Time.now - startTime) < params[:waitForDsymProcessingTimeout]
-                UI.message "Version #{params[:version]} (Build #{params[:versionStr]}) isn't listed yet, retrying in 60 seconds (timeout in #{(params[:waitForDsymProcessingTimeout] - (Time.now - startTime)).round(0)} seconds)."
-                sleep(60)
-              end
-            end
+          UI.message "Checking AppFile for possible username/AppleID" 
+          username = CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)
+          if username
+            UI.message "Using #{username} from your AppFile" 
+          else
+            username = params[:username]
+            UI.message "Didn't find a username in AppFile, using passed username parameter: #{params[:username]}"
+          end
 
-            if (Time.now - startTime) > params[:waitForDsymProcessingTimeout]
-              UI.user_error!("Timeout during dSYM download. Try increasing :waitForDsymProcessingTimeout.")
+          # it takes a couple of minutes until the new build is available through the API
+          #  -> retry until available
+          while params[:waitForDsymProcessing] and # wait is active
+                !lane_context[SharedValues::DSYM_PATHS] and # has dsym path
+                (Time.now - startTime) < params[:waitForDsymProcessingTimeout] # is in time
+
+            Actions::DownloadDsymsAction.run(wait_for_dsym_processing: params[:waitForDsymProcessing],
+                                            wait_timeout: (params[:waitForDsymProcessingTimeout] - (Time.now - startTime)).round(0), # remaining timeout
+                                            app_identifier: bundleId,
+                                            username: username,
+                                            version: params[:version],
+                                            build_number: params[:versionStr],
+                                            platform: :ios) # should be optional (Hint: it's not)
+
+            if !lane_context[SharedValues::DSYM_PATHS] and (Time.now - startTime) < params[:waitForDsymProcessingTimeout]
+              UI.message "Version #{params[:version]} (Build #{params[:versionStr]}) isn't listed yet, retrying in 60 seconds (timeout in #{(params[:waitForDsymProcessingTimeout] - (Time.now - startTime)).round(0)} seconds)."
+              sleep(60)
             end
+          end
 
-            dsym_paths += Actions.lane_context[SharedValues::DSYM_PATHS] if Actions.lane_context[SharedValues::DSYM_PATHS]
+          if (Time.now - startTime) > params[:waitForDsymProcessingTimeout]
+            UI.user_error!("Timeout during dSYM download. Try increasing :waitForDsymProcessingTimeout.")
+          end
 
-            if dsym_paths.count > 0
-              UI.message "Downloaded the dSYMs from App Store Connect. Paths: #{dsym_paths}"
-            else
-              raise 'No dSYM paths found!'
-            end
+          dsym_paths += Actions.lane_context[SharedValues::DSYM_PATHS] if Actions.lane_context[SharedValues::DSYM_PATHS]
+
+          if dsym_paths.count > 0
+            UI.message "Downloaded the dSYMs from App Store Connect. Paths: #{dsym_paths}"
           else
-            UI.error "dSYM download disabled, using local path (#{params[:symbolsfile]})"
-            dsym_paths << params[:symbolsfile] if params[:symbolsfile]
+            raise 'No dSYM paths found!'
           end
-
-        else # android
-           dsym_paths << params[:symbolsfile] if params[:symbolsfile]
-           symbolFilesKey = "file"
+        else
+          UI.important "dSYM download disabled, using local path (#{params[:symbolsfile]})"
+          dsym_paths << params[:symbolsfile] if params[:symbolsfile]
         end
 
         # check if we have dSYMs to proceed with
@@ -106,7 +131,7 @@ module Fastlane
         command << "versionStr=\"#{params[:versionStr]}\""
         command << "version=\"#{params[:version]}\""
         command << symbolFilesCommandSnippet
-        command << "server=\"#{Helper::DynatraceHelper.get_server_base_url(params)}\""
+        command << "server=\"#{Helper::DynatraceHelper.get_base_url(params)}\""
         command << "DTXLogLevel=ALL -verbose" if params[:debugMode] == true
         command << "forced=1" # if the file already exists
 

data/lib/fastlane/plugin/dynatrace/helper/dynatrace_helper.rb

@@ -1,4 +1,8 @@
 require 'fastlane_core/ui/ui'
+require 'digest'
+require 'net/http'
+require 'tempfile'
+require 'uri'
 
 module Fastlane
   UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
@@ -7,69 +11,166 @@ module Fastlane
     class DynatraceHelper
       def self.get_dss_client(params)
         dynatraceDir = "dynatrace"
-        versionFile = "version"
         dtxDssClientBin = "DTXDssClient"
+        versionFilePath = "#{dynatraceDir}/version"
         dtxDssClientPath = "#{dynatraceDir}/#{dtxDssClientBin}"
 
-        if (params.all_keys.include? :dtxDssClientPath and not params[:dtxDssClientPath].nil?)
-          UI.message "DEPRECATION WARNING: DTXDssClientPath doesn't need to be specified anymore, the DTXDssClient is downloaded and updated automatically."
-          dtxDssClientPath = params[:dtxDssClientPath]
-        else
-          # get latest version info
-          clientUri = URI("#{self.get_server_base_url(params)}/api/config/v1/symfiles/dtxdss-download?Api-Token=#{params[:apitoken]}")
-          response = Net::HTTP.get_response(clientUri)
-
-          if not response.kind_of? Net::HTTPSuccess
-            base_error = "Couldn't update DTXDssClient (invalid response: #{response.message} (#{response.code})) for URL: #{clientUri})"
-            if File.exists?("#{dynatraceDir}/#{dtxDssClientBin}")
-              UI.important base_error
-              UI.important "Using cached DTXDssClient: #{dynatraceDir}/#{dtxDssClientBin}"
-              return dtxDssClientPath
-            else
-              UI.user_error! base_error
-            end
-          end
+        if params.all_keys.include? :dtxDssClientPath and not params[:dtxDssClientPath].nil?
+          UI.important "DEPRECATION WARNING: dtxDssClientPath doesn't need to be specified anymore, the #{dtxDssClientBin} is downloaded and updated automatically."
+          return params[:dtxDssClientPath]
+        end
 
-          remoteClientUrl = JSON.parse(response.body)["dssClientUrl"]
-          UI.message "Remote DSS client: #{remoteClientUrl}"
+        # get latest version info
+        clientUri = URI("#{self.get_base_url(params)}/api/config/v1/symfiles/dtxdss-download?Api-Token=#{params[:apitoken]}")
+        response = Net::HTTP.get_response(clientUri)
 
-          # check local state
-          if (!File.directory?(dynatraceDir))
-            Dir.mkdir(dynatraceDir) 
+        # filter any http errors
+        if not response.kind_of? Net::HTTPSuccess
+          error_msg = "Couldn't update #{dtxDssClientBin} (invalid response: #{response.message} (#{response.code})) for URL: #{self.to_redacted_api_token_string(clientUri)})"
+          self.check_fallback_or_raise(dtxDssClientPath, error_msg)
+          return dtxDssClientPath
+        end
+
+        # parse body
+        begin
+          responseJson = JSON.parse(response.body)
+        rescue JSON::GeneratorError, 
+               JSON::JSONError, 
+               JSON::NestingError, 
+               JSON::ParserError
+          error_msg = "Error parsing response body: #{response.body} from URL (#{self.to_redacted_api_token_string(clientUri)}), failed with error #{$!}"
+          self.check_fallback_or_raise(dtxDssClientPath, error_msg)
+          return dtxDssClientPath
+        end
+
+        # parse url
+        remoteClientUrl = responseJson["dssClientUrl"]
+        if remoteClientUrl.nil? or remoteClientUrl.empty?
+          error_msg = "No value for dssClientUrl in response body (#{response.body})."
+          self.check_fallback_or_raise(dtxDssClientPath, error_msg)
+          return dtxDssClientPath
+        end
+        UI.message "Remote DSS client: #{remoteClientUrl}"
+
+        # check/update local state
+        if !File.directory?(dynatraceDir)
+          Dir.mkdir(dynatraceDir) 
+        end
+
+        # only update if a file is missing or the local version is different
+        if !(File.exists?(versionFilePath) and
+           File.exists?(dtxDssClientPath) and 
+           File.read(versionFilePath) == remoteClientUrl and
+           File.size(dtxDssClientPath) > 0)
+          updatedClient = false
+
+          # extract and save client
+          zipped_tmp = self.save_to_tempfile(remoteClientUrl)
+          if File.size(zipped_tmp) <= 0
+            error_msg = "Downloaded symbolication client archive is empty (0 bytes)."
+            self.check_fallback_or_raise(dtxDssClientPath, error_msg)
+            return dtxDssClientPath
           end
 
-          if (!File.exists?("#{dynatraceDir}/#{versionFile}") or
-              !File.exists?("#{dynatraceDir}/#{dtxDssClientBin}") or 
-              File.read("#{dynatraceDir}/#{versionFile}") != remoteClientUrl)
-            # update local state
-            UI.message "Found a different remote DTXDssClient client. Updating local version."
-            File.delete("#{dynatraceDir}/#{versionFile}") if File.exist?("#{dynatraceDir}/#{versionFile}")
-            File.delete("#{dynatraceDir}/#{dtxDssClientBin}") if File.exist?("#{dynatraceDir}/#{dtxDssClientBin}")
-
-            File.write("#{dynatraceDir}/#{versionFile}", remoteClientUrl)
-
-            # get client from served archive
-            open(remoteClientUrl) do |zipped|
-              Zip::InputStream.open(zipped) do |unzipped|
-                entry = unzipped.get_next_entry
-                if (entry.name == dtxDssClientBin)
-                  IO.copy_stream(entry.get_input_stream, "#{dynatraceDir}/#{dtxDssClientBin}")
-                  FileUtils.chmod("+x", "#{dynatraceDir}/#{dtxDssClientBin}")
-                end
+          begin
+            UI.message "Unzipping fetched file with MD5 hash: #{Digest::MD5.new << IO.read(zipped_tmp)}"
+            Zip::InputStream.open(zipped_tmp) do |unzipped|
+              entry = unzipped.get_next_entry
+              if (entry.name == dtxDssClientBin)
+                # remove old client
+                UI.message "Found a different remote #{dtxDssClientBin} client. Removing local version and updating."
+                File.delete(versionFilePath) if File.exist?(versionFilePath)
+                File.delete(dtxDssClientPath) if File.exist?(dtxDssClientPath)
+
+                # write new client
+                File.write(versionFilePath, remoteClientUrl)
+                IO.copy_stream(entry.get_input_stream, dtxDssClientPath)
+                FileUtils.chmod("+x", dtxDssClientPath)
+                updatedClient = true
               end
             end
+          rescue Zip::DecompressionError, 
+                 Zip::DestinationFileExistsError, 
+                 Zip::EntryExistsError, 
+                 Zip::EntryNameError, 
+                 Zip::EntrySizeError, 
+                 Zip::GPFBit3Error, 
+                 Zip::InternalError,
+                 Zip::CompressionMethodError 
+            error_msg = "Could not update/extract #{dtxDssClientBin}, please try again."
+            self.check_fallback_or_raise(dtxDssClientPath, error_msg)
+            return dtxDssClientPath
+          end
+
+          if updatedClient
+            UI.success "Successfully updated DTXDssClient."
+          else
+            error_msg = "#{dtxDssClientBin} not found in served archive, please try again."
+            self.check_fallback_or_raise(dtxDssClientPath, error_msg)
+            return dtxDssClientPath
           end
         end
         return dtxDssClientPath
       end
 
-      def self.get_server_base_url(params)
-        if params[:server][-1] == '/'
-          return params[:server][0..-2]
+      def self.get_base_url(params)
+        uri = URI.split(params[:server])
+        return uri[0] + '://' + uri[2]
+      end
+
+      def self.get_host_name(params)
+        uri = URI.split(params[:server])
+
+        unless uri[2].nil?
+          return uri[2]
+        end
+
+        # no procotol prefix -> host name is with path
+        if uri[5][-1] == '/'
+          return uri[5][0..-2] # remove trailing /
+        else
+          return uri[5]
+        end
+      end
+
+      def self.put_android_symbols(params, bundleId)
+        path = "/api/config/v1/symfiles/#{params[:appId]}/#{bundleId}/ANDROID/#{params[:version]}/#{params[:versionStr]}"
+
+        req = Net::HTTP::Put.new(path, initheader = { 'Content-Type' => 'text/plain',
+                                                      'Authorization' => "Api-Token #{params[:apitoken]}"} )
+
+        req.body = IO.read(params[:symbolsfile])
+        http = Net::HTTP.new(self.get_host_name(params), 443)
+        http.use_ssl = true
+        http.request(req)
+      end
+
+      private
+      def self.check_fallback_or_raise(fallback_client, error)
+        UI.important "If this error persists create an issue on our Github project (https://github.com/Dynatrace/fastlane-plugin-dynatrace/issues) or contact our support at https://www.dynatrace.com/support/contact-support/."
+        UI.important error
+        if File.exists?(fallback_client) and File.size(fallback_client) > 0
+          UI.important "Using cached client: #{fallback_client}"
         else
-          return params[:server]
+          UI.important "No cached fallback found."
+          raise error
         end
       end
+
+      # assumes the token parameter is appended last (there is only one parameter anyway)
+      def self.to_redacted_api_token_string(url)
+        urlStr = url.to_s
+        str = "Api-Token="
+        idx = urlStr.index(str)
+        token_len = urlStr.length - idx - str.length
+        urlStr[idx + str.length..idx + str.length + token_len] = "-" * token_len
+        return urlStr
+      end
+
+      # for test mocking
+      def self.save_to_tempfile(url)
+        open(url)
+      end
     end
   end
 end

data/lib/fastlane/plugin/dynatrace/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module Dynatrace
-    VERSION = "1.0.1"
+    VERSION = "1.0.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-dynatrace
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Dynatrace LLC
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -167,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: This action processes and uploads your symbol files to Dynatrace