fastlane-plugin-dynatrace 1.0.6 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f695a0a113199724b6440168cc2a62ffbd531cde63a5aaf5ac721614831010b8
-  data.tar.gz: d84839f594a4bbc69b73fcdcab2e8883ca6fd059999ac20097ae485f86fec6b7
+  metadata.gz: 1bdb472eb2918d5953d9fdddcce1ae84a4ecd27b71519237f26de179a741841b
+  data.tar.gz: 2fe8fab3e1187ab2b2b1ce32c629a8f7a4b55452a418605749c5c083d306e62b
 SHA512:
-  metadata.gz: ec8631c08720d264f90067ec7c4008d4748e4bbffa6ad3db6507f05afdbbb6f627fb8e808228721d03ae494391c74490d60a58b2aeac89dd6536ffea916dda96
-  data.tar.gz: c38a6198cb709b0869392cf2b7179e83fcbdc0c81ab7dd68306bfb0c972a3a051ad47d5ec3aaf2c82b5043bd0f49c580ec401b64dd39eb5cac5baf5d38b99f8c
+  metadata.gz: 32d4130da7d003f7a1a2a75c7947f4e844f5bbe9a17cd642a4af238635b8d7c0dcbc92cbe22e8eedb13a21ee53a14c73d99d918c8a07deec7b25706488875a3d
+  data.tar.gz: 8715c0bb53db8021da3707aac6775f4b64bbd1bfd57a9c2fbbf0b73ae4ec634aa8fd2ed4a9ac678192fae696465e0dbc9e8375d2ac2ed3fca8a459be58b2e713

data/README.md

