|
| 1 | +#!/usr/bin/env ruby |
| 2 | +# frozen_string_literal: true |
| 3 | + |
| 4 | +require 'optparse' |
| 5 | + |
| 6 | +# A script used to test calling a command line program from Ruby |
| 7 | +# |
| 8 | +# This script is used to test the `Git::CommandLine` class. It is called |
| 9 | +# from the `test_command_line` unit test. |
| 10 | +# |
| 11 | +# --stdout: string to output to stdout |
| 12 | +# --stderr: string to output to stderr |
| 13 | +# --exitstatus: exit status to return (default is zero) |
| 14 | +# --signal: uncaught signal to raise (default is not to signal) |
| 15 | +# |
| 16 | +# Both --stdout and --stderr can be given. |
| 17 | +# |
| 18 | +# If --signal is given, --exitstatus is ignored. |
| 19 | +# |
| 20 | +# Examples: |
| 21 | +# Output "Hello, world!" to stdout and exit with status 0 |
| 22 | +# $ bin/command_line_test --stdout="Hello, world!" --exitstatus=0 |
| 23 | +# |
| 24 | +# Output "ERROR: timeout" to stderr and exit with status 1 |
| 25 | +# $ bin/command_line_test --stderr="ERROR: timeout" --exitstatus=1 |
| 26 | +# |
| 27 | +# Output "Fatal: killed by parent" to stderr and signal 9 |
| 28 | +# $ bin/command_line_test --stderr="Fatal: killed by parent" --signal=9 |
| 29 | +# |
| 30 | +# Output to both stdout and stderr return default exitstatus 0 |
| 31 | +# $ bin/command_line_test --stdout="Hello, world!" --stderr="ERROR: timeout" |
| 32 | +# |
| 33 | + |
| 34 | + |
| 35 | +class CommandLineParser |
| 36 | + def initialize |
| 37 | + @option_parser = OptionParser.new |
| 38 | + define_options |
| 39 | + end |
| 40 | + |
| 41 | + attr_reader :stdout, :stderr, :exitstatus, :signal |
| 42 | + |
| 43 | + # Parse the command line arguements returning the options |
| 44 | + # |
| 45 | + # @example |
| 46 | + # parser = CommandLineParser.new |
| 47 | + # options = parser.parse(['major']) |
| 48 | + # |
| 49 | + # @param args [Array<String>] the command line arguments |
| 50 | + # |
| 51 | + # @return [CreateGithubRelease::Options] the options |
| 52 | + # |
| 53 | + def parse(*args) |
| 54 | + begin |
| 55 | + option_parser.parse!(remaining_args = args.dup) |
| 56 | + rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e |
| 57 | + report_errors(e.message) |
| 58 | + end |
| 59 | + parse_remaining_args(remaining_args) |
| 60 | + # puts options unless options.quiet |
| 61 | + # report_errors(*options.errors) unless options.valid? |
| 62 | + self |
| 63 | + end |
| 64 | + |
| 65 | + private |
| 66 | + |
| 67 | + # @!attribute [rw] option_parser |
| 68 | + # |
| 69 | + # The option parser |
| 70 | + # |
| 71 | + # @return [OptionParser] the option parser |
| 72 | + # |
| 73 | + # @api private |
| 74 | + # |
| 75 | + attr_reader :option_parser |
| 76 | + |
| 77 | + def define_options |
| 78 | + option_parser.banner = "Usage:\n#{command_template}" |
| 79 | + option_parser.separator '' |
| 80 | + option_parser.separator "Both --stdout and --stderr can be given." |
| 81 | + option_parser.separator 'If --signal is given, --exitstatus is ignored.' |
| 82 | + option_parser.separator 'If nothing is given, the script will exit with exitstatus 0.' |
| 83 | + option_parser.separator '' |
| 84 | + option_parser.separator 'Options:' |
| 85 | + %i[ |
| 86 | + define_help_option define_stdout_option define_stderr_option |
| 87 | + define_exitstatus_option define_signal_option |
| 88 | + ].each { |m| send(m) } |
| 89 | + end |
| 90 | + |
| 91 | + # The command line template as a string |
| 92 | + # @return [String] |
| 93 | + # @api private |
| 94 | + def command_template |
| 95 | + <<~COMMAND |
| 96 | + #{File.basename($PROGRAM_NAME)} \ |
| 97 | + --help | \ |
| 98 | + [--stdout="string to stdout"] [--stderr="string to stderr"] [--exitstatus=1] [--signal=9] |
| 99 | + COMMAND |
| 100 | + end |
| 101 | + |
| 102 | + # Define the stdout option |
| 103 | + # @return [void] |
| 104 | + # @api private |
| 105 | + def define_stdout_option |
| 106 | + option_parser.on('--stdout="string to stdout"', 'A string to send to stdout') do |string| |
| 107 | + @stdout = string |
| 108 | + end |
| 109 | + end |
| 110 | + |
| 111 | + # Define the stderr option |
| 112 | + # @return [void] |
| 113 | + # @api private |
| 114 | + def define_stderr_option |
| 115 | + option_parser.on('--stderr="string to stderr"', 'A string to send to stderr') do |string| |
| 116 | + @stderr = string |
| 117 | + end |
| 118 | + end |
| 119 | + |
| 120 | + # Define the exitstatus option |
| 121 | + # @return [void] |
| 122 | + # @api private |
| 123 | + def define_exitstatus_option |
| 124 | + option_parser.on('--exitstatus=1', 'The exitstatus to return') do |exitstatus| |
| 125 | + @exitstatus = Integer(exitstatus) |
| 126 | + end |
| 127 | + end |
| 128 | + |
| 129 | + # Define the signal option |
| 130 | + # @return [void] |
| 131 | + # @api private |
| 132 | + def define_signal_option |
| 133 | + option_parser.on('--signal=9', 'The signal to raise') do |signal| |
| 134 | + @signal = Integer(signal) |
| 135 | + end |
| 136 | + end |
| 137 | + |
| 138 | + # Define the help option |
| 139 | + # @return [void] |
| 140 | + # @api private |
| 141 | + def define_help_option |
| 142 | + option_parser.on_tail('-h', '--help', 'Show this message') do |
| 143 | + puts option_parser |
| 144 | + exit 0 |
| 145 | + end |
| 146 | + end |
| 147 | + |
| 148 | + # An error message constructed from the given errors array |
| 149 | + # @return [String] |
| 150 | + # @api private |
| 151 | + def error_message(errors) |
| 152 | + <<~MESSAGE |
| 153 | + #{errors.map { |e| "ERROR: #{e}" }.join("\n")} |
| 154 | +
|
| 155 | + Use --help for usage |
| 156 | + MESSAGE |
| 157 | + end |
| 158 | + |
| 159 | + # Output an error message and useage to stderr and exit |
| 160 | + # @return [void] |
| 161 | + # @api private |
| 162 | + def report_errors(*errors) |
| 163 | + warn error_message(errors) |
| 164 | + exit 1 |
| 165 | + end |
| 166 | + |
| 167 | + # Parse non-option arguments (there are none for this parser) |
| 168 | + # @return [void] |
| 169 | + # @api private |
| 170 | + def parse_remaining_args(remaining_args) |
| 171 | + report_errors('Too many args') unless remaining_args.empty? |
| 172 | + end |
| 173 | +end |
| 174 | + |
| 175 | +options = CommandLineParser.new.parse(*ARGV) |
| 176 | + |
| 177 | +STDOUT.puts options.stdout if options.stdout |
| 178 | +STDERR.puts options.stderr if options.stderr |
| 179 | +Process.kill(options.signal, Process.pid) if options.signal |
| 180 | +exit(options.exitstatus) if options.exitstatus |
0 commit comments