foreman_vault 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4fbc008315206c64c8641835e56d14ef1b31f42ef411dfc321a3c8670998172
-  data.tar.gz: 3ff7634135705a37592423d8d993790041b826a4d414f7952187290ae4d9109b
+  metadata.gz: 3740f896bbaf5c359055e38306c07e32880ed7caea04802e99f91aa11a5f0f7e
+  data.tar.gz: d3ce5deb29bd8e004daad91412af777815541e94816f11a7fed8f8db16a76c5e
 SHA512:
-  metadata.gz: 9a7afc22a1db923534cd471d61b0837573c3f3db79c82ca7c6454148a281aa1adf76806fec9a39da3e4bb189e00a38ba2e3bf0e69382c48319489e24c943381d
-  data.tar.gz: 34e80dcc58fcf00a8673d6ca9a5f23f30196d5d8ab38640d34eb4323322572ad152f66b308e252d2a2be9d176082193a9acbc4e62006016f279c218841a319fd
+  metadata.gz: 12b5e1377c8e2d85c03b9fc205225b337e2ea21e9a12d9179452e9dd94ec42c17475f671020553026a63c8054c35a83e684748df4f26f74925a7100018de2c95
+  data.tar.gz: 40db8b1479b9ff768c8de84119e9b4c81871bfcc66b3f0853f9872d73be311d8d279db33e79cf62af522e1802f75e9d450dceb3b0a4351f09f427f9730e174b6

data/README.md

@@ -22,6 +22,7 @@ This allows Foreman to create everything needed to access Hashicorp Vault direct
 
 | Foreman Version | Plugin Version |
 | --------------- | -------------- |
+| >= 3.19         | ~> 4.0         |
 | >= 3.13         | ~> 3.0         |
 | >= 3.9          | ~> 2.0         |
 | >= 2.3          | ~> 1.0         |

data/lib/foreman_vault/engine.rb

@@ -15,8 +15,9 @@ module ForemanVault
 
     initializer 'foreman_vault.register_plugin', before: :finisher_hook do |app|
       app.reloader.to_prepare do
+        require 'foreman/cron'
         Foreman::Plugin.register :foreman_vault do
-          requires_foreman '>= 3.13'
+          requires_foreman '>= 3.19'
 
           apipie_documented_controllers ["#{ForemanVault::Engine.root}/app/controllers/api/v2/*.rb"]
 
@@ -53,6 +54,11 @@ module ForemanVault
                 type: :boolean,
                 description: N_('Enable or disable the Vault orchestration step for managing policies and auth methods'),
                 default: false)
+              setting('vault_cronjobs_enabled',
+                full_name: N_('Vault Cronjobs enabled'),
+                type: :boolean,
+                description: N_('Enable or disable the hourly Vault Cronjobs for managing policies and auth methods'),
+                default: false)
             end
           end
 
@@ -60,6 +66,10 @@ module ForemanVault
           menu :top_menu, :vault_connections, url_hash: { controller: :vault_connections, action: :index },
                                               caption: N_('Vault Connections'),
                                               parent: :infrastructure_menu
+
+          # Register recurring task with Foreman::Cron framework
+          Foreman::Cron.register(:hourly, 'foreman_vault:policies:push')
+          Foreman::Cron.register(:hourly, 'foreman_vault:auth_methods:push')
         end
       end
     end

data/lib/foreman_vault/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanVault
-  VERSION = '3.0.0'
+  VERSION = '4.0.0'
 end

data/lib/tasks/foreman_vault_tasks.rake

@@ -8,6 +8,7 @@ namespace :foreman_vault do # rubocop:disable Metrics/BlockLength
     desc 'Push auth methods for all hosts to Vault'
     task push: :environment do
       User.as_anonymous_admin do
+        next unless Setting['vault_cronjobs_enabled']
         hosts = Host::Managed.where(managed: true)
 
         hosts.each_with_index do |host, index|
@@ -28,6 +29,7 @@ namespace :foreman_vault do # rubocop:disable Metrics/BlockLength
     desc 'Push policies for all hosts to Vault'
     task push: :environment do
       User.as_anonymous_admin do
+        next unless Setting['vault_cronjobs_enabled']
         hosts = Host::Managed.where(managed: true)
 
         hosts.each_with_index do |host, index|

data/test/lib/tasks/push_auth_methods_test.rb

@@ -18,6 +18,8 @@ module ForemanVault
 
       FactoryBot.create(:parameter, name: 'vault_connection', value: vault_connection.name)
 
+      Setting[:vault_cronjobs_enabled] = true
+
       ForemanVault::VaultAuthMethod.any_instance.stubs(:vault_policy_name).returns('vault_policy_name')
       ForemanVault::VaultAuthMethod.any_instance.stubs(:certificate).returns('cert')
 
@@ -45,5 +47,16 @@ module ForemanVault
 
       assert_match("[1/1] Failed to push \"#{host.name}\"", stdout)
     end
+
+    it 'does not push auth methods when cronjobs are disabled' do
+      Setting[:vault_cronjobs_enabled] = false
+      host
+
+      stdout, _stderr = capture_io do
+        Rake::Task[TASK_NAME].invoke
+      end
+
+      assert_empty stdout
+    end
   end
 end

data/test/lib/tasks/push_policies_test.rb

@@ -18,6 +18,8 @@ module ForemanVault
 
       FactoryBot.create(:parameter, name: 'vault_connection', value: vault_connection.name)
 
+      Setting[:vault_cronjobs_enabled] = true
+
       ForemanVault::VaultPolicy.any_instance.stubs(:name).returns('vault_policy_name')
       ForemanVault::VaultPolicy.any_instance.stubs(:rules).returns('rules')
 
@@ -45,5 +47,16 @@ module ForemanVault
 
       assert_match("[1/1] Failed to push \"#{host.name}\"", stdout)
     end
+
+    it 'does not push policies when cronjobs are disabled' do
+      Setting[:vault_cronjobs_enabled] = false
+      host
+
+      stdout, _stderr = capture_io do
+        Rake::Task[TASK_NAME].invoke
+      end
+
+      assert_empty stdout
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreman_vault
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - dmTECH GmbH
@@ -139,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Adds support for using credentials from Hashicorp Vault
 test_files: