Class: Bolt::Project
- Inherits:
-
Object
- Object
- Bolt::Project
- Defined in:
- lib/bolt/project.rb
Constant Summary collapse
- BOLTDIR_NAME =
'Boltdir'
- PROJECT_SETTINGS =
{ "name" => "The name of the project", "plans" => "An array of plan names to show, if they exist in the project."\ "These plans are included in `bolt plan show` output", "tasks" => "An array of task names to show, if they exist in the project."\ "These tasks are included in `bolt task show` output" }.freeze
Instance Attribute Summary collapse
-
#config_file ⇒ Object
readonly
Returns the value of attribute config_file.
-
#data ⇒ Object
readonly
Returns the value of attribute data.
-
#deprecations ⇒ Object
readonly
Returns the value of attribute deprecations.
-
#downloads ⇒ Object
readonly
Returns the value of attribute downloads.
-
#hiera_config ⇒ Object
readonly
Returns the value of attribute hiera_config.
-
#inventory_file ⇒ Object
readonly
Returns the value of attribute inventory_file.
-
#modulepath ⇒ Object
readonly
Returns the value of attribute modulepath.
-
#path ⇒ Object
readonly
Returns the value of attribute path.
-
#project_file ⇒ Object
readonly
Returns the value of attribute project_file.
-
#puppetfile ⇒ Object
readonly
Returns the value of attribute puppetfile.
-
#rerunfile ⇒ Object
readonly
Returns the value of attribute rerunfile.
-
#resource_types ⇒ Object
readonly
Returns the value of attribute resource_types.
-
#type ⇒ Object
readonly
Returns the value of attribute type.
-
#warnings ⇒ Object
readonly
Returns the value of attribute warnings.
Class Method Summary collapse
- .create_project(path, type = 'option') ⇒ Object
- .default_project ⇒ Object
-
.find_boltdir(dir) ⇒ Object
Search recursively up the directory hierarchy for the Project.
Instance Method Summary collapse
- #check_deprecated_file ⇒ Object
- #eql?(other) ⇒ Boolean (also: #==)
-
#initialize(raw_data, path, type = 'option') ⇒ Project
constructor
A new instance of Project.
- #name ⇒ Object
- #plans ⇒ Object
- #project_file? ⇒ Boolean
- #tasks ⇒ Object
-
#to_h ⇒ Object
This API is used to prepend the project as a module to Puppet’s internal module_references list.
- #to_s ⇒ Object
- #validate ⇒ Object
Constructor Details
#initialize(raw_data, path, type = 'option') ⇒ Project
Returns a new instance of Project.
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 |
# File 'lib/bolt/project.rb', line 63 def initialize(raw_data, path, type = 'option') @path = Pathname.new(path). @project_file = @path + 'bolt-project.yaml' @warnings = [] @deprecations = [] if (@path + 'bolt.yaml').file? && project_file? msg = "Project-level configuration in bolt.yaml is deprecated if using bolt-project.yaml. "\ "Transport config should be set in inventory.yaml, all other config should be set in "\ "bolt-project.yaml." @deprecations << { type: 'Using bolt.yaml for project configuration', msg: msg } end @inventory_file = @path + 'inventory.yaml' @modulepath = [(@path + 'modules').to_s, (@path + 'site-modules').to_s, (@path + 'site').to_s] @hiera_config = @path + 'hiera.yaml' @puppetfile = @path + 'Puppetfile' @rerunfile = @path + '.rerun.json' @resource_types = @path + '.resource_types' @type = type @downloads = @path + 'downloads' tc = Bolt::Config::INVENTORY_OPTIONS.keys & raw_data.keys if tc.any? msg = "Transport configuration isn't supported in bolt-project.yaml. Ignoring keys #{tc}" @warnings << { msg: msg } end @data = raw_data.reject { |k, _| Bolt::Config::INVENTORY_OPTIONS.include?(k) } # Once bolt.yaml deprecation is removed, this attribute should be removed # and replaced with .project_file in lib/bolt/config.rb @config_file = if (Bolt::Config::BOLT_OPTIONS & @data.keys).any? if (@path + 'bolt.yaml').file? msg = "bolt-project.yaml contains valid config keys, bolt.yaml will be ignored" @warnings << { msg: msg } end @project_file else @path + 'bolt.yaml' end validate if project_file? end |
Instance Attribute Details
#config_file ⇒ Object (readonly)
Returns the value of attribute config_file.
18 19 20 |
# File 'lib/bolt/project.rb', line 18 def config_file @config_file end |
#data ⇒ Object (readonly)
Returns the value of attribute data.
18 19 20 |
# File 'lib/bolt/project.rb', line 18 def data @data end |
#deprecations ⇒ Object (readonly)
Returns the value of attribute deprecations.
18 19 20 |
# File 'lib/bolt/project.rb', line 18 def deprecations @deprecations end |
#downloads ⇒ Object (readonly)
Returns the value of attribute downloads.
18 19 20 |
# File 'lib/bolt/project.rb', line 18 def downloads @downloads end |
#hiera_config ⇒ Object (readonly)
Returns the value of attribute hiera_config.
18 19 20 |
# File 'lib/bolt/project.rb', line 18 def hiera_config @hiera_config end |
#inventory_file ⇒ Object (readonly)
Returns the value of attribute inventory_file.
18 19 20 |
# File 'lib/bolt/project.rb', line 18 def inventory_file @inventory_file end |
#modulepath ⇒ Object (readonly)
Returns the value of attribute modulepath.
18 19 20 |
# File 'lib/bolt/project.rb', line 18 def modulepath @modulepath end |
#path ⇒ Object (readonly)
Returns the value of attribute path.
18 19 20 |
# File 'lib/bolt/project.rb', line 18 def path @path end |
#project_file ⇒ Object (readonly)
Returns the value of attribute project_file.
18 19 20 |
# File 'lib/bolt/project.rb', line 18 def project_file @project_file end |
#puppetfile ⇒ Object (readonly)
Returns the value of attribute puppetfile.
18 19 20 |
# File 'lib/bolt/project.rb', line 18 def puppetfile @puppetfile end |
#rerunfile ⇒ Object (readonly)
Returns the value of attribute rerunfile.
18 19 20 |
# File 'lib/bolt/project.rb', line 18 def rerunfile @rerunfile end |
#resource_types ⇒ Object (readonly)
Returns the value of attribute resource_types.
18 19 20 |
# File 'lib/bolt/project.rb', line 18 def resource_types @resource_types end |
#type ⇒ Object (readonly)
Returns the value of attribute type.
18 19 20 |
# File 'lib/bolt/project.rb', line 18 def type @type end |
#warnings ⇒ Object (readonly)
Returns the value of attribute warnings.
18 19 20 |
# File 'lib/bolt/project.rb', line 18 def warnings @warnings end |
Class Method Details
.create_project(path, type = 'option') ⇒ Object
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'lib/bolt/project.rb', line 47 def self.create_project(path, type = 'option') fullpath = Pathname.new(path). if !Bolt::Util.windows? && type != 'environment' && fullpath.world_writable? raise Bolt::Error.new( "Project directory '#{fullpath}' is world-writable which poses a security risk. Set "\ "BOLT_PROJECT='#{fullpath}' to force the use of this project directory.", "bolt/world-writable-error" ) end project_file = File.join(fullpath, 'bolt-project.yaml') data = Bolt::Util.read_optional_yaml_hash(File.(project_file), 'project') new(data, path, type) end |
.default_project ⇒ Object
22 23 24 25 26 27 |
# File 'lib/bolt/project.rb', line 22 def self.default_project create_project(File.(File.join('~', '.puppetlabs', 'bolt')), 'user') # If homedir isn't defined use the system config path rescue ArgumentError create_project(Bolt::Config.system_path, 'system') end |
.find_boltdir(dir) ⇒ Object
Search recursively up the directory hierarchy for the Project. Look for a directory called Boltdir or a file called bolt.yaml (for a control repo type Project). Otherwise, repeat the check on each directory up the hierarchy, falling back to the default if we reach the root.
33 34 35 36 37 38 39 40 41 42 43 44 45 |
# File 'lib/bolt/project.rb', line 33 def self.find_boltdir(dir) dir = Pathname.new(dir) if (dir + BOLTDIR_NAME).directory? create_project(dir + BOLTDIR_NAME, 'embedded') elsif (dir + 'bolt.yaml').file? || (dir + 'bolt-project.yaml').file? create_project(dir, 'local') elsif dir.root? default_project else find_boltdir(dir.parent) end end |
Instance Method Details
#check_deprecated_file ⇒ Object
162 163 164 165 166 167 |
# File 'lib/bolt/project.rb', line 162 def check_deprecated_file if (@path + 'project.yaml').file? msg = "Project configuration file 'project.yaml' is deprecated; use 'bolt-project.yaml' instead." Bolt::Logger.deprecation_warning('Using project.yaml instead of bolt-project.yaml', msg) end end |
#eql?(other) ⇒ Boolean Also known as: ==
118 119 120 |
# File 'lib/bolt/project.rb', line 118 def eql?(other) path == other.path end |
#name ⇒ Object
127 128 129 |
# File 'lib/bolt/project.rb', line 127 def name @data['name'] end |
#plans ⇒ Object
135 136 137 |
# File 'lib/bolt/project.rb', line 135 def plans @data['plans'] end |
#project_file? ⇒ Boolean
123 124 125 |
# File 'lib/bolt/project.rb', line 123 def project_file? @project_file.file? end |
#tasks ⇒ Object
131 132 133 |
# File 'lib/bolt/project.rb', line 131 def tasks @data['tasks'] end |
#to_h ⇒ Object
This API is used to prepend the project as a module to Puppet’s internal module_references list. CHANGE AT YOUR OWN RISK
114 115 116 |
# File 'lib/bolt/project.rb', line 114 def to_h { path: @path.to_s, name: name } end |
#to_s ⇒ Object
108 109 110 |
# File 'lib/bolt/project.rb', line 108 def to_s @path.to_s end |
#validate ⇒ Object
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'lib/bolt/project.rb', line 139 def validate if name name_regex = /^[a-z][a-z0-9_]*$/ if name !~ name_regex raise Bolt::ValidationError, <<~ERROR_STRING Invalid project name '#{name}' in bolt-project.yaml; project name must match #{name_regex.inspect} ERROR_STRING elsif Dir.children(Bolt::PAL::BOLTLIB_PATH).include?(name) raise Bolt::ValidationError, "The project '#{name}' will not be loaded. The project name conflicts "\ "with a built-in Bolt module of the same name." end else = "No project name is specified in bolt-project.yaml. Project-level content will not be available." @warnings << { msg: } end %w[tasks plans].each do |conf| unless @data.fetch(conf, []).is_a?(Array) raise Bolt::ValidationError, "'#{conf}' in bolt-project.yaml must be an array" end end end |