foreman_dlm 1.0.0 → 1.1.0

data/test/models/host_managed_test.rb

@@ -0,0 +1,23 @@
+require 'test_plugin_helper'
+
+module Host
+  class ManagedTest < ActiveSupport::TestCase
+    should have_many(:dlmlocks)
+    should have_many(:dlmlock_events)
+    should have_one(:dlm_facet)
+
+    context 'scoped search on' do
+      context 'a host' do
+        let(:host) { FactoryBot.create(:host, :with_dlm_facet) }
+        setup do
+          host
+        end
+
+        test 'can be searched by dlm checkin time' do
+          results = Host.search_for('last_dlm_checkin_at < "2 weeks from now"')
+          assert_includes results, host
+        end
+      end
+    end
+  end
+end

data/test/models/host_status/dlmlock_status_test.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class DlmlockStatusTest < ActiveSupport::TestCase
+  setup do
+    FactoryBot.create(:setting, category: Setting::General, name: 'dlm_stale_time', value: 4)
+  end
+
+  let(:host) { FactoryBot.create(:host, :managed) }
+
+  describe '#to_status' do
+    test 'should return STALE if host has any stale dlmlocks' do
+      now = Time.now.utc
+
+      travel_to now do
+        FactoryBot.create(:dlmlock, :locked, host: host, updated_at: now - 5.hours)
+        status = host.get_status(HostStatus::DlmlockStatus)
+
+        refute_empty host.dlmlocks.stale
+        assert_equal HostStatus::DlmlockStatus::STALE, status.to_status
+      end
+    end
+
+    test 'should return OK if host has no stale dlmlocks' do
+      status = host.get_status(HostStatus::DlmlockStatus)
+
+      assert_empty host.dlmlocks.stale
+      assert_equal HostStatus::DlmlockStatus::OK, status.to_status
+    end
+  end
+
+  describe '#relevant?' do
+    test 'should return true if host has any dlmlocks' do
+      FactoryBot.create(:dlmlock, host: host)
+      status = host.get_status(HostStatus::DlmlockStatus)
+
+      refute_empty host.dlmlocks
+      assert_equal true, status.relevant?
+    end
+
+    test 'should return false if host has no dlmlocks' do
+      status = host.get_status(HostStatus::DlmlockStatus)
+
+      assert_empty host.dlmlocks
+      assert_equal false, status.relevant?
+    end
+  end
+end

data/test/models/user_test.rb

@@ -0,0 +1,5 @@
+require 'test_plugin_helper'
+
+class UserTest < ActiveSupport::TestCase
+  should have_many(:dlmlock_events)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_dlm
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Timo Goebel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-09 00:00:00.000000000 Z
+date: 2019-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -49,16 +49,28 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- app/controllers/api/v2/dlmlock_events_controller.rb
 - app/controllers/api/v2/dlmlocks_controller.rb
 - app/controllers/concerns/foreman/controller/parameters/dlmlocks.rb
 - app/controllers/concerns/foreman_dlm/find_host_by_client_cert.rb
 - app/controllers/concerns/foreman_dlm/find_host_by_ip.rb
-- app/controllers/dlmlocks_controller.rb
+- app/controllers/concerns/foreman_dlm/update_checkin_time.rb
+- app/controllers/foreman_dlm/application_controller.rb
+- app/controllers/foreman_dlm/dlmlocks_controller.rb
 - app/helpers/foreman_dlm/dlmlock_helper.rb
+- app/jobs/foreman_dlm/refresh_dlmlock_status.rb
+- app/models/concerns/foreman_dlm/dlm_facet_host_extensions.rb
+- app/models/concerns/foreman_dlm/expirable.rb
 - app/models/concerns/foreman_dlm/host_extensions.rb
 - app/models/concerns/foreman_dlm/host_monitoring_extensions.rb
-- app/models/dlmlock.rb
-- app/models/dlmlock/update.rb
+- app/models/concerns/foreman_dlm/user_extensions.rb
+- app/models/foreman_dlm/dlm_facet.rb
+- app/models/foreman_dlm/dlmlock.rb
+- app/models/foreman_dlm/dlmlock/update.rb
+- app/models/foreman_dlm/dlmlock_event.rb
+- app/models/host_status/dlmlock_status.rb
+- app/models/settings/dlm.rb
+- app/views/api/v2/dlmlock_events/index.json.rabl
 - app/views/api/v2/dlmlocks/acquire.json.rabl
 - app/views/api/v2/dlmlocks/base.json.rabl
 - app/views/api/v2/dlmlocks/create.json.rabl
