1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 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 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 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 232 233 234 235 236 237 238 239 240 241 242 243
|
# frozen_string_literal: true
require 'yaml'
require 'json'
require 'base64'
class Gitlab::CLI
# Defines methods related to CLI output and formatting.
module Helpers
module_function
# Returns actions available to CLI & Shell
#
# @return [Array]
def actions
@actions ||= Gitlab.actions
end
# Returns Gitlab::Client instance
#
# @return [Gitlab::Client]
def client
@client ||= Gitlab::Client.new(endpoint: Gitlab.endpoint || '')
end
# Returns method names and their owners
#
# @return [Array<Hash>]
def method_owners
@method_owners ||= actions.map do |action|
{
name: action.to_s,
owner: client.method(action).owner.to_s
}
end
end
# Returns filtered required fields.
#
# @return [Array]
def required_fields(args)
filtered_fields(args, '--only=')
end
# Returns filtered excluded fields.
#
# @return [Array]
def excluded_fields(args)
filtered_fields(args, '--except=')
end
# Returns fields filtered by a keyword.
#
# @return [Array]
def filtered_fields(args, key)
return [] unless args.any? && args.last.is_a?(String) && args.last.start_with?(key)
args.last.gsub(key, '').split(',')
end
# Confirms command is valid.
#
# @return [Boolean]
def valid_command?(cmd)
command = cmd.is_a?(Symbol) ? cmd : cmd.to_sym
Gitlab.actions.include?(command)
end
# Confirms command with a desctructive action.
#
# @return [String]
def confirm_command(cmd)
return unless cmd.start_with?('remove_', 'delete_')
puts 'Are you sure? (y/n)'
if %w[y yes].include?($stdin.gets.to_s.strip.downcase)
puts 'Proceeding..'
else
puts 'Command aborted.'
exit(1)
end
end
# Gets defined help for a specific command/action.
#
# @return [String]
def help(cmd = nil, &block)
if cmd.nil? || Gitlab::Help.help_map.key?(cmd)
Gitlab::Help.actions_table(cmd)
else
Gitlab::Help.get_help(cmd, &block)
end
end
# Outputs a nicely formatted table or error message.
def output_table(cmd, args, data)
case data
when Gitlab::ObjectifiedHash, Gitlab::FileResponse
puts record_table([data], cmd, args)
when Gitlab::PaginatedResponse
puts record_table(data, cmd, args)
else # probably just an error message
puts data
end
end
def output_json(cmd, args, data)
if data.respond_to?(:empty?) && data.empty?
puts '{}'
else
hash_result = case data
when Gitlab::ObjectifiedHash, Gitlab::FileResponse
record_hash([data], cmd, args, single_value: true)
when Gitlab::PaginatedResponse
record_hash(data, cmd, args)
else
{ cmd: cmd, data: data, args: args }
end
puts JSON.pretty_generate(hash_result)
end
end
# Table to display records.
#
# @return [Terminal::Table]
def record_table(data, cmd, args)
return 'No data' if data.empty?
arr, keys = get_keys(args, data)
table do |t|
t.title = "Gitlab.#{cmd} #{args.join(', ')}"
t.headings = keys
arr.each_with_index do |hash, index|
values = []
keys.each do |key|
case value = hash[key]
when Hash
value = value.key?('id') ? value['id'] : 'Hash'
when StringIO
value = 'File'
when nil
value = 'null'
end
values << value
end
t.add_row values
t.add_separator unless arr.size - 1 == index
end
end
end
# Renders the result of given commands and arguments into a Hash
#
# @param [Array] data Resultset from the API call
# @param [String] cmd The command passed to the API
# @param [Array] args Options passed to the API call
# @param [bool] single_value If set to true, a single result should be returned
# @return [Hash] Result hash
def record_hash(data, cmd, args, single_value: false)
if data.empty?
result = nil
else
arr, keys = get_keys(args, data)
result = []
arr.each do |hash|
row = {}
keys.each do |key|
row[key] = case hash[key]
when Hash
'Hash'
when StringIO
Base64.encode64(hash[key].read)
when nil
nil
else
hash[key]
end
end
result.push row
end
result = result[0] if single_value && result.count.positive?
end
{
cmd: "Gitlab.#{cmd} #{args.join(', ')}".strip,
result: result
}
end
# Helper function to get rows and keys from data returned from API call
def get_keys(args, data)
arr = data.map(&:to_h)
keys = arr.first.keys.sort_by(&:to_s)
keys &= required_fields(args) if required_fields(args).any?
keys -= excluded_fields(args)
[arr, keys]
end
# Helper function to call Gitlab commands with args.
def gitlab_helper(cmd, args = [])
args.any? ? Gitlab.send(cmd, *args) : Gitlab.send(cmd)
rescue StandardError => e
puts e.message
yield if block_given?
end
# Convert a hash (recursively) to use symbol hash keys
# @return [Hash]
def symbolize_keys(hash)
if hash.is_a?(Hash)
hash = hash.each_with_object({}) do |(key, value), new_hash|
new_hash[key.to_sym] = symbolize_keys(value)
rescue NoMethodError
raise "Error: cannot convert hash key to symbol: #{key}"
end
end
hash
end
# Check if arg is a color in 6-digit hex notation with leading '#' sign
def hex_color?(arg)
pattern = /\A#\h{6}\Z/
pattern.match(arg)
end
# YAML::load on a single argument
def yaml_load(arg)
hex_color?(arg) ? arg : YAML.safe_load(arg)
rescue Psych::SyntaxError
raise "Error: Argument is not valid YAML syntax: #{arg}"
end
end
end
|