foreman_ansible 3.0.9 → 4.0.0

data/config/routes.rb

@@ -8,7 +8,6 @@ Rails.application.routes.draw do
           :defaults => { :apiv => 'v2' },
           :apiv => /v1|v2/,
           :constraints => ApiConstraints.new(:version => 2) do
-
       constraints(:id => %r{[^\/]+}) do
         resources :hosts, :only => [] do
           member do
@@ -75,7 +74,6 @@ Rails.application.routes.draw do
             :defaults => { :apiv => 'v2' },
             :apiv => /v1|v2/,
             :constraints => ApiConstraints.new(:version => 2) do
-
         resources :ansible_roles, :only => [:show, :index, :destroy] do
           collection do
             put :import
@@ -99,6 +97,7 @@ Rails.application.routes.draw do
             get :hosts
             post :hostgroups
             get :hostgroups
+            post :schedule
           end
         end
       end

data/db/migrate/20190328114657_remove_top_level_ansible_variables_setting.rb

@@ -1,6 +1,6 @@
 class RemoveTopLevelAnsibleVariablesSetting < ActiveRecord::Migration[5.2]
   def up
     setting = Setting.find_by(:name => 'top_level_ansible_vars')
-    setting.destroy if setting
+    setting&.destroy
   end
 end

data/db/migrate/20191010074208_remove_ansible_implementation_setting.rb

@@ -0,0 +1,5 @@
+class RemoveAnsibleImplementationSetting < ActiveRecord::Migration[5.2]
+  def up
+    Setting.where(:name => 'ansible_implementation').destroy_all
+  end
+end

data/db/seeds.d/75_job_templates.rb

@@ -20,8 +20,8 @@ User.as_anonymous_admin do
                                            :default => true,
                                            :locked => true,
                                            :update => sync)
-        template.organizations = organizations if SETTINGS[:organizations_enabled] && template.present?
-        template.locations = locations if SETTINGS[:locations_enabled] && template.present?
+        template.organizations = organizations if template.present?
+        template.locations = locations if template.present?
       end
     end
   end

data/lib/foreman_ansible/register.rb

@@ -2,7 +2,7 @@
 
 # rubocop:disable BlockLength
 Foreman::Plugin.register :foreman_ansible do
-  requires_foreman '>= 1.22'
+  requires_foreman '>= 1.24'
 
   security_block :foreman_ansible do
     permission :play_roles_on_host,
@@ -71,6 +71,9 @@ Foreman::Plugin.register :foreman_ansible do
     permission :edit_hostgroups,
                { :'api/v2/hostgroups' => [:assign_ansible_roles] },
                :resource_type => 'Hostgroup'
+    permission :generate_report_templates,
+               { :'api/v2/ansible_inventories' => [:schedule] },
+               :resource_type => 'ReportTemplate'
   end
 
   role 'Ansible Roles Manager',
@@ -82,7 +85,7 @@ Foreman::Plugin.register :foreman_ansible do
         :edit_ansible_variables, :destroy_ansible_variables]
 
   role 'Ansible Tower Inventory Reader',
-       [:view_hosts, :view_hostgroups, :view_facts],
+       [:view_hosts, :view_hostgroups, :view_facts, :generate_report_templates],
        'Permissions required for the user which is used by Ansible Tower Dynamic Inventory Item'
 
   add_all_permissions_to_default_roles

data/lib/foreman_ansible/remote_execution.rb

@@ -30,6 +30,12 @@ module ForemanAnsible
         :provided_inputs => %w[organization_id plan_id],
         :notification_builder => ForemanAnsible::InsightsNotificationBuilder
       )
+      RemoteExecutionFeature.register(
+        :ansible_run_playbook,
+        N_('Run playbook'),
+        :description => N_('Run an Ansible playbook against given hosts'),
+        :provided_inputs => %w[playbook]
+      )
     end
   end
 end

data/lib/foreman_ansible/version.rb

@@ -4,5 +4,5 @@
 # This way other parts of Foreman can just call ForemanAnsible::VERSION
 # and detect what version the plugin is running.
 module ForemanAnsible
-  VERSION = '3.0.9'
+  VERSION = '4.0.0'
 end

data/locale/Makefile

@@ -60,3 +60,10 @@ tx-update: tx-pull reset-po $(MOFILES)
 	git add ../locale/*/LC_MESSAGES
 	git commit -a --amend -m "i18n - pulling from tx"
 	-echo Changes commited!
+
+mo-files: $(MOFILES)
+	git add $(POFILES) $(POTFILE) ../locale/*/LC_MESSAGES
+	git commit -m "i18n - pulling from tx"
+	@echo
+	@echo Changes commited!
+	@echo

