Commit 1970c7ed authored by Tan Le's avatar Tan Le Committed by Dylan Griffith

Add internal YARD doc for public interface

Aid developer in future work with this mega class.
parent 4caa2f25
# frozen_string_literal: true
class AuditEventService
# Instantiates a new service
#
# @param author [User] the user who authors the change
# @param entity [Object] an instance of either Project/Group/User type. This
# param is also used to determine at which level the audit events are
# shown.
# - Project: events are visible at Project level
# - Group: events are visible at Group level
# - User: events are visible at Instance level
# @param details [Hash] details to be added to audit event
#
# @return [AuditEventService]
def initialize(author, entity, details = {})
@author, @entity, @details = author, entity, details
@author = author
@entity = entity
@details = details
end
# Builds the @details attribute for authentication
#
# This uses the @author as the target object being changed
#
# @return [AuditEventService]
def for_authentication
@details = {
with: @details[:with],
......@@ -16,11 +35,15 @@ class AuditEventService
self
end
# Writes event to a file and creates an event record in DB
#
# @return [SecurityEvent] persited if saves and non-persisted if fails
def security_event
log_security_event_to_file
log_security_event_to_database
end
# Writes event to a file
def log_security_event_to_file
file_logger.info(base_payload.merge(formatted_details))
end
......
......@@ -4,6 +4,11 @@ module EE
module AuditEventService
extend ::Gitlab::Utils::Override
# rubocop:disable Gitlab/ModuleWithInstanceVariables
# Builds the @details attribute for member
#
# @param member [Member] the member whom is changed
# @return [AuditEventService]
def for_member(member)
action = @details[:action]
old_access_level = @details[:old_access_level]
......@@ -56,6 +61,14 @@ module EE
self
end
# Builds the @details attribute for project group link
#
# This expects [String] :action of :destroy, :create, :update to be
# specified in @details attribute
#
# @param group_link [ProjectGroupLink] the project group link being changed
#
# @return [AuditEventService]
def for_project_group_link(group_link)
@details = custom_project_link_group_attributes(group_link)
.merge(author_name: @author.name,
......@@ -66,6 +79,9 @@ module EE
self
end
# Builds the @details attribute for a failed login
#
# @return [AuditEventService]
def for_failed_login
ip = @details[:ip_address]
auth = @details[:with] || 'STANDARD'
......@@ -80,6 +96,9 @@ module EE
self
end
# Builds the @details attribute for changes
#
# @return [AuditEventService]
def for_changes
@details =
{
......@@ -91,9 +110,11 @@ module EE
target_type: @entity.class.name,
target_details: @details[:target_details] || @entity.name
}
self
end
# Write event to file and create an event record in DB
def security_event
prepare_security_event
......@@ -106,6 +127,10 @@ module EE
end
end
# Creates an event record in DB
#
# @return [nil] if audit events is not enabled
# @return [SecurityEvent] if record is persisted
def unauth_security_event
return unless audit_events_enabled?
......@@ -120,14 +145,33 @@ module EE
)
end
# Builds the @details attribute for user
#
# This uses the [User] @entity as the target object being changed
#
# @param full_path [String] required if it is different from the User model
# in @entity. This is for backward compatability and this parameter will
# be dropped after all of these incorrect usages are removed.
#
# @return [AuditEventService]
def for_user(full_path = @entity.full_path)
for_custom_model('user', full_path)
end
# Builds the @details attribute for project
#
# This uses the [Project] @entity as the target object being changed
#
# @return [AuditEventService]
def for_project
for_custom_model('project', @entity.full_path)
end
# Builds the @details attribute for group
#
# This uses the [Group] @entity as the target object being changed
#
# @return [AuditEventService]
def for_group
for_custom_model('group', @entity.full_path)
end
......
......@@ -68,30 +68,4 @@ describe EE::AuditEvents::ProtectedBranchAuditEventService do
end
end
end
describe '#enabled?' do
let(:service) { described_class.new(author, protected_branch, :any) }
subject { service.enabled? }
context 'when not licensed' do
before do
stub_licensed_features(audit_events: false,
extended_audit_events: false,
admin_audit_log: false)
end
it { is_expected.to be(false) }
end
context 'when licensed' do
before do
stub_licensed_features(audit_events: true,
extended_audit_events: false,
admin_audit_log: false)
end
it { is_expected.to be(true) }
end
end
end
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment