Module: Cheffish

Defined in:
lib/cheffish.rb,
lib/cheffish/version.rb,
lib/cheffish/server_api.rb,
lib/cheffish/with_pattern.rb,
lib/cheffish/chef_run_data.rb,
lib/cheffish/key_formatter.rb,
lib/cheffish/merged_config.rb,
lib/cheffish/basic_chef_client.rb,
lib/cheffish/chef_run_listener.rb,
lib/cheffish/chef_provider_base.rb

Defined Under Namespace

Modules: WithPattern Classes: ActorProviderBase, BasicChefClient, ChefProviderBase, ChefRunData, ChefRunListener, KeyFormatter, MergedConfig, ServerAPI

Constant Summary collapse

NAME_REGEX = 
/^[.\-[:alnum:]_]+$/
NOT_PASSED = 
Object.new
VERSION = 
'0.8.2'

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.chef_server_api(chef_server = default_chef_server) ⇒ Object 



26
27
28
 
# File 'lib/cheffish.rb', line 26

def self.chef_server_api(chef_server = default_chef_server)
  Cheffish::ServerAPI.new(chef_server[:chef_server_url], chef_server[:options] || {})
end

.default_chef_server(config = profiled_config) ⇒ Object 



16
17
18
19
20
21
22
23
24
 
# File 'lib/cheffish.rb', line 16

def self.default_chef_server(config = profiled_config)
  {
    :chef_server_url => config[:chef_server_url],
    :options => {
      :client_name => config[:node_name],
      :signing_key_filename => config[:client_key]
    }
  }
end

.get_private_key(name, config = profiled_config) ⇒ Object 



83
84
85
86
 
# File 'lib/cheffish.rb', line 83

def self.get_private_key(name, config = profiled_config)
  key, key_path = get_private_key_with_path(name, config)
  key
end

.get_private_key_with_path(name, config = profiled_config) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/cheffish.rb', line 88

def self.get_private_key_with_path(name, config = profiled_config)
  if config[:private_keys] && config[:private_keys][name]
    if config[:private_keys][name].is_a?(String)
      return [ IO.read(config[:private_keys][name]), config[:private_keys][name] ]
    else
      return [ config[:private_keys][name].to_pem, nil ]
    end
  elsif config[:private_key_paths]
    config[:private_key_paths].each do |private_key_path|
      next unless File.exist?(private_key_path)
      Dir.entries(private_key_path).sort.each do |key|
        ext = File.extname(key)
        if ext == '' || ext == '.pem'
          key_name = key[0..-(ext.length+1)]
          if key_name == name
            return [ IO.read("#{private_key_path}/#{key}"), "#{private_key_path}/#{key}" ]
          end
        end
      end
    end
  end
  nil
end

.honor_local_mode(local_mode_default = true) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/cheffish.rb', line 60

def self.honor_local_mode(local_mode_default = true)
  if !Chef::Config.has_key?(:local_mode) && !local_mode_default.nil?
    Chef::Config.local_mode = local_mode_default
  end
  if Chef::Config.local_mode && !Chef::Config.has_key?(:cookbook_path) && !Chef::Config.has_key?(:chef_repo_path)
    Chef::Config.chef_repo_path = Chef::Config.find_chef_repo_path(Dir.pwd)
  end
  begin
    require 'chef/local_mode'
    Chef::LocalMode.with_server_connectivity(&block)

  rescue LoadError
    Chef::Application.setup_server_connectivity
    if block_given?
      begin
        yield
      ensure
        Chef::Application.destroy_server_connectivity
      end
    end
  end
end

.inline_resource(provider, provider_action, *resources, &block) ⇒ Object 



12
13
14
 
# File 'lib/cheffish.rb', line 12

def self.inline_resource(provider, provider_action, *resources, &block)
  BasicChefClient.inline_resource(provider, provider_action, *resources, &block)
end

.load_chef_config(chef_config = Chef::Config) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/cheffish.rb', line 38

