dbaudit

README

dbaudit

Module for tracking create and update audit attributes for database records

Documentation

Index

• type Audit
  • func NewForCreate(client *client.Client, user *usr.User) *Audit
  • func NewFromContext(ctx context.Context) (*Audit, error)
  • func TestDBAuditHelper(t *testing.T) *Audit
  • func (a Audit) Valid() bool

Types

type Audit

type Audit struct {
	CreateClient    client.Client
	CreateUser      usr.User
	CreateTimestamp time.Time
	UpdateClient    client.Client
	UpdateUser      usr.User
	UpdateTimestamp time.Time
}

Audit represents fields meant to track when an action was taken and by whom

func NewForCreate

func NewForCreate(client *client.Client, user *usr.User) *Audit

NewForCreate is a constructor that takes a Client and User and populates CreateClient, CreateUser, UpdateClient and UpdateUser (as they all should be the same)

func NewFromContext

func NewFromContext(ctx context.Context) (*Audit, error)

NewFromContext is a constructor that takes a Client and User set to the Context and populates CreateClient, CreateUser, UpdateClient and UpdateUser (as they all should be the same for creates)

func TestDBAuditHelper

func TestDBAuditHelper(t *testing.T) *Audit

TestDBAuditHelper is a constructor for a dbAudit struct populating it with test data

func (Audit) Valid

func (a Audit) Valid() bool

Valid ensures that CreateClient, CreateUser, UpdateClient and UpdateUser are populated