Class: Squared::Workspace::Project::Docker

Inherits:
Base
  • Object
show all
Defined in:
lib/squared/workspace/project/docker.rb

Constant Summary collapse

DIR_DOCKER = 
(COMPOSEFILE + BAKEFILE).freeze

Constants included from Common

Common::ARG, Common::PATH

Instance Attribute Summary collapse

Attributes inherited from Base

#dependfile, #exception, #group, #name, #parent, #path, #pipe, #project, #theme, #verbose, #workspace

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#<=>, #add, aliasargs, #allref, #archive, #archive?, #as, as_path, bannerargs, #basepath, batchargs, #build, #chain, #copy, #copy?, #depend, #depend?, #dependtype, #dev?, #doc, #doc?, #enabled?, #error, #event, #exclude?, #first, #generate, #graph, #graph?, #has?, #initialize_build, #initialize_env, #initialize_events, #initialize_logger, #initialize_ref, #inject, #inspect, #last, #lint, #lint?, #localname, #log, populate, #prereqs, #prereqs?, #prod?, ref, #ref?, #rootpath, #script?, #series, subtasks, #task_include?, #test, #test?, to_s, #to_s, #to_sym, #unpack, #variable_set, #version, #with

Methods included from Common::Format

#enable_aixterm, #enable_drawing

Constructor Details

#initialize(file: nil, context: nil, tag: nil, secrets: nil, mounts: [], registry: nil, **kwargs) ⇒ Docker

Returns a new instance of Docker.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/squared/workspace/project/docker.rb', line 105

def initialize(*, file: nil, context: nil, tag: nil, secrets: nil, mounts: [], registry: nil, **kwargs)
  super
  return unless dockerfile(file).exist?

  @context = context
  @tag = tag || tagname("#{@project}:#{@version || 'latest'}")
  @mounts = mounts
  @secrets = secrets
  @registry = tagjoin registry, kwargs[:username]
  initialize_ref Docker.ref
  initialize_logger(**kwargs)
  initialize_env(**kwargs)
  @output[4] = merge_opts(kwargs[:args], @output[4]) if kwargs[:args]
end

Instance Attribute Details

#context ⇒ Object (readonly)

Returns the value of attribute context.



102
103
104
 
# File 'lib/squared/workspace/project/docker.rb', line 102

def context
  @context
end

#tag ⇒ Object

Returns the value of attribute tag.



103
104
105
 
# File 'lib/squared/workspace/project/docker.rb', line 103

def tag
  @tag
end

Class Method Details

.config?(val) ⇒ Boolean

Returns:

  • (Boolean) 


86
87
88
89
90
 
# File 'lib/squared/workspace/project/docker.rb', line 86

def config?(val)
  return false unless (val = as_path(val))

  val.join('Dockerfile').exist? || DIR_DOCKER.any? { |file| val.join(file).exist? }
end

.tasks ⇒ Object 



82
83
84
 
# File 'lib/squared/workspace/project/docker.rb', line 82

def tasks
  [].freeze
end

Instance Method Details

#build? ⇒ Boolean

Returns:

  • (Boolean) 


530
531
532
 
# File 'lib/squared/workspace/project/docker.rb', line 530

def build?
  @output[0] != false && dockerfile.exist?
end

#buildx(flag, opts = [], tag: nil, context: nil) ⇒ Object 



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/squared/workspace/project/docker.rb', line 303

def buildx(flag, opts = [], tag: nil, context: nil)
  cmd, opts = docker_session('buildx', opts: opts)
  op = OptionPartition.new(opts, OPT_DOCKER[:buildx][:common], cmd, project: self)
  op << flag
  op.parse(OPT_DOCKER[:buildx][flag == :bake ? :bake : :build] + OPT_DOCKER[:buildx][:shared])
  case flag
  when :build, :context
    append_tag(tag || option('tag', ignore: false) || @tag)
    append_context context
  when :bake
    unless op.empty?
      args = op.dup
      op.extras.clear
      if Dir.exist?(args.last)
        if projectpath?(val = args.pop)
          context = val
        else
          op.extras << val
        end
      end
      op.append(args, escape: true)
      contextdir context if context
    end
  end
  op.clear(pass: false)
  run(from: :"buildx:#{flag}")
end

#clean(sync: invoked_sync?('clean')) ⇒ Object 



