api: Make a Log from other model changes.

Refs #2375.

diff --git a/services/api/app/models/arvados_model.rb b/services/api/app/models/arvados_model.rb
index 38c7a797d164d0a3b984246d89ae6a2f91263aa7..731eecf8381e9c5c81f4782c46d1e1a5d5aecd54 100644 (file)
--- a/services/api/app/models/arvados_model.rb
+++ b/services/api/app/models/arvados_model.rb
@@ -8,11 +8,15 @@ class ArvadosModel < ActiveRecord::Base
   attr_protected :modified_by_user_uuid
   attr_protected :modified_by_client_uuid
   attr_protected :modified_at
+  after_initialize :log_start_state
   before_create :ensure_permission_to_create
   before_update :ensure_permission_to_update
   before_destroy :ensure_permission_to_destroy
   before_create :update_modified_by_fields
   before_update :maybe_update_modified_by_fields
+  around_create { |&block| make_log_around(:create, nil, self, &block) }
+  around_update { |&block| make_log_around(:update, self, self, &block) }
+  around_destroy { |&block| make_log_around(:destroy, self, nil, &block) }
   validate :ensure_serialized_attribute_type
   validate :normalize_collection_uuids
 
@@ -210,4 +214,24 @@ class ArvadosModel < ActiveRecord::Base
     nil
   end
 
+  def log_start_state
+    @old_etag = etag
+    @old_attributes = attributes
+  end
+
+  def make_log_around(event_type, old_thing, new_thing)
+    if self.is_a? Log
+      yield
+    else
+      log = Log.start_from(old_thing, event_type.to_s)
+      if not old_thing.nil?
+        log.properties['old_etag'] = @old_etag
+        log.properties['old_attributes'] = @old_attributes
+      end
+      yield
+      log.update_to new_thing
+      log_start_state
+      log.save
+    end
+  end
 end

diff --git a/services/api/app/models/log.rb b/services/api/app/models/log.rb
index 94967605ca1e73f007adb8a860009ef362cc6bdd..08038db553307fb129fae27b63ff56b7a9f826b5 100644 (file)
--- a/services/api/app/models/log.rb
+++ b/services/api/app/models/log.rb
@@ -4,6 +4,7 @@ class Log < ArvadosModel
   include CommonApiTemplate
   serialize :properties, Hash
   before_validation :set_default_event_at
+  before_save { self.owner_uuid = self.system_user_uuid }
   attr_accessor :object
 
   api_accessible :user, extend: :common do |t|
@@ -16,8 +17,53 @@ class Log < ArvadosModel
     t.add :properties
   end
 
+  def self.start_from(thing, event_type)
+    self.new do |log|
+      log.event_type = event_type
+      log.properties = {
+        'old_etag' => nil,
+        'old_attributes' => nil,
+      }
+      log.seed_basics_from thing
+    end
+  end
+
+  def update_to(thing)
+    self.seed_basics_from thing
+    self.properties["new_etag"] = thing.andand.etag
+    self.properties["new_attributes"] = thing.andand.attributes
+    case self.event_type
+    when "create"
+      self.event_at = thing.created_at
+    when "update"
+      self.event_at = thing.modified_at
+    when "destroy"
+      self.event_at = Time.now
+    end
+  end
+
+  def seed_basics_from(thing)
+    if not thing.nil?
+      self.object_kind ||= thing.kind
+      self.object_uuid ||= thing.uuid
+      self.summary ||= "#{self.event_type} of #{thing.uuid}"
+    end
+  end
+
   protected
 
+  def permission_to_create
+    true
+  end
+
+  def permission_to_update
+    false
+  end
+
+  def permission_to_destroy
+    false
+  end
+
   def set_default_event_at
     self.event_at ||= Time.now
   end

diff --git a/services/api/test/unit/log_test.rb b/services/api/test/unit/log_test.rb
index f2afee2dc91a37e88e03b9ea802b9531d9d17d2f..1554e0afec6515884276ec5ae355209851feba9c 100644 (file)
--- a/services/api/test/unit/log_test.rb
+++ b/services/api/test/unit/log_test.rb
@@ -1,7 +1,139 @@
 require 'test_helper'
 
 class LogTest < ActiveSupport::TestCase
