Class: Dapp::Dimg::Build::Stage::Base

Inherits:
Object
  • Object
show all
Includes:
Mod::Logging, Helper::Sha256, Helper::Trivia
Defined in:
lib/dapp/dimg/build/stage/base.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Mod::Logging

#ignore_log_commands?, #image_should_be_introspected?, #image_should_be_introspected_after_build?, #image_should_be_introspected_before_build?, #log_build, #log_image_build, #log_image_commands, #log_image_created_at, #log_image_details, #log_image_instructions, #log_image_size, #log_name, #log_name_context, #log_state, #should_not_be_detailed?

Methods included from Helper::Trivia

#check_path?, #check_subpath?, #class_to_lowercase, class_to_lowercase, #delete_file, #ignore_path?, #ignore_path_base, #kwargs, #make_path, #path_checker, #search_file_upward

Methods included from Helper::Sha256

#hashsum, #paths_content_hashsum, #sha256

Constructor Details

#initialize(dimg, next_stage) ⇒ Base

Returns a new instance of Base.



13
14
15
16
17
18
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 13

def initialize(dimg, next_stage)
  @dimg = dimg

  @next_stage = next_stage
  @next_stage.prev_stage = self
end

Instance Attribute Details

#dimg ⇒ Object (readonly)

Returns the value of attribute dimg.



11
12
13
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 11

def dimg
  @dimg
end

#next_stage ⇒ Object

Returns the value of attribute next_stage.



10
11
12
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 10

def next_stage
  @next_stage
end

#prev_stage ⇒ Object

Returns the value of attribute prev_stage.



10
11
12
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 10

def prev_stage
  @prev_stage
end

Instance Method Details

#adding_custom_dir_mounts ⇒ Object 



121
122
123
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 121

def adding_custom_dir_mounts
  config_custom_dir_mounts.in_depth_merge(labels_custom_dir_mounts)
end

#adding_mounts_by_type(type) ⇒ Object 



117
118
119
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 117

def adding_mounts_by_type(type)
  (config_mounts_by_type(type) + labels_mounts_by_type(type)).uniq
end

#artifact? ⇒ Boolean

Returns:

  • (Boolean) 


202
203
204
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 202

def artifact?
  false
end

#build! ⇒ Object

rubocop:enable Metrics/MethodLength, Metrics/PerceivedComplexity



53
54
55
56
57
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 53

def build!
  prev_stage.build! if prev_stage
  renew             if should_be_renewed?
  image_build
end

#build_lock! ⇒ Object

rubocop:disable Metrics/PerceivedComplexity



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
46
47
48
49
50
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 21

def build_lock!
  return yield if dimg.dapp.dry_run?

  try_lock = proc do
    next yield unless image_should_be_locked?

    no_lock = false

    dimg.dapp.lock("#{dimg.dapp.name}.image.#{image.name}") do
      image.class.reset_image_inspect(image.name)

      if image_should_be_locked?
        yield
      else
        stage = self
        stage.renew until (stage = stage.next_stage).nil?

        no_lock = true
      end
    end

    yield if no_lock
  end

  if prev_stage
    prev_stage.build_lock! { try_lock.call }
  else
    try_lock.call
  end
end

#builder_checksum ⇒ Object 



175
176
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 175

def builder_checksum
end

#config_custom_dir_mounts ⇒ Object 



125
126
127
128
129
130
131
132
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 125

def config_custom_dir_mounts
  dimg.config._custom_dir_mount.reduce({}) do |mounts, mount|
    from_path = File.expand_path(mount._from)
    mounts[from_path] ||= []
    mounts[from_path] << mount._to
    mounts
  end
end

#config_mounts_by_type(type) ⇒ Object 



134
135
136
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 134

def config_mounts_by_type(type)
  dimg.config.public_send("_#{type}_mount").map(&:_to)
end

#dependencies ⇒ Object 



194
195
196
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 194

def dependencies
  []
end

#dependencies_discard ⇒ Object 



198
199
200
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 198

def dependencies_discard
  @dependencies = nil
end

#dependencies_empty? ⇒ Boolean

Returns:

  • (Boolean) 


153
154
155
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 153

def dependencies_empty?
  dependencies.flatten.compact.delete_if { |val| val.respond_to?(:empty?) && val.empty? }.empty?
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


149
150
151
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 149

def empty?
  dependencies_empty?
end