233
234
235
236
237
 
# File 'lib/squared/workspace/project/docker.rb', line 233

def clean(*, sync: invoked_sync?('clean'), **)
  return super unless @clean.nil?

  image(:rm, sync: sync)
end

#clean? ⇒ Boolean

Returns:

  • (Boolean) 


534
535
536
 
# File 'lib/squared/workspace/project/docker.rb', line 534

def clean?
  super || dockerfile.exist?
end

#compose(opts, flags = nil, script: false, args: nil, from: :run) ⇒ Object 



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/squared/workspace/project/docker.rb', line 239

def compose(opts, flags = nil, script: false, args: nil, from: :run, **)
  return opts if script == false

  ret = docker_session
  if from == :run
    case (n = filetype)
    when 1, 2
      ret << 'buildx' << 'bake'
      append_file n
      from = :bake
    when 3, 4
      ret << 'compose' << 'build'
      append_file n
      from = :compose
    else
      ret << 'build'
    end
  else
    ret << from
  end
  case opts
  when String
    ret << opts
  when Hash
    ret.merge(append_hash(opts, build: true))
  when Enumerable
    ret.merge(opts.to_a)
  end

  [args, flags].each_with_index do |target, index|
    if target.is_a?(String)
      ret << target
    elsif (target = append_any(target, target: []))
      ret.merge(target.map { |arg| index == 0 ? fill_option(arg) : quote_option('build-arg', arg) })
    end
  end
  case from
  when :run
    case @secrets
    when String
      ret << quote_option('secret', @secrets, double: true)
    when Hash
      append = lambda do |type|
        as_a(@secrets[type]).each { |arg| ret << quote_option('secret', "type=#{type},#{arg}", double: true) }
      end
      append.call(:file)
      append.call(:env)
    else
      as_a(@secrets).each { |arg| ret << quote_option('secret', arg) }
    end
    if (val = option('tag', ignore: false))
      append_tag val
    elsif !session_arg?('t', 'tag')
      append_tag tag
    end
    append_context
  when :bake, :compose
    if (val = option(from == :bake ? 'target' : 'service', ignore: false))
      ret.merge(split_escape(val).map! { |s| shell_escape(s) })
    end
  end
  ret
end

#compose!(flag, opts = [], service: nil) ⇒ Object 



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/squared/workspace/project/docker.rb', line 331

def compose!(flag, opts = [], service: nil)
  cmd, opts = docker_session('compose', opts: opts)
  op = OptionPartition.new(opts, OPT_DOCKER[:compose][:common], cmd, project: self)
  append_file filetype unless op.arg?('f', 'file')
  op << flag
  op.parse(OPT_DOCKER[:compose][flag])
  from = :"compose:#{flag}"
  case flag
  when :build, :up
    op.append(escape: true)
  when :exec, :run
    append_command(flag, service, op.extras, from: from)
  end
  run(from: from)
end

#container(flag, opts = [], id: nil) ⇒ Object 



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/squared/workspace/project/docker.rb', line 347

