Class: SalesforceDeployTool::App

Inherits:
Object
  • Object
show all
Defined in:
lib/salesforcedeploytool/app.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ App

Returns a new instance of App.



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/salesforcedeploytool/app.rb', line 9

def initialize config
 
  # Config file validation:
  ( @git_repo = config[:git_repo] ).nil? and raise "Invalid Config: git_repo not found"
  ( @git_dir = config[:git_dir] ).nil? and raise "Invalid Config: git_dir not found"
  ( @src_dir = config[:src_dir] ).nil? and raise "Invalid Config: src_dir not found"
  ( @sandbox = config[:sandbox] ).nil? and raise "Invalid Config: sandbox not found"
  ( @username = config[:username] ).nil? and raise "Invalid Config: username not found, please run `sf config`"
  ( @password = config[:password] ).nil? and raise "Invalid Config: password not found, please run `sf config`"

  # Parameter Normalization
  @git_dir = File.expand_path(@git_dir)
  @full_src_dir = File.join(@git_dir,@src_dir)
  @version_file = File.join(@full_src_dir,config[:version_file]) if !config[:version_file].nil?
  @deploy_ignore_files = config[:deploy_ignore_files].map {|f| File.expand_path(File.join(@full_src_dir,f)) } if !config[:deploy_ignore_files].nil?
  @build_number_pattern = config[:build_number_pattern]
  @commit_hash_pattern = config[:commit_hash_pattern]
  @username = @sandbox == 'prod' ? @username : @username + '.' + @sandbox 
  @server_url = config[:salesforce_url]
  @libant = File.expand_path(config[:libant]) if config[:libant]

  # Defaults
  @check_only = false
  @run_tests = []
  @debug ||= config[:debug]
  @build_number ||= 'N/A'
  @version_file ||= false
  @build_number_pattern ||= false
  @commit_hash_pattern ||= false
  @deploy_ignore_files ||= []

  # Template dir
  buildxml_path = File.join($:.select {|x| x.match(/salesforce-deploy-tool/) },'..','tpl','build.xml.erb')
  @buildxml_erb = File.read(buildxml_path)


end

Instance Attribute Details

#build_number ⇒ Object

Returns the value of attribute build_number.



5
6
7
 
# File 'lib/salesforcedeploytool/app.rb', line 5

def build_number
  @build_number
end

#check_only ⇒ Object

Returns the value of attribute check_only.



7
8
9
 
# File 'lib/salesforcedeploytool/app.rb', line 7

def check_only
  @check_only
end

#run_all_tests ⇒ Object

Returns the value of attribute run_all_tests.



6
7
8
 
# File 'lib/salesforcedeploytool/app.rb', line 6

def run_all_tests
  @run_all_tests
end

Instance Method Details

#clean_git_dir ⇒ Object 



92
93
94
95
96
97
98
 
# File 'lib/salesforcedeploytool/app.rb', line 92

def clean_git_dir

  Dir[File.join(@full_src_dir,'*')].each do |dir|
    FileUtils.rm_rf dir unless dir =~ /.*package.xml$/
  end

end

#clean_version ⇒ Object 



69
70
71
72
73
74
 
# File 'lib/salesforcedeploytool/app.rb', line 69

def clean_version

  g = Git.open(@git_dir)
  g.checkout @version_file if @version_file && File.exists?(@version_file)

end

#clone ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/salesforcedeploytool/app.rb', line 76

def clone

  if Dir.exists? File.join(@git_dir,'.git')
    return
  end

  begin
    Git.clone(@git_repo, File.basename(@git_dir), :path => File.dirname(@git_dir))
  rescue => e
    STDERR.puts "ERROR: A problem occured when cloning #{@git_repo}, error was\n\n"
    puts e
    exit 1
  end

end

#pull ⇒ Object 



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
134
135
136
137
138
139
140
141
142
 
# File 'lib/salesforcedeploytool/app.rb', line 100

def pull

  # Parameter validation
  raise "package.xml not found under #{@full_src_dir}" if !File.exists? File.join(@full_src_dir,'package.xml')

  renderer = ERB.new(@buildxml_erb, nil,'%<>-')
  File.open('build.xml','w') {|f| f.write renderer.result(binding) }

  env_vars = ""
  env_vars += " SF_SRC_DIR=" + @full_src_dir
  env_vars += " SF_USERNAME=" + @username
  env_vars += " SF_PASSWORD=" + @password
  env_vars += " SF_SERVERURL=" + @server_url
  cmd = " ant"
  cmd += " -lib #{@libant}" if @libant
  cmd += " retrieveCode"

  full_cmd = env_vars + cmd

  exec_options = {
    :stderr => @debug,
    :stdout => @debug,
    :spinner => ! @debug,
    :okmsg => "OK",
    :failmsg => "FAILED",
  }

  if @debug
    exec_options[:okmsg] = nil
    exec_options[:failmsg] = nil
  end

  # Pull the code
  exit_code = myexec full_cmd, exec_options

  # Delete files to be ignored:
  @deploy_ignore_files.each do |file|
    FileUtils.rm file if File.exists? file
  end

  exit exit_code if exit_code != 0

end

#push ⇒ Object 



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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/salesforcedeploytool/app.rb', line 144

def push

  # Parameter validation
  raise "package.xml not found under #{@full_src_dir}" if !File.exists? File.join(@full_src_dir,'package.xml')

  renderer = ERB.new(@buildxml_erb, nil,'%<>-')
  File.open('build.xml','w') {|f| f.write renderer.result(binding) }

  # Set env variables to run ant
  env_vars = ""
  env_vars += " SF_SRC_DIR=" + @full_src_dir
  env_vars += " SF_USERNAME=" + @username
  env_vars += " SF_PASSWORD=" + @password
  env_vars += " SF_SERVERURL=" + @server_url

  # myexec options
  exec_options = {
    :stderr   =>  @debug,
    :stdout   =>  @debug,
    :spinner  =>  ! @debug,
    :okmsg    =>  "OK",
    :failmsg  =>  "FAILED",
  }

  if @debug
    exec_options[:okmsg]    =   nil
    exec_options[:failmsg]  =   nil
  end

  ant_cmd = " ant"
  ant_cmd += " -lib #{@libant}" if @libant
  if @run_all_tests  
    cmd = " deployAndTestCode" 
  else
    if ! @run_tests.empty?
      cmd = " deployAndRunSpecifiedTests"
    else
      cmd = " deployCode"
    end
  end

  if @check_only
    cmd = " checkOnlyCode"
  end
   
  full_cmd = env_vars + ant_cmd + cmd

  # Delete files to be ignored:
  @deploy_ignore_files.each do |file|
    FileUtils.rm file if File.exists? file
  end

  # Push the code
  exit_code = myexec full_cmd, exec_options

  # exit with exit_code
  exit exit_code if exit_code != 0

end

#run_tests=(value) ⇒ Object 



48
49
50
51
52
 
# File 'lib/salesforcedeploytool/app.rb', line 48

def run_tests= value
  value ||= []
  raise "ArgumentError" if value.class != Array
  @run_tests = value 
end

#set_version ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/salesforcedeploytool/app.rb', line 54

def set_version

  g = Git.open(@git_dir)

  File.open(@version_file,'r+') do |file|
    content = file.read
    content.gsub!(/#{@build_number_pattern}/,@build_number) if @build_number_pattern
    content.gsub!(/#{@commit_hash_pattern}/,g.log.first.sha) if @commit_hash_pattern
    file.seek(0,IO::SEEK_SET)
    file.truncate 0
    file.write content
  end if @version_file && File.exists?(@version_file)

end