lime

README

lime

lime is the garnish for your Gin Gonic project.

Documentation

Index

• func AssertPanic(t *testing.T, f func())
• func DatabaseProvider(config *DatabaseConfiguration) *gorm.DB
• type Application
  • func NewApplication(databaseConfiguration *DatabaseConfiguration, ...) *Application
  • func (app *Application) Configure()
  • func (app *Application) IsRunning() bool
  • func (app *Application) Start() error
  • func (app *Application) Stop()
• type AtomicBool
• type CorsConfiguration
• type DatabaseConfiguration
• type DatabaseStarter
  • func (ds *DatabaseStarter) Start() *gorm.DB
• type LogConfiguration
• type LogLevel
• type Logger
  • func NewLogger(name string) *Logger
  • func (l *Logger) Debug() *zerolog.Event
  • func (l *Logger) Error() *zerolog.Event
  • func (l *Logger) Fatal() *zerolog.Event
  • func (l *Logger) Info() *zerolog.Event
  • func (l *Logger) Warn() *zerolog.Event
• type RoutedController
• type Router
  • func (r *Router) RegisterRoutes(engine *gin.Engine)
• type RouterFactory
• type RuntimeContext
• type TestAfterStart
• type TestContext
  • func NewTestContext(database *DatabaseConfiguration, routerFactory RouterFactory) *TestContext
  • func (ctx *TestContext) CreateEntity(value interface{}) error
  • func (ctx *TestContext) Perform(req *http.Request) *httptest.ResponseRecorder
  • func (ctx *TestContext) RunTest(t *testing.T, postStartCall TestAfterStart)

Functions

func AssertPanic

func AssertPanic(t *testing.T, f func())

func DatabaseProvider

func DatabaseProvider(config *DatabaseConfiguration) *gorm.DB

Types

type Application

type Application struct {
	// contains filtered or unexported fields
}

func NewApplication

func NewApplication(
	databaseConfiguration *DatabaseConfiguration,
	corsConfiguration *CorsConfiguration,
	logConfiguration *LogConfiguration,
	routerFactory RouterFactory,
) *Application

func (*Application) Configure

func (app *Application) Configure()

func (*Application) IsRunning

func (app *Application) IsRunning() bool

func (*Application) Start

func (app *Application) Start() error

func (*Application) Stop

func (app *Application) Stop()

type AtomicBool

type AtomicBool int32

type CorsConfiguration

type CorsConfiguration struct {
	AllowOrigins []string
}

type DatabaseConfiguration

type DatabaseConfiguration struct {
	DSN     string
	Connect connect
	Models  []interface{}
}

type DatabaseStarter

type DatabaseStarter struct {
	Configuration *DatabaseConfiguration
	// contains filtered or unexported fields
}

func (*DatabaseStarter) Start

func (ds *DatabaseStarter) Start() *gorm.DB

type LogConfiguration

type LogConfiguration struct {
	GlobalLevel LogLevel
}

type LogLevel

type LogLevel zerolog.Level

const (
	DebugLevel LogLevel = LogLevel(zerolog.DebugLevel)
	InfoLevel  LogLevel = LogLevel(zerolog.InfoLevel)
	WarnLevel  LogLevel = LogLevel(zerolog.WarnLevel)
	ErrorLevel LogLevel = LogLevel(zerolog.ErrorLevel)
	FatalLevel LogLevel = LogLevel(zerolog.FatalLevel)
	PanicLevel LogLevel = LogLevel(zerolog.PanicLevel)
	NoLevel    LogLevel = LogLevel(zerolog.NoLevel)
	Disabled   LogLevel = LogLevel(zerolog.Disabled)
	TraceLevel LogLevel = LogLevel(zerolog.TraceLevel)
)

type Logger

type Logger struct {
	// contains filtered or unexported fields
}

func NewLogger

func NewLogger(name string) *Logger

func (*Logger) Debug

func (l *Logger) Debug() *zerolog.Event

func (*Logger) Error

func (l *Logger) Error() *zerolog.Event

func (*Logger) Fatal

func (l *Logger) Fatal() *zerolog.Event

func (*Logger) Info

func (l *Logger) Info() *zerolog.Event

func (*Logger) Warn

func (l *Logger) Warn() *zerolog.Event

type RoutedController

type RoutedController interface {
	Register(engine *gin.Engine)
}

type Router

type Router struct {
	Routes []RoutedController
}

func (*Router) RegisterRoutes

func (r *Router) RegisterRoutes(engine *gin.Engine)

type RouterFactory

type RouterFactory func(runtime *RuntimeContext) *Router

type RuntimeContext

type RuntimeContext struct {
	// contains filtered or unexported fields
}

type TestAfterStart

type TestAfterStart func(t *testing.T)

type TestContext

type TestContext struct {
	// contains filtered or unexported fields
}

func NewTestContext

func NewTestContext(database *DatabaseConfiguration, routerFactory RouterFactory) *TestContext

func (*TestContext) CreateEntity

func (ctx *TestContext) CreateEntity(value interface{}) error

func (*TestContext) Perform

func (ctx *TestContext) Perform(req *http.Request) *httptest.ResponseRecorder

func (*TestContext) RunTest

func (ctx *TestContext) RunTest(t *testing.T, postStartCall TestAfterStart)