class Chef::Provider::Git

Constants

GIT_VERSION_PATTERN

Public Instance Methods

add_remotes() click to toggle source
# File lib/chef/provider/git.rb, line 162
def add_remotes
  if new_resource.additional_remotes.length > 0
    new_resource.additional_remotes.each_pair do |remote_name, remote_url|
      converge_by("add remote #{remote_name} from #{remote_url}") do
        logger.info "#{new_resource} adding git remote #{remote_name} = #{remote_url}"
        setup_remote_tracking_branches(remote_name, remote_url)
      end
    end
  end
end
already_on_target_branch?() click to toggle source
# File lib/chef/provider/git.rb, line 157
def already_on_target_branch?
  current_branch = git("rev-parse", "--abbrev-ref", "HEAD", cwd: cwd, returns: [0, 128]).stdout.strip
  current_branch == (new_resource.checkout_branch || new_resource.revision)
end
checkout() click to toggle source
# File lib/chef/provider/git.rb, line 189
def checkout
  converge_by("checkout ref #{target_revision} branch #{new_resource.revision}") do
    # checkout into a local branch rather than a detached HEAD
    if new_resource.checkout_branch
      # check out to a local branch
      git("branch", "-f", new_resource.checkout_branch, target_revision, cwd: cwd)
      git("checkout", new_resource.checkout_branch, cwd: cwd)
      logger.info "#{new_resource} checked out branch: #{new_resource.revision} onto: #{new_resource.checkout_branch} reference: #{target_revision}"
    elsif sha_hash?(new_resource.revision) || !is_branch?
      # detached head
      git("checkout", target_revision, cwd: cwd)
      logger.info "#{new_resource} checked out reference: #{target_revision}"
    elsif already_on_target_branch?
      # we are already on the proper branch
      git("reset", "--hard", target_revision, cwd: cwd)
    else
      # need a branch with a tracking branch
      git("branch", "-f", new_resource.revision, target_revision, cwd: cwd)
      git("checkout", new_resource.revision, cwd: cwd)
      git("branch", "-u", "#{new_resource.remote}/#{new_resource.revision}", cwd: cwd)
      logger.info "#{new_resource} checked out branch: #{new_resource.revision} reference: #{target_revision}"
    end
  end
end
clone() click to toggle source
# File lib/chef/provider/git.rb, line 173
def clone
  converge_by("clone from #{repo_url} into #{cwd}") do
    remote = new_resource.remote

    clone_cmd = ["clone"]
    clone_cmd << "-o #{remote}" unless remote == "origin"
    clone_cmd << "--depth #{new_resource.depth}" if new_resource.depth
    clone_cmd << "--no-single-branch" if new_resource.depth && git_has_single_branch_option?
    clone_cmd << "\"#{new_resource.repository}\""
    clone_cmd << "\"#{cwd}\""

    logger.info "#{new_resource} cloning repo #{repo_url} to #{cwd}"
    git clone_cmd
  end
end
current_revision_matches_target_revision?() click to toggle source
# File lib/chef/provider/git.rb, line 278
def current_revision_matches_target_revision?
  (!current_resource.revision.nil?) && (target_revision.strip.to_i(16) == current_resource.revision.strip.to_i(16))