#g_a_stage? ⇒ Boolean

Returns:

  • (Boolean) 


206
207
208
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 206

def g_a_stage?
  false
end

#git_artifacts_dependencies ⇒ Object 



178
179
180
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 178

def git_artifacts_dependencies
  dimg.git_artifacts.map { |git_artifact| git_artifact.stage_dependencies_checksum(self) }
end

#image ⇒ Object 



65
66
67
68
69
70
71
72
73
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 65

def image
  @image ||= begin
    if empty?
      prev_stage.image
    else
      Image::Stage.image_by_name(name: image_name, from: from_image, dapp: dimg.dapp)
    end
  end
end

#image_add_custom_mounts ⇒ Object 



109
110
111
112
113
114
115
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 109

def image_add_custom_mounts
  adding_custom_dir_mounts.each do |from, to_pathes|
    FileUtils.mkdir_p(from)
    to_pathes.tap(&:uniq!).map { |to_path| image.add_volume "#{from}:#{to_path}" }
    image.add_service_change_label :"dapp-mount-custom-dir-#{from.gsub('/', '--')}" => to_pathes.join(';')
  end
end

#image_add_mounts ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 93

def image_add_mounts
  [:tmp_dir, :build_dir].each do |type|
    next if (mounts = adding_mounts_by_type(type)).empty?

    mounts.each do |path|
      absolute_path = File.expand_path(File.join('/', path))
      tmp_path = dimg.send(type, 'mount', absolute_path[1..-1]).tap(&:mkpath)
      image.add_volume "#{tmp_path}:#{absolute_path}"
    end

    image.add_service_change_label :"dapp-mount-#{type.to_s.tr('_', '-')}" => mounts.join(';')
  end

  image_add_custom_mounts
end

#labels_custom_dir_mounts ⇒ Object 



142
143
144
145
146
147
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 142

def labels_custom_dir_mounts
  from_image.labels.map do |label, value|
    next unless label =~ /dapp-mount-custom-dir-(?<from>.+)/
    [File.expand_path(Regexp.last_match(:from).gsub('--', '/')), value.split(';')]
  end.compact.to_h
end

#labels_mounts_by_type(type) ⇒ Object 



138
139
140
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 138

def labels_mounts_by_type(type)
  from_image.labels.select { |l, _| l == "dapp-mount-#{type.to_s.tr('_', '-')}" }.map { |_, value| value.split(';') }.flatten
end

#layer_commit(git_artifact) ⇒ Object 



182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 182

def layer_commit(git_artifact)
  commits[git_artifact] ||= begin
    if image.built?
      image.labels[dimg.dapp.dimgstage_g_a_commit_label(git_artifact.paramshash)]
    elsif g_a_stage? && !empty?
      git_artifact.latest_commit
    elsif prev_stage
      prev_stage.layer_commit(git_artifact)
    end
  end
end

#name ⇒ Object 



171
172
173
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 171

def name
  class_to_lowercase.to_sym
end

#prepare_image ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 75

def prepare_image
  return if dimg.dapp.dry_run?

  image_add_mounts

  image.add_service_change_label dapp: dimg.stage_dapp_label
  image.add_service_change_label 'dapp-version'.to_sym => ::Dapp::VERSION
  image.add_service_change_label 'dapp-cache-version'.to_sym => ::Dapp::BUILD_CACHE_VERSION
  image.add_service_change_label 'dapp-dev-mode'.to_sym => true if dimg.dev_mode?

  if dimg.dapp.ssh_auth_sock
    image.add_volume "#{dimg.dapp.ssh_auth_sock}:/tmp/dapp-ssh-agent"
    image.add_env 'SSH_AUTH_SOCK', '/tmp/dapp-ssh-agent'
  end

  yield if block_given?
end

#save_in_cache! ⇒ Object 



59
60
61
62
63
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 59

def save_in_cache!
  prev_stage.save_in_cache! if prev_stage
  return unless should_be_tagged?
  image.save_in_cache! unless dimg.dapp.dry_run?
end

#signature ⇒ Object 



157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/dapp/dimg/build/stage/base.rb', line 157

def signature
  if empty?
    prev_stage.signature
  else
    args = []
    args << prev_stage.signature unless prev_stage.nil?
    args << dimg.build_cache_version
    args << builder_checksum
    args.concat(dependencies.flatten)

    hashsum args
  end
end