foreman_chef 0.4.0 → 0.4.1

data/app/controllers/foreman_chef/concerns/hosts_controller_rescuer.rb

@@ -5,10 +5,20 @@ module ForemanChef
 
       included do
         rescue_from ForemanChef::ProxyException, :with => :chef_exception
+        # this route is only allowed to puppet proxies so we need to allow it for chef proxies too
+        alias_method_chain :require_smart_proxy_or_login, :chef
       end
 
       private
 
+      def require_smart_proxy_or_login_with_chef(features = nil)
+        if params[:action] == 'externalNodes' && features.kind_of?(Array) && features.include?('Puppet')
+          require_smart_proxy_or_login_without_chef(features + [ 'Chef' ])
+        else
+          require_smart_proxy_or_login_without_chef(features)
+        end
+      end
+
       def chef_exception(exception)
         flash[:error] = _(exception.message)
         redirect_to :back

data/app/helpers/foreman_chef/chef_proxy_form.rb

@@ -12,9 +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
+        help = help.html_safe
+      else
+        help = nil
+      end
+
       select_f(f, :chef_environment_id, environments, :id, :name,
                {:include_blank => blank_or_inherit_f(f, :chef_environment_id)},
-               {:label => _("Chef environment")})
+               {:label => _("Chef environment"), :help_inline => help })
     end
 
     def chef_proxy_form_chef_proxy_select(f, proxies)
@@ -24,5 +31,17 @@ module ForemanChef
                  :help_inline => _("Use this foreman proxy as an entry point to your Chef, node will be managed via this proxy"),
                  :data => { :url => environments_for_chef_proxy_foreman_chef_environments_path } })
     end
+
+    def chef_tab_menu
+      if SmartProxy.with_features("Chef").count > 0
+        content_tag :li do
+          '<a href="#chef" data-toggle="tab">Chef</a>'.html_safe
+        end
+      end
+    end
+
+    def chef_tab_content(f)
+      render 'foreman_chef/hosts/chef_tab', :f => f
+    end
   end
 end

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

@@ -3,6 +3,10 @@ module Actions
     module Host
       class Create < Actions::EntryAction
 
+        def resource_locks
+          :link
+        end
+
         def plan(host)
           action_subject(host)
 
@@ -27,18 +31,16 @@ module Actions
           raise ::ForemanChef::ProxyException.new(N_('Unable to communicate with Chef proxy, %s' % e.message))
         end
 
-        # def run
-        #   # TODO create node with runlist?
-        # end
-
         def finalize
-          if input[:create_action_output][:private_key].present?
-            ::Host.find(self.input[:host][:id]).update_attribute(:chef_private_key, input[:create_action_output][:private_key])
+          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 node")
+          _("Create host")
         end
 
         def humanized_input

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

@@ -5,6 +5,10 @@ module Actions
     module Host
       class Destroy < Actions::EntryAction
 
+        def resource_locks
+          :link
+        end
+
         def plan(host)
           action_subject(host)
           if (::Setting::ForemanChef.auto_deletion && proxy = host.chef_proxy)

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

@@ -0,0 +1,38 @@
+module Actions
+  module ForemanChef
+    module Host
+      class Update < Actions::EntryAction
+
+        def resource_locks
+          :link
+        end
+
+        def plan(host)
+          action_subject(host)
+
+          if host.chef_proxy
+            node_exists_in_chef = host.chef_proxy.show_node(host.name)
+
+            if node_exists_in_chef && host.override_chef_attributes
+              plan_action Actions::ForemanChef::Node::Update, host, host.chef_proxy
+            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
+        end
+
+        def humanized_name
+          _("Update host")
+        end
+
+        def humanized_input
+          input[:host][:name]
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,43 @@
+module Actions
+  module ForemanChef
+    module Node
+      class Update < Actions::EntryAction
+
+        def plan(host, proxy)
+          name = host.name
+          node_exists_in_chef = proxy.show_node(name)
+          if node_exists_in_chef
+            # we can't use host.run_list.list_changed? or similar since it's after_save already
+            if host.differs?
+              plan_self :chef_proxy_id => proxy.id, :host_id => host.id
+            else
+              Rails.logger.debug "Host data do not differ from corresponding Chef server Node, skipping update"
+            end
+          else
+            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")
+          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])
+          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
+
+        def humanized_name
+          _("Update node")
+        end
+
+        def humanized_input
+          input[:name]
+        end
+      end
+    end
+  end
+end
+