@@ -10,8 +10,6 @@ This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To
 fastlane add_plugin dynatrace
 ```
 
-⚠️  The way Apple introduced the two-factor authentication interferes with a fully automated workflow. The workaround requires manual interaction. For more information, see **App Store Connect Two-Factor-Authentication** section below for details.
-
 ## About the Dynatrace fastlane plugin
 The Dynatrace fastlane plugin manages uploading symbol files (iOS, tvOS) or obfuscation mapping files (Android) to the Dynatrace cluster. Symbol and mapping files are used to make reported stack traces human-readable. The plugin also allows to download the latest dSYM files from App Store Connect, which enables full automation of the mobile app deployment, and the pre-processing of dSYM files, a step that is necessary for the Dynatrace cluster to be able to symbolicate.
 
@@ -38,22 +36,13 @@ Background: If your app is Bitcode-enabled, then the dSYMs that are generated du
 
 ### Automatically downloading dSYMs
 
-To fully automate the following five-step workflow, add the snippets below to the respective files and fill in the placeholders. Uploading the app the App Store Connect is a necessary prerequisite and either handled manually or by fastlane directly:
+To fully automate the following five-step workflow, add the snippets below to the respective files and fill in the placeholders. Uploading the app to App Store Connect is a necessary prerequisite and either handled manually or by fastlane directly:
 
 1. Wait until the build is processed
 2. Download the resulting dSYM files
 3. Process dSYM files into the format that Dynatrace requires
 4. Upload processed dSYM files to Dynatrace
 
-
-#### AppFile
-Make sure the following information is present in `AppFile` to authenticate with App Store Connect.
-
-```ruby
-app_identifier("com.yourcompany.yourappID") # bundle identifier of your app
-apple_id("user@email.com")
-```
-
 #### Fastfile
 ```ruby
 dynatrace_process_symbols(
@@ -113,14 +102,12 @@ dynatrace_process_symbols(
 | versionStr                   | The CFBundleShortVersionString (iOS, tvOS) / versionName (Android)                                                                                                          |                |
 | version                      | The CFBundleVersion (iOS, tvOS) / versionCode (Android). Is also used for the dSYM download.                                                                                |                |
 | symbolsfile                  | Path to the dSYM file to be processed. If downloadDsyms is set, this is only a fallback.                                                                              |                |
+| symbolsfileAutoZip           | *(Android only)* Automatically zip symbolsfile if it exceeds 10MiB and doesn't already end with `*.zip`.                                                                              | `true` |
 | server                       | The API endpoint for the Dynatrace environment (e.g. `https://environmentID.live.dynatrace.com` or `https://dynatrace-managed.com/e/environmentID`).                  |                |
-| cleanBuildArtifacts | Clean build artifacts after processing.                                                                                         | `true`         |
+| cleanBuildArtifacts          | Clean build artifacts after processing.                                                                                         | `true`         |
+| tempdir                      | (OPTIONAL) Custom temporary directory for the DTXDssClient. **The plugin does not take care of cleaning this directory.**                                                                                         |                |
 | debugMode                    | Enable debug logging.                                                                                                                                                 | false          |
 
-## App Store Connect Two-Factor-Authentication
-When the plugin is used to download symbols from *App Store Connect* automatically (`downloadDsyms: true`),  valid App Store Connect credentials with access to the dSYM files are required. The preferred method of doing so is by setting the `FASTLANE_USER` and `FASTLANE_PASSWORD` environment variables to their respective values.
-
-Apple started enforcing 2-Factor-Authentication for the *App Store Connect* API in February 2021. This [limits the ability to automate the symbol processing](https://github.com/fastlane/fastlane/discussions/17655), because it will most likely involve manual interaction, which is not suitable for CI automation. The only workaround at this point in time is to pre-generate a session and cache it in CI.
 
 ### Fastlane Session
 The full documentation for this can be found on the [fastlane docs](https://docs.fastlane.tools/best-practices/continuous-integration/#two-step-or-two-factor-auth

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

@@ -18,6 +18,7 @@ module Fastlane
         UI.message "Version string: #{params[:versionStr]}"
         UI.message "Version: #{params[:version]}"
         UI.message "Server URL: #{params[:server]}"
+        UI.message "Tempdir: #{params[:tempdir]}"
 
         UI.message "Checking AppFile for possible AppID"
         bundleId = CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier)
@@ -29,16 +30,17 @@ module Fastlane
         end
 
         if params[:os] == "android"
-          response = Helper::DynatraceHelper.put_android_symbols(params, bundleId)
+          symbols_path = Helper::DynatraceHelper.zip_if_required(params)
+          response, request = Helper::DynatraceHelper.put_android_symbols(params, bundleId, symbols_path)
           case response.code
             when '204'
-              UI.success "Successfully uploaded the mapping file (#{params[:symbolsfile]}) to Dynatrace."
+              UI.success "Success. The file has been uploaded and stored."
             when '400'
-              UI.user_error! "Failed to upload. The input is invalid."
+              UI.user_error! "Failed. 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."
+              UI.user_error! "Failed. 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 = nil
               unless response.body.nil?
@@ -137,6 +139,7 @@ module Fastlane
         command << "server=\"#{Helper::DynatraceHelper.without_trailing_slash(params[:server])}\""
         command << "DTXLogLevel=ALL -verbose" if params[:debugMode] == true
         command << "forced=1" # if the file already exists
+        command << "tempdir=\"#{params[:tempdir]}\"" if params[:tempdir]
 
         # Create the full shell command to trigger the DTXDssClient
         shell_command = command.join(' ')
@@ -256,11 +259,17 @@ module Fastlane
 
           FastlaneCore::ConfigItem.new(key: :symbolsfile,
                                        env_name: "FL_UPLOAD_TO_DYNATRACE_SYM_FILE_PATH",
-                                       description: "Path to the dSYM file to be processed. Is only used when downloadDsyms is not set",
+                                       description: "Path to the dSYM file to be processed. Is only used when downloadDsyms is not set. Android only: If the file exceeds 10MiB and doesn't end with *.zip it's zipped before uploading. This can be disabled by setting `symbolsfileAutoZip` to false",
                                        verify_block: proc do |value|
                                           UI.user_error!("Please provide a value for the symbol files. Pass using `symbolsfile: 'symbolsfile'`") unless (value and not value.empty?)
                                       end),
 
+          FastlaneCore::ConfigItem.new(key: :symbolsfileAutoZip,
+                                       env_name: "FL_UPLOAD_TO_DYNATRACE_SYM_FILE_AUTO_ZIP",
+                                       default_value: true,
+                                       is_string: false,
+                                       description: "(Android only) Automatically zip symbolsfile if it exceeds 10MiB and doesn't already end with *.zip"),
+
           FastlaneCore::ConfigItem.new(key: :server,
                                        env_name: "FL_UPLOAD_TO_DYNATRACE_SERVER_URL",
                                        description: "The API endpoint for the Dynatrace environment (e.g. https://environmentID.live.dynatrace.com or https://dynatrace-managed.com/e/environmentID)",
@@ -274,6 +283,11 @@ module Fastlane
                                        is_string: false,
                                        description: "Clean build artifacts after processing"),
 
+          FastlaneCore::ConfigItem.new(key: :tempdir,
+                                       env_name: "FL_UPLOAD_TO_DYNATRACE_TEMP_DIR",
+                                       description: "(OPTIONAL) Custom temporary directory for the DTXDssClient. The plugin does not take care of cleaning this directory",
+                                       optional: true),
+
           FastlaneCore::ConfigItem.new(key: :debugMode,
                                        env_name: "FL_UPLOAD_TO_DYNATRACE_DEBUG_MODE",
                                        description: "Enable debug logging",

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

@@ -3,6 +3,7 @@ require 'digest'
 require 'net/http'
 require 'tempfile'
 require 'open-uri'
+require 'zip'
 
 module Fastlane
   UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
@@ -136,7 +137,7 @@ module Fastlane
         end
       end
 
-      def self.put_android_symbols(params, bundleId)
+      def self.put_android_symbols(params, bundleId, symbolspath)
         path = "/api/config/v1/symfiles/#{params[:appId]}/#{bundleId}/ANDROID/#{params[:version]}/#{params[:versionStr]}"
 
         # if path points to dynatrace managed, we need to prepend the path component from the server (/e/{your-environment-id})
@@ -148,14 +149,46 @@ module Fastlane
           path = self.without_trailing_slash(uri[5]) + path
         end
 
+        is_symbolsfile_zip = symbolspath.end_with?(".zip")
 
-        req = Net::HTTP::Put.new(path, initheader = { 'Content-Type' => 'text/plain',
+        request = Net::HTTP::Put.new(path, initheader = { 'Content-Type' => is_symbolsfile_zip ? 'application/zip' : 'text/plain',
                                                       'Authorization' => "Api-Token #{params[:apitoken]}"} )
 
-        req.body = IO.read(params[:symbolsfile])
+        request.body = IO.read(symbolspath)
         http = Net::HTTP.new(self.get_host_name(params), 443)
         http.use_ssl = true
-        http.request(req)
+        response = http.request(request)
+
+        return [response, request]
+      end
+
+      def self.zip_if_required(params)
+        symbolsfile_path = params[:symbolsfile]
+
+        if !params[:symbolsfileAutoZip]
+          UI.message "Symbolsfile auto-zipping is disbled."
+          return symbolsfile_path
+        end
+
+        if symbolsfile_path.end_with?(".zip")
+          UI.message "Symbolsfile is already a zip."
+          return symbolsfile_path
+        end
+
+        if File.size(symbolsfile_path) > 10 * 1024 * 1024 # 10MiB
+          symbolsfile_path_zip = symbolsfile_path + ".zip"
+          UI.message "Symbolsfile exceeds 10MiB -> zipping to " + symbolsfile_path_zip
+
+          # replace any old file
+          FileUtils.rm_f(symbolsfile_path_zip)
+
+          Zip::File.open(symbolsfile_path_zip, create: true) do |zipfile|
+            zipfile.add(File.basename(symbolsfile_path), symbolsfile_path)
+          end
+          symbolsfile_path = symbolsfile_path_zip
+        end
+
+        return symbolsfile_path
       end
 
       private

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Dynatrace
-    VERSION = "1.0.6"
+    VERSION = "1.0.8"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-dynatrace
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.8
 platform: ruby
 authors:
 - Dynatrace LLC
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-08 00:00:00.000000000 Z
+date: 2023-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -136,6 +136,104 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.142.0
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  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: digest
+  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: net-http
+  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: tempfile
+  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: open-uri
+  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: os
+  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: json
+  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'
 description:
 email: mobile.agent@dynatrace.com
 executables: []
@@ -167,7 +265,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: This action processes and uploads your symbol files to Dynatrace