def container(flag, opts = [], id: nil)
  cmd, opts = docker_session('container', flag, opts: opts)
  rc = flag == :run || flag == :create
  list = OPT_DOCKER[:container].fetch(flag, [])
  list += OPT_DOCKER[:container][:create] if flag == :run
  list += OPT_DOCKER[:container][:update] if rc
  op = OptionPartition.new(opts, list, cmd, project: self, args: rc || flag == :exec)
  from = :"container:#{flag}"
  case flag
  when :run, :create, :exec
    if rc && !op.arg?('mount')
      run = VAL_DOCKER[:run]
      both = run[:bind] + run[:tmpfs]
      diff = run[:bind].reject { |val| run[:tmpfs].include?(val) }
      delim = Regexp.new(",\\s*(?=#{both.join('|')})")
      as_a(@mounts).each do |val|
        args = []
        tmpfs = true
        val.split(delim).each do |opt|
          k, v, q = split_option(opt)
          next unless both.include?(k)

          if k == 'type'
            tmpfs = false if v == 'bind'
            next
          elsif diff.include?(k)
            tmpfs = false
          end
          case k
          when 'readonly', 'ro'
            args << k
            next
          when 'source', 'src', 'destination', 'dst', 'target'
            v = path + v
            v = shell_quote(v, option: false, force: false) if q == ''
            tmpfs = false if k[0] == 's'
          end
          args << "#{k}=#{q + v + q}"
        end
        cmd << "--mount type=#{tmpfs ? 'tmpfs' : 'bind'},#{args.join(',')}"
      end
    end
    append_command(flag, id || tagmain, op.extras, from: from)
  when :update
    raise_error('missing container', hint: from) if op.empty?
    op.append(escape: true)
  when :commit
    latest = op.shift || tagmain
    cmd << id << latest
    raise_error("unknown args: #{op.join(', ')}", hint: from) unless op.empty?
    return unless confirm_command(cmd.to_s, title: from, target: id, as: latest)

    registry = option('registry') || @registry
    run(from: from, exception: registry.nil? ? exception : true)
    return unless registry

    opts = []
    append_option('platform', target: opts, equals: true)
    opts << case option('disable-content-trust', ignore: false)
            when 'false', '0'
              '--disable-content-trust=false'
            else
              '--disable-content-trust'
            end
    opts << '--quiet' unless verbose
    return image(:push, opts, id: latest, registry: registry)
  else
    if op.empty?
      status = []
      no = true
      case flag
      when :inspect, :diff
        no = false
      when :start
        status = %w[created exited]
        no = false
      when :stop, :pause
        status = %w[running restarting]
      when :restart
        status = %w[running paused exited]
      when :unpause
        status << 'paused'
        no = false
      when :top, :stats
        status << 'running'
        cmd << '--no-stream' if flag == :stats
        no = false
      when :kill
        status = %w[running restarting paused]
      when :rm
        status = %w[created exited dead]
      end
      ps = docker_output('ps -a', *status.map { |s| "--filter=\"status=#{s}\"" })
      list_image(flag, ps, no: no, hint: "status: #{status.join(', ')}", from: from) do |img|
        run(cmd.temp(img), from: from)
      end
      return
    else
      op.append(escape: true)
    end
  end
  run(from: from)
end

#dockerfile(val = nil) ⇒ Object 



538
539
540
541
542
543
544
545
546
547
548
549
550
551
 
# File 'lib/squared/workspace/project/docker.rb', line 538

def dockerfile(val = nil)
  if val == 'Dockerfile'
    @file = false
  elsif val
    @file = if val.is_a?(Array)
              val = val.select { |file| basepath(file).exist? }
              val.size > 1 ? val : val.first
            else
              val || DIR_DOCKER.find { |file| basepath(file).exist? }
            end
    @file ||= false
  end
  basepath((@file.is_a?(Array) ? @file.first : @file) || 'Dockerfile')
end

#image(flag, opts = [], sync: true, id: nil, registry: nil) ⇒ Object 



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/squared/workspace/project/docker.rb', line 451

