Module: DeployDoc::CLI

Defined in:
lib/deploy_doc/cli.rb

Class Method Summary collapse

Class Method Details

.check_and_find_envs(test_plan) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/deploy_doc/cli.rb', line 97

def self.check_and_find_envs(test_plan)
  test_plan.required_env_vars.map do |name|
    val = ENV[name]
    if val.nil?
      $stderr.puts "Required environmental variable #{name} is not set"
      exit 1
    else
      "-e#{name}=#{val}"
    end
  end.join(" ")
end

.do_run(test_plan, configuration) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/deploy_doc/cli.rb', line 71

def self.do_run(test_plan, configuration)
  status = nil

  test_instructions_file = Tempfile.new("deploydoc", "/tmp")
  test_instructions_file.write test_plan.to_json
  test_instructions_file.close
  runner_path = File.expand_path("../../../runner/runner.rb", __FILE__)
  extra_opts = [
    "-v#{test_instructions_file.path}:/deploy_doc/steps.json",
    "-v#{runner_path}:/deploy_doc/runner",
  ]
  system Docker.cmd(configuration, check_and_find_envs(test_plan), "ruby /deploy_doc/runner /deploy_doc/steps.json", extra_opts)
  status = $?
  test_instructions_file.close
  test_instructions_file.unlink
  exit status.exitstatus
end

.dump_json(test_plan, configuration) ⇒ Object 



89
90
91
 
# File 'lib/deploy_doc/cli.rb', line 89

def self.dump_json(test_plan, configuration)
  puts test_plan.to_json
end

.just_docker_env(test_plan, configuration) ⇒ Object 



93
94
95
 
# File 'lib/deploy_doc/cli.rb', line 93

def self.just_docker_env(test_plan, configuration)
  Kernel.exec Docker.cmd(configuration, check_and_find_envs(test_plan), "sh", ["-ti"])
end

.parse_arguments(arguments) ⇒ Object 



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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/deploy_doc/cli.rb', line 19

def self.parse_arguments(arguments)
  configuration = Config.defaults

  opt_parser = OptionParser.new do |opts|
    opts.banner = "USAGE: deploy_doc <markdown_file> [options]"

    opts.on("-h", "--help", "Print help") do
      puts opts
      puts
      puts "EXIT STATUS:"
      puts "  If all test passed, and the infrastructure has been cleaned up, 0 is returned."
      puts "  If something went wrong, but there the infrastructure has been destroyed correctly,"
      puts "  a 1 error status is returned, but if the destruction of the infrastructure did not complete,"
      puts "  the process returns an error status 2. These cases will probably require manual cleanup steps."
      puts "  Finally, a error status 3 is returned if the program is aborted. We cannot give any guarrantees in this case!"
      exit
    end

    opts.on("-r", "--run-test", "Run tests") do
      configuration.action = :run
    end

    opts.on("-j", "--dump-json", "Just parse the Markdown file and dump the steps to JSON") do
      configuration.action = :dump_json
    end

    opts.on("-c", "--shell-in-container", "Start a (temporary) docker container with the same environment as the tests will run in") do
      configuration.action = :just_docker_env
    end

    opts.on("-iIMG_NAME", "--docker-image=IMG_NAME", "Use this docker image instead of the default '#{configuration.docker_image}'") do |image|
      configuration.docker_image = image
    end

    opts.on("-dDIR", "--data-dir=DIR", "Set the data directory, instead of the default '#{configuration.data_dir}'")do |data_dir|
      configuration.data_dir = data_dir
    end
  end
  opt_parser.parse!(arguments)
  configuration.markdown_file = arguments.shift

  if configuration.markdown_file.nil?
    raise DeployDoc::Error.new("No markdown file provided! Run `deploy_doc -h' to learn more about how to use this tool.")
  end

  if configuration.action.nil?
    raise DeployDoc::Error.new("No action given. Either --run-tests, --dump-json or --shell-in-container must be specified")
  end

  configuration
end

.run!(arguments) ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/deploy_doc/cli.rb', line 3

def self.run!(arguments)
  configuration = parse_arguments(arguments)

  test_plan = TestPlan.from_file(configuration.markdown_file)

  case configuration.action
    when :run then self.do_run(test_plan, configuration)
    when :dump_json then self.dump_json(test_plan, configuration)
    when :just_docker_env then self.just_docker_env(test_plan, configuration)
    else raise RuntimeError.new("No such action '#{configuration.action}'")
  end
rescue DeployDoc::Error => e
  puts "Runtime error: #{e.message}"
  exit 1
end