end
define_resource_requirements() click to toggle source
# File lib/chef/provider/git.rb, line 43
def define_resource_requirements
  unless new_resource.user.nil?
    requirements.assert(:all_actions) do |a|
      a.assertion do

        get_homedir(new_resource.user)
      rescue ArgumentError
        false

      end
      a.whyrun("User #{new_resource.user} does not exist, this run will fail unless it has been previously created. Assuming it would have been created.")
      a.failure_message(Chef::Exceptions::User, "#{new_resource.user} required by resource #{new_resource.name} does not exist")
    end
  end

  # Parent directory of the target must exist.
  requirements.assert(:checkout, :sync) do |a|
    dirname = ::File.dirname(cwd)
    a.assertion { ::File.directory?(dirname) }
    a.whyrun("Directory #{dirname} does not exist, this run will fail unless it has been previously created. Assuming it would have been created.")
    a.failure_message(Chef::Exceptions::MissingParentDirectory,
                      "Cannot clone #{new_resource} to #{cwd}, the enclosing directory #{dirname} does not exist")
  end

  requirements.assert(:all_actions) do |a|
    a.assertion { !(new_resource.revision =~ %r{^origin/}) }
    a.failure_message Chef::Exceptions::InvalidRemoteGitReference,
      "Deploying remote branches is not supported. " +
        "Specify the remote branch as a local branch for " +
        "the git repository you're deploying from " +
        "(ie: '#{new_resource.revision.gsub("origin/", "")}' rather than '#{new_resource.revision}')."
  end

  requirements.assert(:all_actions) do |a|
    # this can't be recovered from in why-run mode, because nothing that
    # we do in the course of a run is likely to create a valid target_revision
    # if we can't resolve it up front.
    a.assertion { !target_revision.nil? }
    a.failure_message Chef::Exceptions::UnresolvableGitReference,
      "Unable to parse SHA reference for '#{new_resource.revision}' in repository '#{new_resource.repository}'. " +
        "Verify your (case-sensitive) repository URL and revision.\n" +
        "`git ls-remote '#{new_resource.repository}' '#{rev_search_pattern}'` output: #{@resolved_reference}"
  end
end
enable_submodules() click to toggle source
# File lib/chef/provider/git.rb, line 214
def enable_submodules
  if new_resource.enable_submodules
    converge_by("enable git submodules for #{new_resource}") do
      logger.info "#{new_resource} synchronizing git submodules"
      git("submodule", "sync", cwd: cwd)
      logger.info "#{new_resource} enabling git submodules"
      # the --recursive flag means we require git 1.6.5+ now, see CHEF-1827
      git("submodule", "update", "--init", "--recursive", cwd: cwd)
    end
  end
end
existing_git_clone?() click to toggle source
# File lib/chef/provider/git.rb, line 140
def existing_git_clone?
  ::File.exist?(::File.join(cwd, ".git"))
end
fetch_updates() click to toggle source
# File lib/chef/provider/git.rb, line 226
def fetch_updates
  setup_remote_tracking_branches(new_resource.remote, new_resource.repository)
  converge_by("fetch updates for #{new_resource.remote}") do
    # since we're in a local branch already, just reset to specified revision rather than merge
    logger.trace "Fetching updates from #{new_resource.remote} and resetting to revision #{target_revision}"
    git("fetch", "--prune", new_resource.remote, cwd: cwd)
    git("fetch", new_resource.remote, "--tags", cwd: cwd)
    if sha_hash?(new_resource.revision) || is_tag? || already_on_target_branch?
      # detached head or if we are already on the proper branch
      git("reset", "--hard", target_revision, cwd: cwd)
    elsif new_resource.checkout_branch
      # check out to a local branch
      git("branch", "-f", new_resource.checkout_branch, target_revision, cwd: cwd)
      git("checkout", new_resource.checkout_branch, cwd: cwd)
    else
      # need a branch with a tracking branch
      git("branch", "-f", new_resource.revision, target_revision, cwd: cwd)
      git("checkout", new_resource.revision, cwd: cwd)
      git("branch", "-u", "#{new_resource.remote}/#{new_resource.revision}", cwd: cwd)
    end
  end
end
find_current_revision() click to toggle source
# File lib/chef/provider/git.rb, line 148
def find_current_revision
  logger.trace("#{new_resource} finding current git revision")
  if ::File.exist?(::File.join(cwd, ".git"))
    # 128 is returned when we're not in a git repo. this is fine
    result = git("rev-parse", "HEAD", cwd: cwd, returns: [0, 128]).stdout.strip
  end
  sha_hash?(result) ? result : nil