data/app/lib/proxy_api/foreman_chef/chef_proxy.rb

@@ -30,11 +30,19 @@ module ProxyAPI
 
       # Shows a Chef Node entry
       # [+key+] : String containing the hostname
-      # Returns : Hash representation of host on chef server
+      # Returns : Hash representation of node on chef server
       def show_node(key)
         Node.new(@args).send(:get, key)
       end
 
+      # Updates a Chef Node entry
+      # [+key+] : String containing the hostname
+      # [+attributes+] : Hash containing attributes
+      # Returns : Hash representation of node on chef server
+      def update_node(key, attributes)
+        Node.new(@args).send(:put, { :node => attributes }, key )
+      end
+
       # Deletes a Chef Node entry
       # [+key+] : String containing the hostname
       # Returns : Boolean status

data/app/models/foreman_chef/cached_run_list.rb

@@ -0,0 +1,84 @@
+module ForemanChef
+  class CachedRunList < ActiveRecord::Base
+    serialize :list
+
+    belongs_to_host
+
+    class Jail < Safemode::Jail
+      allow :to_chef_json, :as_chef_json
+    end
+
+    def self.parse(run_list_data, run_list_object = nil)
+      data = parse_data(run_list_data)
+
+      if run_list_object.nil?
+        cached_run_list = new(:list => data)
+      else
+        cached_run_list = run_list_object.clone
+        cached_run_list.list = data
+      end
+
+      cached_run_list
+    end
+
+    # return data in format ready for serialization
+    # which means Hash like this
+    # { :run_list => [ 'role[default]', 'recipe[foreman]' ] }
+    def self.parse_data(run_list_data)
+      case run_list_data
+        when Array
+          parse_array(run_list_data)
+        when Hash
+          run_list_data = run_list_data.with_indifferent_access
+          if run_list_data.has_key?(:run_list)
+            parse_array(run_list_data.with_indifferent_access[:run_list])
+          else
+            # from form we get {'0' => { 'name' => ...}, '1' => {...}}
+            parse_array(run_list_data.values)
+          end
+        else
+          raise ArgumentError, 'unsupported run_list_data format'
+      end
+    end
+    
+    def self.parse_array(run_list_array)
+      raise ArgumentError, "run_list is #{run_list_array.class}, expected Array" unless run_list_array.is_a?(Array)
+
+      if run_list_array.first.is_a?(Hash)
+        run_list_array.map { |item| item_to_chef(item) }
+      elsif run_list_array.first.is_a?(String) or run_list_array.empty?
+        run_list_array
+      else
+        raise ArgumentError, "run_list_array Array contains unknown data format of class #{run_list_array.class}"
+      end
+    end
+
+    # converts 'role[default]' to { :type => 'role', :name => 'default' }
+    def self.item_to_form(item)
+      type, name = item.split('[')
+      { :type => type, :name => name.chop! }
+    end
+
+    # converts { :type => 'role', :name => 'default' } to 'role[default]'
+    def self.item_to_chef(item)
+      item = item.with_indifferent_access
+      "#{item[:type]}[#{item[:name]}]"
+    end
+
+    def as_chef_json
+      { :run_list => self.list }
+    end
+
+    def to_chef_json
+      as_chef_json.to_json
+    end
+
+    def as_form_json
+      list.map { |item| self.class.item_to_form(item) }
+    end
+
+    def to_form_json
+      as_form_json.to_json
+    end
+  end
+end

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

@@ -10,6 +10,11 @@ module ForemanChef
         ::Actions::ForemanChef::Host::Create
       end
 
+      def update_action
+        sync_action!
+        ::Actions::ForemanChef::Host::Update
+      end
+
       def destroy_action
         sync_action!
         ::Actions::ForemanChef::Host::Destroy

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

