cheek

package
v1.0.25 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 23, 2024 License: MIT Imports: 26 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	StatusOK    int = 0
	StatusError int = -1
)

Global status constants

Variables

View Source 
var Version = "development"

Version will be set through build flags used to print version via cmd.

Functions

func CheekPath 

func CheekPath() string

func InitDB added in v0.3.34 

func InitDB(db *sqlx.DB) error

func NewDBLogWriter added in v0.3.34 

func NewDBLogWriter(db *sqlx.DB) io.Writer

func NewDefaultWebhook added in v1.0.25 

func NewDefaultWebhook(endpoint string) defaultWebhook

func NewDiscordWebhook added in v1.0.25 

func NewDiscordWebhook(endpoint string) discordWebhook

func NewLogger 

func NewLogger(logLevel string, db *sqlx.DB, extraWriters ...io.Writer) zerolog.Logger

Configures the package's global logger, also allows to pass in custom writers for testing purposes.

func NewSlackWebhook added in v1.0.25 

func NewSlackWebhook(endpoint string) slackWebhook

func OpenDB added in v0.3.34 

func OpenDB(dbPath string) (*sqlx.DB, error)

func PrettyStdout 

func PrettyStdout() io.Writer

func RunSchedule 

func RunSchedule(log zerolog.Logger, cfg Config, scheduleFn string) error

RunSchedule is the main entry entrypoint of cheek.

Types

type Config 

type Config struct {
	Pretty       bool   `yaml:"pretty"`
	SuppressLogs bool   `yaml:"suppressLogs"`
	LogLevel     string `yaml:"logLevel"`
	HomeDir      string `yaml:"homedir"`
	Port         string `yaml:"port"`
	DBPath       string `yaml:"dbpath"`
	DB           *sqlx.DB
}

func NewConfig 

func NewConfig() Config

func (*Config) Init added in v0.3.34 

func (c *Config) Init() error

type DBLogWriter added in v0.3.34 

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

func (DBLogWriter) Write added in v0.3.34 

func (w DBLogWriter) Write(p []byte) (n int, err error)

type JobRun 

type JobRun struct {
	LogEntryId int  `json:"id,omitempty" db:"id"`
	Status     *int `json:"status,omitempty" db:"status,omitempty"`

	Log         string        `json:"log" db:"message"`
	Name        string        `json:"name" db:"job"`
	TriggeredAt time.Time     `json:"triggered_at" db:"triggered_at"`
	TriggeredBy string        `json:"triggered_by" db:"triggered_by,omitempty"`
	Triggered   []string      `json:"triggered,omitempty"`
	Duration    time.Duration `json:"duration,omitempty" db:"duration"`
	// contains filtered or unexported fields
}

JobRun holds information about a job execution.

func RunJob 

func RunJob(log zerolog.Logger, cfg Config, scheduleFn string, jobName string) (JobRun, error)

RunJob allows to run a specific job

type JobSpec 

type JobSpec struct {
	Yaml string `yaml:"-" json:"yaml,omitempty"`

	Cron    string      `yaml:"cron,omitempty" json:"cron,omitempty"`
	Command stringArray `yaml:"command" json:"command"`

	OnSuccess OnEvent `yaml:"on_success,omitempty" json:"on_success,omitempty"`
	OnError   OnEvent `yaml:"on_error,omitempty" json:"on_error,omitempty"`

	Name             string            `json:"name"`
	Retries          int               `yaml:"retries,omitempty" json:"retries,omitempty"`
	Env              map[string]secret `yaml:"env,omitempty"`
	WorkingDirectory string            `yaml:"working_directory,omitempty" json:"working_directory,omitempty"`

	Runs []JobRun `json:"runs" yaml:"-"`
	// contains filtered or unexported fields
}

JobSpec holds specifications and metadata of a job.

func (*JobSpec) OnEvent 

func (j *JobSpec) OnEvent(jr *JobRun)

func (JobSpec) ToYAML added in v0.3.0 

func (j JobSpec) ToYAML(includeRuns bool) (string, error)

func (*JobSpec) ValidateCron 

func (j *JobSpec) ValidateCron() error

type OnEvent 

type OnEvent struct {
	TriggerJob           []string `yaml:"trigger_job,omitempty" json:"trigger_job,omitempty"`
	NotifyWebhook        []string `yaml:"notify_webhook,omitempty" json:"notify_webhook,omitempty"`
	NotifySlackWebhook   []string `yaml:"notify_slack_webhook,omitempty" json:"notify_slack_webhook,omitempty"`
	NotifyDiscordWebhook []string `yaml:"notify_discord_webhook,omitempty" json:"notify_discord_webhook,omitempty"`
}

OnEvent contains specs on what needs to happen after a job event.

type Response added in v0.3.0 

type Response struct {
	Job    string `json:"jobs,omitempty"`
	Status string `json:"status,omitempty"`
	Type   string `json:"type,omitempty"`
}

type Schedule 

type Schedule struct {
	Jobs       map[string]*JobSpec `yaml:"jobs" json:"jobs"`
	OnSuccess  OnEvent             `yaml:"on_success,omitempty" json:"on_success,omitempty"`
	OnError    OnEvent             `yaml:"on_error,omitempty" json:"on_error,omitempty"`
	TZLocation string              `yaml:"tz_location,omitempty" json:"tz_location,omitempty"`
	// contains filtered or unexported fields
}

Schedule defines specs of a job schedule.

func (*Schedule) Run 

func (s *Schedule) Run()

Run a Schedule based on its specs.

type ScheduleStatusResponse added in v1.0.10 

type ScheduleStatusResponse struct {
	Status         map[string]int `json:"status,omitempty"`
	FailedRunCount int            `json:"failed_run_count,omitempty"`
	HasFailedRuns  bool           `json:"has_failed_runs,omitempty"`
}

type TemplateData added in v0.3.34 

type TemplateData struct {
	Name string
}

type VersionResponse added in v1.0.13 

type VersionResponse struct {
	Version   string `json:"version"`
	CommitSHA string `json:"commit_sha"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.
JackTT - Gopher 🇻🇳