def image(flag, opts = [], sync: true, id: nil, registry: nil)
  cmd, opts = docker_session('image', flag, opts: opts)
  op = OptionPartition.new(opts, OPT_DOCKER[:image].fetch(flag, []), cmd, project: self)
  exception = @exception
  banner = true
  from = :"image:#{flag}"
  case flag
  when :list
    if opts.size == op.size
      index = 0
      name = nil
      opts.reverse_each { |opt| break opts.delete(opt) if (name = opt[/^name=["']?(.+?)["']?$/, 1]) }
      list_image(:run, cmd << '-a', from: from) do |val|
        container(:run, if name
                          opts.dup << "name=#{index == 0 ? name : "#{name}-#{index}"}"
                        else
                          opts
                        end, id: val)
        index += 1
      end
      return
    else
      op.clear
    end
  when :rm
    if id
      op << id
      if option('y')
        exception = false
        banner = false
      end
    else
      if op.empty?
        list_image(:rm, docker_output('image ls -a'), from: from) do |val|
          image(:rm, opts, sync: sync, id: val)
        end
      else
        op.each { |val| run(cmd.temp(val), sync: sync, from: from) }
      end
      return
    end
  when :tag, :save
    list_image(flag, docker_output('image ls -a'), from: from) do |val|
      op << val
      if flag == :tag
        op << tagname("#{@project}:#{op.extras.first}")
        break
      end
    end
  when :push
    id ||= option('tag', ignore: false) || tagmain
    registry ||= op.shift || option('registry') || @registry
    raise_error(id ? "unknown args: #{op.join(', ')}" : 'no id/tag given', hint: from) unless id && op.empty?
    raise_error('username/registry not provided', hint: from) unless registry
    registry.chomp!('/')
    uri = shell_quote("#{registry}/#{id}")
    op << uri
    img = docker_output 'image', 'tag', id, uri
    return unless confirm_command(img.to_s, cmd.to_s, target: id, as: registry, title: from)

    cmd = img
    sync = false
    exception = true
    banner = false
  end
  ret = run(cmd, sync: sync, exception: exception, banner: banner, from: from)
  print_success if success?(ret) && (flag == :tag || flag == :save)
end

#network(flag, opts = [], target: nil) ⇒ Object 



520
521
522
523
524
525
526
527
528
 
# File 'lib/squared/workspace/project/docker.rb', line 520

def network(flag, opts = [], target: nil)
  cmd, opts = docker_session('network', flag, opts: opts)
  op = OptionPartition.new(opts, OPT_DOCKER[:network][flag], cmd, project: self)
  op.clear
  from = :"network:#{flag}"
  list_image(flag, docker_output('ps -a'), from: from) do |img|
    print_success if success?(run(cmd.temp(target, img), from: from))
  end
end

#populate ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/squared/workspace/project/docker.rb', line 124

def populate(*, **)
  super
  return unless ref?(Docker.ref)

  namespace name do
    Docker.subtasks do |action, flags|
      next if @pass.include?(action)

      namespace action do
        flags.each do |flag|
          case action
          when 'build'
            case flag
            when :tag, :context
              format_desc(action, flag, 'opts*', before: flag == :tag ? 'name' : 'dir')
              task flag, [flag] do |_, args|
                param = param_guard(action, flag, args: args, key: flag)
                buildx(:build, args.extras, "#{flag}": param)
              end
            when :bake
              format_desc action, flag, ':?,opts*,target*,context?'
              task flag do |_, args|
                args = args.to_a
                if args.first == ':'
                  choice_command :bake
                else
                  buildx flag, args
                end
              end
            end
          when 'compose'
            case flag
            when :build, :up
              format_desc action, flag, 'opts*,service*'
              task flag do |_, args|
                compose! flag, args.to_a
              end
            when :exec, :run
              format_desc action, flag, "service,command#{flag == :exec ? '' : '?'},args*,opts*"
              task flag, [:service] do |_, args|
                service = param_guard(action, flag, args: args, key: :service)
                compose!(flag, args.extras, service: service)
              end
            end
          when 'container'
            case flag
            when :exec, :commit
              format_desc(action, flag, flag == :exec ? 'id/name,opts*,args+' : 'id/name,tag?,opts*')
              task flag, [:id] do |_, args|
                if flag == :exec && !args.id
                  choice_command flag
                else
                  id = param_guard(action, flag, args: args, key: :id)
                  container(flag, args.extras, id: id)
                end
              end
            when :run, :create
              format_desc action, flag, 'image,opts*,args*'
              task flag, [:image] do |_, args|
                if args.image
                  container(flag, args.extras, id: args.image)
                else
                  choice_command flag
                end
              end
            else
              format_desc(action, flag, 'opts*,id/name', after: flag == :update ? '+' : '*')
              task flag do |_, args|
                container flag, args.to_a
              end
            end
          when 'image'
            case flag
            when :push
              format_desc action, flag, 'tag,registry/username?,opts*'
              task flag, [:tag] do |_, args|
                tag = param_guard(action, flag, args: args, key: :tag)
                image(flag, args.extras, id: tag)
              end
            else
              format_desc(action, flag, case flag
                                        when :rm, :save then 'id*,opts*'
                                        when :tag then 'version?'
                                        else 'opts*,args*' end)
              task flag do |_, args|
                args = args.to_a
                if args.empty? && flag != :list
                  choice_command flag
                else
                  image flag, args
                end
              end
            end
          when 'network'
            format_desc action, flag, 'target,opts*'
            task flag, [:target] do |_, args|
              if args.target
                network(flag, args.extras, target: args.target)
              else
                choice_command flag
              end
            end
          end
        end
      end
    end
  end
end

#ref ⇒ Object 



120
121
122
 
# File 'lib/squared/workspace/project/docker.rb', line 120

def ref
  Docker.ref
end