def self.load_chef_config(chef_config = Chef::Config)
  chef_config.config_file = Chef::Knife.locate_config_file
  config_fetcher = Chef::ConfigFetcher.new(chef_config.config_file, chef_config.config_file_jail)
  if chef_config.config_file.nil?
    Chef::Log.warn("No config file found or specified on command line, using command line options.")
  elsif config_fetcher.config_missing?
    Chef::Log.warn("Did not find config file: #{chef_config.config_file}, using command line options.")
  else
    config_content = config_fetcher.read_config
    config_file_path = chef_config.config_file
    begin
      chef_config.from_string(config_content, config_file_path)
    rescue Exception => error
      Chef::Log.fatal("Configuration error #{error.class}: #{error.message}")
      filtered_trace = error.backtrace.grep(/#{Regexp.escape(config_file_path)}/)
      filtered_trace.each {|line| Chef::Log.fatal("  " + line )}
      Chef::Application.fatal!("Aborting due to error in '#{config_file_path}'", 2)
    end
  end
  Cheffish.profiled_config(chef_config)
end

.node_attributes(klass) ⇒ Object 



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
 
# File 'lib/cheffish.rb', line 114

def self.node_attributes(klass)
  klass.class_eval do
    attribute :name, :kind_of => String, :regex => Cheffish::NAME_REGEX, :name_attribute => true
    attribute :chef_environment, :kind_of => String, :regex => Cheffish::NAME_REGEX
    attribute :run_list, :kind_of => Array # We should let them specify it as a series of parameters too
    attribute :attributes, :kind_of => Hash

    # Specifies that this is a complete specification for the environment (i.e. attributes you don't specify will be
    # reset to their defaults)
    attribute :complete, :kind_of => [TrueClass, FalseClass]

    attribute :raw_json, :kind_of => Hash
    attribute :chef_server, :kind_of => Hash

    # attribute 'ip_address', '127.0.0.1'
    # attribute [ 'pushy', 'port' ], '9000'
    # attribute 'ip_addresses' do |existing_value|
    #   (existing_value || []) + [ '127.0.0.1' ]
    # end
    # attribute 'ip_address', :delete
    attr_accessor :attribute_modifiers
    def attribute(attribute_path, value=NOT_PASSED, &block)
      @attribute_modifiers ||= []
      if value != NOT_PASSED
        @attribute_modifiers << [ attribute_path, value ]
      elsif block
        @attribute_modifiers << [ attribute_path, block ]
      else
        raise "attribute requires either a value or a block"
      end
    end

    # Patchy tags
    # tag 'webserver', 'apache', 'myenvironment'
    def tag(*tags)
      attribute 'tags' do |existing_tags|
        existing_tags ||= []
        tags.each do |tag|
          if !existing_tags.include?(tag.to_s)
            existing_tags << tag.to_s
          end
        end
        existing_tags
      end
    end
    def remove_tag(*tags)
      attribute 'tags' do |existing_tags|
        if existing_tags
          tags.each do |tag|
            existing_tags.delete(tag.to_s)
          end
        end
        existing_tags
      end
    end

    # NON-patchy tags
    # tags :a, :b, :c # removes all other tags
    def tags(*tags)
      if tags.size == 0
        attribute('tags')
      else
        tags = tags[0] if tags.size == 1 && tags[0].kind_of?(Array)
        attribute 'tags', tags.map { |tag| tag.to_s }
      end
    end

    # Order matters--if two things here are in the wrong order, they will be flipped in the run list
    # recipe 'apache', 'mysql'
    # recipe 'recipe@version'
    # recipe 'recipe'
    # role ''
    attr_accessor :run_list_modifiers
    attr_accessor :run_list_removers
    def recipe(*recipes)
      if recipes.size == 0
        raise ArgumentError, "At least one recipe must be specified"
      end
      @run_list_modifiers ||= []
      @run_list_modifiers += recipes.map { |recipe| Chef::RunList::RunListItem.new("recipe[#{recipe}]") }
    end
    def role(*roles)
      if roles.size == 0
        raise ArgumentError, "At least one role must be specified"
      end
      @run_list_modifiers ||= []
      @run_list_modifiers += roles.map { |role| Chef::RunList::RunListItem.new("role[#{role}]") }
    end
    def remove_recipe(*recipes)
      if recipes.size == 0
        raise ArgumentError, "At least one recipe must be specified"
      end
      @run_list_removers ||= []
      @run_list_removers += recipes.map { |recipe| Chef::RunList::RunListItem.new("recipe[#{recipe}]") }
    end
    def remove_role(*roles)
      if roles.size == 0
        raise ArgumentError, "At least one role must be specified"
      end
      @run_list_removers ||= []
      @run_list_removers += roles.map { |recipe| Chef::RunList::RunListItem.new("role[#{role}]") }
    end
  end
end

.profiled_config(config = Chef::Config) ⇒ Object 



30
31
32
33
34
35
36
 
# File 'lib/cheffish.rb', line 30

def self.profiled_config(config = Chef::Config)
  if config.profile && config.profiles && config.profiles[config.profile]
    MergedConfig.new(config.profiles[config.profile], config)
  else
    config
  end
end

Instance Method Details

#load_prior_resource ⇒ Object

We are not interested in Chef’s cloning behavior here.



236
237
238
 
# File 'lib/cheffish/chef_provider_base.rb', line 236

def load_prior_resource
  Chef::Log.debug("Overloading #{resource_name}.load_prior_resource with NOOP")
end