foreman_dlm 1.0.0 → 1.1.0

data/app/models/foreman_dlm/dlmlock/update.rb

@@ -0,0 +1,9 @@
+module ForemanDlm
+  class Dlmlock
+    class Update < Dlmlock
+      def humanized_type
+        _('Update Lock')
+      end
+    end
+  end
+end

data/app/models/foreman_dlm/dlmlock_event.rb

@@ -0,0 +1,23 @@
+module ForemanDlm
+  class DlmlockEvent < ApplicationRecord
+    include Authorizable
+    include Expirable
+
+    TYPES = %w[release acquire enable disable fail].freeze
+    validates :event_type, inclusion: { in: TYPES }
+
+    def self.humanize_class_name
+      N_('Distributed Lock Event')
+    end
+
+    belongs_to_host
+    belongs_to :dlmlock, inverse_of: :dlmlock_events, class_name: 'ForemanDlm::Dlmlock'
+    belongs_to :user, inverse_of: :dlmlock_events
+
+    scoped_search on: :event_type, complete_value: true
+
+    def humanized_type
+      _('Dlmlock Event')
+    end
+  end
+end

data/app/models/host_status/dlmlock_status.rb

@@ -0,0 +1,44 @@
+module HostStatus
+  class DlmlockStatus < Status
+    OK = 0
+    STALE = 1
+
+    def self.status_name
+      N_('Distributed Lock')
+    end
+
+    def to_label(_options = {})
+      case to_status
+      when OK
+        N_('Ok')
+      when STALE
+        N_('Stale')
+      else
+        N_('Unknown')
+      end
+    end
+
+    def to_global(_options = {})
+      case to_status
+      when OK
+        HostStatus::Global::OK
+      else
+        HostStatus::Global::ERROR
+      end
+    end
+
+    def to_status(_options = {})
+      ok? ? OK : STALE
+    end
+
+    def relevant?(_options = {})
+      host.dlmlocks.any?
+    end
+
+    private
+
+    def ok?
+      host.dlmlocks.stale.empty?
+    end
+  end
+end

data/app/models/settings/dlm.rb

@@ -0,0 +1,20 @@
+class Setting
+  class Dlm < ::Setting
+    def self.load_defaults
+      return unless ActiveRecord::Base.connection.table_exists?('settings')
+      return unless super
+
+      Setting.transaction do
+        [
+          set('dlm_stale_time', N_('Number of hours after which locked Distributed Lock is stale'), 4, N_('Distributed Lock stale time'))
+        ].compact.each { |s| Setting::General.create s.update(category: 'Setting::General') }
+      end
+
+      true
+    end
+
+    def self.humanized_category
+      N_('Distributed Locks')
+    end
+  end
+end

data/app/views/api/v2/dlmlock_events/index.json.rabl

@@ -0,0 +1,2 @@
+collection @events
+attributes :id, :event_type, :created_at, :updated_at

data/app/views/foreman_dlm/api/v2/dlm_facets/base.json.rabl

@@ -0,0 +1 @@
+attributes :id, :last_checkin_at

data/app/views/foreman_dlm/api/v2/dlm_facets/base_with_root.json.rabl

@@ -0,0 +1,3 @@
+child :dlm_facet => :dlm_facet_attributes do |_dlm_facet|
+  extends 'foreman_dlm/api/v2/dlm_facets/base'
+end

data/app/views/foreman_dlm/api/v2/dlm_facets/show.json.rabl

@@ -0,0 +1,3 @@
+child :dlm_facet => :dlm_facet_attributes do
+  extends 'foreman_dlm/api/v2/dlm_facets/base'
+end

data/app/views/foreman_dlm/dlmlocks/_details.html.erb

@@ -0,0 +1,42 @@
+<% if authorizer.can?(:view_dlmlock_events) %>
+  <table class="<%= table_css_classes('table-fixed') %>">
+    <thead>
+      <tr>
+        <th><%= _("Host") %></th>
+        <th><%= _("User") %></th>
+        <th><%= _("Type") %></th>
+        <th><%= _("Timestamp") %></th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @dlmlock.dlmlock_events.includes(:user).reorder(created_at: :desc).each do |event| %>
+
+        <tr>
+          <td>
+            <% if event.host %>
+              <%= link_to_if_authorized(event.host.name, hash_for_host_path(:id => event.host)) %>
+            <% end %>
+          </td>
+
+          <td>
+            <% if event.user %>
+              <% if event.user.hidden? %>
+                <em><%= event.user.name %></em>
+              <% else %>
+                <%= link_to_if_authorized(event.user.name, hash_for_edit_user_path(event.user)) %>
+              <% end %>
+            <% end %>
+          </td>
+
+          <td>
+            <%= _(event.event_type.humanize) %>
+          </td>
+
+          <td>
+            <%= event.created_at %>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+<% end %>

