Class: Wip::CLI

Inherits:
Thor
  • Object
show all
Defined in:
lib/wip/cli.rb

Overview

Thor-based command-line interface for wip.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.dispatch(meth, given_args, given_opts, config) ⇒ Object

Thor only falls back to the default task when no command name is given at all; an unrecognized first argument (e.g. a custom wip.yml command name) would otherwise raise "Could not find command". Route those to dispatch.



24
25
26
27
28
29
30
31
 
# File 'lib/wip/cli.rb', line 24

def self.dispatch(meth, given_args, given_opts, config)
  name = given_args.first
  if meth.nil? && name && !name.to_s.start_with?('-') && find_command_possibilities(name).empty?
    return super('dispatch', given_args, given_opts, config)
  end

  super
end

.exit_on_failure? ⇒ Boolean

Returns:

  • (Boolean) 


19
 
# File 'lib/wip/cli.rb', line 19

def self.exit_on_failure? = true

Instance Method Details

#build(*extra) ⇒ Object 



69
70
71
72
73
74
75
76
 
# File 'lib/wip/cli.rb', line 69

def build(*extra)
  extra.shift if extra.first == '--'
  settings = load_config.command('build') || {}
  context = settings['context'] || '.'
  BuildContext.new(context).stage do |staged_context|
    execute(builder.build(settings: settings.merge('context' => staged_context), extra: extra))
  end
end

#config ⇒ Object 



64
65
66
 
# File 'lib/wip/cli.rb', line 64

def config
  puts YAML.dump(load_config.to_h)
end

#dispatch(name = nil, *arguments) ⇒ Object

Raises:



180
181
182
183
184
185
186
187
 
# File 'lib/wip/cli.rb', line 180

def dispatch(name = nil, *arguments)
  raise ConfigError, 'A command is required' unless name

  values = load_config.command(name) || raise(ConfigError, "Unknown command: #{name}")
  return dispatch_compose(name, values, arguments) if load_config.compose?

  execute(builder.custom(name, arguments), interactive: tty?(values.fetch('interactive', false)))
end

#doctor ⇒ Object 



57
58
59
60
61
 
# File 'lib/wip/cli.rb', line 57

def doctor
  results = Doctor.new(loader: loader).call
  results.each { |item| puts "[#{item.level.to_s.upcase}] #{item.message}" }
  exit(1) if results.any? { |item| item.level == :fail }
end

#down ⇒ Object 



115
116
117
118
119
120
121
122
123
124
 
# File 'lib/wip/cli.rb', line 115

def down
  return execute(compose_bridge.down, exit_on_failure: false) if load_config.compose?

  execute(builder.down, exit_on_failure: false)
  execute(builder.remove, exit_on_failure: false)
  sidecar_names.each do |name|
    execute(builder.dependency_down(name), exit_on_failure: false)
    execute(builder.dependency_remove(name), exit_on_failure: false)
  end
end

#exec(*command) ⇒ Object 



128
129
130
 
# File 'lib/wip/cli.rb', line 128

def exec(*command)
  execute(exec_target(command, interactive: options[:interactive]), interactive: tty?(options[:interactive]))
end

#init ⇒ Object

Raises:



47
48
49
50
51
52
53
54
 
# File 'lib/wip/cli.rb', line 47

def init
  path = Pathname(options[:config] || ConfigLoader::FILENAME).expand_path
  raise Error, "#{path} already exists (use --force to overwrite)" if path.file? && !options[:force]

  initializer = Initializer.new(dir: path.dirname, template: options[:template])
  path.write(initializer.call)
  warn "wip: wrote #{path} (mode: #{initializer.compose? ? 'compose-native' : 'container'})"
end

#logs(*services) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/wip/cli.rb', line 160

def logs(*services)
  unless load_config.compose? || load_config.compose_native?
    raise ConfigError, '`wip logs` is only available in compose mode'
  end
  if load_config.compose?
    return execute(compose_bridge.logs(services: services, follow: options[:follow]),
                   interactive: true)
  end

  # wslc has no compose-style multi-service log aggregation (see CommandBuilder#logs) —
  # exactly one SERVICE is required, defaulting to compose.service when none is given.
  if services.size > 1
    raise ConfigError, '`wip logs` under mode: compose-native takes at most one SERVICE ' \
                       '(wslc logs, unlike a real compose tool, only follows one container at a time)'
  end

  execute(builder.logs(services.first || load_config.compose_service, follow: options[:follow]), interactive: true)
end

#run_command(*command) ⇒ Object 



134
135
136
137
138
139
140
141
142
143
 
# File 'lib/wip/cli.rb', line 134

def run_command(*command)
  if load_config.compose?
    warn "wip: compose mode has no ephemeral 'run'; executing in the running " \
         "'#{load_config.compose_service}' service instead"
    return execute(exec_target(command, interactive: options[:interactive]),
                   interactive: tty?(options[:interactive]))
  end

  execute(builder.run(command, interactive: options[:interactive]), interactive: tty?(options[:interactive]))
end

#shell_command ⇒ Object 



147
148
149
150
151
152
153
154
155
 
# File 'lib/wip/cli.rb', line 147

def shell_command
  configured = load_config.command('shell')
  return dispatch('shell') if configured

  code = execute(exec_target(['bash'], interactive: true), interactive: tty?(true), exit_on_failure: false)
  return if code.zero?

  execute(exec_target(['sh'], interactive: true), interactive: tty?(true))
end

#sync ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/wip/cli.rb', line 97

def sync
  settings = sync_settings!
  warn_shadowed_command('sync')
  ensure_sync_image(settings)
  return run_sync unless options[:watch]

  interval = watch_interval(settings)
  warn "wip: syncing #{settings.source} -> #{settings.volume}:#{settings.target} " \
       "every #{interval}s (Ctrl-C to stop)"
  loop do
    run_sync(exit_on_failure: false)
    sleep interval
  end
rescue Interrupt
  warn "\nwip: sync stopped"
end

#up ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/wip/cli.rb', line 81

def up
  if load_config.compose?
    sync_before_boot if options[:sync]
    return execute(compose_bridge.up(detach: options[:detach]), interactive: tty?(!options[:detach]))
  end

  ensure_compose_images
  ensure_network
  sidecar_names.each { |name| ensure_dependency(name) }
  sync_before_boot if options[:sync]
  ensure_container
end

#version ⇒ Object 



34
35
36
37
38
39
40
41
 
# File 'lib/wip/cli.rb', line 34

def version
  puts "wip #{VERSION}"
  config = load_config
  command = resolver.resolve(config.wslc_command)
  system(command, 'version')
rescue Error
  nil
end