class Fastlane::Actions::DynatraceProcessSymbolsAction
Public Class Methods
available_options()
click to toggle source
# File lib/fastlane/plugin/dynatrace/actions/dynatrace_action.rb, line 173 def self.available_options [ FastlaneCore::ConfigItem.new(key: :action, env_name: "FL_UPLOAD_TO_DYNATRACE_ACTION", description: "(iOS only) Action to be performed by DTXDssClient (\"upload\" or \"decode\")", default_value: "upload", is_string: true, verify_block: proc do |value| UI.user_error!("Action needs to either be \"upload\" or \"decode\"") unless (value and value == "upload" or value == "decode") end), FastlaneCore::ConfigItem.new(key: :downloadDsyms, env_name: "FL_UPLOAD_TO_DYNATRACE_DOWNLOAD_DSYMS", default_value: false, is_string: false, description: "(iOS only) Download the dSYMs from App Store Connect"), FastlaneCore::ConfigItem.new(key: :waitForDsymProcessing, env_name: "FL_UPLOAD_TO_DYNATRACE_DOWNLOAD_DSYMS_WAIT_PROCESSING", default_value: true, is_string: false, description: "(iOS only) Wait for dSYM processing to be finished"), FastlaneCore::ConfigItem.new(key: :waitForDsymProcessingTimeout, env_name: "FL_UPLOAD_TO_DYNATRACE_DOWNLOAD_DSYMS_WAIT_TIMEOUT", default_value: 1800, is_string: false, description: "(iOS only) Timeout in seconds to wait for the dSYMs be downloadable"), FastlaneCore::ConfigItem.new(key: :username, env_name: "FL_UPLOAD_TO_DYNATRACE_DOWNLOAD_DSYMS_USERNAME", description: "(iOS only) The username/AppleID to use to download the dSYMs"), FastlaneCore::ConfigItem.new(key: :os, env_name: "FL_UPLOAD_TO_DYNATRACE_OS", description: "The type of the symbol files, either \"ios\", \"tvos\" or \"android\"", sensitive: false, optional: false, verify_block: proc do |value| UI.user_error!("Please specify the type of the symbol files. Possible values are \"ios\", \"tvos\" or \"android\".") unless (value and not value.empty? and (value == "ios" || value == "tvos" || value =="android")) end), FastlaneCore::ConfigItem.new(key: :apitoken, env_name: "FL_UPLOAD_TO_DYNATRACE_apitoken", description: "Dynatrace API token with mobile symbolication permissions", verify_block: proc do |value| UI.user_error!("No Dynatrade API token for specified, pass using `apitoken: 'token'`") unless (value and not value.empty?) end), FastlaneCore::ConfigItem.new(key: :dtxDssClientPath, env_name: "FL_UPLOAD_TO_DYNATRACE_DTXDssClientPath", description: "(DEPRECATED) The path to your DTXDssClient. The DTXDssClient is downloaded and updated automatically, unless this key is set", optional: true), FastlaneCore::ConfigItem.new(key: :appId, env_name: "FL_UPLOAD_TO_DYNATRACE_APP_ID", description: "The app ID you get from your Dynatrace environment", verify_block: proc do |value| UI.user_error!("Please provide the appID for your application. Pass using `appId: 'appId'`") unless (value and not value.empty?) end), FastlaneCore::ConfigItem.new(key: :bundleId, env_name: "FL_UPLOAD_TO_DYNATRACE_BUNDLE_ID", description: "The CFBundlebundleId (iOS) / package (Android) of the application", verify_block: proc do |value| UI.user_error!("Please provide the BundleID for your app. Pass using `bundleId: 'bundleId'`") unless (value and not value.empty?) end), FastlaneCore::ConfigItem.new(key: :versionStr, env_name: "FL_UPLOAD_TO_DYNATRACE_VERSION_STRING", description: "The CFBundleShortVersionString (iOS) / versionName (Android)", verify_block: proc do |value| UI.user_error!("Please provide the CFBundleShortVersionString for your app. Pass using `versionStr: 'versionStr'`") unless (value and not value.empty?) end), FastlaneCore::ConfigItem.new(key: :version, env_name: "FL_UPLOAD_TO_DYNATRACE_VERSION", description: "The CFBundleVersion (iOS) / versionCode (Android). Is also used for the dSYM download", verify_block: proc do |value| UI.user_error!("Please provide the version for your app. Pass using `version: 'version'`") unless (value and not value.empty?) end), 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", 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: :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)", verify_block: proc do |value| UI.user_error!("Please provide your environment API endpoint. Pass using `server: 'server'`") unless (value and not value.empty?) end), FastlaneCore::ConfigItem.new(key: :debugMode, env_name: "FL_UPLOAD_TO_DYNATRACE_DEBUG_MODE", description: "Enable debug logging", default_value: false, is_string: false, optional: true) ] end
description()
click to toggle source
# File lib/fastlane/plugin/dynatrace/actions/dynatrace_action.rb, line 165 def self.description "This action processes and uploads your symbol files to Dynatrace." end
details()
click to toggle source
# File lib/fastlane/plugin/dynatrace/actions/dynatrace_action.rb, line 169 def self.details "This action allows you to process and upload symbol files to Dynatrace. If you use Bitcode you can also use it to download the latest dSYM files from App Store Connect." end
is_supported?(platform)
click to toggle source
# File lib/fastlane/plugin/dynatrace/actions/dynatrace_action.rb, line 282 def self.is_supported?(platform) [:ios, :android].include?(platform) end
run(params)
click to toggle source
# File lib/fastlane/plugin/dynatrace/actions/dynatrace_action.rb, line 14 def self.run(params) UI.message "DTXDssClientPath: #{params[:dtxDssClientPath]}" UI.message "Parameter API Token: #{params[:apitoken]}" UI.message "OS: #{params[:os]}" UI.message "Version string: #{params[:versionStr]}" UI.message "Version: #{params[:version]}" UI.message "Server URL: #{params[:server]}" UI.message "Checking AppFile for possible AppID" bundleId = CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier) if bundleId UI.message "Using #{bundleId} from your AppFile" else bundleId = params[:bundleId] 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 = nil unless response.body.nil? message = JSON.parse(response.body)["error"]["message"] end 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" && params[:os] != "tvos" UI.user_error! "Unsopported value os=#{params[:os]}" end # iOS/tvOS workflow dtxDssClientPath = Helper::DynatraceHelper.get_dss_client(params) dsym_paths = [] symbolFilesKey = "symbolsfile" # default to iOS if !OS.mac? UI.user_error! "A macOS machine is required to process iOS symbols." end if params[:downloadDsyms] == true UI.message "Downloading dSYMs from App Store Connect" startTime = Time.now 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 # 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: params[:os] == "ios" ? :ios : :appletvos) 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 if (Time.now - startTime) > params[:waitForDsymProcessingTimeout] UI.user_error!("Timeout during dSYM download. Try increasing :waitForDsymProcessingTimeout.") 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 raise 'No dSYM paths found!' end 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 if dsym_paths.count == 0 UI.message "Symbol file path: #{params[:symbolsfile]}" dsym_paths = params[:symbolsfile] symbolFilesCommandSnippet = "#{symbolFilesKey}=\"#{dsym_paths}\"" else symbolFilesCommandSnippet = "#{symbolFilesKey}=\"#{dsym_paths[0]}\"" end # start constructing the command that will trigger the DTXDssClient command = [] command << "#{dtxDssClientPath}" command << "-#{params[:action]}" #"-upload" command << "appid=\"#{params[:appId]}\"" command << "apitoken=\"#{params[:apitoken]}\"" command << "os=#{params[:os]}" command << "bundleId=\"#{bundleId}\"" command << "versionStr=\"#{params[:versionStr]}\"" command << "version=\"#{params[:version]}\"" command << symbolFilesCommandSnippet 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 # Create the full shell command to trigger the DTXDssClient shell_command = command.join(' ') UI.message "dSYM path: #{dsym_paths[0]}" UI.message "#{shell_command}" sh("#{shell_command}", error_callback: ->(result) { # ShAction doesn't return any reference to the return value -> parse it from the output result_groups = result.match /(?:ERROR: Execution failed, rc=)(-?\d*)(?:\sreason=)(.*)/ if result_groups and result_groups.length() >= 2 if result_groups[1] == "413" UI.user_error!("DTXDssClient: #{result_groups[2]} See https://www.dynatrace.com/support/help/shortlink/mobile-symbolication#manage-the-uploaded-symbol-files for more information.") else UI.user_error!("DTXDssClient: #{result_groups[2]}") end else UI.user_error!("DTXDssClient finished with errors.") end }) UI.message "Cleaning build artifacts" Fastlane::Actions::CleanBuildArtifactsAction.run(exclude_pattern: nil) end