data/app/views/{dlmlocks → foreman_dlm/dlmlocks}/_list.html.erb

@@ -5,6 +5,7 @@
       <th><%= sort :host, :as => _("Owner") %></th>
       <th><%= sort :type, :as => _("Type") %></th>
       <th><%= sort :enabled, :as => _("Enabled") %></th>
+      <th class="col-md-2"><%= _('Actions') %></th>
     </tr>
   </thead>
   <tbody>
@@ -12,7 +13,7 @@
       <tr class="<%= lock.enabled? ? '' : 'warning' %>">
         <td>
           <%= icon_text(dlmlock_status_icon_class(lock),
-                        link_to_if_authorized(lock.name, hash_for_dlmlock_path(:id => lock)),
+                        link_to_if_authorized(lock.name, hash_for_foreman_dlm_dlmlock_path(:id => lock)),
                         kind: 'fa',
                         class: "#{dlmlock_status_icon_color_class(lock)} fa-lg")
                       %>
@@ -38,6 +39,7 @@
             <%= icon_text('toggle-off', 'Disabled', {kind: 'fa', class: 'center fa-lg', title: _('Disabled')}) %>
           <% end %>
         </td>
+        <td><%= action_buttons(*dlmlock_actions(lock, authorizer)) %></td>
       </tr>
     <% end %>
   </tbody>

data/app/views/foreman_dlm/dlmlocks/show.html.erb

@@ -0,0 +1,10 @@
+<% title @dlmlock.name %>
+<% breadcrumbs(
+   resource_url: api_dlmlocks_path
+) if respond_to?(:breadcrumbs) # Requires Foreman >= 1.18 %>
+
+<%= title_actions link_to(_('Back'), foreman_dlm_dlmlocks_path, :class => 'btn btn-default'),
+  ((link_to(_("Host details"), @dlmlock.host, :class => 'btn btn-default') if @dlmlock.host.present?))
+%>
+
+<%= render 'details' %>

data/app/views/hosts/_dlmlocks_tab.html.erb

@@ -0,0 +1,39 @@
+<% if @host.dlmlocks.any? %>
+  <%= alert class: 'alert-info',
+    header: '',
+    text: n_(
+      'This host holds %s lock.',
+      'This host holds %s locks.',
+      @host.dlmlocks.count
+    ) % @host.dlmlocks.count
+  %>
+<% end %>
+
+<table class="<%= table_css_classes %> table-fixed">
+  <thead>
+    <tr>
+      <th colspan="2"><%= _('Locks') %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><%= _('Last checkin') %></td>
+      <td><%= @host.dlm_facet && @host.dlm_facet.last_checkin_at ? date_time_relative(@host.dlm_facet.last_checkin_at) : _('N/A') %></td>
+    </tr>
+    <tr>
+      <td><%= _('Holds Locks') %></td>
+      <td>
+        <% if @host.dlmlocks.any? %>
+          <% @host.dlmlocks.authorized(:view_dlmlocks).each do |lock| %>
+            <%= link_to_if_authorized(lock.name, hash_for_foreman_dlm_dlmlock_path(lock)) %>
+            <span class="label label-<%= lock.updated_at > 6.hours.ago ? 'info' : 'warning' %>">
+              <%= _('acquired') %> <%= date_time_relative_value(lock.updated_at) %>
+            </span>
+          <% end %>
+        <% else %>
+          <%= _('None') %>
+        <% end %>
+      </td>
+    </tr>
+  </tbody>
+</table>

data/config/routes.rb

@@ -6,6 +6,8 @@ Rails.application.routes.draw do
                      :constraints => ApiConstraints.new(:version => 2, :default => true) do
       constraints(id: /[^\/]+/) do
         resources :dlmlocks, only: [:index, :show, :update, :destroy] do
