core

Documentation

Index

• Constants
• Variables
• func AssertReadable(file string) error
• func FindFiles(fileNames ...string) (string, error)
• func FindInDir(dir string, fileNames ...string) (string, error)
• func HasReadPerm(info fs.FileInfo) error
• func IsHex(s string) bool
• func MapFiles(docRoot string) ([]string, error)
• func MockClearFS()
• func MockReader(file string) ([]byte, error)
• func MockTester(file string) error
• func MockWriteFile(fname string, fdata []byte, isReadable bool, ferr error)
• func ParseYAML[T any](file string, obj *T) error
• func ReadFile(file string) ([]byte, error)
• func SetReader(r func(string) ([]byte, error))
• func SetTester(t func(string) error)
• func ValidatePasswordHash(hash string) error
• type Config
  • func DefaultConfig() *Config
  • func NewConfig(flags map[string]string, args []string, env map[string]string) (*Config, error)
• type Logger
  • func NewLogger(out io.Writer, prefix string, flag int, debug bool) *Logger
  • func (l *Logger) Debug(v ...any)
  • func (l *Logger) Debugf(format string, v ...any)
  • func (l *Logger) Print(v ...any)
  • func (l *Logger) Printf(format string, v ...any)
• type MockFile

Constants

const (
	DefaultAPIHost         = "0.0.0.0"
	DefaultAPIPort         = "8080"
	DefaultDocRoot         = "assets"
	DefaultDBRoot          = "db"
	DefaultShutdownTimeout = 5
)

Variables

var (
	FileNotFound  = "file not found"
	ErrInvalidEnv = fmt.Errorf("invalid environment")
	ErrUnknownOpt = fmt.Errorf("unknown option")
)

var (
	ErrParamEmpty     = fmt.Errorf("parameter is empty")
	ErrParamTooLong   = fmt.Errorf("parameter is too long")
	ErrParamBadFormat = fmt.Errorf("parameter format is invalid")
)

var (
	MockFS          = make(map[string]MockFile)
	MockTesterPerms = false
)

