foreman_google 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 367ea676f11cf5a5d354258ec346a46fe763033c2a51a5bbe98da9fa2a79c5ee
-  data.tar.gz: 2b0bb4dfe19b4b6351c37049757c0982f4398b8b47c930b76709f074533175dc
+  metadata.gz: af8138079174df0021538ef3957ab3b4e91fbfddc5647306358e036a54623bc6
+  data.tar.gz: 4a44a5c32b98e15025078bdcfbd5a003b045d8d570767c6e7024e1fd1f0746cd
 SHA512:
-  metadata.gz: 22d1b5fd31a5036b547e5a2aa07909cb4b76ca65c9189c1661b3fa3b89adee9bb44977869c56b3135242193def49a11df33ade1d1c208e0b190988d63994feca
-  data.tar.gz: 4196d8ec947fea1c2105b9e2848299079e2d01d6dae9dce3a074192fe18df9ce30e1a5ef52ec0634d9a9bd737e78aa04f70fb39fa948d2c5f5102f3190d5323e
+  metadata.gz: '07847edac1b7ea54faafa702f5718178ba4c23a43fc8d861479d9c57a069ce23278515990f4ba844a9ea98e81fba382d1bb3bd6e20a09d555c5b0ac51fc9b767'
+  data.tar.gz: 68794184e443c7037deceb999fcb65a03c32ff18711b5807d61c38c2441873e6b58a9d8145748f10251faa1c83927ad0e88ad712bf4e8b98c05a9dad2432b142

data/app/controllers/concerns/foreman/controller/parameters/compute_resource_extension.rb

@@ -7,7 +7,7 @@ module Foreman
         class_methods do
           def compute_resource_params_filter
             super.tap do |filter|
-              filter.permit :key_path, :zone
+              filter.permit :key_content, :zone
             end
           end
         end

data/app/controllers/foreman_google/api/v2/apipie_extensions.rb

@@ -6,7 +6,7 @@ module ForemanGoogle
 
         update_api(:create, :update) do
           param :compute_resource, Hash do
-            param :key_path, String, desc: N_('Certificate path, for GCE only')
+            param :key_content, String, desc: N_('Certificate JSON content, for GCE only')
             param :zone, String, desc: N_('Zone, for GCE only')
             param :project, String, desc: N_('Deprecated, project is automatically loaded from the JSON file. For GCE only')
             param :email, String, desc: N_('Deprecated, email is automatically loaded from the JSON file. For GCE only')

data/app/controllers/foreman_google/api/v2/compute_resources_extensions.rb

@@ -6,16 +6,30 @@ module ForemanGoogle
 
         # rubocop:disable Rails/LexicallyScopedActionFilter
         included do
-          before_action :read_key, only: [:create]
-          before_action :deprecated_params, only: [:create]
+          filter_parameters lambda { |key, value|
+            value.replace('[FILTERED]') if key == 'key_content'
+          }
+          before_action :read_key, only: %i[create update]
+          before_action :deprecated_params, only: %i[create update]
         end
         # rubocop:enable Rails/LexicallyScopedActionFilter
 
         private
 
         def read_key
-          return unless compute_resource_params['provider'] == 'GCE'
-          params[:compute_resource][:password] = File.read(params['compute_resource'].delete('key_path'))
+          return unless gce_provider?
+
+          key_content = extract_key_content
+          params[:compute_resource][:password] = key_content if key_content.present?
+        end
+
+        def gce_provider?
+          provider = action_name == 'create' ? params[:compute_resource][:provider] : @compute_resource&.provider
+          provider == 'GCE'
+        end
+
+        def extract_key_content
+          params[:compute_resource].delete(:key_content)
         end
 
         def deprecated_params

data/lib/foreman_google/engine.rb

@@ -16,6 +16,10 @@ module ForemanGoogle
       end
     end
 
+    initializer 'foreman_google.filter_parameters' do |app|
+      app.config.filter_parameters << 'key_content'
+    end
+
     initializer 'foreman_google.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_google do
         requires_foreman '>= 5.1'
@@ -31,10 +35,11 @@ module ForemanGoogle
     # Include concerns in this config.to_prepare block
     config.to_prepare do
       ::Host::Managed.include ForemanGoogle::HostManagedExtensions
+      ::Api::V2::ComputeResourcesController.include Foreman::Controller::FilterParameters
       ::Api::V2::ComputeResourcesController.include ForemanGoogle::Api::V2::ComputeResourcesExtensions
       ::Api::V2::ComputeResourcesController.include ForemanGoogle::Api::V2::ApipieExtensions
