Class: Octopusci::Job

Inherits:
Object
  • Object
show all
Defined in:
lib/octopusci/job.rb

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.context_stack ⇒ Object

Returns the value of attribute context_stack.



4
5
6
 
# File 'lib/octopusci/job.rb', line 4

def context_stack
  @context_stack
end

Class Method Details

.checkout_branch(job_conf) ⇒ Object 



120
121
122
 
# File 'lib/octopusci/job.rb', line 120

def self.checkout_branch(job_conf)
  return run_shell_cmd("cd #{repository_path} 2>&1 && git fetch --all -p 2>&1 && git reset --hard && git checkout #{@job['branch_name']} 2>&1 && git pull -f origin #{@job['branch_name']}:#{@job['branch_name']} 2>&1", true, false)
end

.clone_code(job_conf) ⇒ Object 



109
110
111
112
113
114
115
116
117
118
 
# File 'lib/octopusci/job.rb', line 109

def self.clone_code(job_conf)
  if File.directory?(repository_path)
    return 0
  else
    if !Dir.exists?(workspace_path)
      FileUtils.mkdir_p(workspace_path)
    end
    return run_shell_cmd("cd #{workspace_path} 2>&1 && git clone #{job_conf['repo_uri']} #{@job['repo_name']}-#{job_conf['owner']} 2>&1", true, false)
  end
end

.context(desc_str) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/octopusci/job.rb', line 15

def self.context(desc_str)
  num_contexts_before = context_stack.length
  context_lead_in = '  '*num_contexts_before
  context_stack.push(desc_str)
  num_contexts_now = context_stack.length
  @output_lead_in = '  '*num_contexts_now
  context_str = context_stack.join(' ')
  output("\n\n#{desc_str}:\n\n")
  begin
    yield
    Octopusci::Notifier.job_complete(@job, get_recip_email(), context_str, true).deliver
  rescue Octopusci::JobRunFailed => e
    write_exception(e)
    Octopusci::Notifier.job_complete(@job, get_recip_email(), context_str, false).deliver
    # setup notification and send notification
    raise JobHalted.new("JobRunFailed:\n  Context: #{context_str}\n  Message: #{e.message}")
  ensure
    context_stack.pop
  end
end

.failed!(msg = "") ⇒ Object

Raises:



71
72
73
 
# File 'lib/octopusci/job.rb', line 71

def self.failed!(msg = "")
  raise Octopusci::JobRunFailed.new(msg)
end

.get_recip_email ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/octopusci/job.rb', line 124

def self.get_recip_email
  recip_email = nil
  if @job['branch_name'] == 'master'
    recip_email = @job_conf['default_email']
  else
    if @job['payload']['pusher']['email']
      recip_email = @job['payload']['pusher']['email']
    else
      recip_email = @job_conf['default_email']
    end
  end
end

.inherited(subclass) ⇒ Object 



6
7
8
 
# File 'lib/octopusci/job.rb', line 6

def inherited(subclass)
  subclass.context_stack = []
end

.log(msg) ⇒ Object 



79
80
81
82
83
 
# File 'lib/octopusci/job.rb', line 79

def self.log(msg)
  @io.write_raw_output(true) do |f|
    f << "\n#{context_stack.join(' ')}:\n\t#{msg}" 
  end
end

.output(msg) ⇒ Object 



75
76
77
 
# File 'lib/octopusci/job.rb', line 75

def self.output(msg)
  @io.write_raw_output(false, "#{@output_lead_in}#{msg}")
end

.perform(project_name, branch_name, job_id, job_conf) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
149
150
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
 
# File 'lib/octopusci/job.rb', line 137