+          resources :dlmlock_events, only: [:index]
+
           get :lock, on: :member, action: :show, controller: 'dlmlocks'
           put :lock, on: :member, action: :acquire, controller: 'dlmlocks'
           delete :lock, on: :member, action: :release, controller: 'dlmlocks'
@@ -15,10 +17,15 @@ Rails.application.routes.draw do
     end
   end
 
-  scope '/foreman_dlm' do
-    resources :dlmlocks, only: [:index, :show] do
+  namespace :foreman_dlm do
+    resources :dlmlocks, only: [:index, :show, :destroy] do
       collection do
-        get 'auto_complete_search'
+        get :auto_complete_search
+      end
+      member do
+        put :enable
+        put :disable
+        put :release
       end
     end
   end

data/contrib/systemd/foreman-dlm-expire-events.service

@@ -0,0 +1,10 @@
+[Unit]
+Description=Clean up expired Foreman DLM events
+Documentation=https://github.com/dm-drogeriemarkt/foreman_dlm/blob/master/README.md
+Requires=network.target
+
+[Service]
+Type=oneshot
+EnvironmentFile=-/etc/sysconfig/foreman_dlm
+ExecStart=/sbin/foreman-rake dlmlocks:expire
+TimeoutSec=30m

data/contrib/systemd/foreman-dlm-expire-events.timer

@@ -0,0 +1,8 @@
+[Unit]
+Description=Run foreman-dlm-expire-events.service nightly
+
+[Timer]
+OnCalendar=*-*-* 02:00:00
+
+[Install]
+WantedBy=timers.target

data/db/migrate/20180627150003_rename_dlmlock_sti_models.rb

@@ -0,0 +1,9 @@
+class RenameDlmlockStiModels < ActiveRecord::Migration[5.1]
+  def up
+    execute "UPDATE dlmlocks set type='ForemanDlm::Dlmlock::Update' where type='Dlmlock::Update';"
+  end
+
+  def down
+    execute "UPDATE dlmlocks set type='Dlmlock::Update' where type='ForemanDlm::Dlmlock::Update';"
+  end
+end

data/db/migrate/20180704162345_add_dlmlock_events.rb

@@ -0,0 +1,11 @@
+class AddDlmlockEvents < ActiveRecord::Migration[5.1]
+  def change
+    create_table :dlmlock_events do |t|
+      t.integer :dlmlock_id, index: true, null: false
+      t.string :event_type, index: true
+      t.integer :host_id, index: true
+      t.integer :user_id
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20180711090022_add_hosts_fk_to_dlmlocks.rb

@@ -0,0 +1,5 @@
+class AddHostsFkToDlmlocks < ActiveRecord::Migration[5.1]
+  def change
+    add_foreign_key :dlmlocks, :hosts
+  end
+end

data/db/migrate/20180711111903_create_dlm_facets.foreman_dlm.rb

@@ -0,0 +1,10 @@
+class CreateDlmFacets < ActiveRecord::Migration[5.1]
+  def change
+    create_table :dlm_facets do |t|
+      t.references :host, null: false, foreign_key: true, index: true, unique: true
+      t.column :last_checkin_at, :datetime
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20180713113208_update_permissions_for_scoped_models.rb

@@ -0,0 +1,13 @@
+class UpdatePermissionsForScopedModels < ActiveRecord::Migration[5.1]
+  class FakePermission < ApplicationRecord
+    self.table_name = 'permissions'
+  end
+
+  def up
+    FakePermission.where(resource_type: 'Dlmlock').update_all(resource_type: 'ForemanDlm::Dlmlock')
+  end
+
+  def down
+    FakePermission.where(resource_type: 'ForemanDlm::Dlmlock').update_all(resource_type: 'Dlmlock')
+  end
+end

data/lib/foreman_dlm/engine.rb

@@ -4,6 +4,15 @@ module ForemanDlm
 
     config.autoload_paths += Dir["#{config.root}/app/controllers/concerns"]
     config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/jobs"]
+
+    initializer 'foreman_dlm.load_default_settings', before: :load_config_initializers do
+      require_dependency File.expand_path('../../app/models/settings/dlm.rb', __dir__) if begin
+                                                                                         Setting.table_exists?
+                                                                                       rescue StandardError
+                                                                                         (false)
+                                                                                       end
+    end
 
     # Add any db migrations
     initializer 'foreman_dlm.load_app_instance_data' do |app|
