Class: ChefConfig::WorkstationConfigLoader

Inherits:
Object
  • Object
show all
Includes:
Mixin::Credentials, Mixin::DotD
Defined in:
lib/chef-config/workstation_config_loader.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Mixin::Credentials

#credentials_file_path, #credentials_profile, #load_credentials, #parse_credentials_file

Methods included from Mixin::DotD

#find_dot_d, #load_dot_d

Constructor Details

#initialize(explicit_config_file, logger = nil, profile: nil) ⇒ WorkstationConfigLoader

TODO: initialize this with a logger for Chef and Knife


40
41
42
43
44
45
46
47
# File 'lib/chef-config/workstation_config_loader.rb', line 40

def initialize(explicit_config_file, logger = nil, profile: nil)
  @explicit_config_file = explicit_config_file
  @chef_config_dir = nil
  @config_location = nil
  @profile = profile
  @logger = logger || NullLogger.new
  @credentials_found = false
end

Instance Attribute Details

#credentials_foundObject (readonly)

Returns the value of attribute credentials_found


37
38
39
# File 'lib/chef-config/workstation_config_loader.rb', line 37

def credentials_found
  @credentials_found
end

#explicit_config_fileObject

Path to a config file requested by user, (e.g., via command line option). Can be nil


34
35
36
# File 'lib/chef-config/workstation_config_loader.rb', line 34

def explicit_config_file
  @explicit_config_file
end

#profileObject

The name of a credentials profile. Can be nil


36
37
38
# File 'lib/chef-config/workstation_config_loader.rb', line 36

def profile
  @profile
end

Instance Method Details

#chef_config_dirObject


57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'lib/chef-config/workstation_config_loader.rb', line 57

def chef_config_dir
  if @chef_config_dir.nil?
    @chef_config_dir = false
    full_path = working_directory.split(File::SEPARATOR)
    (full_path.length - 1).downto(0) do |i|
      candidate_directory = File.join(full_path[0..i] + [ChefConfig::Dist::USER_CONF_DIR])
      if File.exist?(candidate_directory) && File.directory?(candidate_directory)
        @chef_config_dir = candidate_directory
        break
      end
    end
  end
  @chef_config_dir
end

#config_locationObject


53
54
55
# File 'lib/chef-config/workstation_config_loader.rb', line 53

def config_location
  @config_location ||= (explicit_config_file || locate_local_config)
end

#envObject

(Private API, public for test purposes)


92
93
94
# File 'lib/chef-config/workstation_config_loader.rb', line 92

def env
  ENV
end

#loadObject


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/chef-config/workstation_config_loader.rb', line 72

def load
  load_credentials(profile)
  # Ignore it if there's no explicit_config_file and can't find one at a
  # default path.
  unless config_location.nil?
    if explicit_config_file && !path_exists?(config_location)
      raise ChefConfig::ConfigurationError, "Specified config file #{config_location} does not exist"
    end

    # Have to set Config.config_file b/c other config is derived from it.
    Config.config_file = config_location
    apply_config(IO.read(config_location), config_location)
  end

  load_dot_d(Config[:config_d_dir]) if Config[:config_d_dir]

  apply_defaults
end

#no_config_found?Boolean

Returns:

  • (Boolean)

49
50
51
# File 'lib/chef-config/workstation_config_loader.rb', line 49

def no_config_found?
  config_location.nil? && !credentials_found
end

#path_exists?(path) ⇒ Boolean

(Private API, public for test purposes)

Returns:

  • (Boolean)

97
98
99
# File 'lib/chef-config/workstation_config_loader.rb', line 97

def path_exists?(path)
  Pathname.new(path).expand_path.exist?
end