Module: Dependabot::SharedHelpers

Defined in:
lib/dependabot/shared_helpers.rb

Defined Under Namespace

Classes: HelperSubprocessFailed

Constant Summary collapse

GIT_CONFIG_GLOBAL_PATH = 
File.expand_path("~/.gitconfig")
USER_AGENT = 
"dependabot-core/#{Dependabot::VERSION} "\
"#{Excon::USER_AGENT} ruby/#{RUBY_VERSION} "\
"(#{RUBY_PLATFORM}) "\
"(+https://github.com/dependabot/dependabot-core)"
SIGKILL = 
9

Class Method Summary collapse

Class Method Details

.configure_git_to_use_https(host) ⇒ Object

rubocop:enable Metrics/AbcSize rubocop:enable Metrics/PerceivedComplexity



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/dependabot/shared_helpers.rb', line 231

def self.configure_git_to_use_https(host)
  # NOTE: we use --global here (rather than --system) so that Dependabot
  # can be run without privileged access
  run_shell_command(
    "git config --global --replace-all url.https://#{host}/."\
    "insteadOf ssh://git@#{host}/"
  )
  run_shell_command(
    "git config --global --add url.https://#{host}/."\
    "insteadOf ssh://git@#{host}:"
  )
  run_shell_command(
    "git config --global --add url.https://#{host}/."\
    "insteadOf git@#{host}:"
  )
  run_shell_command(
    "git config --global --add url.https://#{host}/."\
    "insteadOf git@#{host}/"
  )
  run_shell_command(
    "git config --global --add url.https://#{host}/."\
    "insteadOf git://#{host}/"
  )
end

.configure_git_to_use_https_with_credentials(credentials) ⇒ Object

rubocop:disable Metrics/AbcSize rubocop:disable Metrics/PerceivedComplexity



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/dependabot/shared_helpers.rb', line 178

def self.configure_git_to_use_https_with_credentials(credentials)
  File.open(GIT_CONFIG_GLOBAL_PATH, "w") do |file|
    file << "# Generated by dependabot/dependabot-core"
  end

  # Then add a file-based credential store that loads a file in this repo.
  # Under the hood this uses git credential-store, but it's invoked through
  # a wrapper binary that only allows non-mutating commands. Without this,
  # whenever the credentials are deemed to be invalid, they're erased.
  run_shell_command(
    "git config --global credential.helper "\
    "'!#{credential_helper_path} --file #{Dir.pwd}/git.store'",
    allow_unsafe_shell_command: true
  )

  github_credentials = credentials.
                       select { |c| c["type"] == "git_source" }.
                       select { |c| c["host"] == "github.com" }.
                       select { |c| c["password"] && c["username"] }

  # If multiple credentials are specified for github.com, pick the one that
  # *isn't* just an app token (since it must have been added deliberately)
  github_credential =
    github_credentials.find { |c| !c["password"]&.start_with?("v1.") } ||
    github_credentials.first

  # Make sure we always have https alternatives for github.com.
  configure_git_to_use_https("github.com") if github_credential.nil?

  deduped_credentials = credentials -
                        github_credentials +
                        [github_credential].compact

  # Build the content for our credentials file
  git_store_content = ""
  deduped_credentials.each do |cred|
    next unless cred["type"] == "git_source"
    next unless cred["username"] && cred["password"]

    authenticated_url =
      "https://#{cred.fetch('username')}:#{cred.fetch('password')}"\
      "@#{cred.fetch('host')}"

    git_store_content += authenticated_url + "\n"
    configure_git_to_use_https(cred.fetch("host"))
  end

  # Save the file
  File.write("git.store", git_store_content)
end

.credential_helper_path ⇒ Object 



172
173
174
 
# File 'lib/dependabot/shared_helpers.rb', line 172

def self.credential_helper_path
  File.join(__dir__, "../../bin/git-credential-store-immutable")
end

.escape_command(command) ⇒ Object

Escapes all special characters, e.g. = & | <>



71
72
73
74
 
# File 'lib/dependabot/shared_helpers.rb', line 71

def self.escape_command(command)
  command_parts = command.split.map(&:strip).reject(&:empty?)
  Shellwords.join(command_parts)
end

.excon_defaults(options = nil) ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/dependabot/shared_helpers.rb', line 149

def self.excon_defaults(options = nil)
  options ||= {}
  headers = options.delete(:headers)
  {
    connect_timeout: 5,
    write_timeout: 5,
    read_timeout: 20,
    omit_default_port: true,
    middlewares: excon_middleware,
    headers: excon_headers(headers)
  }.merge(options)
end

.excon_headers(headers = nil) ⇒ Object 



142
143
144
145
146
147
 
# File 'lib/dependabot/shared_helpers.rb', line 142

def self.excon_headers(headers = nil)
  headers ||= {}
  {
    "User-Agent" => USER_AGENT
  }.merge(headers)
end

.excon_middleware ⇒ Object

rubocop:enable Metrics/MethodLength



136
137
138
139
140
 
# File 'lib/dependabot/shared_helpers.rb', line 136

def self.excon_middleware
  Excon.defaults[:middlewares] +
    [Excon::Middleware::Decompress] +
    [Excon::Middleware::RedirectFollower]
end

.in_a_temporary_directory(directory = "/") ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/dependabot/shared_helpers.rb', line 41

def self.in_a_temporary_directory(directory = "/")
  Dir.mkdir(Utils::BUMP_TMP_DIR_PATH) unless Dir.exist?(Utils::BUMP_TMP_DIR_PATH)
  tmp_dir = Dir.mktmpdir(Utils::BUMP_TMP_FILE_PREFIX, Utils::BUMP_TMP_DIR_PATH)

  begin
    path = Pathname.new(File.join(tmp_dir, directory)).expand_path
    FileUtils.mkpath(path)
    Dir.chdir(path) { yield(path) }
  ensure
    FileUtils.rm_rf(tmp_dir)
  end
