Class: Fastlane::Helper::SentryConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/fastlane/plugin/sentry/helper/sentry_config.rb

Class Method Summary collapse

Class Method Details

.common_api_config_items ⇒ Object 



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
 
# File 'lib/fastlane/plugin/sentry/helper/sentry_config.rb', line 16

def self.common_api_config_items
  [
    FastlaneCore::ConfigItem.new(key: :url,
                                 env_name: "SENTRY_URL",
                                 description: "Url for Sentry",
                                 is_string: true,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :auth_token,
                                 env_name: "SENTRY_AUTH_TOKEN",
                                 description: "Authentication token for Sentry",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :api_key,
                                 env_name: "SENTRY_API_KEY",
                                 description: "API key for Sentry",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :org_slug,
                                 env_name: "SENTRY_ORG_SLUG",
                                 description: "Organization slug for Sentry project",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :project_slug,
                                 env_name: "SENTRY_PROJECT_SLUG",
                                 description: "Project slug for Sentry",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :log_level,
                                 env_name: "SENTRY_LOG_LEVEL",
                                 description: "Configures the log level used by sentry-cli",
                                 optional: true,
                                 verify_block: proc do |value|
                                   UI.user_error! "Invalid log level '#{value}'" unless ['trace', 'debug', 'info', 'warn', 'error'].include? value.downcase
                                 end)
  ] + self.common_cli_config_items
end

.common_cli_config_items ⇒ Object 



4
5
6
7
8
9
10
11
12
13
14
 
# File 'lib/fastlane/plugin/sentry/helper/sentry_config.rb', line 4

def self.common_cli_config_items
  [
    FastlaneCore::ConfigItem.new(key: :sentry_cli_path,
                                 env_name: "SENTRY_CLI_PATH",
                                 description: "Path to your sentry-cli. Defaults to `which sentry-cli`",
                                 optional: true,
                                 verify_block: proc do |value|
                                   UI.user_error! "'#{value}' is not executable" unless FastlaneCore::Helper.executable?(value)
                                 end)
  ]
end

.fallback_sentry_cli_auth(params) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/fastlane/plugin/sentry/helper/sentry_config.rb', line 98

def self.fallback_sentry_cli_auth(params)
  sentry_cli_result = JSON.parse(SentryHelper.call_sentry_cli(
                                   params,
                                   [
                                     "info",
                                     "--config-status-json"
                                   ]
                                 ))
  return (sentry_cli_result["auth"]["successful"] &&
    !sentry_cli_result["auth"]["type"].nil?)
end

.parse_api_params(params) ⇒ Object 



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
 
# File 'lib/fastlane/plugin/sentry/helper/sentry_config.rb', line 49

def self.parse_api_params(params)
  require 'shellwords'

  url = params[:url]
  auth_token = params[:auth_token]
  api_key = params[:api_key]
  org = params[:org_slug]
  project = params[:project_slug]
  log_level = params[:log_level]

  has_org = !org.to_s.empty?
  has_project = !project.to_s.empty?
  has_api_key = !api_key.to_s.empty?
  has_auth_token = !auth_token.to_s.empty?

  ENV['SENTRY_URL'] = url unless url.to_s.empty?

  if log_level.to_s.empty?
    ENV['SENTRY_LOG_LEVEL'] = 'debug' if FastlaneCore::Globals.verbose?
  else
    ENV['SENTRY_LOG_LEVEL'] = log_level
  end

  # Fallback to .sentryclirc if possible when no auth token is provided
  if !has_api_key && !has_auth_token && fallback_sentry_cli_auth(params)
    UI.important("No auth config provided, will fallback to .sentryclirc")
  else
    # Will fail if none or both authentication methods are provided
    if !has_api_key && !has_auth_token
      UI.user_error!("No API key or authentication token found for SentryAction given, pass using `api_key: 'key'` or `auth_token: 'token'`")
    elsif has_api_key && has_auth_token
      UI.user_error!("Both API key and authentication token found for SentryAction given, please only give one")
    elsif has_api_key && !has_auth_token
      UI.deprecated("Please consider switching to auth_token ... api_key will be removed in the future")
    end
    ENV['SENTRY_API_KEY'] = api_key unless api_key.to_s.empty?
    ENV['SENTRY_AUTH_TOKEN'] = auth_token unless auth_token.to_s.empty?
  end

  if has_org && has_project
    ENV['SENTRY_ORG'] = Shellwords.escape(org) unless org.to_s.empty?
    ENV['SENTRY_PROJECT'] = Shellwords.escape(project) unless project.to_s.empty?
  elsif !has_org
    UI.important("Missing 'org_slug' parameter. Provide both 'org_slug' and 'project_slug'. Falling back to .sentryclirc")
  elsif !has_project
    UI.important("Missing 'project_slug' parameter. Provide both 'org_slug' and 'project_slug'. Falling back to .sentryclirc")
  end
end