end
find_revision(refs, revision, suffix = "") click to toggle source
# File lib/chef/provider/git.rb, line 317
def find_revision(refs, revision, suffix = "")
  found = refs_search(refs, rev_match_pattern("refs/tags/", revision) + suffix)
  if !found.empty?
    @is_tag = true
    found
  else
    found = refs_search(refs, rev_match_pattern("refs/heads/", revision) + suffix)
    if !found.empty?
      @is_branch = true
      found
    else
      refs_search(refs, revision + suffix)
    end
  end
end
git_gem_version() click to toggle source
# File lib/chef/provider/git.rb, line 126
def git_gem_version
  return @git_gem_version if defined?(@git_gem_version)

  output = git("--version").stdout
  match = GIT_VERSION_PATTERN.match(output)
  if match
    @git_gem_version = Gem::Version.new(match[1])
  else
    logger.warn "Unable to parse git version from '#{output}'"
    @git_gem_version = nil
  end
  @git_gem_version
end
Also aliased as: git_minor_version
git_has_single_branch_option?() click to toggle source
# File lib/chef/provider/git.rb, line 122
def git_has_single_branch_option?
  @git_has_single_branch_option ||= !git_gem_version.nil? && git_gem_version >= Gem::Version.new("1.7.10")
end
git_ls_remote(rev_pattern) click to toggle source
# File lib/chef/provider/git.rb, line 349
def git_ls_remote(rev_pattern)
  git("ls-remote", "\"#{new_resource.repository}\"", "\"#{rev_pattern}\"").stdout
end
git_minor_version()
Alias for: git_gem_version
load_current_resource() click to toggle source
# File lib/chef/provider/git.rb, line 35
def load_current_resource
  @resolved_reference = nil
  @current_resource = Chef::Resource::Git.new(new_resource.name)
  if current_revision = find_current_revision
    current_resource.revision current_revision
  end
end
multiple_remotes?(check_remote_command_result) click to toggle source
# File lib/chef/provider/git.rb, line 270
def multiple_remotes?(check_remote_command_result)
  check_remote_command_result.exitstatus == 2
end
remote_matches?(remote_url, check_remote_command_result) click to toggle source
# File lib/chef/provider/git.rb, line 274
def remote_matches?(remote_url, check_remote_command_result)
  check_remote_command_result.stdout.strip.eql?(remote_url)
end
remote_resolve_reference() click to toggle source
# File lib/chef/provider/git.rb, line 293
def remote_resolve_reference
  logger.trace("#{new_resource} resolving remote reference")
  # The sha pointed to by an annotated tag is identified by the
  # '^{}' suffix appended to the tag. In order to resolve
  # annotated tags, we have to search for "revision*" and
  # post-process. Special handling for 'HEAD' to ignore a tag
  # named 'HEAD'.
  @resolved_reference = git_ls_remote(rev_search_pattern)
  refs = @resolved_reference.split("\n").map { |line| line.split("\t") }
  # First try for ^{} indicating the commit pointed to by an
  # annotated tag.
  # It is possible for a user to create a tag named 'HEAD'.
  # Using such a degenerate annotated tag would be very
  # confusing. We avoid the issue by disallowing the use of
  # annotated tags named 'HEAD'.
  if rev_search_pattern != "HEAD"
    found = find_revision(refs, new_resource.revision, "^{}")
  else
    found = refs_search(refs, "HEAD")
  end
  found = find_revision(refs, new_resource.revision) if found.empty?
  found.size == 1 ? found.first[0] : nil
end
rev_match_pattern(prefix, revision) click to toggle source
# File lib/chef/provider/git.rb, line 333
def rev_match_pattern(prefix, revision)
  if revision.start_with?(prefix)
    revision
  else
    prefix + revision
  end
end
rev_search_pattern() click to toggle source
# File lib/chef/provider/git.rb, line 341
def rev_search_pattern
  if ["", "HEAD"].include? new_resource.revision
    "HEAD"
  else
    new_resource.revision + "*"
  end
