Add puppetfile option to bolt-project.yaml

lib/bolt/config/options.rb

@@ -484,6 +484,14 @@ module Options
           },
           _plugin: true
         },
+        "puppetfile" => {
+          description: "The path to the project's Puppetfile, used by `bolt module install` and " \
+                       "related commands. Relative paths are resolved from the project directory; " \
+                       "absolute paths are used as-is. Defaults to `Puppetfile` in the project directory.",
+          type: String,
+          _example: "control-repo/Puppetfile",
+          _plugin: true
+        },
         "rerunfile" => {
           description: "The path to the project's rerun file. The rerun file is used to store information " \
                        "about targets from the most recent run. Expands relative to the project directory.",
@@ -668,6 +676,7 @@ module Options
         policies
         puppetdb
         puppetdb-instances
+        puppetfile
         rerunfile
         save-rerun
         spinner

lib/bolt/module_installer/puppetfile.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'fileutils'
+
 require_relative '../../bolt/error'
 require_relative 'puppetfile/forge_module'
 require_relative 'puppetfile/git_module'
@@ -69,6 +71,7 @@ def self.parse(path, skip_unsupported_modules: false)
       # modules.
       #
       def write(path, moduledir = nil)
+        FileUtils.mkdir_p(File.dirname(path))
         File.open(path, 'w') do |file|
           if moduledir
             file.puts "# This Puppetfile is managed by Bolt. Do not edit."

lib/bolt/project.rb

@@ -132,6 +132,15 @@ def initialize(data, path, type = 'option')
         @rerunfile = File.expand_path(@data['rerunfile'], @path)
       end
 
+      if @data['puppetfile'].is_a?(String)
+        expanded = File.expand_path(@data['puppetfile'], @path)
+        unless expanded.start_with?(@path.to_s + '/')
+          raise Bolt::ValidationError,
+                "Option 'puppetfile' must be a relative path within the project directory."
+        end
+        @puppetfile = Pathname.new(expanded)
+      end
+
       validate if project_file?
     end
 

schemas/bolt-project.schema.json

@@ -67,6 +67,9 @@
     "puppetdb-instances": {
       "$ref": "#/definitions/puppetdb-instances"
     },
+    "puppetfile": {
+      "$ref": "#/definitions/puppetfile"
+    },
     "rerunfile": {
       "$ref": "#/definitions/rerunfile"
     },
@@ -605,6 +608,17 @@
         }
       ]
     },
+    "puppetfile": {
+      "description": "The path to the project's Puppetfile, used by `bolt module install` and related commands. Relative paths are resolved from the project directory; absolute paths are used as-is. Defaults to `Puppetfile` in the project directory.",
+      "oneOf": [
+        {
+          "type": "string"
+        },
+        {
+          "$ref": "#/definitions/_plugin"
+        }
+      ]
+    },
     "rerunfile": {
       "description": "The path to the project's rerun file. The rerun file is used to store information about targets from the most recent run. Expands relative to the project directory.",
       "oneOf": [

spec/integration/module_installer/module_installer_spec.rb

@@ -57,6 +57,22 @@
     end
   end
 
+  context 'with a puppetfile override in bolt-project.yaml' do
+    let(:project_config) { { 'puppetfile' => 'custom/Puppetfile' } }
+
+    it 'writes the puppetfile at the override path and not the default' do
+      output = run_cli_json(%w[module add puppetlabs-yaml], project: project)
+      expect(output['puppetfile']).to eq((project.path + 'custom' + 'Puppetfile').to_s)
+      expect(output['success']).to be
+
+      expect(File.exist?(project.path + 'custom' + 'Puppetfile')).to be true
+      expect(File.exist?(project.path + 'Puppetfile')).to be false
+
+      puppetfile_content = File.read(project.path + 'custom' + 'Puppetfile')
+      expect(puppetfile_content.lines).to include(%r{mod 'puppetlabs/yaml'})
+    end
+  end
+
   context 'with install configuration' do
     let(:base_config) do
       {

spec/unit/project_spec.rb

@@ -81,6 +81,51 @@
       end
     end
 
+    describe "#puppetfile" do
+      context "without a puppetfile override" do
+        let(:project_config) { {} }
+
+        it "defaults to <project>/Puppetfile" do
+          expect(project.puppetfile).to be_a(Pathname)
+          expect(project.puppetfile).to eq(project.path + 'Puppetfile')
+        end
+      end
+
+      context "with a relative puppetfile override" do
+        let(:project_config) { { 'puppetfile' => 'custom/Puppetfile.dev' } }
+
+        it "resolves the path relative to the project directory" do
+          expect(project.puppetfile).to be_a(Pathname)
+          expect(project.puppetfile).to eq(project.path + 'custom' + 'Puppetfile.dev')
+        end
+      end
+
+      context "with an absolute puppetfile path" do
+        let(:project_config) { { 'puppetfile' => File.expand_path('/tmp/shared/Puppetfile') } }
+
+        it "raises a validation error" do
+          expect { project }.to raise_error(Bolt::ValidationError, /must be a relative path within the project directory/)
+        end
+      end
+
+      context "with a puppetfile path that escapes the project directory" do
+        let(:project_config) { { 'puppetfile' => '../outside/Puppetfile' } }
+
+        it "raises a validation error" do
+          expect { project }.to raise_error(Bolt::ValidationError, /must be a relative path within the project directory/)
+        end
+      end
+
+      context "with a non-string puppetfile value" do
+        let(:project_config) { { 'puppetfile' => 42 } }
+
+        it "fails project schema validation" do
+          expect { Bolt::Project.create_project(@project_path) }
+            .to raise_error(Bolt::ValidationError, /puppetfile/)
+        end
+      end
+    end
+
     describe "with namespaced project names" do
       let(:project_config) { { 'name' => 'puppetlabs-foo' } }