@@ -68,29 +80,53 @@ files:
 - app/views/api/v2/dlmlocks/show.json.rabl
 - app/views/api/v2/dlmlocks/update.json.rabl
 - app/views/api/v2/errors/precondition_failed.json.rabl
-- app/views/dlmlocks/_details.html.erb
-- app/views/dlmlocks/_list.html.erb
-- app/views/dlmlocks/index.html.erb
-- app/views/dlmlocks/show.html.erb
-- app/views/dlmlocks/welcome.html.erb
+- app/views/foreman_dlm/api/v2/dlm_facets/base.json.rabl
+- app/views/foreman_dlm/api/v2/dlm_facets/base_with_root.json.rabl
+- app/views/foreman_dlm/api/v2/dlm_facets/show.json.rabl
+- app/views/foreman_dlm/dlmlocks/_details.html.erb
+- app/views/foreman_dlm/dlmlocks/_list.html.erb
+- app/views/foreman_dlm/dlmlocks/index.html.erb
+- app/views/foreman_dlm/dlmlocks/show.html.erb
+- app/views/foreman_dlm/dlmlocks/welcome.html.erb
+- app/views/hosts/_dlmlocks_tab.html.erb
 - config/routes.rb
+- contrib/systemd/foreman-dlm-expire-events.service
+- contrib/systemd/foreman-dlm-expire-events.timer
 - db/migrate/20170824084100_add_dlmlock.foreman_dlm.rb
+- db/migrate/20180627150003_rename_dlmlock_sti_models.rb
+- db/migrate/20180704162345_add_dlmlock_events.rb
+- db/migrate/20180711090022_add_hosts_fk_to_dlmlocks.rb
+- db/migrate/20180711111903_create_dlm_facets.foreman_dlm.rb
+- db/migrate/20180713113208_update_permissions_for_scoped_models.rb
 - lib/foreman_dlm.rb
 - lib/foreman_dlm/engine.rb
 - lib/foreman_dlm/version.rb
+- lib/tasks/dlmlock_events.rake
 - lib/tasks/foreman_dlm_tasks.rake
 - locale/Makefile
 - locale/en/foreman_dlm.po
 - locale/foreman_dlm.pot
 - locale/gemspec.rb
 - test/controllers/api/v2/dlmlocks_controller_test.rb
-- test/controllers/dlmlocks_test.rb
+- test/controllers/api/v2/dlmlocks_dlmlock_events_controller_test.rb
+- test/controllers/api/v2/hosts_controller_test.rb
 - test/controllers/find_host_by_client_cert_test.rb
+- test/controllers/foreman_dlm/dlmlocks_test.rb
+- test/controllers/hosts_controller_test.rb
+- test/factories/dlm_facets.rb
 - test/factories/dlmlock.rb
-- test/models/dlmlock_test.rb
+- test/factories/dlmlock_events.rb
+- test/factories/host.rb
+- test/jobs/refresh_dlmlock_status_test.rb
+- test/models/foreman_dlm/dlm_facet_test.rb
+- test/models/foreman_dlm/dlmlock_event_test.rb
+- test/models/foreman_dlm/dlmlock_test.rb
+- test/models/host_managed_test.rb
 - test/models/host_monitoring_test.rb
+- test/models/host_status/dlmlock_status_test.rb
+- test/models/user_test.rb
 - test/test_plugin_helper.rb
-homepage: https://github.com/timogoebel/foreman_dlm
+homepage: https://github.com/dm-drogeriemarkt/foreman_dlm
 licenses:
 - GPL-3.0
 metadata: {}
@@ -115,10 +151,22 @@ signing_key:
 specification_version: 4
 summary: Distributed Lock Manager for Foreman.
 test_files:
+- test/models/host_managed_test.rb
+- test/models/foreman_dlm/dlmlock_event_test.rb
+- test/models/foreman_dlm/dlm_facet_test.rb
+- test/models/foreman_dlm/dlmlock_test.rb
+- test/models/host_status/dlmlock_status_test.rb
 - test/models/host_monitoring_test.rb