def self.perform(project_name, branch_name, job_id, job_conf)
  context_stack = []
  @job_conf = job_conf

  # Note: There is no logic for handling stage coming back as nil because
  # it should never happen because there are the same number of resque
  # workers as there are stages at all times.
  if Octopusci::Config.has_key?('stages')
    # Get the next available stage from redis which locks it by removing it
    # from the list of available
    stage = Octopusci::StageLocker.pop
  end
  
  begin
    # Using redis to get the associated github_payload
    github_payload = Octopusci::Queue.github_payload(project_name, branch_name)
    
    @job = Octopusci::JobStore.list_repo_branch(github_payload['repository']['name'], github_payload['ref'].split('/').last, 0, 1).first
    if @job
      @io = Octopusci::IO.new(@job)
      record_start(stage)
      
      begin
        clone_code(job_conf)
        checkout_branch(job_conf)
        
        self.run(@job)

        @job['status'] = 'successful'
      rescue JobHalted => e
        @job['status'] = 'failed'
      rescue => e
        write_exception(e)
        @job['status'] = 'error'
      ensure
        @job['ended_at'] = Time.new
        Octopusci::JobStore.set(@job['id'], @job)
      end
    end
  ensure
    if Octopusci::Config.has_key?('stages')
      # Unlock the stage by adding it back to the list of available stages
      Octopusci::StageLocker.push(stage)
    end
  end
end

.record_start(stage) ⇒ Object 



94
95
96
97
98
99
 
# File 'lib/octopusci/job.rb', line 94

def self.record_start(stage)
  @job['started_at'] = Time.new
  @job['stage'] = stage
  @job['status'] = 'running'
  Octopusci::JobStore.set(@job['id'], @job)
end

.repository_path ⇒ Object 



105
106
107
 
# File 'lib/octopusci/job.rb', line 105

def self.repository_path
  return "#{workspace_path}/#{@job['repo_name']}-#{@job['repo_owner_name']}"
end

.run(job_rec) ⇒ Object

Raises:



11
12
13
 
# File 'lib/octopusci/job.rb', line 11

def self.run(job_rec)
  raise Octopusci::PureVirtualMethod, "The self.run method needs to be defined on your Octopusci::Job based class."
end

.run_shell_cmd(cmd_str, output_to_log = false, go_to_repo = true) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/octopusci/job.rb', line 36

def self.run_shell_cmd(cmd_str, output_to_log=false, go_to_repo=true)
  horiz_line = "-"*30
  @io.write_raw_output(output_to_log) do |out_f|
    out_f << "\n\n#{@output_lead_in}Running: #{cmd_str}\n"
    out_f << "#{@output_lead_in}#{horiz_line}"
    out_f << "\n"
    out_f.flush
  
    
    real_cmd_str = ""
    if (go_to_repo)
      real_cmd_str += "cd #{repository_path} 2>&1 && "
    end
    real_cmd_str += cmd_str
    in_f = ::IO.popen(real_cmd_str)
    while(cur_line = in_f.gets) do
      out_f << "#{@output_lead_in}#{cur_line}"
      out_f.flush
    end

    in_f.close
  end

  return $?.exitstatus.to_i
end

.run_shell_cmd!(cmd_str, output_to_log = false, go_to_repo = true) ⇒ Object 



62
63
64
65
66
67
68
69
 
# File 'lib/octopusci/job.rb', line 62

def self.run_shell_cmd!(cmd_str, output_to_log=false, go_to_repo=true)
  r = self.run_shell_cmd(cmd_str, output_to_log, go_to_repo)
  if (r != 0)
    raise Octopusci::JobRunFailed.new("#{cmd_str} exited with non-zero return value (#{r})")
  else
    return 0
  end
end

.workspace_path ⇒ Object 



101
102
103
 
# File 'lib/octopusci/job.rb', line 101

def self.workspace_path
  return "#{Octopusci::Config['general']['workspace_base_path']}/#{@job['stage']}"
end

.write_exception(e) ⇒ Object 



85
86
87
88
89
90
91
92
 
# File 'lib/octopusci/job.rb', line 85

def self.write_exception(e)
  @io.write_raw_output do |f|
    f << "\n\nException: #{e.message}\n"
    f << "-"*30
    f << "\n"
    f << e.backtrace.join("\n")
  end
end