Merge pull request #23576 from Fryguy/ansible_runner_async_bug

Fix issue where ansible-runner async did not respect the venv

(cherry picked from commit c257ffb)

Author: bdunne

lib/ansible/runner.rb

@@ -163,6 +163,21 @@ def run_role_queue(env_vars, extra_vars, role_name, user_id, queue_opts, roles_p
         run_in_queue("run_role", user_id, queue_opts, [env_vars, extra_vars, role_name, kwargs])
       end
 
+      # Executes ansible-runner within the venv.
+      #
+      # Prefer the various run_* methods unless you need to run the ansible-runner command directly.
+      #
+      # @param env [Hash] Hash that will be passed as environment variables to ansible-runner
+      # @param params [Hash,Array] Command line parameters to pass to ansible-runner
+      # @return [AwesomeSpawn::CommandResult] Result of the ansible-runner command
+      def raw_execute(env: {}, params:)
+        env = env.merge(runner_env)
+
+        # puts "#{env.map { |k, v| "#{k}=#{v}" }.join(" ")} #{AwesomeSpawn.build_command_line("ansible-runner", params)}"
+
+        AwesomeSpawn.run("ansible-runner", :env => env, :params => params)
+      end
+
       private
 
       # Run a method on self class, via queue, executed by generic worker
@@ -219,7 +234,7 @@ def run_via_cli(hosts, credentials, env_vars, extra_vars, tags: nil, ansible_run
         end
         command_line_hash.merge!(cred_command_line)
 
-        env_vars_hash   = env_vars.merge(cred_env_vars).merge(runner_env)
+        env_vars_hash   = env_vars.merge(cred_env_vars)
         extra_vars_hash = extra_vars.merge(cred_extra_vars)
 
         create_hosts_file(base_dir, hosts)
@@ -228,15 +243,13 @@ def run_via_cli(hosts, credentials, env_vars, extra_vars, tags: nil, ansible_run
 
         params = runner_params(base_dir, ansible_runner_method, playbook_or_role_args, verbosity)
 
-        # puts "#{env_vars_hash.map { |k, v| "#{k}=#{v}" }.join(" ")} #{AwesomeSpawn.build_command_line("ansible-runner", params)}"
-
         begin
           fetch_galaxy_roles(playbook_or_role_args)
 
           result = if async?(ansible_runner_method)
-                     wait_for(base_dir, "pid") { AwesomeSpawn.run("ansible-runner", :env => env_vars_hash, :params => params) }
+                     wait_for(base_dir, "pid") { raw_execute(:env => env_vars_hash, :params => params) }
                    else
-                     AwesomeSpawn.run("ansible-runner", :env => env_vars_hash, :params => params)
+                     raw_execute(:env => env_vars_hash, :params => params)
                    end
 
           res = response(base_dir, ansible_runner_method, result, debug)

lib/ansible/runner/response_async.rb

@@ -23,12 +23,12 @@ def initialize(base_dir:, command_line: nil, ident: "result", debug: false)
 
       # @return [Boolean] true if the ansible job is still running, false when it's finished
       def running?
-        AwesomeSpawn.run("ansible-runner", :params => ["is-alive", base_dir, :json, {:ident => "result"}]).success?
+        Ansible::Runner.raw_execute(:params => ["is-alive", base_dir, :json, {:ident => "result"}]).success?
       end
 
       # Stops the running Ansible job
       def stop
-        AwesomeSpawn.run("ansible-runner", :params => ["stop", base_dir, :json, {:ident => "result"}])
+        Ansible::Runner.raw_execute(:params => ["stop", base_dir, :json, {:ident => "result"}])
       end
 
       # @return [Ansible::Runner::Response, NilClass] Response object with all details about the Ansible run, or nil

spec/lib/ansible/runner_execution_spec.bats

@@ -139,49 +139,49 @@ exec_ansible_runner_role() {
   rails runner "resp = Ansible::Runner.run_role({}, {}, '$1', roles_path: '$ROLES_DIR'); puts resp.human_stdout; exit resp.return_code"
 }
 
-@test "[Ansible::Runner] runs a playbook" {
+@test "[Ansible::Runner#run] runs a playbook" {
   run exec_ansible_runner hello_world.yml
   assert_success
   assert_output --partial '"msg": "Hello World!"'
 }
 
-@test "[Ansible::Runner] runs a playbook with variables in a vars file" {
+@test "[Ansible::Runner#run] runs a playbook with variables in a vars file" {
   run exec_ansible_runner hello_world_vars_file.yml
   assert_success
   assert_output --partial '"msg": "Hello World! vars_file_1=vars_file_1_value, vars_file_2=vars_file_2_value"'
 }
 
-@test "[Ansible::Runner] runs a playbook with vault encrypted variables" {
+@test "[Ansible::Runner#run] runs a playbook with vault encrypted variables" {
   skip "requires database access"
 
   run exec_ansible_runner hello_world_vault_encrypted_vars.yml
   assert_success
   assert_output --partial '"msg": "Hello World! (NOTE: This message has been encrypted with ansible-vault)"'
 }
 
-@test "[Ansible::Runner] runs a playbook with variables in a vault encrypted vars file" {
+@test "[Ansible::Runner#run] runs a playbook with variables in a vault encrypted vars file" {
   skip "requires database access"
 
   run exec_ansible_runner hello_world_vault_encrypted_vars_file.yml
   assert_success
   assert_output --partial '"msg": "Hello World! vars_file_1=vars_file_1_value, vars_file_2=vars_file_2_value"'
 }
 
-@test "[Ansible::Runner] runs a playbook using roles from github" {
+@test "[Ansible::Runner#run] runs a playbook using roles from github" {
   run exec_ansible_runner hello_world_with_requirements_github/hello_world_with_requirements_github.yml
   assert_success
   assert_output --partial '"msg": "Hello World! example_var='\''example var value'\''"'
 }
 
-@test "[Ansible::Runner] runs a role" {
+@test "[Ansible::Runner#run_role] runs a role" {
   setup_roles_dir $ROLES_DIR $DATA_DIR/hello_world_with_requirements_github/roles/requirements.yml
 
   run exec_ansible_runner_role manageiq.example
   assert_success
   assert_output --partial '"msg": "Hello from manageiq.example role! example_var='\''example var value'\''"'
 }
 
-@test "[Ansible::Runner] vmware collection" {
+@test "[Ansible::Runner#run] vmware collection" {
   if [ ! -d /var/lib/manageiq/venv ]; then
     skip "manageiq venv collections are not present"
   fi
@@ -191,7 +191,7 @@ exec_ansible_runner_role() {
   assert_output --partial '"msg": "Unknown error while connecting to vCenter or ESXi API at vcenter_hostname:443 : [Errno -2] Name or service not known"'
 }
 
-@test "[Ansible::Runner] aws collection" {
+@test "[Ansible::Runner#run] aws collection" {
   if [ ! -d /var/lib/manageiq/venv ]; then
     skip "manageiq venv collections are not present"
   fi
@@ -200,3 +200,75 @@ exec_ansible_runner_role() {
   assert_failure # We expect to this to fail due to connecting with bad creds
   assert_output --partial '"msg": "Failed to describe instances: An error occurred (AuthFailure) when calling the DescribeInstances operation: AWS was not able to validate the provided access credentials"'
 }
+
+################################################################################
+
+exec_ansible_runner_async() {
+  rails runner "resp = Ansible::Runner.run_async({}, {}, '$DATA_DIR/$1').wait(5); puts resp.human_stdout; exit resp.return_code"
+}
+
+exec_ansible_runner_role_async() {
+  rails runner "resp = Ansible::Runner.run_role_async({}, {}, '$1', roles_path: '$ROLES_DIR').wait(5); puts resp.human_stdout; exit resp.return_code"
+}
+
+@test "[Ansible::Runner#run_async] runs a playbook" {
+  run exec_ansible_runner_async hello_world.yml
+  assert_success
+  assert_output --partial '"msg": "Hello World!"'
+}
+
+@test "[Ansible::Runner#run_async] runs a playbook with variables in a vars file" {
+  run exec_ansible_runner_async hello_world_vars_file.yml
+  assert_success
+  assert_output --partial '"msg": "Hello World! vars_file_1=vars_file_1_value, vars_file_2=vars_file_2_value"'
+}
+
+@test "[Ansible::Runner#run_async] runs a playbook with vault encrypted variables" {
+  skip "requires database access"
+
+  run exec_ansible_runner_async hello_world_vault_encrypted_vars.yml
+  assert_success
+  assert_output --partial '"msg": "Hello World! (NOTE: This message has been encrypted with ansible-vault)"'
+}
+
+@test "[Ansible::Runner#run_async] runs a playbook with variables in a vault encrypted vars file" {
+  skip "requires database access"
+
+  run exec_ansible_runner_async hello_world_vault_encrypted_vars_file.yml
+  assert_success
+  assert_output --partial '"msg": "Hello World! vars_file_1=vars_file_1_value, vars_file_2=vars_file_2_value"'
+}
+
+@test "[Ansible::Runner#run_async] runs a playbook using roles from github" {
+  run exec_ansible_runner_async hello_world_with_requirements_github/hello_world_with_requirements_github.yml
+  assert_success
+  assert_output --partial '"msg": "Hello World! example_var='\''example var value'\''"'
+}
+
+@test "[Ansible::Runner#run_role_async] runs a role" {
+  setup_roles_dir $ROLES_DIR $DATA_DIR/hello_world_with_requirements_github/roles/requirements.yml
+
+  run exec_ansible_runner_role_async manageiq.example
+  assert_success
+  assert_output --partial '"msg": "Hello from manageiq.example role! example_var='\''example var value'\''"'
+}
+
+@test "[Ansible::Runner#run_async] vmware collection" {
+  if [ ! -d /var/lib/manageiq/venv ]; then
+    skip "manageiq venv collections are not present"
+  fi
+
+  run exec_ansible_runner_async vmware.yml
+  assert_failure # We expect to this to fail due to connecting to an unknown vcenter
+  assert_output --partial '"msg": "Unknown error while connecting to vCenter or ESXi API at vcenter_hostname:443 : [Errno -2] Name or service not known"'
+}
+
+@test "[Ansible::Runner#run_async] aws collection" {
+  if [ ! -d /var/lib/manageiq/venv ]; then
+    skip "manageiq venv collections are not present"
+  fi
+
+  run exec_ansible_runner_async aws.yml
+  assert_failure # We expect to this to fail due to connecting with bad creds
+  assert_output --partial '"msg": "Failed to describe instances: An error occurred (AuthFailure) when calling the DescribeInstances operation: AWS was not able to validate the provided access credentials"'
+}