-- test/models/dlmlock_test.rb
+- test/models/user_test.rb
+- test/factories/dlm_facets.rb
+- test/factories/host.rb
+- test/factories/dlmlock_events.rb
 - test/factories/dlmlock.rb
 - test/test_plugin_helper.rb
-- test/controllers/dlmlocks_test.rb
+- test/jobs/refresh_dlmlock_status_test.rb
+- test/controllers/foreman_dlm/dlmlocks_test.rb
 - test/controllers/api/v2/dlmlocks_controller_test.rb
+- test/controllers/api/v2/hosts_controller_test.rb
+- test/controllers/api/v2/dlmlocks_dlmlock_events_controller_test.rb
+- test/controllers/hosts_controller_test.rb
 - test/controllers/find_host_by_client_cert_test.rb

data/app/controllers/dlmlocks_controller.rb

@@ -1,12 +0,0 @@
-class DlmlocksController < ::ApplicationController
-  include Foreman::Controller::AutoCompleteSearch
-
-  before_action :setup_search_options, :only => :index
-  before_action :find_resource, :only => [:show]
-
-  def index
-    @dlmlocks = resource_base_search_and_page(:host)
-  end
-
-  def show; end
-end

data/app/models/dlmlock.rb

@@ -1,79 +0,0 @@
-class Dlmlock < ApplicationRecord
-  include Authorizable
-
-  def self.humanize_class_name
-    N_('Distributed Lock')
-  end
-
-  belongs_to_host
-  audited
-
-  validates :name, presence: true, uniqueness: true
-
-  scoped_search :on => :name, :complete_value => true, :default_order => true
-  scoped_search :relation => :host, :on => :name, :complete_value => true, :rename => :host
-  scoped_search :on => :type, :complete_value => true, :default_order => true
-  scoped_search :on => :enabled, :complete_value => { :true => true, :false => false }, :only_explicit => true
-
-  attr_accessor :old
-
-  def acquire!(host)
-    atomic_update(nil, host)
-  end
-
-  def release!(host)
-    atomic_update(host, nil)
-  end
-
-  def locked_by?(host)
-    self.host == host
-  end
-  alias acquired_by? locked_by?
-
-  def disabled?
-    !enabled?
-  end
-
-  def locked?
-    host.present?
-  end
-  alias taken? locked?
-
-  def humanized_type
-    _('Generic Lock')
-  end
-
-  private
-
-  def atomic_update(old_host, new_host)
-    changes = {
-      host_id: new_host.try(:id)
-    }
-    self.old = dup
-    num_updated = self.class.where(
-      id: id,
-      host_id: [new_host.try(:id), old_host.try(:id)],
-      enabled: true
-    ).update_all(changes.merge(updated_at: Time.now.utc))
-    if num_updated > 0
-      reload
-      process_host_change(old_host, new_host, changes)
-      return self
-    end
-    false
-  end
-
-  def process_host_change(old_host, new_host, changes)
-    return if host.try(:id) == old.host.try(:id)
-    write_audit(action: 'update', audited_changes: changes)
-    run_callback(old_host, :unlock) if old.host
-    run_callback(new_host, :lock) if host
-  end
-
-  def run_callback(h, callback)
-    h.run_callbacks callback do
-      logger.debug { "custom hook after_#{callback} on #{h} will be executed if defined." }
-      true
-    end
-  end
-end

data/app/models/dlmlock/update.rb

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

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

@@ -1,35 +0,0 @@
-<table class="<%= table_css_classes('table-fixed') %>">
-  <thead>
-    <tr>
-      <th><%= _("Owner") %></th>
-      <th><%= _("Initiator") %></th>
-      <th><%= _("Timestamp") %></th>
-      <th><%= _("Enabled") %></th>
-    </tr>
-  </thead>
-  <tbody>
-    <% @dlmlock.audits.includes(:user).reorder(created_at: :desc).each do |audit| %>
-      <% revision = audit.revision %>
-      <tr>
-        <td>
-          <% if revision.host.present? %>
-            <%= link_to_if_authorized(revision.host.name, hash_for_host_path(:id => revision.host)) %>
-          <% end %>
-        </td>
-        <td>
-          <% if audit.user.hidden? %>
-            <em><%= audit.user.name %></em>
-          <% else %>
-            <%= link_to_if_authorized(audit.user.name, hash_for_edit_user_path(audit.user)) %>
-          <% end %>
-        </td>
-        <td>
-          <%= audit.created_at %>
-        </td>
-        <td>
-          <%= revision.enabled? %>
-        </td>
-      </tr>
-    <% end %>
-  </tbody>
-</table>

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