@@ -6,7 +6,18 @@ module ForemanChef
         include ForemanTasks::Concerns::ActionSubject
         include ForemanTasks::Concerns::ActionTriggering
 
-        after_build :plan_destroy_action
+        after_build do |host|
+          ::ForemanTasks.sync_task ::Actions::ForemanChef::Client::Destroy, host.name, host.chef_proxy
+          # private key is no longer valid
+          host.chef_private_key = nil
+
+          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
+
+          host.disable_dynflow_hooks { |h| h.save! }
+        end
       end
 
     end

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

@@ -3,15 +3,79 @@ module ForemanChef
     module HostExtensions
       extend ActiveSupport::Concern
 
+      DEFAULT = ['role[default]']
+
       included do
-        alias_method_chain :set_hostgroup_defaults, :chef_attributes
+        alias_method_chain :inherited_attributes, :chef_attributes
+
+        # even with autosave, save is called only if there's some change in attributes
+        has_one :cached_run_list, :autosave => true, :class_name => 'ForemanChef::CachedRunList', :foreign_key => :host_id
+        attr_accessor :override_chef_attributes
+      end
+
+      def run_list
+        self.cached_run_list || ForemanChef::CachedRunList.parse(DEFAULT, self.build_cached_run_list)
       end
 
-      def set_hostgroup_defaults_with_chef_attributes
-        set_hostgroup_defaults_without_chef_attributes
-        return unless hostgroup
-        assign_hostgroup_attributes(['chef_proxy_id', 'chef_environment_id'])
+      def run_list=(run_list)
+        # returns CachedRunList instance, if there was one for host, return that one with modified attributes
+        @run_list = ForemanChef::CachedRunList.parse(run_list, self.cached_run_list)
+        # this ensures that host#save will save the cached run list too
+        self.cached_run_list = @run_list
+      end
+
+      # although it does not save anything, it changes existing run list object attributes or builds new one
+      def refresh_run_list!
+        data = fresh_run_list_data
+        ForemanChef::CachedRunList.parse(data, self.cached_run_list || self.build_cached_run_list) unless data.nil?
+      end
+
+      def run_list_differs?
+        self.run_list.try(:list) != fresh_run_list.try(:list)
+      end
+
+      def fresh_run_list
+        data = fresh_run_list_data
+        @fresh_run_list ||= ForemanChef::CachedRunList.parse(data) unless data.nil?
+      end
+
+      def fresh_run_list_data
+        if (data = load_node_data)
+          data['run_list']
+        else
+          nil
+        end
+      end
+
+      def chef_environment_differs?
+        self.chef_environment.try(:name) != fresh_chef_environment
+      end
+
+      def fresh_chef_environment
+        if (data = load_node_data)
+          data['chef_environment']
+        else
+          nil
+        end
+      end
+
+      def differs?
+        run_list_differs? || chef_environment_differs?
+      end
+
+      def inherited_attributes_with_chef_attributes
+        inherited_attributes_without_chef_attributes.concat(%w(chef_proxy_id chef_environment_id))
+      end
+
+      private
+
+      def load_node_data
+        self.chef_proxy && self.chef_proxy.show_node(self.name)
       end
     end
   end
 end
+
+class ::Host::Managed::Jail < Safemode::Jail
+  allow :run_list
+end

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

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

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

@@ -16,6 +16,13 @@ module ForemanChef
         return false
       end
 
+      def update_node(fqdn, attributes)
+        begin
+          reply = ProxyAPI::ForemanChef::ChefProxy.new(:url => url).update_node(fqdn, attributes)
+          JSON.parse(reply)
+        end
+      end
+
       def delete_node(fqdn)
         begin
           reply = ProxyAPI::ForemanChef::ChefProxy.new(:url => url).delete_node(fqdn)

data/app/models/foreman_chef/fact_name.rb

@@ -1,4 +1,7 @@
 module ForemanChef
   class FactName < ::FactName
+    def origin
+      'Chef'
+    end
   end
 end

data/app/models/foreman_chef/fact_parser.rb

@@ -32,9 +32,9 @@ module ForemanChef
       klass.where(args).first || klass.new(args.merge(:description => description, :release_name => release_name)).tap(&:save!)
     end
 