end

.in_a_temporary_repo_directory(directory = "/", repo_contents_path = nil, &block) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/dependabot/shared_helpers.rb', line 25

def self.in_a_temporary_repo_directory(directory = "/",
                                       repo_contents_path = nil,
                                       &block)
  if repo_contents_path
    path = Pathname.new(File.join(repo_contents_path, directory)).
           expand_path
    reset_git_repo(repo_contents_path)
    # Handle missing directories by creating an empty one and relying on the
    # file fetcher to raise a DependencyFileNotFound error
    FileUtils.mkdir_p(path) unless Dir.exist?(path)
    Dir.chdir(path) { yield(path) }
  else
    in_a_temporary_directory(directory, &block)
  end
end

.reset_git_repo(path) ⇒ Object 



256
257
258
259
260
261
 
# File 'lib/dependabot/shared_helpers.rb', line 256

def self.reset_git_repo(path)
  Dir.chdir(path) do
    run_shell_command("git reset HEAD --hard")
    run_shell_command("git clean -fx")
  end
end

.reset_global_git_config(backup_path) ⇒ Object 



274
275
276
277
278
279
280
281
282
 
# File 'lib/dependabot/shared_helpers.rb', line 274

def self.reset_global_git_config(backup_path)
  if backup_path.nil?
    FileUtils.rm(GIT_CONFIG_GLOBAL_PATH)
    return
  end
  return unless File.exist?(backup_path)

  FileUtils.mv(backup_path, GIT_CONFIG_GLOBAL_PATH)
end

.run_helper_subprocess(command:, function:, args:, env: nil, stderr_to_stdout: false, allow_unsafe_shell_command: false) ⇒ Object

rubocop:disable Metrics/MethodLength



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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/dependabot/shared_helpers.rb', line 77

def self.run_helper_subprocess(command:, function:, args:, env: nil,
                               stderr_to_stdout: false,
                               allow_unsafe_shell_command: false)
  start = Time.now
  stdin_data = JSON.dump(function: function, args: args)
  cmd = allow_unsafe_shell_command ? command : escape_command(command)

  # NOTE: For debugging native helpers in specs and dry-run: outputs the
  # bash command to run in the tmp directory created by
  # in_a_temporary_directory
  if ENV["DEBUG_FUNCTION"] == function
    puts helper_subprocess_bash_command(stdin_data: stdin_data, command: cmd, env: env)
    # Pause execution so we can run helpers inside the temporary directory
    debugger # rubocop:disable Lint/Debugger
  end

  env_cmd = [env, cmd].compact
  stdout, stderr, process = Open3.capture3(*env_cmd, stdin_data: stdin_data)
  time_taken = Time.now - start

  if ENV["DEBUG_HELPERS"] == "true"
    puts env_cmd
    puts stdout
    puts stderr
  end

  # Some package managers output useful stuff to stderr instead of stdout so
  # we want to parse this, most package manager will output garbage here so
  # would mess up json response from stdout
  stdout = "#{stderr}\n#{stdout}" if stderr_to_stdout

  error_context = {
    command: command,
    function: function,
    args: args,
    time_taken: time_taken,
    stderr_output: stderr ? stderr[0..50_000] : "", # Truncate to ~100kb
    process_exit_value: process.to_s,
    process_termsig: process.termsig
  }

  response = JSON.parse(stdout)
  return response["result"] if process.success?

  raise HelperSubprocessFailed.new(
    message: response["error"],
    error_class: response["error_class"],
    error_context: error_context,
    trace: response["trace"]
  )
rescue JSON::ParserError
  raise HelperSubprocessFailed.new(
    message: stdout || "No output from command",
    error_class: "JSON::ParserError",
    error_context: error_context
  )
end

.run_shell_command(command, allow_unsafe_shell_command: false, env: {}) ⇒ Object

Raises:



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/dependabot/shared_helpers.rb', line 284

def self.run_shell_command(command, allow_unsafe_shell_command: false, env: {})
  start = Time.now
  cmd = allow_unsafe_shell_command ? command : escape_command(command)
  stdout, process = Open3.capture2e(env || {}, cmd)
  time_taken = Time.now - start

  # Raise an error with the output from the shell session if the
  # command returns a non-zero status
  return stdout if process.success?

  error_context = {
    command: cmd,
    time_taken: time_taken,
    process_exit_value: process.to_s
  }

  raise SharedHelpers::HelperSubprocessFailed.new(
    message: stdout,
    error_context: error_context
  )
end

.stash_global_git_config ⇒ Object 



263
264
265
266
267
268
269
270
271
272
 
# File 'lib/dependabot/shared_helpers.rb', line 263

def self.stash_global_git_config
  return unless File.exist?(GIT_CONFIG_GLOBAL_PATH)

  contents = File.read(GIT_CONFIG_GLOBAL_PATH)
  digest = Digest::SHA2.hexdigest(contents)[0...10]
  backup_path = GIT_CONFIG_GLOBAL_PATH + ".backup-#{digest}"

  FileUtils.mv(GIT_CONFIG_GLOBAL_PATH, backup_path)
  backup_path
end

.with_git_configured(credentials:) ⇒ Object 



162
163
164
165
166
167
168
169
170
 
# File 'lib/dependabot/shared_helpers.rb', line 162

def self.with_git_configured(credentials:)
  backup_git_config_path = stash_global_git_config
  configure_git_to_use_https_with_credentials(credentials)
  yield
rescue Errno::ENOSPC => e
  raise Dependabot::OutOfDisk, e.message
ensure
  reset_global_git_config(backup_git_config_path)
end