Class: Git

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

Overview

Base class for working with Git

Instance Method Summary collapse

Constructor Details

#initialize(git, options, compat_options = {}) ⇒ Git

Initializes an instance of the class

Attributes

  • git - path to the git executable

  • options - hash of options includes: url - url for svn repository base_path - path for the local repository username - repository user username password - repository user password verbose - true for verbose output repository - name of remote git repository (default = origin) artifact_path - path in repository for artifacts (default = .) branch - scm branch (default = master) simulate - simulate command - echo it (default = false) output_file - file for logging results (default = step output file)



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/version_control/git.rb', line 23

def initialize(git, options, compat_options = {})
  self.extend Utilities
  if options.has_key?("SS_output_dir")
    BrpmAuto.log "Load for this class has changed, no longer necessary to send params as 2nd argument"
    options = compat_options 
  end
  @url = get_option(options,"url")
  @base_path = get_option(options,"base_path")
  user = get_option(options,"username")
  password = get_option(options,"password")
  @verbose = get_option(options,"verbose", false)
  @artifact_path = get_option(options,"artifact_path")
  @simulate = get_option(options,"simulate", false)
  update_repo_info(options)
  if user != "" && password != ""
    @credential = " --username #{user} --password #{password}"
  else
    @credential = ""
  end
  super(params)
  @git = git
end

Instance Method Details

#add_files(exclude_regex = "") ⇒ Object

Adds any new files in the local repo to the git commit list

note: you need to commit after adding files

Attributes

  • exclude_regex - regex to filter add files (file !=~ filter)

Returns

  • command output



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/version_control/git.rb', line 148

def add_files(exclude_regex = "")
  result = status
  lines = result.split("\n")
  ipos = lines.index("Untracked files:")
  unless ipos.nil?
    files = lines[(ipos + 2)..-3]
    files.each do |item|
      unless File.basename.start_with?(".")
        cmd = "#{@git} add #{item}"
        if exclude == ""
          result += process_cmd(cmd)
        else
          result += process_cmd(cmd)  unless file =~ /#{exclude}/
        end      
      end
    end
  end
  result += status   
  result
end

#checkout(init = false, options = {}) ⇒ Object

Performs a GIT checkout or initialize repository

Attributes

  • init - true to initilize the checkout and local repo

  • options - hash of options, keys [repository, branch, revision, tag]

Returns

  • command output



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/version_control/git.rb', line 68

def checkout(init = false, options = {})
  update_repo_info(options)
  if init
    cmd = "#{@git} clone #{@url} #{@credential}"
    process_cmd(cmd)
    cmd = "#{@git} checkout #{@branch}"
  else
    revision = get_option(options,"revision")
    tag = get_option(options,"tag")
    if revision != ""
      cmd = "#{@git} checkout #{revision}"
    elsif tag != ""
      cmd = "#{@git} checkout tags/#{tag}"
    else
      cmd = "#{@git} pull #{@repo} #{@branch}"
    end
  end
  process_cmd(cmd)
end

#commit(message = "Automation pushed changes", options = {}) ⇒ Object

Performs an GIT commit

Attributes

  • message - commit string

  • options - hash of options, keys [repository, branch, push_to_repository]

Returns

  • command output



97
98
99
100
101
102
103
104
105
 
# File 'lib/version_control/git.rb', line 97

def commit(message = "Automation pushed changes", options = {})
  update_repo_info(options)
  push_to_repo = get_option(options,"push_to_repository", true)
  cmd = "#{@git} commit -a -m \"#{message}\""
  result = process_cmd(cmd)
  cmd = "#{@git} push #{repo} #{branch}" if push_to_repo
  result += process_cmd if push_to_repo
  result
end

#status ⇒ Object

Performs an svn statud

Returns

  • command output



134
135
136
 
# File 'lib/version_control/git.rb', line 134

def status
  process_cmd "#{@git} status"
end

#tag(tag_name, message, options = {}) ⇒ Object

Performs an git tag

Attributes

  • tag_name - name for tag

  • message - message to add to tag

  • options - hash of options, keys [repository, branch, push_to_repository, tag_path]

Returns

  • command output



118
119
120
121
122
123
124
125
126
127
 
# File 'lib/version_control/git.rb', line 118

def tag(tag_name, message, options = {})
  update_repo_info(options)
  tag_path = get_option(options,"push_to_repository", true)
  push_to_repo = get_option(options,"tag_path")
  cmd = "#{@git} tag -a #{tag_path} -m \"#{message}\""
  result = process_cmd(cmd)
  cmd = "#{@git} push #{repo} #{branch}" if push_to_repo
  result += process_cmd if push_to_repo
  result
end

#update_repo_info(options) ⇒ Object

Updates repository info from options

Attributes

  • options - hash of options, keys [repository, branch]

Returns

  • command output



54
55
56
57
 
# File 'lib/version_control/git.rb', line 54

def update_repo_info(options)
  @repo = get_option(options,"repository","origin")
  @branch = get_option(options,"branch","master")
end