Class: Chef::Node

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
DSL::IncludeAttribute, DSL::Universal, Mixin::FromFile, Mixin::ParamsValidate
Defined in:
lib/chef/node.rb,
lib/chef/node/attribute.rb,
lib/chef/node/common_api.rb,
lib/chef/node/mixin/mashy_array.rb,
lib/chef/node/mixin/state_tracking.rb,
lib/chef/node/attribute_collections.rb,
lib/chef/node/immutable_collections.rb,
lib/chef/node/mixin/deep_merge_cache.rb,
lib/chef/node/mixin/immutablize_hash.rb,
lib/chef/node/mixin/immutablize_array.rb

Defined Under Namespace

Modules: CommonAPI, Immutablize, Mixin Classes: AttrArray, Attribute, ImmutableArray, ImmutableMash, VividMash

Instance Attribute Summary collapse

Attributes included from Mixin::FromFile

#source_file

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Mixin::ParamsValidate

#lazy, #set_or_return, #validate

Methods included from Mixin::LazyModuleInclude

#descendants, #include, #included

Methods included from Mixin::ShellOut

apply_default_env, maybe_add_timeout, #shell_out, #shell_out!

Methods included from Mixin::PathSanity

#enforce_path_sanity, #sanitized_path

Methods included from Mixin::PowershellOut

#powershell_out, #powershell_out!

Methods included from Mixin::WindowsArchitectureHelper

#assert_valid_windows_architecture!, #disable_wow64_file_redirection, #forced_32bit_override_required?, #is_i386_process_on_x86_64_windows?, #node_supports_windows_architecture?, #node_windows_architecture, #restore_wow64_file_redirection, #valid_windows_architecture?, #with_os_architecture, #wow64_architecture_override_required?, #wow64_directory

Methods included from Mixin::PowershellExec

#powershell_exec

Methods included from DSL::Powershell

#ps_credential

Methods included from DSL::RegistryHelper

#registry_data_exists?, #registry_get_subkeys, #registry_get_values, #registry_has_subkeys?, #registry_key_exists?, #registry_value_exists?

Methods included from DSL::DataQuery

#data_bag, #data_bag_item, #search, #tagged?

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Methods included from DSL::PlatformIntrospection

#docker?, #older_than_win_2012_or_8?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family

Methods included from DSL::IncludeAttribute

#include_attribute, #parse_attribute_file_spec

Methods included from Mixin::FromFile

#class_from_file, #from_file

Constructor Details

#initialize(chef_server_rest: nil, logger: nil) ⇒ Node

Create a new Chef::Node object.


70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/chef/node.rb', line 70

def initialize(chef_server_rest: nil, logger: nil)
  @chef_server_rest = chef_server_rest
  @name = nil
  @logger = logger || Chef::Log.with_child(subsystem: "node")

  @chef_environment = "_default"
  @primary_runlist = Chef::RunList.new
  @override_runlist = Chef::RunList.new

  @policy_name = nil
  @policy_group = nil

  @attributes = Chef::Node::Attribute.new({}, {}, {}, {}, self)

  @run_state = {}
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args, &block) ⇒ Object

Only works for attribute fetches, setting is no longer supported XXX: this should be deprecated


265
266
267
# File 'lib/chef/node.rb', line 265

def method_missing(method, *args, &block)
  attributes.public_send(method, *args, &block)
end

Instance Attribute Details

#loggerObject (readonly)

Returns the value of attribute logger


53
54
55
# File 'lib/chef/node.rb', line 53

def logger
  @logger
end

#recipe_listObject

Returns the value of attribute recipe_list


51
52
53
# File 'lib/chef/node.rb', line 51

def recipe_list
  @recipe_list
end

#run_contextObject

