foreman_chef 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57d753bf6cad20e4c8f3f0e42d4cb54c2ea512e2
-  data.tar.gz: 7e475417097bdde646e155490805d0aa7ea3a944
+  metadata.gz: bed7f43a8fda06fdc85e6e6d2e6059dad4a0b3e2
+  data.tar.gz: 01c9bc5cd705a62dc4ec7ce017b40446c5ee5974
 SHA512:
-  metadata.gz: 3e320c37bb73d8cbee67781de5ee4eef0d17d21812c5600fb5de76402f6cb891ca906d7c0b1080182d5d848477904689e99dd8149ee5cc00d470072f12abc0f0
-  data.tar.gz: 10665df2e4facabc26657275d43da9c530f8df3d8cc541acba54a639cd02b81bc7147b163f68c7dc3701e0a18607fbfb37fcb40c3456e71ae00f04eeb6a769e2
+  metadata.gz: 59b5c3e2e49bcf6b1e86902995fc14b5ca152f541c84f4f82e7d2529c6c65a9315fad4a59e1f94717f5eb4dfff68fae4aedde4fb0779a408ab0f0b9adf084f0e
+  data.tar.gz: b3f03e1b028a868bb6ea788b9e59dcf89e592b70632736381da589057242617c3e2cae98c4fde8ba5fe22aaf289fbf96c9d9d186cc98e370bba655de93e657dd

data/app/helpers/foreman_chef/chef_proxy_form.rb

@@ -12,11 +12,16 @@ module ForemanChef
     end
 
     def chef_proxy_form_chef_environment_select(f, environments)
-      if f.object.is_a?(Host::Base) &&f.object.persisted? && f.object.chef_environment_differs?
-        help = content_tag(:span, ' ', :class => 'pficon pficon-warning-triangle-o') + ' ' + _('Chef environment is set to %s on Chef server, submitting will override it') % f.object.fresh_chef_environment
+      begin
+        if f.object.is_a?(Host::Base) && f.object.persisted? && f.object.chef_environment_differs?
+          help = content_tag(:span, ' ', :class => 'pficon pficon-warning-triangle-o') + ' ' + _('Chef environment is set to %s on Chef server, submitting will override it') % f.object.fresh_chef_environment
+          help = help.html_safe
+        else
+          help = nil
+        end
+      rescue => e # chef server communication issue
+        help = content_tag(:span, ' ', :class => 'pficon pficon-warning-triangle-o') + ' ' + _('Unable to communicate with Chef server - %s.') % e.message
         help = help.html_safe