data/locale/de/foreman_ansible.po

@@ -5,7 +5,7 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_ansible 3.0.2\n"
+"Project-Id-Version: foreman_ansible 3.0.1\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2018-03-12 12:24-0400\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"

data/locale/en/foreman_ansible.po

@@ -4,7 +4,7 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_ansible 3.0.2\n"
+"Project-Id-Version: foreman_ansible 3.0.1\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2014-08-20 08:54+0100\n"
 "Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"

data/locale/es/foreman_ansible.po

@@ -5,7 +5,7 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_ansible 3.0.2\n"
+"Project-Id-Version: foreman_ansible 3.0.1\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2018-03-12 12:24-0400\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"

data/locale/fr/foreman_ansible.po

@@ -5,7 +5,7 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_ansible 3.0.2\n"
+"Project-Id-Version: foreman_ansible 3.0.1\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2018-03-12 12:24-0400\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"

data/locale/it/foreman_ansible.po

@@ -5,7 +5,7 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_ansible 3.0.2\n"
+"Project-Id-Version: foreman_ansible 3.0.1\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2018-03-12 12:24-0400\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"

data/locale/ja/foreman_ansible.po

@@ -5,7 +5,7 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_ansible 3.0.2\n"
+"Project-Id-Version: foreman_ansible 3.0.1\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2018-03-12 12:24-0400\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"

data/locale/ko/foreman_ansible.po

@@ -5,7 +5,7 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_ansible 3.0.2\n"
+"Project-Id-Version: foreman_ansible 3.0.1\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2018-03-12 12:24-0400\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"

data/locale/pt_BR/foreman_ansible.po

@@ -5,7 +5,7 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_ansible 3.0.2\n"
+"Project-Id-Version: foreman_ansible 3.0.1\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2018-03-12 12:24-0400\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"

data/locale/ru/foreman_ansible.po

@@ -5,7 +5,7 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_ansible 3.0.2\n"
+"Project-Id-Version: foreman_ansible 3.0.1\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2018-03-12 12:24-0400\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"

data/locale/zh_CN/foreman_ansible.po

@@ -5,7 +5,7 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_ansible 3.0.2\n"
+"Project-Id-Version: foreman_ansible 3.0.1\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2018-03-12 12:24-0400\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"

data/locale/zh_TW/foreman_ansible.po

@@ -5,7 +5,7 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_ansible 3.0.2\n"
+"Project-Id-Version: foreman_ansible 3.0.1\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2018-03-12 12:24-0400\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"

data/package.json