RunContext will set itself as run_context via this setter when initialized. This is needed so DSL::IncludeAttribute (in particular, #include_recipe) can access the run_context to determine if an attributes file has been seen yet. – TODO: This is a pretty ugly way to solve that problem.


61
62
63
# File 'lib/chef/node.rb', line 61

def run_context
  @run_context
end

#run_stateObject

Returns the value of attribute run_state


51
52
53
# File 'lib/chef/node.rb', line 51

def run_state
  @run_state
end

Class Method Details

.build(node_name) ⇒ Object


612
613
614
615
616
617
# File 'lib/chef/node.rb', line 612

def self.build(node_name)
  node = new
  node.name(node_name)
  node.chef_environment(Chef::Config[:environment]) unless Chef::Config[:environment].nil? || Chef::Config[:environment].chomp.empty?
  node
end

.find_or_create(node_name) ⇒ Object


603
604
605
606
607
608
609
610
# File 'lib/chef/node.rb', line 603

def self.find_or_create(node_name)
  load(node_name)
rescue Net::HTTPClientException => e
  raise unless e.response.code == "404"

  node = build(node_name)
  node.create
end

.from_hash(o) ⇒ Object


548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
# File 'lib/chef/node.rb', line 548

def self.from_hash(o)
  return o if o.is_a? Chef::Node

  node = new
  node.name(o["name"])

  node.policy_name = o["policy_name"] if o.key?("policy_name")
  node.policy_group = o["policy_group"] if o.key?("policy_group")

  unless node.policy_group.nil?
    node.chef_environment(o["policy_group"])
  else
    node.chef_environment(o["chef_environment"])
  end

  if o.key?("attributes")
    node.normal_attrs = o["attributes"]
  end
  node.automatic_attrs = Mash.new(o["automatic"]) if o.key?("automatic")
  node.normal_attrs = Mash.new(o["normal"]) if o.key?("normal")
  node.default_attrs = Mash.new(o["default"]) if o.key?("default")
  node.override_attrs = Mash.new(o["override"]) if o.key?("override")

  if o.key?("run_list")
    node.run_list.reset!(o["run_list"])
  elsif o.key?("recipes")
    o["recipes"].each { |r| node.recipes << r }
  end

  node
end

.list(inflate = false) ⇒ Object


590
591
592
593
594
595
596
597
598
599
600
601
# File 'lib/chef/node.rb', line 590

def self.list(inflate = false)
  if inflate
    response = {}
    Chef::Search::Query.new.search(:node) do |n|
      n = Chef::Node.from_hash(n)
      response[n.name] = n unless n.nil?
    end
    response
  else
    Chef::ServerAPI.new(Chef::Config[:chef_server_url]).get("nodes")
  end
end

.list_by_environment(environment, inflate = false) ⇒ Object


580
581
582
583
584
585
586
587
588
# File 'lib/chef/node.rb', line 580

def self.list_by_environment(environment, inflate = false)
  if inflate
    response = {}
    Chef::Search::Query.new.search(:node, "chef_environment:#{environment}") { |n| response[n.name] = n unless n.nil? }
    response
  else
    Chef::ServerAPI.new(Chef::Config[:chef_server_url]).get("environments/#{environment}/nodes")
  end
end

.load(name) ⇒ Object

Load a node by name


620
621
622
# File 'lib/chef/node.rb', line 620

def self.load(name)
  from_hash(Chef::ServerAPI.new(Chef::Config[:chef_server_url]).get("nodes/#{name}"))
end

Instance Method Details

#<=>(other) ⇒ Object


676
677
678
# File 'lib/chef/node.rb', line 676

def <=>(other)
  name <=> other.name
end

#==(other) ⇒ Object


668
669
670
671
672
673
674
# File 'lib/chef/node.rb', line 668

def ==(other)
  if other.is_a?(self.class)
    name == other.name
  else
    false
  end
end

#[](attrib) ⇒ Object

Return an attribute of this node. Returns nil if the attribute is not found.


198
199
200
# File 'lib/chef/node.rb', line 198

def [](attrib)
  attributes[attrib]
end

#apply_expansion_attributes(expansion) ⇒ Object

Apply the default and overrides attributes from the expansion passed in, which came from roles.


471
472
473
474
475
476
477
478
479
480
481
482
483
# File 'lib/chef/node.rb', line 471

def apply_expansion_attributes(expansion)
  loaded_environment = if chef_environment == "_default"
                         Chef::Environment.new.tap { |e| e.name("_default") }
                       else
                         Chef::Environment.load(chef_environment)
                       end

  attributes.env_default = loaded_environment.default_attributes
  attributes.env_override = loaded_environment.override_attributes

  attribute.role_default = expansion.default_attrs
  attributes.role_override = expansion.override_attrs
end

#attribute?(attrib) ⇒ Boolean

Return true if this Node has a given attribute, false if not. Takes either a symbol or a string.

Only works on the top level. Preferred way is to use the normal [] style lookup and call attribute?()

Returns:

  • (Boolean)

249
250
251
# File 'lib/chef/node.rb', line 249

def attribute?(attrib)
  attributes.attribute?(attrib)
end

#attributesObject Also known as: attribute, construct_attributes


190
191
192
# File 'lib/chef/node.rb', line 190

def attributes
  @attributes
end

#automatic_attrsObject


236
237
238
# File 'lib/chef/node.rb', line 236

def automatic_attrs
  attributes.automatic
end

#automatic_attrs=(new_values) ⇒ Object


240
241
242
# File 'lib/chef/node.rb', line 240

def automatic_attrs=(new_values)
  attributes.automatic = new_values
end

#chef_environment(arg = nil) ⇒ Object Also known as: environment


130
131
132
133
134
135
136
# File 'lib/chef/node.rb', line 130

def chef_environment(arg = nil)
  set_or_return(
    :chef_environment,
    arg,
    { regex: /^[\-[:alnum:]_]+$/, kind_of: String }
  )
end

#chef_environment=(environment) ⇒ Object


138
139
140
# File 'lib/chef/node.rb', line 138

def chef_environment=(environment)
  chef_environment(environment)
end

#chef_server_restObject


102
103
104
105
106
107
108
109
110
111
112
# File 'lib/chef/node.rb', line 102

def chef_server_rest
  # for saving node data we use validate_utf8: false which will not
  # raise an exception on bad utf8 data, but will replace the bad
  # characters and render valid JSON.
  @chef_server_rest ||= Chef::ServerAPI.new(
    Chef::Config[:chef_server_url],
    client_name: Chef::Config[:node_name],
    signing_key_filename: Chef::Config[:client_key],
    validate_utf8: false
  )
end

#consume_attributes(attrs) ⇒ Object

Consumes the combined run_list and other attributes in attrs


379
380
381
382
383
384
385
386
# File 'lib/chef/node.rb', line 379

def consume_attributes(attrs)
  normal_attrs_to_merge = consume_run_list(attrs)
  normal_attrs_to_merge = consume_chef_environment(normal_attrs_to_merge)
  # FIXME(log): should be trace
  logger.debug("Applying attributes from json file")
  self.normal_attrs = Chef::Mixin::DeepMerge.merge(normal_attrs, normal_attrs_to_merge)
  tags # make sure they're defined
end

#consume_chef_environment(attrs) ⇒ Object

chef_environment when set in -j JSON will take precedence over -E ENVIRONMENT. Ideally, IMO, the order of precedence should be (lowest to

highest):
 config_file
 -j JSON
 -E ENVIRONMENT

so that users could reuse their JSON and override the chef_environment configured within it with -E ENVIRONMENT. Because command line options are merged with Chef::Config there is currently no way to distinguish between an environment set via config from an environment set via command line.


426
427
428
429
430
431
432
# File 'lib/chef/node.rb', line 426

def consume_chef_environment(attrs)
  attrs = attrs ? attrs.dup : {}
  if env = attrs.delete("chef_environment")
    chef_environment(env)
  end
  attrs
end

#consume_external_attrs(ohai_data, json_cli_attrs) ⇒ Object

Consume data from ohai and Attributes provided as JSON on the command line.


357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
# File 'lib/chef/node.rb', line 357

def consume_external_attrs(ohai_data, json_cli_attrs)
  # FIXME(log): should be trace
  logger.debug("Extracting run list from JSON attributes provided on command line")
  consume_attributes(json_cli_attrs)

  self.automatic_attrs = ohai_data

  platform, version = Chef::Platform.find_platform_and_version(self)
  # FIXME(log): should be trace
  logger.debug("Platform is #{platform} version #{version}")
  automatic[:platform] = platform
  automatic[:platform_version] = version
  automatic[:chef_guid] = Chef::Config[:chef_guid] || ( Chef::Config[:chef_guid] = node_uuid )
  automatic[:name] = name
  automatic[:chef_environment] = chef_environment
end

#consume_ohai_data(ohai_data) ⇒ Object


374
375
376
# File 'lib/chef/node.rb', line 374

def consume_ohai_data(ohai_data)
  self.automatic_attrs = Chef::Mixin::DeepMerge.merge(automatic_attrs, ohai_data)
end

#consume_run_list(attrs) ⇒ Object

Extracts the run list from attrs and applies it. Returns the remaining attributes


403
404
405
406
407
408
409
410
411
412
413
414
# File 'lib/chef/node.rb', line 403

def consume_run_list(attrs)
  attrs = attrs ? attrs.dup : {}
  if new_run_list = attrs.delete("recipes") || attrs.delete("run_list")
    if attrs.key?("recipes") || attrs.key?("run_list")
      raise Chef::Exceptions::AmbiguousRunlistSpecification, "please set the node's run list using the 'run_list' attribute only."
    end

    logger.info("Setting the run_list to #{new_run_list} from CLI options")
    run_list(new_run_list)
  end
  attrs
end

#createObject

Create the node via the REST API


650
651
652
653
654
655
656
657
658
659
660
661
662
# File 'lib/chef/node.rb', line 650

def create
  chef_server_rest.post("nodes", data_for_save)
  self
rescue Net::HTTPClientException => e
  # Chef Server before 12.3 rejects node JSON with 'policy_name' or
  # 'policy_group' keys, but 'policy_name' will be detected first.
  # Backcompat can be removed in 13.0
  if e.response.code == "400" && e.response.body.include?("Invalid key policy_name")
    chef_server_rest.post("nodes", data_for_save_without_policyfile_attrs)
  else
    raise
  end
end

#defaultObject Also known as: default_attrs

Set a default of this node, but auto-vivify any Mashes that might be missing


210
211
212
# File 'lib/chef/node.rb', line 210

def default
  attributes.default
end

#default_attrs=(new_values) ⇒ Object


228
229
230
# File 'lib/chef/node.rb', line 228

def default_attrs=(new_values)
  attributes.default = new_values
end

#destroyObject

Remove this node via the REST API


625
626
627
# File 'lib/chef/node.rb', line 625

def destroy
  chef_server_rest.delete("nodes/#{name}")
end

#display_hashObject


497
498
499
500
501
502
503
504
505
506
507
# File 'lib/chef/node.rb', line 497

def display_hash
  display = {}
  display["name"]             = name
  display["chef_environment"] = chef_environment
  display["automatic"]        = attributes.automatic.to_hash
  display["normal"]           = attributes.normal.to_hash
  display["default"]          = attributes.combined_default.to_hash
  display["override"]         = attributes.combined_override.to_hash
  display["run_list"]         = run_list.run_list_items
  display
end

#each(&block) ⇒ Object

Yield each key of the top level to the block.


254
255
256
# File 'lib/chef/node.rb', line 254

def each(&block)
  attributes.each(&block)
end

#each_attribute(&block) ⇒ Object

Iterates over each attribute, passing the attribute and value to the block.


259
260
261
# File 'lib/chef/node.rb', line 259

def each_attribute(&block)
  attributes.each_attribute(&block)
end

#expand!(data_source = "server") ⇒ Object

Expands the node's run list and sets the default and override attributes. Also applies stored attributes (from json provided on the command line)

Returns the fully-expanded list of recipes, a RunListExpansion.

– TODO: timh/cw, 5-14-2010: Should this method exist? Should we instead modify default_attrs and override_attrs whenever our run_list is mutated? Or perhaps do something smarter like on-demand generation of default_attrs and override_attrs, invalidated only when run_list is mutated?


453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
# File 'lib/chef/node.rb', line 453

def expand!(data_source = "server")
  expansion = run_list.expand(chef_environment, data_source)
  raise Chef::Exceptions::MissingRole, expansion if expansion.errors?

  tags # make sure they're defined

  automatic_attrs[:recipes] = expansion.recipes.with_duplicate_names
  automatic_attrs[:expanded_run_list] = expansion.recipes.with_fully_qualified_names_and_version_constraints
  automatic_attrs[:roles] = expansion.roles

  apply_expansion_attributes(expansion)

  automatic_attrs[:chef_environment] = chef_environment
  expansion
end

#for_jsonObject


514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
# File 'lib/chef/node.rb', line 514

def for_json
  result = {
    "name" => name,
    "chef_environment" => chef_environment,
    "json_class" => self.class.name,
    "automatic" => attributes.automatic.to_hash,
    "normal" => attributes.normal.to_hash,
    "chef_type" => "node",
    "default" => attributes.combined_default.to_hash,
    "override" => attributes.combined_override.to_hash,
    # Render correctly for run_list items so malformed json does not result
    "run_list" => @primary_runlist.run_list.map(&:to_s),
  }
  # Chef Server rejects node JSON with extra keys; prior to 12.3,
  # "policy_name" and "policy_group" are unknown; after 12.3 they are
  # optional, therefore only including them in the JSON if present
  # maximizes compatibility for most people.
  unless policy_group.nil? && policy_name.nil?
    result["policy_name"] = policy_name
    result["policy_group"] = policy_group
  end
  result
end

#loaded_recipe(cookbook, recipe) ⇒ Object

used by include_recipe to add recipes to the expanded run_list to be saved back to the node and be searchable


287
288
289
290
291
# File 'lib/chef/node.rb', line 287

def loaded_recipe(cookbook, recipe)
  fully_qualified_recipe = "#{cookbook}::#{recipe}"

  automatic_attrs[:recipes] << fully_qualified_recipe unless Array(self[:recipes]).include?(fully_qualified_recipe)
end

#name(arg = nil) ⇒ Object

Set the name of this Node, or return the current name.


115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'lib/chef/node.rb', line 115

def name(arg = nil)
  if !arg.nil?
    validate(
      { name: arg },
      { name: { kind_of: String,
                cannot_be: :blank,
                regex: /^[\-[:alnum:]_:.]+$/ },
      }
    )
    @name = arg
  else
    @name
  end
end

#nodeObject

Used by DSL


98
99
100
# File 'lib/chef/node.rb', line 98

def node
  self
end

#normalObject Also known as: normal_attrs

Set a normal attribute of this node, but auto-vivify any Mashes that might be missing


204
205
206
# File 'lib/chef/node.rb', line 204

def normal
  attributes.normal
end

#normal_attrs=(new_values) ⇒ Object


232
233
234
# File 'lib/chef/node.rb', line 232

def normal_attrs=(new_values)
  attributes.normal = new_values
end

#overrideObject Also known as: override_attrs

Set an override attribute of this node, but auto-vivify any Mashes that might be missing


216
217
218
# File 'lib/chef/node.rb', line 216

def override
  attributes.override
end

#override_attrs=(new_values) ⇒ Object


224
225
226
# File 'lib/chef/node.rb', line 224

def override_attrs=(new_values)
  attributes.override = new_values
end

#override_runlist(*args) ⇒ Chef::RunList

Accessor for override_runlist (this cannot set an empty override run list)

Returns:


319
320
321
322
323
324
# File 'lib/chef/node.rb', line 319

def override_runlist(*args)
  return @override_runlist if args.length == 0

  @override_runlist_set = true
  @override_runlist.reset!(args)
end

#override_runlist=(array) ⇒ Chef::RunList

Setter for override_runlist which allows setting an empty override run list and marking it to be used

Returns:


330
331
332
333
# File 'lib/chef/node.rb', line 330

def override_runlist=(array)
  @override_runlist_set = true
  @override_runlist.reset!(array)
end

#override_runlist_set?Boolean

This boolean can be useful to determine if an override_runlist is set, it can be true even if the override_runlist is empty.

(Mutators can set the override_runlist so any non-empty override_runlist is considered set)

Returns:

  • (Boolean)

    if the override run list has been set


311
312
313
# File 'lib/chef/node.rb', line 311

def override_runlist_set?
  !!@override_runlist_set || !override_runlist.empty?
end

#policy_group(arg = NOT_PASSED) ⇒ String

The `policy_group` for this node. Setting this to a non-nil value will enable policyfile mode when `chef-client` is run. If set in the config file or in node json, running `chef-client` will update this value.

Parameters:

  • arg (String) (defaults to: NOT_PASSED)

    the new policy_group value

Returns:

  • (String)

    the current policy_group, or the one you just set

See Also:


176
177
178
179
180
181
# File 'lib/chef/node.rb', line 176

def policy_group(arg = NOT_PASSED)
  return @policy_group if arg.equal?(NOT_PASSED)

  validate({ policy_group: arg }, { policy_group: { kind_of: [ String, NilClass ], regex: /^[\-:.[:alnum:]_]+$/ } })
  @policy_group = arg
end

#policy_group=(policy_group) ⇒ Object

A “non-DSL-style” setter for `policy_group`

See Also:


186
187
188
# File 'lib/chef/node.rb', line 186

def policy_group=(policy_group)
  policy_group(policy_group)
end

#policy_name(arg = NOT_PASSED) ⇒ String

The `policy_name` for this node. Setting this to a non-nil value will enable policyfile mode when `chef-client` is run. If set in the config file or in node json, running `chef-client` will update this value.

Parameters:

  • arg (String) (defaults to: NOT_PASSED)

    the new policy_name value

Returns:

  • (String)

    the current policy_name, or the one you just set

See Also:


153
154
155
156
157
158
# File 'lib/chef/node.rb', line 153

def policy_name(arg = NOT_PASSED)
  return @policy_name if arg.equal?(NOT_PASSED)

  validate({ policy_name: arg }, { policy_name: { kind_of: [ String, NilClass ], regex: /^[\-:.[:alnum:]_]+$/ } })
  @policy_name = arg
end

#policy_name=(policy_name) ⇒ Object

A “non-DSL-style” setter for `policy_name`

See Also:


163
164
165
# File 'lib/chef/node.rb', line 163

def policy_name=(policy_name)
  policy_name(policy_name)
end

#primary_runlistObject


301
302
303
# File 'lib/chef/node.rb', line 301

def primary_runlist
  @primary_runlist
end

#recipe?(recipe_name) ⇒ Boolean

Returns true if this Node expects a given recipe, false if not.

First, the run list is consulted to see whether the recipe is explicitly included. If it's not there, it looks in `node`, which is populated when the run_list is expanded

NOTE: It's used by cookbook authors

Returns:

  • (Boolean)

281
282
283
# File 'lib/chef/node.rb', line 281

def recipe?(recipe_name)
  run_list.include?(recipe_name) || Array(self[:recipes]).include?(recipe_name)
end

#reset_defaults_and_overridesObject

Clear defaults and overrides, so that any deleted attributes between runs are still gone.


436
437
438
439
# File 'lib/chef/node.rb', line 436

def reset_defaults_and_overrides
  default.clear
  override.clear
end

#respond_to_missing?(method, include_private = false) ⇒ Boolean

Fix respond_to + method so that it works with method_missing delegation

Returns:

  • (Boolean)

270
271
272
# File 'lib/chef/node.rb', line 270

def respond_to_missing?(method, include_private = false)
  attributes.respond_to?(method, false)
end

#role?(role_name) ⇒ Boolean

Returns true if this Node expects a given role, false if not.

Parameters:

  • role_name (String)

    Role to check for

Returns:

  • (Boolean)

297
298
299
# File 'lib/chef/node.rb', line 297

def role?(role_name)
  Array(self[:roles]).include?(role_name)
end

#run_list(*args) ⇒ Object

Returns an Array of roles and recipes, in the order they will be applied. If you call it with arguments, they will become the new list of roles and recipes.


341
342
343
344
# File 'lib/chef/node.rb', line 341

def run_list(*args)
  rl = select_run_list
  args.length > 0 ? rl.reset!(args) : rl
end

#run_list=(list) ⇒ Object


346
347
348
349
# File 'lib/chef/node.rb', line 346

def run_list=(list)
  rl = select_run_list
  rl = list
end

#run_list?(item) ⇒ Boolean

Returns true if this Node expects a given role, false if not.

Returns:

  • (Boolean)

352
353
354
# File 'lib/chef/node.rb', line 352

def run_list?(item)
  run_list.detect { |r| r == item } ? true : false
end

#saveObject

Save this node via the REST API


630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
# File 'lib/chef/node.rb', line 630

def save
  # Try PUT. If the node doesn't yet exist, PUT will return 404,
  # so then POST to create.
  begin
    if Chef::Config[:why_run]
      logger.warn("In why-run mode, so NOT performing node save.")
    else
      chef_server_rest.put("nodes/#{name}", data_for_save)
    end
  rescue Net::HTTPClientException => e
    if e.response.code == "404"
      chef_server_rest.post("nodes", data_for_save)
    else
      raise
    end
  end
  self
end

#select_run_listObject


335
336
337
# File 'lib/chef/node.rb', line 335

def select_run_list
  override_runlist_set? ? @override_runlist : @primary_runlist
end

#set_cookbook_attributeObject

after the run_context has been set on the node, go through the cookbook_collection and setup the node attribute so that it is published in the node object


89
90
91
92
93
94
95
# File 'lib/chef/node.rb', line 89

def set_cookbook_attribute
  return unless run_context.cookbook_collection

  run_context.cookbook_collection.each do |cookbook_name, cookbook|
    automatic_attrs[:cookbooks][cookbook_name][:version] = cookbook.version
  end
end

#tag(*args) ⇒ Object


394
395
396
397
398
399
400
# File 'lib/chef/node.rb', line 394

def tag(*args)
  args.each do |tag|
    tags.push(tag.to_s) unless tags.include? tag.to_s
  end

  tags
end

#tagsObject

Lazy initializer for tags attribute


389
390
391
392
# File 'lib/chef/node.rb', line 389

def tags
  normal[:tags] = Array(normal[:tags])
  normal[:tags]
end

#to_hashObject

Transform the node to a Hash


486
487
488
489
490
491
492
493
494
495
# File 'lib/chef/node.rb', line 486

def to_hash
  index_hash = attributes.to_hash
  index_hash["chef_type"] = "node"
  index_hash["name"] = name
  index_hash["chef_environment"] = chef_environment
  index_hash["recipe"] = run_list.recipe_names if run_list.recipe_names.length > 0
  index_hash["role"] = run_list.role_names if run_list.role_names.length > 0
  index_hash["run_list"] = run_list.run_list_items
  index_hash
end

#to_json(*a) ⇒ Object

Serialize this object as a hash


510
511
512
# File 'lib/chef/node.rb', line 510

def to_json(*a)
  Chef::JSONCompat.to_json(for_json, *a)
end

#to_sObject


664
665
666
# File 'lib/chef/node.rb', line 664

def to_s
  "node[#{name}]"
end

#update_from!(o) ⇒ Object


538
539
540
541
542
543
544
545
546
# File 'lib/chef/node.rb', line 538

def update_from!(o)
  run_list.reset!(o.run_list)
  self.automatic_attrs = o.automatic_attrs
  self.normal_attrs = o.normal_attrs
  self.override_attrs = o.override_attrs
  self.default_attrs = o.default_attrs
  chef_environment(o.chef_environment)
  self
end