admin

Documentation

Index

• type DefaultHandler
  • func (DefaultHandler) InitHandler(ctx context.Context, db *gorm.DB) error
  • func (DefaultHandler) ResetHandler(ctx context.Context, db *gorm.DB) error
  • func (DefaultHandler) SetIdentityHandler(ctx context.Context, db *gorm.DB, request SetIdentityRequest) error
• type Handler
• type MockAdmin
  • func (m *MockAdmin) InitHandler(ctx context.Context, db *gorm.DB) error
  • func (m *MockAdmin) ResetHandler(ctx context.Context, db *gorm.DB) error
  • func (m *MockAdmin) SetIdentityHandler(ctx context.Context, db *gorm.DB, request SetIdentityRequest) error
• type SetIdentityRequest

Types

type DefaultHandler

type DefaultHandler struct{}

func (DefaultHandler) InitHandler

func (DefaultHandler) InitHandler(ctx context.Context, db *gorm.DB) error

InitHandler initializes the database by running migrations on the provided db instance. It ensures the database schema matches the expected schema defined in the model.

Parameters:

• db: A pointer to the gorm.DB instance representing the database connection.

Returns:

• An error, if any occurred during the operation.

func (DefaultHandler) ResetHandler

func (DefaultHandler) ResetHandler(ctx context.Context, db *gorm.DB) error

ResetHandler resets the database by dropping all existing tables and then recreating them using migrations defined in the model.

It's generally used during testing or for complete system resets, and caution should be exercised before invoking it in a production environment.

Parameters:

• db: A pointer to the gorm.DB instance representing the database connection.

Returns:

• An error, if any occurred during the operation.

func (DefaultHandler) SetIdentityHandler

func (DefaultHandler) SetIdentityHandler(ctx context.Context, db *gorm.DB, request SetIdentityRequest) error

type Handler

type Handler interface {
	InitHandler(ctx context.Context, db *gorm.DB) error
	ResetHandler(ctx context.Context, db *gorm.DB) error
	SetIdentityHandler(ctx context.Context, db *gorm.DB, request SetIdentityRequest) error
}

var Default Handler = &DefaultHandler{}

type MockAdmin

type MockAdmin struct {
	mock.Mock
}

func (*MockAdmin) InitHandler

func (m *MockAdmin) InitHandler(ctx context.Context, db *gorm.DB) error

func (*MockAdmin) ResetHandler

func (m *MockAdmin) ResetHandler(ctx context.Context, db *gorm.DB) error

func (*MockAdmin) SetIdentityHandler

func (m *MockAdmin) SetIdentityHandler(ctx context.Context, db *gorm.DB, request SetIdentityRequest) error

type SetIdentityRequest

type SetIdentityRequest struct {
	Identity string `json:"identity"`
}