[ARVADOS] created: 54978ac2108a5b1913f641d480143356659a413a
git at public.curoverse.com
git at public.curoverse.com
Tue Apr 8 16:42:21 EDT 2014
at 54978ac2108a5b1913f641d480143356659a413a (commit)
commit 54978ac2108a5b1913f641d480143356659a413a
Author: Brett Smith <brett at curoverse.com>
Date: Tue Apr 8 16:18:46 2014 -0400
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 38c7a79..731eecf 100644
--- 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 9496760..08038db 100644
--- 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 f2afee2..1554e0a 100644
--- 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
commit 19f8cc45bfbe938c0988a719a146a577c2ca7ca5
Author: Brett Smith <brett at curoverse.com>
Date: Mon Apr 7 14:54:06 2014 -0400
api: Rename Log.info to .properties.
Refs #2375.
diff --git a/services/api/app/models/log.rb b/services/api/app/models/log.rb
index 29efc9d..9496760 100644
--- a/services/api/app/models/log.rb
+++ b/services/api/app/models/log.rb
@@ -2,7 +2,7 @@ class Log < ArvadosModel
include AssignUuid
include KindAndEtag
include CommonApiTemplate
- serialize :info, Hash
+ serialize :properties, Hash
before_validation :set_default_event_at
attr_accessor :object
@@ -13,7 +13,7 @@ class Log < ArvadosModel
t.add :event_at
t.add :event_type
t.add :summary
- t.add :info
+ t.add :properties
end
protected
diff --git a/services/api/db/migrate/20140407184311_rename_log_info_to_properties.rb b/services/api/db/migrate/20140407184311_rename_log_info_to_properties.rb
new file mode 100644
index 0000000..06561c5
--- /dev/null
+++ b/services/api/db/migrate/20140407184311_rename_log_info_to_properties.rb
@@ -0,0 +1,5 @@
+class RenameLogInfoToProperties < ActiveRecord::Migration
+ def change
+ rename_column :logs, :info, :properties
+ end
+end
diff --git a/services/api/db/schema.rb b/services/api/db/schema.rb
index fe31666..2ef90d2 100644
--- a/services/api/db/schema.rb
+++ b/services/api/db/schema.rb
@@ -11,18 +11,18 @@
#
# It's strongly recommended to check this file into your version control system.
-ActiveRecord::Schema.define(:version => 20140402001908) do
+ActiveRecord::Schema.define(:version => 20140407184311) do
create_table "api_client_authorizations", :force => true do |t|
- t.string "api_token", :null => false
- t.integer "api_client_id", :null => false
- t.integer "user_id", :null => false
+ t.string "api_token", :null => false
+ t.integer "api_client_id", :null => false
+ t.integer "user_id", :null => false
t.string "created_by_ip_address"
t.string "last_used_by_ip_address"
t.datetime "last_used_at"
t.datetime "expires_at"
- t.datetime "created_at", :null => false
- t.datetime "updated_at", :null => false
+ t.datetime "created_at", :null => false
+ t.datetime "updated_at", :null => false
t.string "default_owner_uuid"
t.text "scopes", :default => "---\n- all\n", :null => false
end
@@ -70,7 +70,7 @@ ActiveRecord::Schema.define(:version => 20140402001908) do
create_table "collections", :force => true do |t|
t.string "locator"
t.string "owner_uuid"
- t.datetime "created_at"
+ t.datetime "created_at", :null => false
t.string "modified_by_client_uuid"
t.string "modified_by_user_uuid"
t.datetime "modified_at"
@@ -80,7 +80,7 @@ ActiveRecord::Schema.define(:version => 20140402001908) do
t.string "redundancy_confirmed_by_client_uuid"
t.datetime "redundancy_confirmed_at"
t.integer "redundancy_confirmed_as"
- t.datetime "updated_at"
+ t.datetime "updated_at", :null => false
t.string "uuid"
t.text "manifest_text"
end
@@ -104,8 +104,8 @@ ActiveRecord::Schema.define(:version => 20140402001908) do
t.string "repository_name"
t.string "sha1"
t.string "message"
- t.datetime "created_at"
- t.datetime "updated_at"
+ t.datetime "created_at", :null => false
+ t.datetime "updated_at", :null => false
end
add_index "commits", ["repository_name", "sha1"], :name => "index_commits_on_repository_name_and_sha1", :unique => true
@@ -133,8 +133,8 @@ ActiveRecord::Schema.define(:version => 20140402001908) do
t.string "modified_by_user_uuid"
t.datetime "modified_at"
t.text "properties"
- t.datetime "created_at"
- t.datetime "updated_at"
+ t.datetime "created_at", :null => false
+ t.datetime "updated_at", :null => false
end
add_index "humans", ["uuid"], :name => "index_humans_on_uuid", :unique => true
@@ -235,7 +235,7 @@ ActiveRecord::Schema.define(:version => 20140402001908) do
create_table "links", :force => true do |t|
t.string "uuid"
t.string "owner_uuid"
- t.datetime "created_at"
+ t.datetime "created_at", :null => false
t.string "modified_by_client_uuid"
t.string "modified_by_user_uuid"
t.datetime "modified_at"
@@ -245,7 +245,7 @@ ActiveRecord::Schema.define(:version => 20140402001908) do
t.string "name"
t.string "head_uuid"
t.text "properties"
- t.datetime "updated_at"
+ t.datetime "updated_at", :null => false
t.string "head_kind"
end
@@ -267,7 +267,7 @@ ActiveRecord::Schema.define(:version => 20140402001908) do
t.datetime "event_at"
t.string "event_type"
t.text "summary"
- t.text "info"
+ t.text "properties"
t.datetime "created_at", :null => false
t.datetime "updated_at", :null => false
t.datetime "modified_at"
@@ -308,7 +308,7 @@ ActiveRecord::Schema.define(:version => 20140402001908) do
create_table "pipeline_instances", :force => true do |t|
t.string "uuid"
t.string "owner_uuid"
- t.datetime "created_at"
+ t.datetime "created_at", :null => false
t.string "modified_by_client_uuid"
t.string "modified_by_user_uuid"
t.datetime "modified_at"
@@ -317,7 +317,7 @@ ActiveRecord::Schema.define(:version => 20140402001908) do
t.text "components"
t.boolean "success"
t.boolean "active", :default => false
- t.datetime "updated_at"
+ t.datetime "updated_at", :null => false
t.text "properties"
end
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list