Class: Fastlane::Helper::DynatraceHelper

Inherits:
Object
  • Object
show all
Defined in:
lib/fastlane/plugin/dynatrace/helper/dynatrace_helper.rb

Class Method Summary collapse

Class Method Details

.check_fallback_or_raise(fallback_client, error) ⇒ Object 



195
196
197
198
199
200
201
202
203
204
 
# File 'lib/fastlane/plugin/dynatrace/helper/dynatrace_helper.rb', line 195

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
    UI.important "No cached fallback found."
    raise error
  end
end

.get_dss_client(params) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/fastlane/plugin/dynatrace/helper/dynatrace_helper.rb', line 13

def self.get_dss_client(params)
  dynatraceDir = "dynatrace"
  dtxDssClientBin = "DTXDssClient"
  versionFilePath = "#{dynatraceDir}/version"
  dtxDssClientPath = "#{dynatraceDir}/#{dtxDssClientBin}"

  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

  # get latest version info
  clientUri = URI("#{self.without_trailing_slash(params[:server])}/api/config/v1/symfiles/dtxdss-download?Api-Token=#{params[:apitoken]}")
  response = Net::HTTP.get_response(clientUri)

  # 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

    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

.get_host_name(params) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/fastlane/plugin/dynatrace/helper/dynatrace_helper.rb', line 125

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

.put_android_symbols(params, bundleId, symbolspath) ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/fastlane/plugin/dynatrace/helper/dynatrace_helper.rb', line 140

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})
  if params[:server].include? '/e/'
    uri = URI.split(params[:server])
    if uri[5].nil?
      UI.user_error! "The path component of your managed Dynatrace URL is empty. Does the server URL follow the correct pattern (https://{your-domain}/e/{your-environment-id})?"
    end
    path = self.without_trailing_slash(uri[5]) + path
  end

  is_symbolsfile_zip = symbolspath.end_with?(".zip")

  request = Net::HTTP::Put.new(path, initheader = { 'Content-Type' => is_symbolsfile_zip ? 'application/zip' : 'text/plain',
                                                'Authorization' => "Api-Token #{params[:apitoken]}"} )

  request.body = IO.read(symbolspath)
  http = Net::HTTP.new(self.get_host_name(params), 443)
  http.use_ssl = true
  response = http.request(request)

  return [response, request]
end

.save_to_tempfile(url) ⇒ Object

for test mocking



217
218
219
 
# File 'lib/fastlane/plugin/dynatrace/helper/dynatrace_helper.rb', line 217

def self.save_to_tempfile(url)
  URI.open(url)
end

.to_redacted_api_token_string(url) ⇒ Object

assumes the token parameter is appended last (there is only one parameter anyway)



207
208
209
210
211
212
213
214
 
# File 'lib/fastlane/plugin/dynatrace/helper/dynatrace_helper.rb', line 207

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

.without_trailing_slash(server) ⇒ Object 



117
118
119
120
121
122
123
 
# File 'lib/fastlane/plugin/dynatrace/helper/dynatrace_helper.rb', line 117

def self.without_trailing_slash(server)
  if server[-1] == '/'
    return server[0..-2]
  else
    return server
  end
end

.zip_if_required(params) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/fastlane/plugin/dynatrace/helper/dynatrace_helper.rb', line 165

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