Merge pull request #632 from bastelfreak/noop

run task/plan: Allow noop and environment option

Author: mhashizume

plans/run.pp

@@ -1,8 +1,12 @@
 # Starts a Puppet agent run on the specified targets.
 # Note: This plan may cause issues when run in Puppet Enterprise.
 # @param targets The targets to start a Puppet agent run on.
+# @param noop if true, all runs will use --noop
+# @param environment the desired puppet code environment
 plan puppet_agent::run (
-  TargetSpec $targets
+  TargetSpec $targets,
+  Boolean $noop = false,
+  Optional[String[1]] $environment = undef,
 ) {
   # Check which targets have the agent installed by checking
   # the version of the agent. No point in trying to run the
@@ -21,8 +25,8 @@
       '_error' => {
         'msg'     => "The task puppet_agent::version failed: ${result.error.message}. Unable to determine if the Puppet agent is installed.",
         'kind'    => 'puppet_agent/agent-version-error',
-        'details' => {}
-      }
+        'details' => {},
+      },
     }
 
     Result.new($result.target, $err)
@@ -45,19 +49,28 @@
       '_error' => {
         'msg'     => 'Puppet agent is not installed on the target. Run the puppet_agent::install task on these targets to install the Puppet agent.',
         'kind'    => 'puppet_agent/agent-not-installed',
-        'details' => {}
-      }
+        'details' => {},
+      },
     }
 
     Result.new($result.target, $err)
   }
 
   # Run the agent on all targets that have the agent installed.
+  $arg_env = $environment ? {
+    Undef   => {},
+    default => { 'environment' => $environment, },
+  }
+  $arg_noop = $noop ? {
+    true    => { 'noop' => true, },
+    default => {},
+  }
+  $args = $arg_env + $arg_noop + { '_catch_errors' => true }
   $run_results = run_task(
     'puppet_agent::run',
     $agent_results.targets,
     'Run Puppet agent',
-    '_catch_errors' => true
+    $args,
   )
 
   # Merge all of the results into a single ResultSet so each

tasks/run.json

@@ -1,6 +1,16 @@
 {
   "description": "Run the Puppet agent. This task may cause problems if run in Puppet Enterprise.",
-  "parameters": {},
+  "parameters": {
+    "noop": {
+      "description": "run the puppet agent with --noop",
+      "type": "Boolean",
+      "default": false
+    },
+    "environment": {
+      "description": "The desired puppet code environment to use",
+      "type": "Optional[String[1]]"
+    }
+  },
   "files": ["puppet_agent/files/rb_task_helper.rb"],
   "private": true
 }

tasks/run.rb

@@ -138,26 +138,34 @@ def config_print(*keys)
       end
     end
 
+    def noop(params)
+      params['noop'] == true ? '--noop' : ''
+    end
+
+    def environment(params)
+      params['environment'].length > 1 ? "--environment=#{params['environment']}" : ''
+    end
+
     # Attempts to run the Puppet agent, returning the mtime for the last run report
     # and the exit code from the Puppet agent run.
-    def try_run(last_run_report)
+    def try_run(last_run_report, params)
       start_time = get_start_time(last_run_report)
 
-      command = [puppet_bin, 'agent', '-t', '--color', 'false']
+      command = [puppet_bin, 'agent', '-t', '--color', 'false', noop(params), environment(params)]
 
       options = {
         failonfail:         false,
         custom_environment: get_env_fix_up,
         override_locale:    false
       }
 
-      run_result = Puppet::Util::Execution.execute(command, options)
+      run_result = Puppet::Util::Execution.execute(command.reject(&:empty?), options)
 
       [start_time, run_result]
     end
 
     # Runs the Puppet agent and returns the last run report.
-    def run
+    def run(params)
       unless puppet_bin_present?
         return error_result(
           'puppet_agent/no-puppet-bin-error',
@@ -177,7 +185,7 @@ def run
 
       # Initially ignore the lockfile. It might be out-dated, so we give Puppet a chance
       # to clean it up and run.
-      start_time, run_result = try_run(last_run_report)
+      start_time, run_result = try_run(last_run_report, params)
       if run_result.nil?
         return error_result(
           'puppet_agent/fail-to-start-error',
@@ -204,7 +212,7 @@ def run
         if running?(lockfile)
           wait_for_lockfile(lockfile)
 
-          start_time, run_result = try_run(last_run_report)
+          start_time, run_result = try_run(last_run_report, params)
           if run_result.nil?
             return error_result(
               'puppet_agent/fail-to-start-error',
@@ -237,5 +245,5 @@ def run
 
 if __FILE__ == $PROGRAM_NAME
   runner = PuppetAgent::Runner.new
-  puts JSON.dump(runner.run)
+  puts JSON.dump(runner.run(params))
 end