-      ::Api::V2::ComputeResourcesController.include Foreman::Controller::Parameters::ComputeResourceExtension
-      ::ComputeResourcesController.include Foreman::Controller::Parameters::ComputeResourceExtension
+      ::Api::V2::ComputeResourcesController.prepend Foreman::Controller::Parameters::ComputeResourceExtension
+      ::ComputeResourcesController.prepend Foreman::Controller::Parameters::ComputeResourceExtension
       Google::Cloud::Compute::V1::AttachedDisk.include GoogleExtensions::AttachedDisk
     rescue StandardError => e
       Rails.logger.warn "ForemanGoogle: skipping engine hook (#{e})"

data/lib/foreman_google/version.rb

@@ -1,3 +1,3 @@
 module ForemanGoogle
-  VERSION = '3.1.1'.freeze
+  VERSION = '3.2.0'.freeze
 end

data/test/controllers/foreman_google/api/v2/compute_resources_extensions_test.rb

@@ -13,14 +13,14 @@ module ForemanGoogle
           it 'permits Google compute resource parameters' do
             context = ::Api::V2::ComputeResourcesController.parameter_filter_context
             params = ActionController::Parameters.new(
-              compute_resource: { key_path: '/tmp/key.json', zone: 'us-east1-b' }
+              compute_resource: { key_content: '{"type":"service_account"}', zone: 'us-east1-b' }
             )
 
             filtered = ::Api::V2::ComputeResourcesController
                        .compute_resource_params_filter
                        .filter_params(params, context)
 
-            assert_equal({ 'key_path' => '/tmp/key.json', 'zone' => 'us-east1-b' }, filtered.to_h)
+            assert_equal({ 'key_content' => '{"type":"service_account"}', 'zone' => 'us-east1-b' }, filtered.to_h)
           end
         end
 
@@ -29,9 +29,13 @@ module ForemanGoogle
             def self.before_action(*)
             end
 
+            def self.filter_parameters(*)
+              # Stub for parameter filtering in tests
+            end
+
             include ForemanGoogle::Api::V2::ComputeResourcesExtensions
 
-            attr_accessor :params
+            attr_accessor :params, :action_name, :compute_resource
 
             def compute_resource_params
               params[:compute_resource]
@@ -40,29 +44,40 @@ module ForemanGoogle
         end
 
         describe '#read_key' do
-          it 'reads key file content into password for GCE provider' do
+          it 'copies key_content into password for GCE provider on create' do
             key_content = '{"type": "service_account", "project_id": "test"}'
+            ctrl = controller_class.new
+            ctrl.action_name = 'create'
+            ctrl.params = { 'compute_resource' => { 'provider' => 'GCE', 'key_content' => key_content } }.with_indifferent_access
+            ctrl.send(:read_key)
 
-            Tempfile.open('gce_key') do |f|
-              f.write(key_content)
-              f.flush
+            assert_equal key_content, ctrl.params[:compute_resource][:password]
+            assert_not ctrl.params[:compute_resource].key?('key_content')
+          end
 
-              ctrl = controller_class.new
-              ctrl.params = { 'compute_resource' => { 'provider' => 'GCE', 'key_path' => f.path } }.with_indifferent_access
-              ctrl.send(:read_key)
+          it 'copies key_content into password for GCE provider on update' do
+            key_content = '{"type": "service_account", "project_id": "test"}'
+            ctrl = controller_class.new
+            ctrl.action_name = 'update'
+            compute_resource = mock('compute_resource')
+            compute_resource.stubs(:provider).returns('GCE')
+            ctrl.instance_variable_set(:@compute_resource, compute_resource)
+            ctrl.params = { 'compute_resource' => { 'key_content' => key_content } }.with_indifferent_access
+            ctrl.send(:read_key)
 
-              assert_equal key_content, ctrl.params[:compute_resource][:password]
-              assert_not ctrl.params[:compute_resource].key?('key_path')
-            end
+            assert_equal key_content, ctrl.params[:compute_resource][:password]
+            assert_not ctrl.params[:compute_resource].key?('key_content')
           end
 
           it 'skips when provider is not GCE' do
+            key_content = '{"type": "service_account", "project_id": "test"}'
             ctrl = controller_class.new
-            ctrl.params = { 'compute_resource' => { 'provider' => 'EC2', 'key_path' => '/nonexistent' } }.with_indifferent_access
+            ctrl.action_name = 'create'
+            ctrl.params = { 'compute_resource' => { 'provider' => 'EC2', 'key_content' => key_content } }.with_indifferent_access
             ctrl.send(:read_key)
 
             assert_nil ctrl.params[:compute_resource][:password]
-            assert_equal '/nonexistent', ctrl.params[:compute_resource]['key_path']
+            assert_equal key_content, ctrl.params[:compute_resource]['key_content']
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreman_google
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - The Foreman Team