var (
	MockTestConfig = []byte(`env: prod
debug: true
tls_cert_file: "/tmp/cuttle_cert.cert"
tls_key_file: "/tmp/cuttle_key.pem"
api_host: 127.0.0.1
api_port: "9090"
db_root: /tmp/db
shutdown_timeout: 0`)
	MockTestCert = []byte(`-----BEGIN CERTIFICATE-----
MIIF1TCCA72gAwIBAgIUQFIA0nAR355w7z6OfjUI3TY5K1EwDQYJKoZIhvcNAQEN
BQAwejELMAkGA1UEBhMCVVMxEDAOBgNVBAgMB0dlb3JnaWExEDAOBgNVBAcMB0F0
bGFudGExEDAOBgNVBAoMB1Rlc3RMQUIxDDAKBgNVBAsMA0RldjETMBEGA1UEAwwK
Q3V0dGxlIEFwcDESMBAGCSqGSIb3DQEJARYDbmFuMB4XDTI0MDcyMzIxNTkzMVoX
DTI1MDcyMzIxNTkzMVowejELMAkGA1UEBhMCVVMxEDAOBgNVBAgMB0dlb3JnaWEx
EDAOBgNVBAcMB0F0bGFudGExEDAOBgNVBAoMB1Rlc3RMQUIxDDAKBgNVBAsMA0Rl
djETMBEGA1UEAwwKQ3V0dGxlIEFwcDESMBAGCSqGSIb3DQEJARYDbmFuMIICIjAN
BgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAtrO6nYQCUr8OGNq1LQtEPHQtOJ4n
d3yZwVgfMnRUE41Dd1qJCobjmqurWOiHj2zWv6f63rOmEXL3y+i4ZDclNlUH0viI
oXWZnYiO1d9yjvekorLV89jAa2B2Uhq5AVWPmO7Vs2BZx1ZOkZQgJsbhGngW9a/o
2tphUjNWB5cgKyV/rZk8k0PC5Ba3Fzp6hKDaDTXwrZQRlYvaYz5jZUqOi3WRheaQ
XhxmBwMWXcSD1CtNM0cHIR0RcIWIrDqMHzqcQ9eyhPnrd6UQvEyYN7zXXdegJa7S
mgKlUUdkCt22Q3YP1DAN9UZMzCtIdlLEdCP1NuXxGIppjQAvirTA2mJcNoTkRE4R
rvZR/8BEyG2NIAglpfsgHAZCZpQIR0zy/Zn38W68RWwKtnj85n+hmsiMQ7rlQvsj
TyioVKQVtRs/V/LAghpmzzbqkrpyVW/npYFXYL4KVyEG4ZvEByHC/Jm85F3elUDP
ZyvorKfum9CYf5CnrM+FGx8FPjOxgQezTAPgCAqe2JwRF8dwrOd/aTnccvWknQ/V
f2TrdwkzhhVU3PxhK1JRnygy/Mrux5GoNfyaXLyQQI4dJ2a1rWeZ1h+xMgVbsqe1
vV8MhRk9hB2Hq0awzqMpT48ASjen3Lp0VmmuE2KhjvsjZK/sDRm1/wAgBE5kQwXe
MV6hWO1v0TrzDsUCAwEAAaNTMFEwHQYDVR0OBBYEFDLpEyxv8sG07PXl1Izv5Vzu
d5/VMB8GA1UdIwQYMBaAFDLpEyxv8sG07PXl1Izv5Vzud5/VMA8GA1UdEwEB/wQF
MAMBAf8wDQYJKoZIhvcNAQENBQADggIBAKBqvFWSeJwmfCTo/MGUO36SatJ7wAj4
tM+CBMaxZrI5EXKl8Fc6Im93yDEu3wubkCSrv6y3UGXzKqrXdAf0TzIL+BK/HfLC
ygQQZUFakywBwCbzxoP+scz7rikwzP7MS/mZIHDPYSsuzLVKJXFqgzP6MbZEiETb
c/XKG0ReEy+ruEd4r9yKH0vuBHz5RG483gMsvC0hhQTfj6dkJWKz9Pmo0dvKcAN1
7YQX8XteKEjUUDBXI+zoOSKnXOdSMzDnH0ndRxoqiJcZjKS+s5aEgCTf5pME6Va9
899pcwZBBsOpYI1kqLcTlykcWzKeN8Id9TM9kgy04YJGUcJlW6QMDQGxSzunopim
tTgGFNswPaaODkPPoEhBVD6TEyZBgwQuchvbN6b4FEjyOiVf23+KgyVbzKH2L0TR
VoeHwFLXFxuCt074ExityQK6arbi3GiZwbOcmGJhjLt6WNiy2Ew5KmFUBX2Mgz+b
KM8UyRONFQDwTj+L7JWoRfOTtXBly1qbccME12nbnZzlUjBDPspqxEvh5WoJEgnm
p2P/F6tRqVkDZJdNoF/EZgXDYKyEPmNVjVFO8FFqYEq7xEGmnBtlXZKl48pH7w53
x8r9seUwowiZQkrRz6A3RyFPXtgJakisEsAjknz+9Cn+Mq5kkY7pXDwwDRl6LIuY
prDLZKx0Xw3n
-----END CERTIFICATE-----`)
	MockTestKey = []byte(`-----BEGIN PRIVATE KEY-----
MIIJQQIBADANBgkqhkiG9w0BAQEFAASCCSswggknAgEAAoICAQC2s7qdhAJSvw4Y
2rUtC0Q8dC04nid3fJnBWB8ydFQTjUN3WokKhuOaq6tY6IePbNa/p/res6YRcvfL
6LhkNyU2VQfS+IihdZmdiI7V33KO96SistXz2MBrYHZSGrkBVY+Y7tWzYFnHVk6R
lCAmxuEaeBb1r+ja2mFSM1YHlyArJX+tmTyTQ8LkFrcXOnqEoNoNNfCtlBGVi9pj
PmNlSo6LdZGF5pBeHGYHAxZdxIPUK00zRwchHRFwhYisOowfOpxD17KE+et3pRC8
TJg3vNdd16AlrtKaAqVRR2QK3bZDdg/UMA31RkzMK0h2UsR0I/U25fEYimmNAC+K
tMDaYlw2hOREThGu9lH/wETIbY0gCCWl+yAcBkJmlAhHTPL9mffxbrxFbAq2ePzm
f6GayIxDuuVC+yNPKKhUpBW1Gz9X8sCCGmbPNuqSunJVb+elgVdgvgpXIQbhm8QH
IcL8mbzkXd6VQM9nK+isp+6b0Jh/kKesz4UbHwU+M7GBB7NMA+AICp7YnBEXx3Cs
539pOdxy9aSdD9V/ZOt3CTOGFVTc/GErUlGfKDL8yu7Hkag1/JpcvJBAjh0nZrWt
Z5nWH7EyBVuyp7W9XwyFGT2EHYerRrDOoylPjwBKN6fcunRWaa4TYqGO+yNkr+wN
GbX/ACAETmRDBd4xXqFY7W/ROvMOxQIDAQABAoICAAnvR1QuC8ugv00or2C4qR2P
GlpmzIdEdj6Q4nlli/Yti0qf2K3YMeOE4Yy0cD1N/Mtv1fDAMg/m1tn2rfgnwNVD
KxQUwaaN9NbKcyyRZEhT56w/2enS59EEQ3V+0H/lvX43wSpqMII/YNxXrVE5JUps
LKDFelL+5vsyTBjzkHiS0cOIfpu/ZodCmPLMEkIeAQgQ3nqB1QbzE41WpM8AOTS/
et9IxKGUHRQqiHp8J3L6ZnibAc880RLzn+qa8GhOUUBQfVDvyhcNGcDeJV96hvd/
tHdNb1RClTy7NhHFMUEFLXfV+RxU60jQMwuEFVH/a+PFUyaIzZPbkQ+TeUfRa2l6
oJxaLMgvSp9X6xoBqR22zyP2By9PEZ4I1MuHwXJc77zN/iK6F8lugFib/Ar0S1x9
iXg328rquyaUg+kAb4CN0929ikD3U/oglMq1WuZy9hb/5hReB5ZjlMRhmY039Cyx
0gHPf4q2wVPngdKNzjOom2HZnE/OKoQKe+MhimCAJAWv+N/HdZdWhgsyaKLIyzWB
eqwByIj+CnW5J5enxfqZvz3xIou5xiq0aP0OBjM7awJjIsfMcayjj8SgnBx2Ei+c
6+mSGsfKg7SKB6GPqhwn7ZocfDwKMlVQaSKTDHCydMljmwooHoJxruQ+OdrGC/hN
1Py2BkX0Rd1wisT7iLjhAoIBAQDl+B3hjAROi6duJgkWht3mUexXLTeNRUkUrR1c
waZv/vdS4HfVFX1mUMd5zeeL0E87hgCerHMauAcczRaXfDNyT9VzoWTzvf372tek
sgW8GjBmbxdviOg6AwH7MVN4KwzDhG3ScbLawwl12Ts0gI37waIazkGydJShveix
iWurzGkgWHTtXiGlJcHN0pVU72sLC5HodZYmgTJTT7wkxVRLJrT1x/aDcc1K9Zgi
H8HrRuXEohcJKam9x2jLsey3STDIrNCXVOYtUEI7334pT6NL9FFCYhSxgObecw+V
OWegwn9vaT4snXo8lTYL/EqaO8ZufGWR4N09tRtc6+XylyqJAoIBAQDLYfBYwe9r
1FTVc9SrHJ7OXSoHJN2/65RtBrTajDqFjnBMcrP5xHr5TmQa+MWghA7eY+X00/OO
HQjOJpRiiaynxrF7sZ+wzNayphnoNiQaQRhBBTAe+T0imUwlcsjAJ9Zbr0Iqbn+w
Ch/wX4IELXww8pqwocV9vBu9311sln1XM3TeEgPH+5QRxFFKZFrqUGgaec7Nfh9R
qJ160V1SNlWi8b0XzaxzrKFFVEm6DoFQHg58AD7i7TwzQgPt6eTknMFX0soqT1Hw
50+lidMlBOuyfI2CzcDVI0gLkSjkEuPx7YdTngE5jxgl/tiaA6wGM0i8chYtyGkv
bDmn931aAQNdAoIBAEwvET8aEocuzq233gTfcv2NID2VFjUvwdEetH55DLlHfwmu
oSQvNVbC5gJdCxsPTGBMuUHXoV41nu2Up6pRk/2How/mZLo2s8BOtGe0LiAtkOEu
ZlYlxcEKJAriQWOq51SSN4ui7Px55lVrPKjc+axwblJxB+SlqGOYtVCzVL8aPa1g
gIPuTjkWtAiKfbwggJatI44d/jsNS+27mXmZAZ7P2N0ffHP5LGhryhVr7eMSnqWw
iO8ZJUlgmT/51pC1p3qjfYrUrlhOoVKSbIok/tT3wD+8nFxddp41AfGOjdz88hin
hdhj5w3Q5JG9570GlmsdvMxB8SkzKTh0Ub43A/kCggEAPwKIw/bRhkayQa8xJBIp
4SVb7/qr+NmzklORlGP9fYMzp3uh5q/IqZRvzytjjuda8+tfQwqnWlAEelnZfu3I
X/Je6kONhejwW0i6ngaoCLpCGWLSFcaB+kYkITX+nAm7j4wso5i4VoHMg1wTm9e7
si53XmHAHcQ5lAmvmATHsExw2JwcL8jxhs+bn8CXqiBfIFS8jU2VxmbG41YZ426R
+XmLa+R8mRnSnPgQH2R/C6NEOYaZ9RQqonbBYOQl1e36uIrFt3X7nPcM5exdTgrI
OvP7o5q7M01K9Mp0MLTpifpdArrhBkQe5yadVJnuob0hu8BcvrJoZBjThAZY/5lw
wQKCAQBH8T841Yug/8sCnv6aVBfbBh2sJQC9UX+qYvVpap3WsmQ/OmRyUfZURBVa
SPD/II+4TojbbSebvjECUwIQgbPUDFqXowFqaCh/ToBemF7vxSPkJJI0mJBs5R9L
3jP0TTmm0sjTRFixE61GN81kc7M6eW8jNAtjruPXKBJbCt2r/Zp4NAwnVKm+xYN+
YMGxbuXcrXmDwi3HWtTSrvQ7ugy4GM8xh5A9LO23put2g4GnmfKJslejWynzbGoz
bvBOUno4U5SvrTs2IBvkmZAMnYO9+B1j7NXPOYUXqBNHLmxJW6wYXvGMRePEjHmn
R3zzWGC9q0+JqmI7jKW/g9d5TBvy
-----END PRIVATE KEY-----`)
)