@@ -21,32 +30,57 @@ module ForemanDlm
         # Add permissions
         security_block :foreman_dlm do
           permission :view_dlmlocks, {
-            :dlmlocks => [:index, :show, :auto_complete_search],
+            :'foreman_dlm/dlmlocks' => [:index, :show, :auto_complete_search],
             :'api/v2/dlmlocks' => [:index, :show]
-          }, :resource_type => 'Dlmlock'
+          }, :resource_type => 'ForemanDlm::Dlmlock'
 
           permission :create_dlmlocks, {
             :'api/v2/dlmlocks' => [:create]
-          }, :resource_type => 'Dlmlock'
+          }, :resource_type => 'ForemanDlm::Dlmlock'
 
           permission :edit_dlmlocks, {
+            :'foreman_dlm/dlmlocks' => [:release, :enable, :disable],
             :'api/v2/dlmlocks' => [:update, :acquire, :release]
-          }, :resource_type => 'Dlmlock'
+          }, :resource_type => 'ForemanDlm::Dlmlock'
 
           permission :destroy_dlmlocks, {
+            :'foreman_dlm/dlmlocks' => [:destroy],
             :'api/v2/dlmlocks' => [:destroy]
-          }, :resource_type => 'Dlmlock'
+          }, :resource_type => 'ForemanDlm::Dlmlock'
+
+          permission :view_dlmlock_events, {
+            :'api/v2/dlmlock_events' => [:index]
+          }, :resource_type => 'ForemanDlm::DlmlockEvent'
         end
 
         # Add a new role called 'Distributed Lock Manager' if it doesn't exist
-        role 'Distributed Lock Manager', [:view_dlmlocks, :create_dlmlocks, :edit_dlmlocks, :destroy_dlmlocks]
+        role 'Distributed Lock Manager', [:view_dlmlocks,
+                                          :create_dlmlocks,
+                                          :edit_dlmlocks,
+                                          :destroy_dlmlocks,
+                                          :view_dlmlock_events]
 
         # add menu entry
         menu :top_menu, :distributed_locks,
-             url_hash: { controller: :dlmlocks, action: :index },
+             url_hash: { controller: :'foreman_dlm/dlmlocks', action: :index },
              caption: N_('Distributed Locks'),
              parent: :monitor_menu,
              after: :audits
+
+        # Dlm Facet
+        register_facet(ForemanDlm::DlmFacet, :dlm_facet) do
+          api_view list: 'foreman_dlm/api/v2/dlm_facets/base_with_root', single: 'foreman_dlm/api/v2/dlm_facets/show'
+        end
+
+        register_custom_status HostStatus::DlmlockStatus
+
+        # extend host show page
+        extend_page('hosts/show') do |context|
+          context.add_pagelet :main_tabs,
+                              :name => N_('Locks'),
+                              :partial => 'hosts/dlmlocks_tab',
+                              :onlyif => proc { |host| host.dlm_facet }
+        end
       end
     end
 
@@ -54,6 +88,8 @@ module ForemanDlm
     config.to_prepare do
       begin
         Host::Managed.send(:include, ForemanDlm::HostExtensions)
+        User.send(:include, ForemanDlm::UserExtensions)
+        Host::Managed.send(:include, ForemanDlm::DlmFacetHostExtensions)
 
         Host::Managed.send(:include, ForemanDlm::HostMonitoringExtensions) if ForemanDlm.with_monitoring?
       rescue StandardError => e

data/lib/foreman_dlm/version.rb

@@ -1,3 +1,3 @@
 module ForemanDlm
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/tasks/dlmlock_events.rake

@@ -0,0 +1,19 @@
+desc <<-TASK_DESCRIPTION
+ Expire lock events automatically
+
+ Available conditions:
+   * days        => number of days to keep reports (defaults to 14)
+   * batch_size  => number of records deleted in single SQL transaction (defaults to 1k)
+   * sleep_time  => delay in seconds between batches (defaults to 0.2)
+
+TASK_DESCRIPTION
+
+namespace :dlmlocks do
+  task expire: :environment do
+    created_before = ENV['days'].to_i.days if ENV['days']
+    batch_size = ENV['batch_size'].to_i if ENV['batch_size']
+    sleep_time = ENV['sleep_time'].to_f if ENV['sleep_time']
+
+    ForemanDlm::DlmlockEvent.expire(created_before: created_before, batch_size: batch_size, sleep_time: sleep_time)
+  end
+end