-  # test "the truth" do
-  #   assert true
-  # end
+  include CurrentApiClient
+
+  EVENT_TEST_METHODS = {
+    :create => [:created_at, :assert_nil, :assert_not_nil],
+    :update => [:modified_at, :assert_not_nil, :assert_not_nil],
+    :destroy => [nil, :assert_not_nil, :assert_nil],
+  }
+
+  def setup
+    @start_time = Time.now
+    @log_count = 1
+  end
+
+  def assert_properties(test_method, event, props, *keys)
+    verb = (test_method == :assert_nil) ? 'not include' : 'include'
+    keys.each do |prop_name|
+      self.send(test_method, props[prop_name],
+                "#{event.to_s} log should #{verb} #{prop_name}")
+    end
+  end
+
+  def assert_logged(thing, event_type)
+    logs = Log.where(object_uuid: thing.uuid).order("created_at ASC").all
+    assert_equal(@log_count, logs.size, "log count mismatch")
+    @log_count += 1
+    log = logs.last
+    props = log.properties
+    assert_equal(system_user_uuid, log.owner_uuid,
+                 "log is not owned by system user")
+    assert_equal(current_user.andand.uuid, log.modified_by_user_uuid,
+                 "log is not 'modified by' current user")
+    assert_equal(current_api_client.andand.uuid, log.modified_by_client_uuid,
+                 "log is not 'modified by' current client")
+    assert_equal(thing.kind, log.object_kind, "log kind mismatch")
+    assert_equal(thing.uuid, log.object_uuid, "log UUID mismatch")
+    assert_equal(event_type.to_s, log.event_type, "log event type mismatch")
+    time_method, old_props_test, new_props_test = EVENT_TEST_METHODS[event_type]
+    if time_method.nil? or (timestamp = thing.send(time_method)).nil?
+      assert(log.event_at >= @start_time, "log timestamp too old")
+    else
+      assert_in_delta(timestamp, log.event_at, 1, "log timestamp mismatch")
+    end
+    assert_properties(old_props_test, event_type, props,
+                      'old_etag', 'old_attributes')
+    assert_properties(new_props_test, event_type, props,
+                      'new_etag', 'new_attributes')
+    yield props if block_given?
+  end
+
+  def set_user_from_auth(auth_name)
+    client_auth = api_client_authorizations(auth_name)
+    Thread.current[:api_client_authorization] = client_auth
+    Thread.current[:api_client] = client_auth.api_client
+    Thread.current[:user] = client_auth.user
+  end
+
+  test "creating a user makes a log" do
+    set_user_from_auth :admin_trustedclient
+    u = User.new(first_name: "Log", last_name: "Test")
+    u.save!
+    assert_logged(u, :create) do |props|
+      assert_equal(u.etag, props['new_etag'], "new user etag mismatch")
+      assert_equal(u.first_name, props['new_attributes']['first_name'],
+                   "new user first name mismatch")
+      assert_equal(u.last_name, props['new_attributes']['last_name'],
+                   "new user first name mismatch")
+    end
+  end
+
+  test "updating a virtual machine makes a log" do
+    set_user_from_auth :admin_trustedclient
+    vm = virtual_machines(:testvm)
+    orig_etag = vm.etag
+    vm.hostname = 'testvm.testshell'
+    vm.save!
+    assert_logged(vm, :update) do |props|
+      assert_equal(orig_etag, props['old_etag'], "updated VM old etag mismatch")
+      assert_equal(vm.etag, props['new_etag'], "updated VM new etag mismatch")
+      assert_equal('testvm.shell', props['old_attributes']['hostname'],
+                   "updated VM old name mismatch")
+      assert_equal('testvm.testshell', props['new_attributes']['hostname'],
+                   "updated VM new name mismatch")
+    end
+  end
+
+  test "destroying an authorization makes a log" do
+    set_user_from_auth :admin_trustedclient
+    auth = api_client_authorizations(:spectator)
+    orig_etag = auth.etag
+    orig_attrs = auth.attributes
+    auth.destroy
+    assert_logged(auth, :destroy) do |props|
+      assert_equal(orig_etag, props['old_etag'], "destroyed auth etag mismatch")
+      assert_equal(orig_attrs, props['old_attributes'],
+                   "destroyed auth attributes mismatch")
+    end
+  end
+
+  test "saving an unchanged client still makes a log" do
+    set_user_from_auth :admin_trustedclient
+    client = api_clients(:untrusted)
+    client.is_trusted = client.is_trusted
+    client.save!
+    assert_logged(client, :update) do |props|
+      ['old', 'new'].each do |age|
+        assert_equal(client.etag, props["#{age}_etag"],
+                     "unchanged client #{age} etag mismatch")
+        assert_equal(client.attributes, props["#{age}_attributes"],
+                     "unchanged client #{age} attributes mismatch")
+      end
+    end
+  end
+
+  test "updating a group twice makes two logs" do
+    set_user_from_auth :admin_trustedclient
+    group = groups(:empty_lonely_group)
+    name1 = group.name
+    name2 = "#{name1} under test"
+    group.name = name2
+    group.save!
+    assert_logged(group, :update) do |props|
+      assert_equal(name1, props['old_attributes']['name'],
+                   "group start name mismatch")
+      assert_equal(name2, props['new_attributes']['name'],
+                   "group updated name mismatch")
+    end
+    group.name = name1
+    group.save!
+    assert_logged(group, :update) do |props|
+      assert_equal(name2, props['old_attributes']['name'],
+                   "group pre-revert name mismatch")
+      assert_equal(name1, props['new_attributes']['name'],
+                   "group final name mismatch")
+    end
+  end
 end