Functions

func AssertReadable

func AssertReadable(file string) error

CheckReadability returns nil if file is readable.

func FindFiles

func FindFiles(fileNames ...string) (string, error)

FindFiles returns the location of the config file if found. Returns "" and an error if not.

func FindInDir

func FindInDir(dir string, fileNames ...string) (string, error)

FindInDir returns the contents of the first file found in the directory. dir should not contain a trailing "/". If no file is found, return FileNotFound.

func HasReadPerm

func HasReadPerm(info fs.FileInfo) error

HasReadPerm returns nil if the app has read permission to the file.

func IsHex

func IsHex(s string) bool

func MapFiles

func MapFiles(docRoot string) ([]string, error)

func MockClearFS

func MockClearFS()

func MockReader

func MockReader(file string) ([]byte, error)

func MockTester

func MockTester(file string) error

func MockWriteFile

func MockWriteFile(fname string, fdata []byte, isReadable bool, ferr error)

MockWriteFile creates a new MockFile and appends it to the MockTesterFiles slice. If the file already exists, it will update the file with the new data.

func ParseYAML

func ParseYAML[T any](file string, obj *T) error

func ReadFile

func ReadFile(file string) ([]byte, error)

func SetReader

func SetReader(r func(string) ([]byte, error))

func SetTester