end
revision_slug()
Alias for: target_revision
setup_remote_tracking_branches(remote_name, remote_url) click to toggle source
# File lib/chef/provider/git.rb, line 249
def setup_remote_tracking_branches(remote_name, remote_url)
  converge_by("set up remote tracking branches for #{remote_url} at #{remote_name}") do
    logger.trace "#{new_resource} configuring remote tracking branches for repository #{remote_url} " + "at remote #{remote_name}"
    check_remote_command = ["config", "--get", "remote.#{remote_name}.url"]
    remote_status = git(check_remote_command, cwd: cwd, returns: [0, 1, 2])
    case remote_status.exitstatus
    when 0, 2
      # * Status 0 means that we already have a remote with this name, so we should update the url
      #   if it doesn't match the url we want.
      # * Status 2 means that we have multiple urls assigned to the same remote (not a good idea)
      #   which we can fix by replacing them all with our target url (hence the --replace-all option)

      if multiple_remotes?(remote_status) || !remote_matches?(remote_url, remote_status)
        git("config", "--replace-all", "remote.#{remote_name}.url", %{"#{remote_url}"}, cwd: cwd)
      end
    when 1
      git("remote", "add", remote_name, remote_url, cwd: cwd)
    end
  end
end
target_dir_non_existent_or_empty?() click to toggle source
# File lib/chef/provider/git.rb, line 144
def target_dir_non_existent_or_empty?
  !::File.exist?(cwd) || Dir.entries(cwd).sort == [".", ".."]
end
target_revision() click to toggle source
# File lib/chef/provider/git.rb, line 282
def target_revision
  @target_revision ||=
    if sha_hash?(new_resource.revision)
      @target_revision = new_resource.revision
    else
      @target_revision = remote_resolve_reference
    end
end
Also aliased as: revision_slug

Private Instance Methods

get_homedir(user) click to toggle source

Returns the home directory of the user @param [String] user must be a string. @return [String] the home directory of the user.

# File lib/chef/provider/git.rb, line 412
def get_homedir(user)
  require "etc" unless defined?(Etc)
  case user
  when Integer
    Etc.getpwuid(user).dir
  else
    Etc.getpwnam(user.to_s).dir
  end
end
git(*args, **run_opts) click to toggle source
# File lib/chef/provider/git.rb, line 387
def git(*args, **run_opts)
  git_command = ["git", args].compact.join(" ")
  logger.trace "running #{git_command}"
  shell_out!(git_command, **run_options(run_opts))
end
is_branch?() click to toggle source
# File lib/chef/provider/git.rb, line 361
def is_branch?
  !!@is_branch
end
is_tag?() click to toggle source
# File lib/chef/provider/git.rb, line 365
def is_tag?
  !!@is_tag
end
repo_url() click to toggle source

Returns a message for sensitive repository URL if sensitive is true otherwise repository URL is returned @return [String]

# File lib/chef/provider/git.rb, line 400
def repo_url
  if new_resource.sensitive
    "**Suppressed Sensitive URL**"
  else
    new_resource.repository
  end
end
run_options(run_opts = {}) click to toggle source
# File lib/chef/provider/git.rb, line 369
def run_options(run_opts = {})
  env = {}
  if new_resource.user
    run_opts[:user] = new_resource.user
    # Certain versions of `git` misbehave if git configuration is
    # inaccessible in $HOME. We need to ensure $HOME matches the
    # user who is executing `git` not the user running Chef.
    env["HOME"] = get_homedir(new_resource.user)
  end
  run_opts[:group] = new_resource.group if new_resource.group
  env["GIT_SSH"] = new_resource.ssh_wrapper if new_resource.ssh_wrapper
  run_opts[:log_tag] = new_resource.to_s
  run_opts[:timeout] = new_resource.timeout if new_resource.timeout
  env.merge!(new_resource.environment) if new_resource.environment
  run_opts[:environment] = env unless env.empty?
  run_opts
end
sha_hash?(string) click to toggle source
# File lib/chef/provider/git.rb, line 393
def sha_hash?(string)
  string =~ /^[0-9a-f]{40}$/
end