Class: Gitlab::Git::HookEnv

Inherits:
Object
  • Object
show all
Defined in:
lib/gitlab/git/hook_env.rb

Overview

Ephemeral (per request) storage for environment variables that some Git commands need during internal API calls made from the Git pre-receive push hook.

See gitlab.com/gitlab-org/gitaly/-/blob/master/doc/object_quarantine.md#gitlab-and-git-object-quarantine for more information.

This class is thread-safe via RequestStore.

Constant Summary collapse

ALLOWLISTED_VARIABLES = 
%w[
  GIT_OBJECT_DIRECTORY_RELATIVE
  GIT_ALTERNATE_OBJECT_DIRECTORIES_RELATIVE
].freeze

Class Method Summary collapse

Class Method Details

.all(gl_repository) ⇒ Object 



46
47
48
49
50
51
 
# File 'lib/gitlab/git/hook_env.rb', line 46

def self.all(gl_repository)
  return {} unless Gitlab::SafeRequestStore.active?

  h = Gitlab::SafeRequestStore.fetch(:gitlab_git_env) { {} }
  h.fetch(gl_repository, {})
end

.allowlist_git_env(env) ⇒ Object 



64
65
66
 
# File 'lib/gitlab/git/hook_env.rb', line 64

def self.allowlist_git_env(env)
  env.select { |key, _| ALLOWLISTED_VARIABLES.include?(key.to_s) }.with_indifferent_access
end

.get_relative_path ⇒ Object

get_relative_path returns the relative path of the repository this hook call is triggered for. This is the repository’s relative path in the transaction’s snapshot and is passed back to Gitaly in quarantined calls.



40
41
42
43
44
 
# File 'lib/gitlab/git/hook_env.rb', line 40

def self.get_relative_path
  return unless Gitlab::SafeRequestStore.active?

  Gitlab::SafeRequestStore.fetch(:gitlab_git_relative_path)
end

.set(gl_repository, relative_path, env) ⇒ Object

set stores the quarantining variables into request store.

relative_path is sent from Gitaly to Rails when invoking internal API. In production it points to the transaction’s snapshot repository. Tests should pass the original relative path of the repository as Gitaly is stubbed out from the invokation loop and doesn’t create a transaction snapshot.



27
28
29
30
31
32
33
34
35
 
# File 'lib/gitlab/git/hook_env.rb', line 27

def self.set(gl_repository, relative_path, env)
  return unless Gitlab::SafeRequestStore.active?

  raise "missing gl_repository" if gl_repository.blank?

  Gitlab::SafeRequestStore[:gitlab_git_env] ||= {}
  Gitlab::SafeRequestStore[:gitlab_git_env][gl_repository] = allowlist_git_env(env)
  Gitlab::SafeRequestStore[:gitlab_git_relative_path] = relative_path
end

.to_env_hash(gl_repository) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
 
# File 'lib/gitlab/git/hook_env.rb', line 53

def self.to_env_hash(gl_repository)
  env = {}

  all(gl_repository).compact.each do |key, value|
    value = value.join(File::PATH_SEPARATOR) if value.is_a?(Array)
    env[key.to_s] = value
  end

  env
end