func SetTester(t func(string) error)

func ValidatePasswordHash

func ValidatePasswordHash(hash string) error

Types

type Config

type Config struct {
	Env             string `yaml:"env,omitempty"`
	Debug           bool   `yaml:"debug,omitempty"`
	TLSCertFile     string `yaml:"tls_cert_file,omitempty"`
	TLSKeyFile      string `yaml:"tls_key_file,omitempty"`
	APIHost         string `yaml:"api_host,omitempty"`
	APIPort         string `yaml:"api_port,omitempty"`
	DBRoot          string `yaml:"db_root,omitempty"`                      // DBRoot is the root path for the database.
	DocRoot         string `yaml:"doc_root,omitempty"`                     // DocRoot is the document root path for the serving static html files.
	ShutdownTimeout int    `default:"5" yaml:"shutdown_timeout,omitempty"` // in seconds
	Secret          string `yaml:"secret,omitempty"`
}

func DefaultConfig

func DefaultConfig() *Config

func NewConfig

func NewConfig(
	flags map[string]string,
	args []string,
	env map[string]string,
) (*Config, error)

type Logger

type Logger struct {
	DebugMode bool
	*log.Logger
}

func NewLogger

func NewLogger(out io.Writer, prefix string, flag int, debug bool) *Logger

func (*Logger) Debug

func (l *Logger) Debug(v ...any)

func (*Logger) Debugf

func (l *Logger) Debugf(format string, v ...any)

func (*Logger) Print

func (l *Logger) Print(v ...any)

func (*Logger) Printf

func (l *Logger) Printf(format string, v ...any)

type MockFile

type MockFile struct {
	Name       string
	Contents   []byte
	IsReadable bool
	Error      error
}