utils

Documentation

Index

• func AuthedRequest(req *http.Request) (*http.Request, error)
• func CorsMiddleware(ctx huma.Context, next func(huma.Context))
• func FailOnError(err error, msg string)
• func GetDelLogTags(msg *amqp.Delivery) string
• func LoadConfig()
• func LogResponse(ctx context.Context, resp *http.Response, req *http.Request)
• func LogWithContext(ctx context.Context, msg ...string)
• func MockLoadConfig()
• func OidcMiddleware(ctx huma.Context, next func(huma.Context))
• func PrettyPrint(i interface{}) string
• func RegisterOidcProvider(ctx context.Context)
• func SendRequest(ctx context.Context, method string, sendUrl string, pBody *bytes.Reader, ...) (*http.Response, error)
• func TraceTagList(ctx context.Context) []string
• func TraceTags(ctx context.Context) string
• type ClientClaims
  • func Authorize(w http.ResponseWriter, r *http.Request, allowedMethods []string, ...) (claims *ClientClaims, err error)
  • func ValidateToken(ctx context.Context, tokenString string) (claims *ClientClaims, err error)
• type ConfigValues
  • func MockConfig() ConfigValues
  • func (c *ConfigValues) GetGenXchange() string
  • func (c *ConfigValues) GetLoggerLevel() slog.Level
  • func (c *ConfigValues) GetMqUrl() string
  • func (c *ConfigValues) GetProgXchange() string

Functions

func AuthedRequest

func AuthedRequest(req *http.Request) (*http.Request, error)

Add the auth header to a request

func CorsMiddleware

func CorsMiddleware(ctx huma.Context, next func(huma.Context))

Middleware to add cors headers

func FailOnError

func FailOnError(err error, msg string)

func GetDelLogTags

func GetDelLogTags(msg *amqp.Delivery) string

func LoadConfig

func LoadConfig()

LoadConfig loads and validates the configuration from a .env and environment variables

func LogResponse

func LogResponse(ctx context.Context, resp *http.Response, req *http.Request)

This isn't working for some reason

func LogWithContext

func LogWithContext(ctx context.Context, msg ...string)

Logs the message and appends span/traceId tags from the passed context

func MockLoadConfig

func MockLoadConfig()

func OidcMiddleware

func OidcMiddleware(ctx huma.Context, next func(huma.Context))

Middleware to provide authentication in cxt.Values("user.id")

func PrettyPrint

func PrettyPrint(i interface{}) string

func RegisterOidcProvider

func RegisterOidcProvider(ctx context.Context)

Register an Oidc Provider

func SendRequest

func SendRequest(ctx context.Context, method string, sendUrl string, pBody *bytes.Reader, timeout time.Duration) (*http.Response, error)

Post an unauthed request to the given url Returns the response or an error if requests statusCode is not 2xx uses to application/json content type for post bodies

func TraceTagList

func TraceTagList(ctx context.Context) []string

List of traceId, spanId for slog, can't get this working for some reason

func TraceTags

func TraceTags(ctx context.Context) string

String formatted traceId, spanId for logging

Types

type ClientClaims

type ClientClaims struct {
	//The user id
	Uid    string   `json:"sub"`
	Groups []string `json:"groups"`
	jwt.RegisteredClaims
}

Wrapper type for claims from the jwt

func Authorize

func Authorize(w http.ResponseWriter, r *http.Request, allowedMethods []string, requiredScope string) (claims *ClientClaims, err error)

Extract a token, add cors headers, and validate the token

func ValidateToken

func ValidateToken(ctx context.Context, tokenString string) (claims *ClientClaims, err error)

Validate a token and return the claims

type ConfigValues

type ConfigValues struct {
	// RabbitMQ config
	MQ_HOST string `validate:"required"`
	MQ_PORT string `validate:"required"`
	MQ_USER string `validate:"required"`
	MQ_PASS string `validate:"required"`
	// Queue config
	GEN_XCHANGE  string `validate:"required"`
	PROG_XCHANGE string `validate:"required"`
	// Prefix for exchanges and queues to enable different environments
	MQ_PREFIX string
	// OIDC config
	OIDC_ISSUER        string `validate:"required"`
	OIDC_CLIENT_ID     string `validate:"required"`
	OIDC_CLIENT_SECRET string `validate:"required"`
	GEN_HANDLER_SECRET string `validate:"required"`
	GEN_HANDLER_SA     string `validate:"required"`

	// API to query machines and send results
	API_SEND_URL string

	// Port number for http server
	PORT_NUM int
	// Machine refetch interval
	MACHINE_CACHE_DURATION time.Duration
	// Machine status check interval
	MACHINE_STATUS_INTERVAL time.Duration

	// OTLP config
	DEPLOYMENT_ENVIRONMENT_NAME string `validate:"required"`
	OTEL_SERVICE_NAME           string `validate:"required"`
	// Enable a debug consumer queue
	DEBUG_CONSUMER_QUEUE bool
	// Machine status check interval
	QUEUE_CHECK_INTERVAL time.Duration

	LOG_LEVEL string
}

var Config *ConfigValues

func MockConfig

func MockConfig() ConfigValues

func (*ConfigValues) GetGenXchange

func (c *ConfigValues) GetGenXchange() string

func (*ConfigValues) GetLoggerLevel

func (c *ConfigValues) GetLoggerLevel() slog.Level

func (*ConfigValues) GetMqUrl

func (c *ConfigValues) GetMqUrl() string

func (*ConfigValues) GetProgXchange

func (c *ConfigValues) GetProgXchange() string