+    # we don't want to parse puppet environment, foreman_chef already has its own environment
     def environment
-      name = facts['environment'] || Setting[:default_puppet_environment]
-      Environment.where(:name => name).first_or_create
+      nil
     end
 
     def architecture

data/app/overrides/add_chef_tab.rb

@@ -0,0 +1,10 @@
+Deface::Override.new(:virtual_path => "hosts/_form",
+                     :name => "add_chef_tab",
+                     :insert_before => 'li#network_tab',
+                     :text => ("<%= chef_tab_menu %>")
+)
+Deface::Override.new(:virtual_path => "hosts/_form",
+                     :name => "add_chef_tab_pane",
+                     :insert_before => "div#primary",
+                     :text => ("<%= chef_tab_content(f) %>")
+)

data/app/services/foreman_chef/object_does_not_exist_exception.rb

@@ -0,0 +1,4 @@
+module ForemanChef
+  class ObjectDoesNotExistException < Foreman::Exception
+  end
+end

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

@@ -1,14 +1,18 @@
-<% if validation_bootstrap_method? -%>
-echo "Creating validation.pem"
 mkdir /etc/chef
-touch /etc/chef/validation.pem
-chmod 600 /etc/chef/validation.pem
+<% if validation_bootstrap_method? -%>
+  echo "Creating validation.pem"
+  touch /etc/chef/validation.pem
+  chmod 600 /etc/chef/validation.pem
 
-cat << 'EOF' > /etc/chef/validation.pem
+  cat << 'EOF' > /etc/chef/validation.pem
 <%= @host.params['chef_validation_private_key'] %>
 EOF
 <% else -%>
-cat << 'EOF' > /etc/chef/client.pem
+  echo "Creating client.pem"
+  touch /etc/chef/client.pem
+  chmod 600 /etc/chef/client.pem
+
+  cat << 'EOF' > /etc/chef/client.pem
 <%= @host.chef_private_key %>
 EOF
 <% end -%>
@@ -41,9 +45,7 @@ EOF
 
 # You may set here the default run list for all your nodes
 cat << 'EOF' > /tmp/base.json
-{
-"run_list": ["role[default]"]
-}
+<%= @host.run_list.to_chef_json %>
 EOF
 
 #first run of chef-client

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

@@ -0,0 +1,17 @@
+<% javascript('jsoneditor', 'foreman_chef/chef_tab') %>
+
+<div class="tab-pane" id="chef">
+
+  <% if f.object.persisted? && f.object.run_list_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 %>
+
+  <div id="runlist-editor" data-default="<%= f.object.run_list.to_form_json %>">
+
+  </div>
+
+  <%= f.hidden_field(:override_chef_attributes, :value => true) %>
+</div>

data/db/migrate/20160324151437_create_foreman_chef_cached_run_list.rb

@@ -0,0 +1,8 @@
+class CreateForemanChefCachedRunList < ActiveRecord::Migration
+  def change
+    create_table :foreman_chef_cached_run_lists do |t|
+      t.text :list, :null => false
+      t.integer :host_id
+    end
+  end
+end

data/lib/foreman_chef/engine.rb

@@ -20,7 +20,7 @@ module ForemanChef
     # content twice.
     assets_to_precompile =
       Dir.chdir(root) do
-        Dir['app/assets/javascripts/**/*', 'app/assets/stylesheets/**/*'].map do |f|
+        Dir['app/assets/javascripts/**/*', 'app/assets/stylesheets/**/*', 'app/assets/images/**/*'].map do |f|
           f.split(File::SEPARATOR, 4).last.gsub(/\.scss\Z/, '')
         end
       end
@@ -48,7 +48,7 @@ module ForemanChef
     initializer 'foreman_chef.register_plugin', :before => :finisher_hook do |app|
       Foreman::Plugin.register :foreman_chef do
         requires_foreman '>= 1.13'
