Class: Docman::Deployers::Deployer

Inherits:
Command
  • Object
show all
Defined in:
lib/docman/deployers/deployer.rb

Direct Known Subclasses

CommonDeployer, GitDeployer

Constant Summary collapse

@@deployers = 
{}

Instance Attribute Summary

Attributes inherited from Command

#type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Command

#add_action, #add_actions, #perform, #prefix, register_command, #replace_placeholder, #run_actions, #run_with_hooks

Methods included from Logging

#log, logger, #logger, #prefix, #properties_info, #with_logging

Constructor Details

#initialize(params, context = nil, caller = nil, type = nil) ⇒ Deployer

Returns a new instance of Deployer.



31
32
33
34
35
36
 
# File 'lib/docman/deployers/deployer.rb', line 31

def initialize(params, context = nil, caller = nil, type = nil)
  super(params, context, caller, type)
  @docroot_config = caller.docroot_config
  @builded = []
  @build_results = {}
end

Class Method Details

.create(params, context = nil, caller = nil) ⇒ Object

todo: prod ssh settings deploy target todo: docroot config in separate repos for projects



18
19
20
21
22
23
24
25
 
# File 'lib/docman/deployers/deployer.rb', line 18

def self.create(params, context = nil, caller = nil)
  c = @@deployers[params['handler']]
  if c
    c.new(params, context, caller, 'deployer')
  else
    raise "Bad deployer type: #{type}"
  end
end

.register_deployer(name) ⇒ Object 



27
28
29
 
# File 'lib/docman/deployers/deployer.rb', line 27

def self.register_deployer(name)
  @@deployers[name] = self
end

Instance Method Details

#build ⇒ Object 



129
130
131
132
133
134
135
 
# File 'lib/docman/deployers/deployer.rb', line 129

def build
  if self['name'].nil?
    build_recursive
  else
    build_dir_chain(@docroot_config.info_by(self['name']))
  end
end

#build_dir(info) ⇒ Object 



149
150
151
152
153
154
155
156
157
 
# File 'lib/docman/deployers/deployer.rb', line 149

def build_dir(info)
  return if @builded.include? info['name']
  info.state = self['state']
  build_result = Docman::Builders::Builder.create(self['builders'][info['type']], info, self).perform
  logger.info '-------------------------------------------------------'
  @changed = true if build_result
  @build_results[info['name']] = build_result
  @builded << info['name']
end

#build_dir_chain(info) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/docman/deployers/deployer.rb', line 137

def build_dir_chain(info)
  @docroot_config.chain(info).values.each do |item|
    item.state = self['state']
    if item.need_rebuild?
      build_recursive(item)
      return
    elsif
    build_dir(item)
    end
  end
end

#build_recursive(info = nil) ⇒ Object 



159
160
161
162
163
164
165
166
 
# File 'lib/docman/deployers/deployer.rb', line 159

def build_recursive(info = nil)
  info = info ? info : @docroot_config.structure
  build_dir(info)

  info['children'].each do |child|
    build_recursive(child)
  end
end

#config ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/docman/deployers/deployer.rb', line 38

def config
  unless self['name'].nil?
    @docroot_config.chain(@docroot_config.info_by(self['name'])).values.each do |info|
      add_actions(info, info)
    end
  end

  path = @docroot_config.root['full_build_path']
  if File.directory?(path) and GitUtil.repo?(path)
    Dir.chdir path
    if GitUtil.repo_changed? path
      GitUtil.reset_repo path
    end
  end

  stored_config_hash = read_version_file_param('config_hash')
  @config_hash = Docman::Application.instance.config.config_hash
  @config_yaml = Docman::Application.instance.config.to_yaml

  #TODO: need to refactor
  stored_docroot_config_hash = read_version_file_param('docroot_config_hash')
  @docroot_config_hash = @docroot_config.config_hash
  @docroot_config_yaml = @docroot_config.raw_infos.to_yaml
  if stored_config_hash != @config_hash
    log 'Forced rebuild as configuration was changed', 'info'
    filename = File.join(@docroot_config.root['full_build_path'], 'config.yaml')
    log Diffy::Diff.new(read_file(filename), @config_yaml) if File.file? filename
    Docman::Application.instance.force = true
  end
  if stored_docroot_config_hash != @docroot_config_hash
    log 'Forced rebuild as configuration was changed', 'info'
    filename = File.join(@docroot_config.root['full_build_path'], 'docroot_config.yaml')
    log Diffy::Diff.new(read_file(filename), @docroot_config_yaml) if File.file? filename
    Docman::Application.instance.force = true
  end
end

#deploy ⇒ Object 



85
86
87
88
89
90
91
92
93
94
 
# File 'lib/docman/deployers/deployer.rb', line 85

def deploy
  filename = 'version.yaml'
  path = File.join(@docroot_config.root['full_build_path'], filename)
  version = SecureRandom.hex
  write_version_file version, path
  write_config_file @config_yaml, File.join(@docroot_config.root['full_build_path'], 'config.yaml')
  write_config_file @docroot_config_yaml, File.join(@docroot_config.root['full_build_path'], 'docroot_config.yaml')
  run_with_hooks('push')
  raise 'Files are not deployed' unless files_deployed? version, filename
end

#describe(type = 'short') ⇒ Object 



168
169
170
 
# File 'lib/docman/deployers/deployer.rb', line 168

def describe(type = 'short')
  properties_info(['handler'])
end

#execute ⇒ Object 



75
76
77
78
79
80
81
82
83
 
# File 'lib/docman/deployers/deployer.rb', line 75

def execute
  run_with_hooks('build')
  if @changed
    run_with_hooks('deploy')
  else
    log 'No changes in docroot', 'info'
  end
  log "Deploy results:\n" + @build_results.to_yaml
end

#files_deployed?(version, filename) ⇒ Boolean

Returns:

  • (Boolean) 


96
97
98
99
100
101
102
 
# File 'lib/docman/deployers/deployer.rb', line 96

def files_deployed?(version, filename)
  return true unless self.has_key? 'target_checker'
  params = self['target_checker']
  params['version'] = version
  params['filename'] = filename
  Docman::TargetChecker.create(params, self).perform
end

#read_file(path) ⇒ Object 



104
105
106
107
108
 
# File 'lib/docman/deployers/deployer.rb', line 104

def read_file(path)
  YAML::load_file(path)
rescue
  raise "Error in config file #{path}"
end

#read_version_file_param(param) ⇒ Object 



110
111
112
113
114
115
 
# File 'lib/docman/deployers/deployer.rb', line 110

def read_version_file_param(param)
  path = File.join(@docroot_config.root['full_build_path'], 'version.yaml')
  return false unless File.file?(path)
  content = read_file(path)
  content[param] if content.has_key? param
end

#write_config_file(config, path) ⇒ Object 



125
126
127
 
# File 'lib/docman/deployers/deployer.rb', line 125

def write_config_file(config, path)
  File.open(path, 'w') {|f| f.write config.to_yaml}
end

#write_version_file(version, path) ⇒ Object 



117
118
119
120
121
122
123
 
# File 'lib/docman/deployers/deployer.rb', line 117

def write_version_file(version, path)
  to_write = Hash.new
  to_write['random'] = version
  to_write['config_hash'] = @config_hash
  to_write['docroot_config_hash'] = @docroot_config_hash
  File.open(path, 'w') {|f| f.write to_write.to_yaml}
end