Class: Deliver::Runner

Inherits:
Object
  • Object
show all
Defined in:
deliver/lib/deliver/runner.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options, skip_auto_detection = {}) ⇒ Runner

Returns a new instance of Runner.



19
20
21
22
23
24
25
26
 
# File 'deliver/lib/deliver/runner.rb', line 19

def initialize(options, skip_auto_detection = {})
  self.options = options

  

  Deliver::DetectValues.new.run!(self.options, skip_auto_detection)
  FastlaneCore::PrintTable.print_values(config: options, hide_keys: [:app], mask_keys: ['app_review_information.demo_password'], title: "deliver #{Fastlane::VERSION} Summary")
end

Instance Attribute Details

#options ⇒ Object

Returns the value of attribute options.



17
18
19
 
# File 'deliver/lib/deliver/runner.rb', line 17

def options
  @options
end

Instance Method Details

#login ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'deliver/lib/deliver/runner.rb', line 28

def 
  if (api_token = Spaceship::ConnectAPI::Token.from(hash: options[:api_key], filepath: options[:api_key_path]))
    UI.message("Creating authorization token for App Store Connect API")
    Spaceship::ConnectAPI.token = api_token
  elsif !Spaceship::ConnectAPI.token.nil?
    UI.message("Using existing authorization token for App Store Connect API")
  else
    # Username is now optional since addition of App Store Connect API Key
    # Force asking for username to prompt user if not already set
    options.fetch(:username, force_ask: true)

    # Team selection passed though FASTLANE_TEAM_ID and FASTLANE_TEAM_NAME environment variables
    # Prompts select team if multiple teams and none specified
    UI.message("Login to App Store Connect (#{options[:username]})")
    Spaceship::ConnectAPI.(options[:username], nil, use_portal: false, use_tunes: true)
    UI.message("Login successful")
  end
end

#precheck_app ⇒ Object

Make sure we pass precheck before uploading



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
 
# File 'deliver/lib/deliver/runner.rb', line 68

def precheck_app
  return true unless options[:run_precheck_before_submit]
  UI.message("Running precheck before submitting to review, if you'd like to disable this check you can set run_precheck_before_submit to false")

  if options[:submit_for_review]
    UI.message("Making sure we pass precheck 👮‍♀️ 👮 before we submit  🛫")
  else
    UI.message("Running precheck 👮‍♀️ 👮")
  end

  precheck_options = {
    default_rule_level: options[:precheck_default_rule_level],
    include_in_app_purchases: options[:precheck_include_in_app_purchases],
    app_identifier: options[:app_identifier]
  }

  if options[:api_key] || options[:api_key_path]
    if options[:precheck_include_in_app_purchases]
      UI.user_error!("Precheck cannot check In-app purchases with the App Store Connect API Key (yet). Exclude In-app purchases from precheck, disable the precheck step in your build step, or use Apple ID login")
    end

    precheck_options[:api_key] = options[:api_key]
    precheck_options[:api_key_path] = options[:api_key_path]
  else
    precheck_options[:username] = options[:username]
    precheck_options[:platform] = options[:platform]
  end

  precheck_config = FastlaneCore::Configuration.create(Precheck::Options.available_options, precheck_options)
  Precheck.config = precheck_config

  precheck_success = true
  begin
    precheck_success = Precheck::Runner.new.run
  rescue => ex
    UI.error("fastlane precheck just tried to inspect your app's metadata for App Store guideline violations and ran into a problem. We're not sure what the problem was, but precheck failed to finished. You can run it in verbose mode if you want to see the whole error. We'll have a fix out soon 🚀")
    UI.verbose(ex.inspect)
    UI.verbose(ex.backtrace.join("\n"))
  end

  return precheck_success
end

#reject_version_if_possible ⇒ Object 



189
190
191
192
193
194
195
 
# File 'deliver/lib/deliver/runner.rb', line 189

def reject_version_if_possible
  app = Deliver.cache[:app]
  platform = Spaceship::ConnectAPI::Platform.map(options[:platform])
  if app.reject_version_if_possible!(platform: platform)
    UI.success("Successfully rejected previous version!")
  end
end

#run ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'deliver/lib/deliver/runner.rb', line 47

def run
  verify_version if options[:app_version].to_s.length > 0 && !options[:skip_app_version_update]

  # Rejecting before upload meta
  # Screenshots can not be update/deleted if in waiting for review
  reject_version_if_possible if options[:reject_if_possible]

  upload_metadata

  has_binary = (options[:ipa] || options[:pkg])
  if !options[:skip_binary_upload] && !options[:build_number] && has_binary
    upload_binary
  end

  UI.success("Finished the upload to App Store Connect") unless options[:skip_binary_upload]

  precheck_success = precheck_app
  submit_for_review if options[:submit_for_review] && precheck_success
end

#submit_for_review ⇒ Object 



197
198
199
 
# File 'deliver/lib/deliver/runner.rb', line 197

def submit_for_review
  SubmitForReview.new.submit!(options)
end

#upload_binary ⇒ Object

Upload the binary to App Store Connect



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'deliver/lib/deliver/runner.rb', line 151

def upload_binary
  UI.message("Uploading binary to App Store Connect")

  upload_ipa = options[:ipa]
  upload_pkg = options[:pkg]

  # 2020-01-27
  # Only verify platform if if both ipa and pkg exists (for backwards support)
  if upload_ipa && upload_pkg
    upload_ipa = ["ios", "appletvos"].include?(options[:platform])
    upload_pkg = options[:platform] == "osx"
  end

  if upload_ipa
    package_path = FastlaneCore::IpaUploadPackageBuilder.new.generate(
      app_id: Deliver.cache[:app].id,
      ipa_path: options[:ipa],
      package_path: "/tmp",
      platform: options[:platform]
    )
  elsif upload_pkg
    package_path = FastlaneCore::PkgUploadPackageBuilder.new.generate(
      app_id: Deliver.cache[:app].id,
      pkg_path: options[:pkg],
      package_path: "/tmp",
      platform: options[:platform]
    )
  end

  transporter = transporter_for_selected_team
  result = transporter.upload(package_path: package_path)

  unless result
    transporter_errors = transporter.displayable_errors
    UI.user_error!("Error uploading ipa file: \n #{transporter_errors}")
  end
end

#upload_metadata ⇒ Object

Upload all metadata, screenshots, pricing information, etc. to App Store Connect



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'deliver/lib/deliver/runner.rb', line 130

def upload_metadata
  upload_metadata = UploadMetadata.new
  upload_screenshots = UploadScreenshots.new

  # First, collect all the things for the HTML Report
  screenshots = upload_screenshots.collect_screenshots(options)
  upload_metadata.load_from_filesystem(options)

  # Assign "default" values to all languages
  upload_metadata.assign_defaults(options)

  # Validate
  validate_html(screenshots)

  # Commit
  upload_metadata.upload(options)
  upload_screenshots.upload(options, screenshots)
  UploadPriceTier.new.upload(options)
end

#verify_version ⇒ Object

Make sure the version on App Store Connect matches the one in the ipa If not, the new version will automatically be created



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'deliver/lib/deliver/runner.rb', line 113

def verify_version
  app_version = options[:app_version]
  UI.message("Making sure the latest version on App Store Connect matches '#{app_version}'...")

  app = Deliver.cache[:app]

  platform = Spaceship::ConnectAPI::Platform.map(options[:platform])
  changed = app.ensure_version!(app_version, platform: platform)

  if changed
    UI.success("Successfully set the version to '#{app_version}'")
  else
    UI.success("'#{app_version}' is the latest version on App Store Connect")
  end
end