-        allowed_template_helpers :chef_bootstrap, :validation_bootstrap_method?
+        extend_template_helpers ForemanChef::Concerns::Renderer
 
         permission :import_chef_environments, { :environments => [:import, :synchronize] }, :resource_type => 'ForemanChef::Environment'
         permission :view_chef_environments, { :environments => [:index, :environments_for_chef_proxy] }, :resource_type => 'ForemanChef::Environment'
@@ -62,14 +62,14 @@ module ForemanChef
              parent: :configure_menu,
              last: true
 
-        parameter_filter Host::Managed, :chef_private_key, :chef_proxy_id, :chef_environment_id
+        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
       end
     end
 
     initializer 'foreman_chef.chef_proxy_form' do |app|
       ActionView::Base.send :include, ChefProxyForm
-      ActionView::Base.send :include, ForemanChef::Concerns::Renderer
     end
 
     initializer 'foreman_chef.dynflow_world', :before => 'foreman_tasks.initialize_dynflow' do |app|
@@ -87,13 +87,9 @@ module ForemanChef
       ::Host::Managed.send :include, ForemanChef::Concerns::HostExtensions
       ::Hostgroup.send :include, ForemanChef::Concerns::HostgroupExtensions
       ::SmartProxy.send :include, ForemanChef::Concerns::SmartProxyExtensions
-      ::Host::Base.send :include, ForemanChef::Concerns::HostActionSubject
+      ::Host::Managed.send :include, ForemanChef::Concerns::HostActionSubject
       ::Host::Managed.send :include, ForemanChef::Concerns::HostBuild
       ::HostsController.send :include, ForemanChef::Concerns::HostsControllerRescuer
-      # Renderer Concern needs to be injected to controllers, ForemanRenderer was already included
-      (TemplatesController.descendants + [TemplatesController]).each do |klass|
-        klass.send(:include, ForemanChef::Concerns::Renderer)
-      end
     end
 
     config.after_initialize do

data/lib/foreman_chef/version.rb

@@ -1,3 +1,3 @@
 module ForemanChef
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_chef
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Marek Hulan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-19 00:00:00.000000000 Z
+date: 2017-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -62,7 +62,11 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- app/assets/images/Chef.png
 - app/assets/javascripts/foreman_chef/chef_proxy_environment_refresh.js
+- app/assets/javascripts/foreman_chef/chef_tab.js
+- app/assets/javascripts/jsoneditor.js
+- app/assets/javascripts/jsoneditor.js.map
 - app/controllers/foreman_chef/application_controller.rb
 - app/controllers/foreman_chef/concerns/environment_parameters.rb
 - app/controllers/foreman_chef/concerns/hosts_controller_rescuer.rb
@@ -72,7 +76,10 @@ files:
 - 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
 - app/lib/proxy_api/foreman_chef/chef_proxy.rb
+- app/models/foreman_chef/cached_run_list.rb
 - app/models/foreman_chef/concerns/host_action_subject.rb
 - app/models/foreman_chef/concerns/host_and_hostgroup_extensions.rb
 - app/models/foreman_chef/concerns/host_build.rb
@@ -86,7 +93,9 @@ files:
 - app/models/foreman_chef/fact_parser.rb
 - app/models/setting/foreman_chef.rb
 - app/overrides/add_chef_proxy.rb
+- app/overrides/add_chef_tab.rb
 - app/services/foreman_chef/chef_server_importer.rb
+- app/services/foreman_chef/object_does_not_exist_exception.rb
 - app/services/foreman_chef/object_exists_exception.rb
 - app/services/foreman_chef/proxy_exception.rb
 - app/views/foreman/unattended/snippets/_chef_client_bootstrap.erb
@@ -98,10 +107,12 @@ files:
 - app/views/foreman_chef/environments/import.html.erb
 - 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
 - config/routes.rb
 - db/migrate/20140220145827_add_chef_proxy_id_to_host.rb
 - db/migrate/20140513144804_add_chef_proxy_id_to_hostgroup.rb
 - db/migrate/20150916141657_create_chef_environment.rb
+- db/migrate/20160324151437_create_foreman_chef_cached_run_list.rb
 - db/migrate/20160408091653_add_chef_private_key_to_host.rb
 - db/seeds.rb
 - lib/foreman_chef.rb