@@ -7,11 +7,11 @@
     "test": "test"
   },
   "dependencies": {
-    "@theforeman/vendor": "^0.1.1",
+    "@theforeman/vendor": "^1.7.0",
     "react-json-tree": "^0.11.0"
   },
   "devDependencies": {
-    "@theforeman/vendor-dev": "^0.1.1",
+    "@theforeman/vendor-dev": "^1.7.0",
     "babel-eslint": "^8.2.1",
     "babel-plugin-transform-class-properties": "^6.24.1",
     "babel-plugin-transform-object-assign": "^6.22.0",
@@ -38,7 +38,7 @@
   },
   "scripts": {
     "test": "node node_modules/.bin/jest webpack",
-    "lint": "./node_modules/.bin/eslint -c .eslintrc webpack/ || exit 0"
+    "lint": "eslint ./webpack"
   },
   "repository": {
     "type": "git",

data/test/unit/ansible_provider_test.rb

@@ -29,6 +29,22 @@ class AnsibleProviderTest < ActiveSupport::TestCase
       end
     end
 
+    context 'when using secrets' do
+      let(:host) { FactoryBot.build(:host) }
+
+      it 'generates secrets properly' do
+        params = {
+          'remote_execution_ssh_password' => 'password',
+          'remote_execution_sudo_password' => 'letmein'
+        }
+        host.expects(:params).twice.returns(params)
+        secrets = ForemanAnsible::AnsibleProvider.secrets(host)
+        host_secrets = secrets['per-host'][host.name]
+        assert_equal host_secrets['ansible_ssh_pass'], 'password'
+        assert_equal host_secrets['ansible_sudo_pass'], 'letmein'
+      end
+    end
+
     def command_options
       ForemanAnsible::AnsibleProvider.
         proxy_command_options(template_invocation, dummyhost)

data/test/unit/ansible_variable_test.rb

@@ -11,4 +11,14 @@ class AnsibleRoleTest < ActiveSupport::TestCase
     subject { AnsibleRole.new(:name => 'foo') }
     should validate_uniqueness_of(:name)
   end
+
+  test 'should cast default_value to hash' do
+    variable = FactoryBot.create(
+      :ansible_variable,
+      :key_type => 'hash',
+      :default_value => "{\r\n  \"bat\": \"man\"\r\n}\r\n",
+      :override => true
+    )
+    assert variable.default_value.is_a?(Hash)
+  end
 end

data/test/unit/lib/foreman_ansible_core/ansible_runner_test.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module ForemanAnsibleCore
+  module Runner
+    class AnsibleRunnerTest < ActiveSupport::TestCase
+      describe AnsibleRunner do
+        it 'parses files without event data' do
+          content = <<~JSON
+            {"uuid": "a29d8592-f805-4d0e-b73d-7a53cc35a92e", "stdout": " [WARNING]: Consider using the yum module rather than running 'yum'.  If you", "counter": 8, "end_line": 8, "runner_ident": "e2d9ae11-026a-4f9f-9679-401e4b852ab0", "start_line": 7, "event": "verbose"}
+          JSON
+
+          File.expects(:read).with('fake.json').returns(content)
+          runner = AnsibleRunner.allocate
+          runner.expects(:handle_broadcast_data)
+          assert runner.send(:handle_event_file, 'fake.json')
+        end
+      end
+
+      describe '#rebuild_secrets' do
+        let(:inventory) do
+          { 'all' => { 'hosts' => ['foreman.example.com'] },
+            '_meta' => { 'hostvars' => { 'foreman.example.com' => {} } } }
+        end
+        let(:input) do
+          host_secrets = { 'ansible_ssh_pass' => 'letmein', 'ansible_sudo_pass' => 'iamroot' }
+          secrets = { 'per-host' => { 'foreman.example.com' => host_secrets } }
+          host_input = { 'input' => { 'action_input' => { 'secrets' => secrets } } }
+          { 'foreman.example.com' => host_input }
+        end
+        let(:runner) { ForemanAnsibleCore::Runner::AnsibleRunner.allocate }
+
+        test 'uses secrets from inventory' do
+          test_inventory = inventory.merge('ssh_password' => 'sshpass', 'sudo_password' => 'sudopass')
+          rebuilt = runner.send(:rebuild_secrets, test_inventory, input)
+          host_vars = rebuilt.dig('_meta', 'hostvars', 'foreman.example.com')
+          assert_equal 'sshpass', host_vars['ansible_ssh_pass']
+          assert_equal 'sudopass', host_vars['ansible_sudo_pass']
+        end
+
+        test 'host secrets are used when not overriden by inventory secrest' do
+          rebuilt = runner.send(:rebuild_secrets, inventory, input)
+          host_vars = rebuilt.dig('_meta', 'hostvars', 'foreman.example.com')
+          assert_equal 'letmein', host_vars['ansible_ssh_pass']
+          assert_equal 'iamroot', host_vars['ansible_sudo_pass']
+        end
+      end
+    end
+  end
+end

data/test/unit/lib/foreman_ansible_core/playbook_runner_test.rb

@@ -10,6 +10,7 @@ class PlaybookRunnerTest < ActiveSupport::TestCase
       ForemanAnsibleCore::Runner::Playbook.any_instance.stubs(:unknown_hosts).
         returns([])
       File.expects(:exist?).with(Dir.home).returns(true)
+      ForemanAnsibleCore::Runner::Playbook.any_instance.expects(:rebuild_secrets).returns(nil)
       runner = ForemanAnsibleCore::Runner::Playbook.new(nil, nil, :suspended_action => nil)
       assert '/etc/ansible', runner.instance_variable_get('@ansible_dir')
     end
@@ -24,6 +25,7 @@ class PlaybookRunnerTest < ActiveSupport::TestCase
     test 'creates temp one if not provided' do
       Dir.expects(:mktmpdir)
       File.expects(:exist?).with(Dir.home).returns(true)
+      ForemanAnsibleCore::Runner::Playbook.any_instance.expects(:rebuild_secrets).returns(nil)
       ForemanAnsibleCore::Runner::Playbook.new(nil, nil, :suspended_action => nil)
     end
 
@@ -32,6 +34,7 @@ class PlaybookRunnerTest < ActiveSupport::TestCase
       ForemanAnsibleCore.expects(:settings).returns(settings)
       File.expects(:exist?).with(settings[:ansible_dir]).returns(true)
       Dir.expects(:mktmpdir).never
+      ForemanAnsibleCore::Runner::Playbook.any_instance.expects(:rebuild_secrets).returns(nil)
       runner = ForemanAnsibleCore::Runner::Playbook.new(nil, nil, :suspended_action => nil)
       assert '/foo', runner.instance_variable_get('@working_dir')
     end
@@ -39,7 +42,7 @@ class PlaybookRunnerTest < ActiveSupport::TestCase
 
   context 'TOFU policy' do # Trust On First Use
     setup do
-      @inventory = { 'all' => { 'hosts' => ['foreman.example.com'] } }.to_json
+      @inventory = { 'all' => { 'hosts' => ['foreman.example.com'] } }
       @output = StringIO.new
       logger = Logger.new(@output)
       ForemanAnsibleCore::Runner::Playbook.any_instance.stubs(:logger).
@@ -51,6 +54,7 @@ class PlaybookRunnerTest < ActiveSupport::TestCase
         with('foreman.example.com').returns(['somekey'])
       ForemanAnsibleCore::Runner::Playbook.any_instance.
         expects(:add_to_known_hosts).never
+      ForemanAnsibleCore::Runner::Playbook.any_instance.expects(:rebuild_secrets).returns(@inventory)
       ForemanAnsibleCore::Runner::Playbook.new(@inventory, nil, :suspended_action => nil)
     end
 
@@ -59,6 +63,7 @@ class PlaybookRunnerTest < ActiveSupport::TestCase
         with('foreman.example.com').returns([])
       ForemanAnsibleCore::Runner::Playbook.any_instance.
         expects(:add_to_known_hosts).with('foreman.example.com')
+      ForemanAnsibleCore::Runner::Playbook.any_instance.expects(:rebuild_secrets).returns(@inventory)
       ForemanAnsibleCore::Runner::Playbook.new(@inventory, nil, :suspended_action => nil)
     end
 
@@ -67,6 +72,7 @@ class PlaybookRunnerTest < ActiveSupport::TestCase
         with('foreman.example.com').returns([])
       Net::SSH::Transport::Session.expects(:new).with('foreman.example.com').
         raises(Net::Error)
+      ForemanAnsibleCore::Runner::Playbook.any_instance.expects(:rebuild_secrets).returns(@inventory)
       ForemanAnsibleCore::Runner::Playbook.new(@inventory, nil, :suspended_action => nil)
       assert_match(
         /ERROR.*Failed to save host key for foreman.example.com: Net::Error/,
@@ -74,4 +80,31 @@ class PlaybookRunnerTest < ActiveSupport::TestCase
       )
     end
   end
+
+  context 'rebuild secrets' do
+    let(:inventory) do
+      { 'all' => { 'hosts' => ['foreman.example.com'] },
+        '_meta' => { 'hostvars' => { 'foreman.example.com' => {} } } }
+    end
+    let(:secrets) do
+      host_secrets = { 'ansible_ssh_pass' => 'letmein', 'ansible_sudo_pass' => 'iamroot' }
+      { 'per-host' => { 'foreman.example.com' => host_secrets } }
+    end
+    let(:runner) { ForemanAnsibleCore::Runner::Playbook.allocate }
+
+    test 'uses secrets from inventory' do
+      test_inventory = inventory.merge('ssh_password' => 'sshpass', 'sudo_password' => 'sudopass')
+      rebuilt = runner.send(:rebuild_secrets, test_inventory, secrets)
+      host_vars = rebuilt.dig('_meta', 'hostvars', 'foreman.example.com')
+      assert_equal 'sshpass', host_vars['ansible_ssh_pass']
+      assert_equal 'sudopass', host_vars['ansible_sudo_pass']
+    end
+
+    test 'host secrets are used when not overriden by inventory secrest' do
+      rebuilt = runner.send(:rebuild_secrets, inventory, secrets)
+      host_vars = rebuilt.dig('_meta', 'hostvars', 'foreman.example.com')
+      assert_equal 'letmein', host_vars['ansible_ssh_pass']
+      assert_equal 'iamroot', host_vars['ansible_sudo_pass']
+    end
+  end
 end

data/test/unit/services/fact_importer_test.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'test_plugin_helper'
+
 module ForemanAnsible
   # Test for the facts importer - only verify that given
   # a set of facts it's able to import them
@@ -18,8 +20,8 @@ module ForemanAnsible
 
     test 'missing_facts returns facts we do not have in the database' do
       @fact_importer = FactImporter.new(@host, facts_json)
-      @fact_importer.expects(:db_facts).
-        returns('ansible_cmdline' => 'fakevalue').twice
+      @fact_importer.expects(:host_fact_names).
+        returns(['ansible_cmdline'])
       refute @fact_importer.send(:missing_facts).include?('ansible_cmdline')
     end