duty

README

duty

Duty (Database Utility) is a home for common database tools, models and helpers used within the mission control suite of projects.

Duty wraps the awesome atlas library, and copies some of its code to make use of internal functions.

Running Tests

1. make test will run tests against a new embedded postgres instance

If you set DUTY_DB_URL environment variable to the postgres db, each test will run against a new database called duty_gingko

Documentation

Index

• Variables
• func BindFlags(flags *pflag.FlagSet)
• func BindGoFlags()
• func CheckSummary(ctx context.Context, checkID string) (*models.CheckSummary, error)
• func DefaultGormConfig() *gorm.Config
• func Delete(ctx dutyContext.Context, model Table) error
• func GetComponent(ctx gocontext.Context, db *gorm.DB, id string) (*models.Component, error)
• func GetConfigMapFromCache(c kubernetes.Interface, namespace, name, key string) (string, error)
• func GetEnvStringFromCache(c kubernetes.Interface, env string, namespace string) (string, error)
• func GetEnvValueFromCache(c kubernetes.Interface, input types.EnvVar, namespace string) (string, error)
• func GetSecretFromCache(c kubernetes.Interface, namespace, name, key string) (string, error)
• func HasMigrationsRun(ctx context.Context, pool *pgxpool.Pool) (bool, error)
• func InitDB(connection string, migrateOpts *migrate.MigrateOptions) (*dutyContext.Context, error)
• func IsForeignKeyError(err error) bool
• func LookupComponents(ctx context.Context, lookup LookupSpec, labels map[string]string, ...) ([]uuid.UUID, error)
• func LookupConfigs(ctx context.Context, lookup LookupSpec, labels map[string]string, ...) ([]uuid.UUID, error)
• func Migrate(connection string, opts *migrate.MigrateOptions) error
• func NewDB(connection string) (*sql.DB, error)
• func NewGorm(connection string, config *gorm.Config) (*gorm.DB, error)
• func NewPgxPool(connection string) (*pgxpool.Pool, error)
• func Now() clause.Expr
• func QueryCheckSummary(ctx context.Context, dbpool *pgxpool.Pool, opts ...query.CheckSummaryOptions) ([]models.CheckSummary, error)
• func SetupDB(connection string, migrateOpts *migrate.MigrateOptions) (gormDB *gorm.DB, pgxpool *pgxpool.Pool, err error)
• type FindOption
  • func PickColumns(columns ...string) FindOption
  • func WhereClause(query any, args ...any) FindOption
• type Lookup
  • func (t *Lookup) Empty() bool
  • func (t *Lookup) Eval(labels map[string]string, envVar map[string]any) (string, error)
• type LookupEvalResult
• type LookupSpec
  • func (t *LookupSpec) Eval(labels map[string]string, envVar map[string]any) (*LookupEvalResult, error)
• type Table
• type TopologyOptions
• type TopologyResponse
  • func QueryTopology(ctx gocontext.Context, dbpool *pgxpool.Pool, params TopologyOptions) (*TopologyResponse, error)

Variables

var DefaultQueryTimeout = 30 * time.Second

var LocalFilter = "deleted_at is NULL AND agent_id = '00000000-0000-0000-0000-000000000000' OR agent_id IS NULL"

var LogLevel string

LogLevel is the log level for gorm logger

Functions

func BindFlags

func BindFlags(flags *pflag.FlagSet)

func BindGoFlags

func BindGoFlags()

func CheckSummary

func CheckSummary(ctx context.Context, checkID string) (*models.CheckSummary, error)

deprecated use query.CheckSummaryByID

func DefaultGormConfig

func DefaultGormConfig() *gorm.Config

func Delete

func Delete(ctx dutyContext.Context, model Table) error

func GetComponent

func GetComponent(ctx gocontext.Context, db *gorm.DB, id string) (*models.Component, error)

deprecated use query.GetComponent

func GetConfigMapFromCache

func GetConfigMapFromCache(c kubernetes.Interface, namespace, name, key string) (string, error)

deprecated use the methods in the context package

func GetEnvStringFromCache

func GetEnvStringFromCache(c kubernetes.Interface, env string, namespace string) (string, error)

