Class: Bosh::Cli::Config
Constant Summary collapse
- VALID_ID =
/^[-a-z0-9_.]+$/i
Class Attribute Summary collapse
-
.colorize ⇒ Boolean
Should CLI output be colorized?.
-
.commands ⇒ Hash<String,Bosh::Cli::CommandDefinition>
readonly
Available commands.
-
.interactive ⇒ Boolean
Is CLI being used interactively?.
-
.max_parallel_downloads ⇒ Integer
CLI max parallel downloads.
-
.output ⇒ IO
Where output goes.
-
.poll_interval ⇒ Integer
CLI polling interval.
Instance Attribute Summary collapse
-
#filename ⇒ Object
readonly
Returns the value of attribute filename.
Class Method Summary collapse
-
.register_command(command) ⇒ void
Register command with BOSH CLI.
Instance Method Summary collapse
-
#access_token(target) ⇒ String
Token associated with target.
- #aliases(category) ⇒ Object
- #ca_cert(for_target = nil) ⇒ Object
-
#credentials_for(target) ⇒ Hash
Director credentials.
-
#deployment ⇒ String?
Read the deployment configuration.
-
#initialize(filename, work_dir = Dir.pwd) ⇒ Config
constructor
A new instance of Config.
-
#is_old_deployment_config? ⇒ Boolean
Deployment used to be a string that was only stored for your current target.
-
#max_parallel_downloads ⇒ Integer
Read the max parallel downloads configuration.
-
#password(target) ⇒ String
Password associated with target.
- #read(attr, try_local_first = true) ⇒ Object
-
#refresh_token(target) ⇒ String
Refresh token associated with target.
- #release ⇒ Object
- #release=(value) ⇒ Object
- #resolve_alias(category, alias_name) ⇒ Object
- #save ⇒ Object
- #save_ca_cert_path(cert_path) ⇒ Object
- #set_alias(category, alias_name, value) ⇒ Object
- #set_credentials(target, credentials) ⇒ Object
-
#set_deployment(deployment_file_path) ⇒ Object
Sets the deployment file for the current target.
- #target ⇒ Object
- #target=(value) ⇒ Object
- #target_name ⇒ Object
- #target_name=(value) ⇒ Object
- #target_uuid ⇒ Object
- #target_uuid=(value) ⇒ Object
- #target_version ⇒ Object
- #target_version=(value) ⇒ Object
-
#username(target) ⇒ String
Username associated with target.
- #write(attr, value) ⇒ Object
- #write_global(attr, value) ⇒ Object
Constructor Details
#initialize(filename, work_dir = Dir.pwd) ⇒ Config
Returns a new instance of Config.
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
# File 'lib/cli/config.rb', line 42 def initialize(filename, work_dir = Dir.pwd) @filename = File.(filename || Bosh::Cli::DEFAULT_CONFIG_PATH) @work_dir = work_dir unless File.exists?(@filename) File.open(@filename, "w") { |f| Psych.dump({}, f) } File.chmod(0600, @filename) end @config_file = load_yaml_file(@filename, nil) unless @config_file.is_a?(Hash) @config_file = {} # Just ignore it if it's malformed end rescue SystemCallError => e raise ConfigError, "Cannot read config file: #{e.}" end |
Class Attribute Details
.colorize ⇒ Boolean
Returns Should CLI output be colorized?.
12 13 14 |
# File 'lib/cli/config.rb', line 12 def colorize @colorize end |
.commands ⇒ Hash<String,Bosh::Cli::CommandDefinition> (readonly)
Returns Available commands.
9 10 11 |
# File 'lib/cli/config.rb', line 9 def commands @commands end |
.interactive ⇒ Boolean
Returns Is CLI being used interactively?.
18 19 20 |
# File 'lib/cli/config.rb', line 18 def interactive @interactive end |
.max_parallel_downloads ⇒ Integer
Returns CLI max parallel downloads.
24 25 26 |
# File 'lib/cli/config.rb', line 24 def max_parallel_downloads @max_parallel_downloads end |
.output ⇒ IO
Returns Where output goes.
15 16 17 |
# File 'lib/cli/config.rb', line 15 def output @output end |
.poll_interval ⇒ Integer
Returns CLI polling interval.
21 22 23 |
# File 'lib/cli/config.rb', line 21 def poll_interval @poll_interval end |
Instance Attribute Details
#filename ⇒ Object (readonly)
Returns the value of attribute filename.
264 265 266 |
# File 'lib/cli/config.rb', line 264 def filename @filename end |
Class Method Details
.register_command(command) ⇒ void
This method returns an undefined value.
Register command with BOSH CLI
35 36 37 38 39 40 |
# File 'lib/cli/config.rb', line 35 def self.register_command(command) if @commands.has_key?(command.usage) raise CliError, "Duplicate command `#{command.usage}'" end @commands[command.usage] = command end |
Instance Method Details
#access_token(target) ⇒ String
Returns Token associated with target.
120 121 122 |
# File 'lib/cli/config.rb', line 120 def access_token(target) credentials_for(target)["access_token"] end |
#aliases(category) ⇒ Object
84 85 86 87 88 89 90 |
# File 'lib/cli/config.rb', line 84 def aliases(category) if @config_file.has_key?("aliases") && @config_file["aliases"].is_a?(Hash) @config_file["aliases"][category.to_s] else nil end end |
#ca_cert(for_target = nil) ⇒ Object
210 211 212 213 214 215 216 217 218 |
# File 'lib/cli/config.rb', line 210 def ca_cert(for_target=nil) if for_target return @config_file.fetch('ca_cert', {}).fetch(for_target, nil) end return nil if target.nil? @config_file.fetch('ca_cert', {}).fetch(target, nil) end |
#credentials_for(target) ⇒ Hash
Returns Director credentials.
62 63 64 65 66 67 68 69 70 71 |
# File 'lib/cli/config.rb', line 62 def credentials_for(target) if @config_file["auth"].is_a?(Hash) && @config_file["auth"][target] @config_file["auth"][target] else { "username" => nil, "password" => nil } end end |
#deployment ⇒ String?
Read the deployment configuration. Return the deployment for the current target.
144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/cli/config.rb', line 144 def deployment return nil if target.nil? if @config_file.has_key?("deployment") if is_old_deployment_config? set_deployment(@config_file["deployment"]) save end if @config_file["deployment"].is_a?(Hash) return @config_file["deployment"][target] end end end |
#is_old_deployment_config? ⇒ Boolean
Deployment used to be a string that was only stored for your current target. As soon as you switched targets, the deployment was erased. If the user has the old config we convert it to the new config.
136 137 138 |
# File 'lib/cli/config.rb', line 136 def is_old_deployment_config? @config_file["deployment"].is_a?(String) end |
#max_parallel_downloads ⇒ Integer
Read the max parallel downloads configuration.
232 233 234 |
# File 'lib/cli/config.rb', line 232 def max_parallel_downloads self.class.max_parallel_downloads || @config_file.fetch("max_parallel_downloads", 1) end |
#password(target) ⇒ String
Returns Password associated with target.
114 115 116 |
# File 'lib/cli/config.rb', line 114 def password(target) credentials_for(target)["password"] end |
#read(attr, try_local_first = true) ⇒ Object
236 237 238 239 240 241 242 243 244 |
# File 'lib/cli/config.rb', line 236 def read(attr, try_local_first = true) attr = attr.to_s if try_local_first && @config_file[@work_dir].is_a?(Hash) && @config_file[@work_dir].has_key?(attr) @config_file[@work_dir][attr] else @config_file[attr] end end |
#refresh_token(target) ⇒ String
Returns Refresh token associated with target.
126 127 128 |
# File 'lib/cli/config.rb', line 126 def refresh_token(target) credentials_for(target)["refresh_token"] end |
#release ⇒ Object
194 195 196 |
# File 'lib/cli/config.rb', line 194 def release read(:release, false) end |
#release=(value) ⇒ Object
198 199 200 |
# File 'lib/cli/config.rb', line 198 def release=(value) write_global(:release, value) end |
#resolve_alias(category, alias_name) ⇒ Object
92 93 94 95 96 97 98 99 100 101 102 103 104 |
# File 'lib/cli/config.rb', line 92 def resolve_alias(category, alias_name) category = category.to_s if @config_file.has_key?("aliases") && @config_file["aliases"].is_a?(Hash) && @config_file["aliases"].has_key?(category) && @config_file["aliases"][category].is_a?(Hash) && !@config_file["aliases"][category][alias_name].blank? @config_file["aliases"][category][alias_name].to_s else nil end end |
#save ⇒ Object
255 256 257 258 259 260 261 262 |
# File 'lib/cli/config.rb', line 255 def save File.open(@filename, "w") do |f| Psych.dump(@config_file, f) end rescue SystemCallError => e raise ConfigError, e. end |
#save_ca_cert_path(cert_path) ⇒ Object
221 222 223 224 225 226 227 |
# File 'lib/cli/config.rb', line 221 def save_ca_cert_path(cert_path) = cert_path ? File.(cert_path) : nil @config_file['ca_cert'] ||= {} @config_file['ca_cert'][target] = end |
#set_alias(category, alias_name, value) ⇒ Object
78 79 80 81 82 |
# File 'lib/cli/config.rb', line 78 def set_alias(category, alias_name, value) @config_file["aliases"] ||= {} @config_file["aliases"][category.to_s] ||= {} @config_file["aliases"][category.to_s][alias_name] = value end |
#set_credentials(target, credentials) ⇒ Object
73 74 75 76 |
# File 'lib/cli/config.rb', line 73 def set_credentials(target, credentials) @config_file["auth"] ||= {} @config_file["auth"][target] = credentials end |
#set_deployment(deployment_file_path) ⇒ Object
Sets the deployment file for the current target. If the deployment is the old deployment configuration, it will turn it into the format.
163 164 165 166 167 168 |
# File 'lib/cli/config.rb', line 163 def set_deployment(deployment_file_path) raise MissingTarget, "Must have a target set" if target.nil? @config_file["deployment"] = {} if is_old_deployment_config? @config_file["deployment"] ||= {} @config_file["deployment"][target] = deployment_file_path end |
#target ⇒ Object
170 171 172 |
# File 'lib/cli/config.rb', line 170 def target read(:target, false) end |
#target=(value) ⇒ Object
174 175 176 |
# File 'lib/cli/config.rb', line 174 def target=(value) write_global(:target, value) end |
#target_name ⇒ Object
178 179 180 |
# File 'lib/cli/config.rb', line 178 def target_name read(:target_name, false) end |
#target_name=(value) ⇒ Object
182 183 184 |
# File 'lib/cli/config.rb', line 182 def target_name=(value) write_global(:target_name, value) end |
#target_uuid ⇒ Object
202 203 204 |
# File 'lib/cli/config.rb', line 202 def target_uuid read(:target_uuid, false) end |
#target_uuid=(value) ⇒ Object
206 207 208 |
# File 'lib/cli/config.rb', line 206 def target_uuid=(value) write_global(:target_uuid, value) end |
#target_version ⇒ Object
186 187 188 |
# File 'lib/cli/config.rb', line 186 def target_version read(:target_version, false) end |
#target_version=(value) ⇒ Object
190 191 192 |
# File 'lib/cli/config.rb', line 190 def target_version=(value) write_global(:target_version, value) end |
#username(target) ⇒ String
Returns Username associated with target.
108 109 110 |
# File 'lib/cli/config.rb', line 108 def username(target) credentials_for(target)["username"] end |
#write(attr, value) ⇒ Object
246 247 248 249 |
# File 'lib/cli/config.rb', line 246 def write(attr, value) @config_file[@work_dir] ||= {} @config_file[@work_dir][attr.to_s] = value end |
#write_global(attr, value) ⇒ Object
251 252 253 |
# File 'lib/cli/config.rb', line 251 def write_global(attr, value) @config_file[attr.to_s] = value end |