Module: Cheffish

Defined in:
lib/cheffish.rb,
lib/cheffish/version.rb,
lib/cheffish/key_formatter.rb,
lib/cheffish/inline_resource.rb,
lib/cheffish/chef_provider_base.rb,
lib/cheffish/cheffish_server_api.rb

Defined Under Namespace

Classes: ActorProviderBase, ChefProviderBase, CheffishServerAPI, InlineResource, KeyFormatter

Constant Summary collapse

NAME_REGEX = 
/^[.\-[:alnum:]_]+$/
NOT_PASSED = 
Object.new
VERSION = 
'0.1'
@@enclosing_data_bag = 
nil
@@enclosing_environment = 
nil
@@enclosing_data_bag_item_encryption = 
nil
@@enclosing_chef_server = 
nil

Class Method Summary collapse

Class Method Details

.enclosing_chef_server ⇒ Object 



36
37
38
39
40
41
42
43
44
 
# File 'lib/cheffish.rb', line 36

def self.enclosing_chef_server
  @@enclosing_chef_server || {
    :chef_server_url => Chef::Config[:chef_server_url],
    :options => {
      :client_name => Chef::Config[:node_name],
      :signing_key_filename => Chef::Config[:client_key]
    }
  }
end

.enclosing_chef_server=(chef_server) ⇒ Object 



45
46
47
 
# File 'lib/cheffish.rb', line 45

def self.enclosing_chef_server=(chef_server)
  @@enclosing_chef_server = chef_server
end

.enclosing_data_bag ⇒ Object 



8
9
10
 
# File 'lib/cheffish.rb', line 8

def self.enclosing_data_bag
  @@enclosing_data_bag
end

.enclosing_data_bag=(name) ⇒ Object 



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

def self.enclosing_data_bag=(name)
  @@enclosing_data_bag = name
end

.enclosing_data_bag_item_encryption ⇒ Object 



24
25
26
 
# File 'lib/cheffish.rb', line 24

def self.enclosing_data_bag_item_encryption
  @@enclosing_data_bag_item_encryption
end

.enclosing_data_bag_item_encryption=(options) ⇒ Object 



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

def self.enclosing_data_bag_item_encryption=(options)
  @@enclosing_data_bag_item_encryption = options
end

.enclosing_environment ⇒ Object 



16
17
18
 
# File 'lib/cheffish.rb', line 16

def self.enclosing_environment
  @@enclosing_environment
end

.enclosing_environment=(name) ⇒ Object 



19
20
21
 
# File 'lib/cheffish.rb', line 19

def self.enclosing_environment=(name)
  @@enclosing_environment = name
end

.inline_resource(provider, &block) ⇒ Object 



31
32
33
 
# File 'lib/cheffish.rb', line 31

def self.inline_resource(provider, &block)
  InlineResource.new(provider).instance_eval(&block)
end

.node_attributes(klass) ⇒ Object 



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

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 :default_attributes, :kind_of => Hash
    attribute :normal_attributes, :kind_of => Hash
    attribute :override_attributes, :kind_of => Hash
    attribute :automatic_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

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

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

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

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

    # Patchy tags
    # tag 'webserver', 'apache', 'myenvironment'
    def tag(*tags)
      normal '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)
      normal '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
        normal('tags')
      else
        tags = tags[0] if tags.size == 1 && tags[0].kind_of?(Array)
        normal 'tags', tags.map { |tag| tag.to_s }
      end
    end


    alias :attributes :normal_attributes
    alias :attribute :normal

    # 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

.reset ⇒ Object 



49
50
51
52
53
54
 
# File 'lib/cheffish.rb', line 49

def self.reset
  @@enclosing_data_bag = nil
  @@enclosing_environment = nil
  @@enclosing_data_bag_item_encryption = nil
  @@enclosing_chef_server = nil
end