deprecated use the methods in the context package

func GetEnvValueFromCache

func GetEnvValueFromCache(c kubernetes.Interface, input types.EnvVar, namespace string) (string, error)

deprecated use the methods in the context package

func GetSecretFromCache

func GetSecretFromCache(c kubernetes.Interface, namespace, name, key string) (string, error)

deprecated use the methods in the context package

func HasMigrationsRun

func HasMigrationsRun(ctx context.Context, pool *pgxpool.Pool) (bool, error)

HasMigrationsRun performs a rudimentary check to see if the migrations have run at least once.

func InitDB

func InitDB(connection string, migrateOpts *migrate.MigrateOptions) (*dutyContext.Context, error)

func IsForeignKeyError

func IsForeignKeyError(err error) bool

func LookupComponents

func LookupComponents(ctx context.Context, lookup LookupSpec, labels map[string]string, env map[string]any) ([]uuid.UUID, error)

func LookupConfigs

func LookupConfigs(ctx context.Context, lookup LookupSpec, labels map[string]string, env map[string]any) ([]uuid.UUID, error)

func Migrate

func Migrate(connection string, opts *migrate.MigrateOptions) error

func NewDB

func NewDB(connection string) (*sql.DB, error)

func NewGorm

func NewGorm(connection string, config *gorm.Config) (*gorm.DB, error)

creates a new Gorm DB connection using the global pgx connection pool, must be called after NewPgxPool

func NewPgxPool

func NewPgxPool(connection string) (*pgxpool.Pool, error)

func Now

func Now() clause.Expr

func QueryCheckSummary

func QueryCheckSummary(ctx context.Context, dbpool *pgxpool.Pool, opts ...query.CheckSummaryOptions) ([]models.CheckSummary, error)

deprecated use query.CheckSummary

func SetupDB

func SetupDB(connection string, migrateOpts *migrate.MigrateOptions) (gormDB *gorm.DB, pgxpool *pgxpool.Pool, err error)

SetupDB runs migrations for the connection and returns a gorm.DB and a pgxpool.Pool

Types

type FindOption

type FindOption func(db *gorm.DB)

func PickColumns

func PickColumns(columns ...string) FindOption

func WhereClause

func WhereClause(query any, args ...any) FindOption

type Lookup

type Lookup struct {
	// Expr is a cel-expression.
	Expr string `json:"expr,omitempty" yaml:"expr,omitempty"`
	// Value is the static value to use.
	Value string `json:"value,omitempty" yaml:"value,omitempty"`
	// Label specifies the key to lookup on the label.
	Label string `json:"label,omitempty" yaml:"label,omitempty"`
}

Lookup specifies the type of lookup to perform.

func (*Lookup) Empty

func (t *Lookup) Empty() bool

func (*Lookup) Eval

func (t *Lookup) Eval(labels map[string]string, envVar map[string]any) (string, error)

type LookupEvalResult

type LookupEvalResult struct {
	Name      string
	Namespace string
	Type      string
}

LookupEvalResult is the result of evaluation of a LookupSpec.

type LookupSpec

type LookupSpec struct {
	Name      Lookup `json:"name,omitempty" yaml:"name,omitempty"`
	Namespace Lookup `json:"namespace,omitempty" yaml:"namespace,omitempty"`
	Type      Lookup `json:"type,omitempty" yaml:"type,omitempty"`
}

LookupSpec defines a tuple of fields to lookup.

func (*LookupSpec) Eval

func (t *LookupSpec) Eval(labels map[string]string, envVar map[string]any) (*LookupEvalResult, error)

Eval evaluates all the fields in the lookup spec based on labels and environment variables. Returns nil if any non-empty lookup evaluates to an empty value.

type Table

type Table interface {
	TableName() string
}

type TopologyOptions

type TopologyOptions = query.TopologyOptions

type TopologyResponse

type TopologyResponse = query.TopologyResponse

func QueryTopology

func QueryTopology(ctx gocontext.Context, dbpool *pgxpool.Pool, params TopologyOptions) (*TopologyResponse, error)

deprecated use query.Topology