Class: Chef::DataBag

Inherits:
Object
  • Object
show all
Includes:
Mixin::FromFile, Mixin::ParamsValidate
Defined in:
lib/chef/data_bag.rb

Constant Summary collapse

VALID_NAME =
/^[\.\-[:alnum:]_]+$/.freeze
RESERVED_NAMES =
/^(node|role|environment|client)$/.freeze

Instance Attribute Summary

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::FromFile

#class_from_file, #from_file

Constructor Details

#initialize(chef_server_rest: nil) ⇒ DataBag

Create a new Chef::DataBag


48
49
50
51
# File 'lib/chef/data_bag.rb', line 48

def initialize(chef_server_rest: nil)
  @name = ""
  @chef_server_rest = chef_server_rest
end

Class Method Details

.chef_server_restObject


81
82
83
# File 'lib/chef/data_bag.rb', line 81

def self.chef_server_rest
  Chef::ServerAPI.new(Chef::Config[:chef_server_url])
end

.from_hash(o) ⇒ Object


85
86
87
88
89
# File 'lib/chef/data_bag.rb', line 85

def self.from_hash(o)
  bag = new
  bag.name(o["name"])
  bag
end

.list(inflate = false) ⇒ Object


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
# File 'lib/chef/data_bag.rb', line 91

def self.list(inflate = false)
  if Chef::Config[:solo_legacy_mode]
    paths = Array(Chef::Config[:data_bag_path])
    names = []
    paths.each do |path|
      unless File.directory?(path)
        raise Chef::Exceptions::InvalidDataBagPath, "Data bag path '#{path}' is invalid"
      end

      names += Dir.glob(File.join(
        Chef::Util::PathHelper.escape_glob_dir(path), "*"
      )).map { |f| File.basename(f) }.sort
    end
    names.inject({}) { |h, n| h[n] = n; h }
  else
    if inflate
      # Can't search for all data bags like other objects, fall back to N+1 :(
      list(false).inject({}) do |response, bag_and_uri|
        response[bag_and_uri.first] = load(bag_and_uri.first)
        response
      end
    else
      Chef::ServerAPI.new(Chef::Config[:chef_server_url]).get("data")
    end
  end
end

.load(name) ⇒ Object

Load a Data Bag by name via either the RESTful API or local data_bag_path if run in solo mode


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
# File 'lib/chef/data_bag.rb', line 119

def self.load(name)
  if Chef::Config[:solo_legacy_mode]
    paths = Array(Chef::Config[:data_bag_path])
    data_bag = {}
    paths.each do |path|
      unless File.directory?(path)
        raise Chef::Exceptions::InvalidDataBagPath, "Data bag path '#{path}' is invalid"
      end

      Dir.glob(File.join(Chef::Util::PathHelper.escape_glob_dir(path, name.to_s), "*.json")).inject({}) do |bag, f|
        item = Chef::JSONCompat.parse(IO.read(f))

        # Check if we have multiple items with similar names (ids) and raise if their content differs
        if data_bag.key?(item["id"]) && data_bag[item["id"]] != item
          raise Chef::Exceptions::DuplicateDataBagItem, "Data bag '#{name}' has items with the same name '#{item["id"]}' but different content."
        else
          data_bag[item["id"]] = item
        end
      end
    end
    data_bag
  else
    Chef::ServerAPI.new(Chef::Config[:chef_server_url]).get("data/#{name}")
  end
end

.validate_name!(name) ⇒ Object


38
39
40
41
42
43
44
45
# File 'lib/chef/data_bag.rb', line 38

def self.validate_name!(name)
  unless name =~ VALID_NAME
    raise Exceptions::InvalidDataBagName, "DataBags must have a name matching #{VALID_NAME.inspect}, you gave #{name.inspect}"
  end
  if name =~ RESERVED_NAMES
    raise Exceptions::InvalidDataBagName, "DataBags may not have a name matching #{RESERVED_NAMES.inspect}, you gave #{name.inspect}"
  end
end

Instance Method Details

#chef_server_restObject


77
78
79
# File 'lib/chef/data_bag.rb', line 77

def chef_server_rest
  @chef_server_rest ||= Chef::ServerAPI.new(Chef::Config[:chef_server_url])
end

#createObject

create a data bag via RESTful API


164
165
166
167
# File 'lib/chef/data_bag.rb', line 164

def create
  chef_server_rest.post("data", self)
  self
end

#destroyObject


145
146
147
# File 'lib/chef/data_bag.rb', line 145

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

#name(arg = nil) ⇒ Object


53
54
55
56
57
58
59
# File 'lib/chef/data_bag.rb', line 53

def name(arg = nil)
  set_or_return(
    :name,
    arg,
    regex: VALID_NAME
  )
end

#saveObject

Save the Data Bag via RESTful API


150
151
152
153
154
155
156
157
158
159
160
161
# File 'lib/chef/data_bag.rb', line 150

def save
  begin
    if Chef::Config[:why_run]
      Chef::Log.warn("In why-run mode, so NOT performing data bag save.")
    else
      create
    end
  rescue Net::HTTPClientException => e
    raise e unless e.response.code == "409"
  end
  self
end

#to_hObject Also known as: to_hash


61
62
63
64
65
66
67
68
# File 'lib/chef/data_bag.rb', line 61

def to_h
  result = {
    "name" => @name,
    "json_class" => self.class.name,
    "chef_type" => "data_bag",
  }
  result
end

#to_json(*a) ⇒ Object

Serialize this object as a hash


73
74
75
# File 'lib/chef/data_bag.rb', line 73

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

#to_sObject

As a string


170
171
172
# File 'lib/chef/data_bag.rb', line 170

def to_s
  "data_bag[#{@name}]"
end