-      else
-        help = nil
       end
 
       select_f(f, :chef_environment_id, environments, :id, :name,
@@ -35,8 +40,12 @@ module ForemanChef
     def chef_tab_menu(host)
       if SmartProxy.with_features("Chef").count > 0
         warning = ''
-        if chef_run_list_differs?(host)
-          warning = content_tag(:span, ' '.html_safe, :class => "pficon pficon-warning-triangle-o")
+        begin
+          if chef_run_list_differs?(host)
+            warning = chef_warning_icon
+          end
+        rescue => e
+          warning = chef_warning_icon
         end
         content_tag :li do
           link_to(warning + _('Chef'), '#chef', :data => { :toggle => 'tab'})
@@ -44,6 +53,10 @@ module ForemanChef
       end
     end
 
+    def chef_warning_icon
+      content_tag(:span, ' '.html_safe, :class => "pficon pficon-warning-triangle-o")
+    end
+
     def chef_tab_content(f)
       render 'foreman_chef/hosts/chef_tab', :f => f
     end

data/app/lib/actions/foreman_chef/client/create.rb

@@ -13,13 +13,12 @@ module Actions
             plan_self :chef_proxy_id => proxy.id, :name => name
           end
         rescue => e
-          Rails.logger.debug "Unable to communicate with Chef proxy, #{e.message}"
-          Rails.logger.debug e.backtrace.join("\n")
+          ::Foreman::Logging.exception("Unable to communicate with Chef proxy", e)
           raise ::ForemanChef::ProxyException.new(N_('CLIENT Unable to communicate with Chef proxy, %s' % e.message))
         end
 
         def run
-          proxy = ::SmartProxy.find_by_id(input[:chef_proxy_id])
+          proxy = ::SmartProxy.unscoped.find_by_id(input[:chef_proxy_id])
           action_logger.debug "Creating client #{input[:name]} on proxy #{proxy.name} at #{proxy.url}"
           self.output = proxy.create_client(input[:name])
         end

data/app/lib/actions/foreman_chef/client/destroy.rb

@@ -4,19 +4,19 @@ module Actions
       class Destroy < Actions::EntryAction
 
         def plan(fqdn, proxy)
-          if ::Setting::ForemanChef.auto_deletion && proxy.present?
+          if ::Setting[:auto_deletion] && proxy.present?
             client_exists_in_chef = proxy.show_client(fqdn)
             if client_exists_in_chef
               plan_self :chef_proxy_id => proxy.id, :fqdn => fqdn
             end
           end
         rescue => e
-          ::Foreman::Logging.exception('Unable to communicate with Chef proxy', e, :logger => 'foreman_chef')
+          ::Foreman::Logging.exception('Unable to communicate with Chef proxy', e)
           raise ::ForemanChef::ProxyException.new(N_('Unable to communicate with Chef proxy, %s' % e.message))
         end
 
         def run
-          proxy = ::SmartProxy.find_by_id(input[:chef_proxy_id])
+          proxy = ::SmartProxy.unscoped.find_by_id(input[:chef_proxy_id])
           action_logger.debug "Deleting client #{input[:fqdn]} on proxy #{proxy.name} at #{proxy.url}"
           self.output = proxy.delete_client(input[:fqdn])
         end

data/app/lib/actions/foreman_chef/host/destroy.rb

@@ -11,7 +11,7 @@ module Actions
 
         def plan(host)
           action_subject(host)
-          if (::Setting::ForemanChef.auto_deletion && proxy = host.chef_proxy)
+          if (::Setting[:auto_deletion] && proxy = host.chef_proxy)
             node_exists_in_chef = proxy.show_node(host.name)
             if node_exists_in_chef
               plan_self :chef_proxy_id => host.chef_proxy_id
@@ -20,12 +20,12 @@ module Actions
             plan_action Actions::ForemanChef::Client::Destroy, host.name, proxy
           end
         rescue => e
-          ::Foreman::Logging.exception('Unable to communicate with Chef proxy', e, :logger => 'foreman_chef')
+          ::Foreman::Logging.exception('Unable to communicate with Chef proxy', e)
           raise ::ForemanChef::ProxyException.new(N_('Unable to communicate with Chef proxy, %s' % e.message))
         end
 
         def run
-          proxy = ::SmartProxy.find_by_id(input[:chef_proxy_id])
+          proxy = ::SmartProxy.unscoped.find_by_id(input[:chef_proxy_id])
           action_logger.debug "Deleting #{input[:host][:name]} on proxy #{proxy.name} at #{proxy.url}"
           self.output = proxy.delete_node(input[:host][:name])
         end

data/app/lib/actions/foreman_chef/host/update.rb

@@ -18,10 +18,7 @@ module Actions
             end
           end
         rescue => e
-          Rails.logger.debug "Unable to communicate with Chef proxy, #{e.message}"
-          Rails.logger.debug e.backtrace.join("\n")
-          raise ::ForemanChef::ProxyException.new(N_('Unable to communicate with Chef proxy, %s' % e.message))
-          # TODO these errors causing form not to display anything and double traces, we need reraise
+          ::Foreman::Logging.exception("Unable to communicate with Chef proxy", e)
         end
 
         def humanized_name

data/app/lib/actions/foreman_chef/node/update.rb

@@ -19,14 +19,13 @@ module Actions
             raise ::ForemanChef::ObjectDoesNotExistException.new(N_('Node with name %s does not exist on this Chef proxy' % name))
           end
         rescue => e
-          Rails.logger.debug "Unable to communicate with Chef proxy, #{e.message}"
-          Rails.logger.debug e.backtrace.join("\n")
+          ::Foreman::Logging.exception("Unable to communicate with Chef proxy", e)
           raise ::ForemanChef::ProxyException.new(N_('Unable to communicate with Chef proxy, %s' % e.message))
         end
 
         def run
-          proxy = ::SmartProxy.find_by_id(input[:chef_proxy_id])
-          host = ::Host.find(input[:host_id])
+          proxy = ::SmartProxy.unscoped.find_by_id(input[:chef_proxy_id])
+          host = ::Host.unscoped.find(input[:host_id])
           action_logger.debug "Updating node #{input[:name]} on proxy #{proxy.name} at #{proxy.url}"
           proxy.update_node(host.name, host.run_list.as_chef_json.merge(:chef_environment => host.chef_environment.name))
         end

data/app/models/foreman_chef/concerns/host_action_subject.rb

@@ -5,11 +5,6 @@ module ForemanChef
       include ForemanTasks::Concerns::ActionSubject
       include ForemanTasks::Concerns::ActionTriggering
 
-      def create_action
-        sync_action!
-        ::Actions::ForemanChef::Host::Create
-      end
-
       def update_action
         sync_action!
         ::Actions::ForemanChef::Host::Update

data/app/models/foreman_chef/concerns/host_build.rb

@@ -13,7 +13,7 @@ module ForemanChef
           # private key is no longer valid
           host.chef_private_key = nil
 
-          if !::Setting.validation_bootstrap_method
+          if !::Setting[:validation_bootstrap_method]
             new_client = ::ForemanTasks.sync_task ::Actions::ForemanChef::Client::Create, host.name, host.chef_proxy
             host.chef_private_key = new_client.output[:private_key]
           end
@@ -27,7 +27,7 @@ module ForemanChef
         # private key is no longer valid
         self.chef_private_key = nil
 
-        if !::Setting.validation_bootstrap_method
+        if !::Setting[:validation_bootstrap_method]
           new_client = ::ForemanTasks.sync_task ::Actions::ForemanChef::Client::Create, self.name, self.chef_proxy
           self.chef_private_key = new_client.output[:private_key]
         end

data/app/models/foreman_chef/concerns/renderer.rb

@@ -11,7 +11,7 @@ module ForemanChef
       end
 
       def validation_bootstrap_method?
-        ::Setting.validation_bootstrap_method
+        ::Setting[:validation_bootstrap_method]
       end
     end
   end

data/app/models/foreman_chef/environment.rb

@@ -7,9 +7,9 @@ module ForemanChef
 
     has_many :hosts, :class_name => '::Host::Managed'
     has_many :hostgroups, :class_name => '::Hostgroup'
-    belongs_to :chef_proxy, :class_name => '::SmartProxy'
+    belongs_to :chef_proxy,  -> { unscope(:where) }, :class_name => '::SmartProxy'
 
-    validates :name, :uniqueness => true, :presence => true, :format => { :with => /\A[\w\d\.]+\z/, :message => N_('is alphanumeric and cannot contain spaces') }
+    validates :name, :uniqueness => true, :presence => true, :format => { :with => /\A[-_\w\d]+\Z/, :message => N_('must be alphanumeric with dashes and hyphens and cannot contain spaces') }
 
     scoped_search :on => :name, :complete_value => true
     scoped_search :in => :hostgroups, :on => :name, :complete_value => true, :rename => :hostgroup

data/app/views/foreman/unattended/snippets/_chef_client_bootstrap.erb

@@ -5,7 +5,7 @@ mkdir /etc/chef
   chmod 600 /etc/chef/validation.pem
 
   cat << 'EOF' > /etc/chef/validation.pem
-<%= @host.params['chef_validation_private_key'] %>
+<%= host_param('chef_validation_private_key') %>
 EOF
 <% else -%>
   echo "Creating client.pem"
@@ -18,7 +18,7 @@ EOF
 <% end -%>
 
 ## If chef_server_certificate is present, install it into /etc/chef/trusted_certs
-<% chef_server_certificate = @host.params['chef_server_certificate'] -%>
+<% chef_server_certificate = host_param('chef_server_certificate') -%>
 <% if !chef_server_certificate.nil? && !chef_server_certificate.empty? -%>
 mkdir -p /etc/chef/trusted_certs
 chmod 0755 /etc/chef/trusted_certs
@@ -31,14 +31,14 @@ echo "Configuring chef client.rb"
 cat << 'EOF' > /etc/chef/client.rb
 log_level        :info
 log_location     STDOUT
-chef_server_url  "<%= @host.params['chef_server_url'] %>"
-validation_client_name "<%= @host.params['chef_validator_name'] -%>"
+chef_server_url  "<%= host_param('chef_server_url') %>"
+validation_client_name "<%= host_param('chef_validator_name') -%>"
 file_backup_path   "/var/lib/chef"
 file_cache_path    "/var/cache/chef"
 pid_file           "/var/run/chef/client.pid"
 
 require 'chef_handler_foreman'
-foreman_server_options  :url => "<%= @host.params['chef_handler_foreman_url'] %>"
+foreman_server_options  :url => "<%= host_param('chef_handler_foreman_url') %>"
 foreman_facts_upload    true
 foreman_reports_upload  true
 foreman_enc             true

data/app/views/foreman/unattended/snippets/_chef_client_gem_bootstrap.erb

@@ -1,4 +1,5 @@
 echo "Installing chef and chef_handler_foreman"
-gem install chef chef_handler_foreman
+gem install chef <%= host_param('chef_bootstrap_version') ? '-v ' + host_param('chef_bootstrap_version') : '' %>
+gem install chef_handler_foreman
 
 <%= snippet 'chef-client bootstrap' %>

data/app/views/foreman/unattended/snippets/_chef_client_omnibus_bootstrap.erb

@@ -3,11 +3,12 @@
 apt-get -y install ca-certificates
 <% end -%>
 
-# install.sh will install latest chef client version
+# run install.sh with specific version if set
+<% version = host_param('chef_bootstrap_version') ? '-v ' + host_param('chef_bootstrap_version') : '' -%>
 if [ -f /usr/bin/curl ]; then
-  curl -L https://www.chef.io/chef/install.sh | bash
+  curl -L https://www.chef.io/chef/install.sh | bash -s -- <%= version %>
 else
-  wget https://www.chef.io/chef/install.sh -O- | bash
+  wget https://www.chef.io/chef/install.sh -O- | bash -s -- <%= version %>
 fi
 
 # if you want specific version you can use something like this instead of install.sh

data/app/views/foreman_chef/hosts/_chef_tab.html.erb

@@ -2,13 +2,24 @@
 
 <div class="tab-pane" id="chef">
 
-  <% if chef_run_list_differs?(f.object) %>
+  <% communication_error = nil
+  begin
+    differs = chef_run_list_differs?(f.object)
+  rescue => e
+    communication_problem = e
+  end -%>
+  <% if differs %>
     <%= alert(:class => 'alert-warning', :header => 'Warning',
               :text => _('Run list on chef server differs, by submitting the form, you will override the run list there. ').html_safe +
                   link_to(_('Reset'), '#', :class => 'refresh_run_list', :'data-run-list' => (f.object.fresh_run_list.try(:to_form_json) || '[]')) +
                   _(' to run list from chef-server').html_safe) %>
   <% end %>
 
+  <% if communication_problem %>
+    <%= alert(:class => 'alert-warning', :header => 'Warning',
+                         :text => (_('Unable to fetch data from Chef server - %s. Any changes to environment or runlist will not be persisted in Chef server. To fix it, save the host again when communication with Chef server is restored.') % e.message).html_safe) %>
+  <% end %>
+
   <div id="runlist-editor" data-default="<%= f.object.run_list.to_form_json %>">
 
   </div>

data/app/views/job_templates/run_chefclient_once.erb

@@ -0,0 +1,25 @@
+<%#
+name: Run chef-client once
+job_category: Chef
+description_format: "%{template_name}"
+snippet: false
+template_inputs:
+- name: log-level
+  required: true
+  input_type: user
+  description: Set the log level (auto, debug, info, warn, error, fatal)
+  options: "auto\r\ndebug\r\ninfo\r\nwarn\r\nerror\r\nfatal"
+  advanced: true
+- name: why-run
+  required: true
+  input_type: user
+  description: Enable whyrun mode
+  options: "no\r\nyes"
+  advanced: true
+provider_type: SSH
+kind: job_template
+%>
+
+chef-client --once \
+<%= ' --why-run' if input('why-run') == 'yes' -%>
+<%= " --log_level #{input('log-level')}" if input('log-level') && input('log-level') != 'auto' -%>

data/app/views/job_templates/run_chefclient_wrapper.erb

@@ -0,0 +1,10 @@
+<%#
+name: Run chef-client wrapper
+job_category: Chef
+description_format: Run chef-client once
+snippet: false
+provider_type: SSH
+kind: job_template
+%>
+
+<%= render_template 'Run chef-client once', :log_level => 'auto', :why_run => 'no' %>

data/db/seeds.rb

@@ -14,9 +14,25 @@ templates.each do |template|
   ProvisioningTemplate.where(:name => template[:name]).first_or_create.update_attributes(defaults.merge(template))
 end
 
+if ForemanChef.with_remote_execution?
+  User.as_anonymous_admin do
+    JobTemplate.without_auditing do
+      Dir[File.join("#{ForemanChef::Engine.root}/app/views/job_templates/**/*.erb")].each do |template|
+        sync = !Rails.env.test? && Setting[:remote_execution_sync_templates]
+        # import! was renamed to import_raw! around 1.3.1
+        if JobTemplate.respond_to?('import_raw!')
+          JobTemplate.import_raw!(File.read(template), :default => true, :locked => true, :update => sync)
+        else
+          JobTemplate.import!(File.read(template), :default => true, :locked => true, :update => sync)
+        end
+      end
+    end
+  end
+end
+
 # Global parameters used in configuration snippets
 parameters = [
-  { :name => 'chef_handler_foreman_url', :value => SmartProxy.with_features('Chef').first.try(:url) || Setting.foreman_url },
+  { :name => 'chef_handler_foreman_url', :value => SmartProxy.with_features('Chef').first.try(:url) || Setting[:foreman_url] },
   { :name => 'chef_server_url', :value => "https://#{Socket.gethostbyname(Socket.gethostname).first}" },
   { :name => 'chef_validation_private_key', :value => 'UNSPECIFIED, you must upload your validation key here' },
   { :name => 'chef_bootstrap_template', :value => 'chef-client omnibus bootstrap' },

data/lib/foreman_chef/engine.rb

@@ -47,7 +47,7 @@ module ForemanChef
 
     initializer 'foreman_chef.register_plugin', :before => :finisher_hook do |app|
       Foreman::Plugin.register :foreman_chef do
-        requires_foreman '>= 1.14'
+        requires_foreman '>= 1.15'
         extend_template_helpers ForemanChef::Concerns::Renderer
 
         permission :import_chef_environments, { :environments => [:import, :synchronize] }, :resource_type => 'ForemanChef::Environment'
@@ -65,6 +65,10 @@ module ForemanChef
         parameter_filter ForemanChef::CachedRunList, :type, :name
         parameter_filter Host::Managed, :chef_private_key, :chef_proxy_id, :override_chef_attributes, :chef_environment_id, :run_list => [ parameter_filters(ForemanChef::CachedRunList) ]
         parameter_filter Hostgroup, :chef_proxy_id, :chef_environment_id
+
+        if ForemanChef.with_remote_execution? && Gem::Version.new(ForemanRemoteExecution::VERSION) >= Gem::Version.new('1.2.3')
+          RemoteExecutionFeature.register(:foreman_chef_run_chef_client, N_("Run chef-client Once"), :description => N_("Run chef-client once"), :host_action_button => true)
+        end
       end
     end
 
@@ -102,4 +106,9 @@ module ForemanChef
   def use_relative_model_naming
     true
   end
+
+  # check whether foreman_remote_execution to integrate is available in the system
+  def self.with_remote_execution?
+    (RemoteExecutionFeature rescue false) ? true : false
+  end
 end

data/lib/foreman_chef/version.rb

@@ -1,3 +1,3 @@
 module ForemanChef
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_chef
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Marek Hulan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-02 00:00:00.000000000 Z
+date: 2017-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -74,7 +74,6 @@ files:
 - app/helpers/foreman_chef/chef_proxy_form.rb
 - app/lib/actions/foreman_chef/client/create.rb
 - app/lib/actions/foreman_chef/client/destroy.rb
-- app/lib/actions/foreman_chef/host/create.rb
 - app/lib/actions/foreman_chef/host/destroy.rb
 - app/lib/actions/foreman_chef/host/update.rb
 - app/lib/actions/foreman_chef/node/update.rb
@@ -109,6 +108,8 @@ files:
 - app/views/foreman_chef/environments/index.html.erb
 - app/views/foreman_chef/environments/new.html.erb
 - app/views/foreman_chef/hosts/_chef_tab.html.erb
+- app/views/job_templates/run_chefclient_once.erb
+- app/views/job_templates/run_chefclient_wrapper.erb
 - config/routes.rb
 - db/migrate/20140220145827_add_chef_proxy_id_to_host.rb
 - db/migrate/20140513144804_add_chef_proxy_id_to_hostgroup.rb
@@ -139,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Plugin for Chef integration with Foreman

data/app/lib/actions/foreman_chef/host/create.rb

@@ -1,53 +0,0 @@
-module Actions
-  module ForemanChef
-    module Host
-      class Create < Actions::EntryAction
-
-        def resource_locks
-          :link
-        end
-
-        def plan(host)
-          action_subject(host)
-
-          if host.chef_proxy
-            client_exists_in_chef = host.chef_proxy.show_client(host.name)
-
-            sequence do
-              if client_exists_in_chef
-                plan_action Actions::ForemanChef::Client::Destroy, host.name, host.chef_proxy
-              end
-
-              unless ::Setting::ForemanChef.validate_bootstrap_method
-                client_creation = plan_action Actions::ForemanChef::Client::Create, host.name, host.chef_proxy
-              end
-
-              plan_self(:create_action_output => client_creation.output)
-            end
-          end
-        rescue => e
-          Rails.logger.debug "Unable to communicate with Chef proxy, #{e.message}"
-          Rails.logger.debug e.backtrace.join("\n")
-          raise ::ForemanChef::ProxyException.new(N_('Unable to communicate with Chef proxy, %s' % e.message))
-        end
-
-        def finalize
-          if input[:create_action_output][:private_key].present? && !Setting.validation_bootstrap_method
-            host = ::Host.find(self.input[:host][:id])
-            host.chef_private_key = input[:create_action_output][:private_key]
-            host.disable_dynflow_hooks { |h| h.save! }
-          end
-        end
-
-        def humanized_name
-          _("Create host")
-        end
-
-        def humanized_input
-          input[:host][:name]
-        end
-      end
-    end
-  end
-end
-