@@ -1,7 +0,0 @@
-<% title "#{@dlmlock.name} "%>
-
-<%= title_actions link_to(_('Back'), :back, :class => 'btn btn-default'),
-  ((link_to(_("Host details"), @dlmlock.host, :class => 'btn btn-default') if @dlmlock.host.present?))
-%>
-
-<%= render 'details' %>

data/test/controllers/dlmlocks_test.rb

@@ -1,24 +0,0 @@
-require 'test_plugin_helper'
-
-class DlmlocksControllerTest < ActionController::TestCase
-  test '#index' do
-    FactoryBot.create(:dlmlock)
-    get :index, session: set_session_user
-    assert_response :success
-    assert_not_nil assigns('dlmlocks')
-    assert_template 'index'
-  end
-
-  test '#index with no lock shows welcome page' do
-    get :index, session: set_session_user
-    assert_response :success
-    assert_template 'welcome'
-  end
-
-  test '#show' do
-    dlmlock = FactoryBot.create(:dlmlock)
-    get :show, params: { :id => dlmlock.id }, session: set_session_user
-    assert_response :success
-    assert_template 'show'
-  end
-end

data/test/models/dlmlock_test.rb

@@ -1,201 +0,0 @@
-require 'test_plugin_helper'
-
-class DlmlockTest < ActiveSupport::TestCase
-  setup do
-    User.current = users(:admin)
-  end
-
-  subject { FactoryBot.create(:dlmlock) }
-  should validate_presence_of(:name)
-  should validate_uniqueness_of(:name)
-
-  let(:host1) { FactoryBot.create(:host, :managed) }
-  let(:host2) { FactoryBot.create(:host, :managed) }
-
-  class HostWithCallbacks < ::Host::Managed
-    attr_accessor :callbacks
-
-    def initialize(*attributes, &block)
-      super
-      @callbacks = []
-    end
-
-    after_lock :callback1
-    after_unlock :callback2
-
-    def callback1
-      Rails.logger.debug "callback1 executed for #{self} (#{self.class})"
-      callbacks << 'callback1'
-    end
-
-    def callback2
-      Rails.logger.debug "callback2 executed for #{self} (#{self.class})"
-      callbacks << 'callback2'
-    end
-  end
-
-  let(:host1_with_callbacks) { HostWithCallbacks.create(:name => 'test1.example.com') }
-  let(:host2_with_callbacks) { HostWithCallbacks.create(:name => 'test2.example.com') }
-
-  context 'a free and enabled DLM lock' do
-    let(:dlmlock) { FactoryBot.create(:dlmlock) }
-
-    test 'should be enabled and unlocked' do
-      assert_equal true, dlmlock.enabled?
-      assert_equal false, dlmlock.disabled?
-      assert_equal false, dlmlock.locked?
-      assert_equal false, dlmlock.taken?
-    end
-
-    test 'can be acquired' do
-      assert_nil dlmlock.host
-      assert dlmlock.acquire!(host1)
-      assert_equal host1, dlmlock.reload.host
-    end
-
-    test 'can be released' do
-      assert_nil dlmlock.host
-      assert dlmlock.release!(host1)
-      assert_nil dlmlock.reload.host
-    end
-
-    test 'records audit change on acquisition by owner' do
-      assert_difference "Audit.where(auditable_type: 'Dlmlock', action: 'update').count" do
-        assert dlmlock.acquire!(host1)
-      end
-      audit_record = dlmlock.audits.last
-      assert_equal 'update', audit_record.action
-      assert_equal({ :host_id => host1.id }, audit_record.audited_changes)
-    end
-
-    test 'records no audit change on release' do
-      assert_no_difference "Audit.where(auditable_type: 'Dlmlock', action: 'update').count" do
-        assert dlmlock.release!(host1)
-      end
-    end
-
-    test 'triggers after_lock callback' do
-      host = HostWithCallbacks.new
-      host.name = 'test.example.com'
-      host.save
-      assert dlmlock.acquire!(host)
-      assert_equal ['callback1'], host.callbacks
-    end
-  end
-
-  context 'a free and disabled DLM lock' do
-    let(:dlmlock) { FactoryBot.create(:dlmlock, :enabled => false) }
-
-    test 'should be disabled and unlocked' do
-      assert_equal false, dlmlock.enabled?
-      assert_equal true, dlmlock.disabled?
-      assert_equal false, dlmlock.locked?
-      assert_equal false, dlmlock.taken?
-    end
-
-    test 'can not be acquired' do
-      assert_nil dlmlock.host
-      assert_equal false, dlmlock.acquire!(host1)
-      assert_nil dlmlock.reload.host
-    end
-
-    test 'can not be released' do
-      assert_nil dlmlock.host
-      assert_equal false, dlmlock.release!(host1)
-      assert_nil dlmlock.reload.host
-    end
-
-    test 'triggers no callbacks' do
-      host = HostWithCallbacks.new
-      host.name = 'test.example.com'
-      host.save
-      assert_equal false, dlmlock.release!(host)
-      assert_equal [], host.callbacks
-    end
-  end
-
-  context 'an acquired DLM lock' do
-    let(:dlmlock) { FactoryBot.create(:dlmlock, :host => host1) }
-
-    test 'should be enabled and locked' do
-      assert_equal true, dlmlock.enabled?
-      assert_equal false, dlmlock.disabled?
-      assert_equal true, dlmlock.locked?
-      assert_equal true, dlmlock.taken?
-      assert_equal true, dlmlock.locked_by?(host1)
-      assert_equal true, dlmlock.acquired_by?(host1)
-    end
-
-    test 'can be acquired by owner' do
-      assert_equal host1, dlmlock.host
-      assert dlmlock.acquire!(host1)
-      assert_equal host1, dlmlock.reload.host
-    end
-
-    test 'can not be acquired by other host' do
-      assert_equal host1, dlmlock.host
-      assert_equal false, dlmlock.acquire!(host2)
-      assert_equal host1, dlmlock.reload.host
-    end
-
-    test 'can be released by owner' do
-      assert_equal host1, dlmlock.host
-      assert dlmlock.release!(host1)
-      assert_nil dlmlock.reload.host
-    end
-
-    test 'can not be released by other host' do
-      assert_equal host1, dlmlock.host
-      assert_equal false, dlmlock.release!(host2)
-      assert_equal host1, dlmlock.reload.host
-    end
-
-    test 'records audit change on release by owner' do
-      assert_difference "Audit.where(auditable_type: 'Dlmlock', action: 'update').count" do
-        assert dlmlock.release!(host1)
-      end
-      audit_record = dlmlock.audits.last
-      assert_equal 'update', audit_record.action
-      assert_equal({ :host_id => nil }, audit_record.audited_changes)
-    end
-
-    test 'records no audit change on acquisition by owner' do
-      assert_no_difference "Audit.where(auditable_type: 'Dlmlock', action: 'update').count" do
-        assert dlmlock.acquire!(host1)
-      end
-    end
-
-    test 'triggers after_unlock callback on release by owner' do
-      host = HostWithCallbacks.new
-      host.name = 'test.example.com'
-      host.save
-      dlmlock.host = host
-      dlmlock.save
-      assert dlmlock.release!(host)
-      assert_equal ['callback2'], host.callbacks
-    end
-
-    test 'triggers no callbacks on release attempt by other host' do
-      assert host1_with_callbacks
-      assert host2_with_callbacks
-      dlmlock.update(:host => host1_with_callbacks)
-      assert_equal false, dlmlock.release!(host2_with_callbacks)
-      assert_equal [], host1_with_callbacks.callbacks
-      assert_equal [], host2_with_callbacks.callbacks
-    end
-
-    test 'triggers no callbacks on acquiry attempt by owner' do
-      assert host1_with_callbacks
-      dlmlock.update(:host => host1_with_callbacks)
-      assert dlmlock.acquire!(host1_with_callbacks)
-      assert_equal [], host1_with_callbacks.callbacks
-    end
-  end
-
-  context 'scoped search' do
-    test 'can be searched by name' do
-      dlmlock = FactoryBot.create(:dlmlock)
-      assert_equal Dlmlock::Update.find(dlmlock.id), Dlmlock.search_for("name ~ #{dlmlock.name}").first
-    end
-  end
-end