application

Documentation

Index

• Constants
• func ContextWithJob(parent context.Context, job *BuildJob) context.Context
• func CurrentVersion() string
• func Initialize() error
• func IsLatestVersion() bool
• func VersionString() string
• type BuildJob
  • func BuildJobFromContext(ctx context.Context) (*BuildJob, error)
  • func (j *BuildJob) BeginAt(time time.Time)
  • func (j *BuildJob) Duration() string
  • func (j *BuildJob) EndAt(time time.Time)
• type Configuration
  • func (c *Configuration) Addr() string
  • func (c *Configuration) Set(path string) error
  • func (c *Configuration) String() string
  • func (c *Configuration) Timeout() time.Duration
  • func (c *Configuration) Type() string
• type GitHub
• type Job
• type Server

Constants

const (
	// Name is a application name.
	Name = "duci"
	// DefaultConfigurationPath is a path to configuration file
	DefaultConfigurationPath = "./config.yml"
)

Functions

func ContextWithJob

func ContextWithJob(parent context.Context, job *BuildJob) context.Context

ContextWithJob set parent context BuildJob and returns it.

func CurrentVersion

func CurrentVersion() string

CurrentVersion returns current version string

func Initialize

func Initialize() error

Initialize singleton instances that are needed by application

func IsLatestVersion

func IsLatestVersion() bool

IsLatestVersion return witch latest stable version or not

func VersionString

func VersionString() string

VersionString returns application version

Types

type BuildJob

type BuildJob struct {
	ID           job.ID
	TargetSource *github.TargetSource
	TaskName     string
	TargetURL    *url.URL
	// contains filtered or unexported fields
}

BuildJob represents once of job

func BuildJobFromContext

func BuildJobFromContext(ctx context.Context) (*BuildJob, error)

BuildJobFromContext extract BuildJob from context

func (*BuildJob) BeginAt

func (j *BuildJob) BeginAt(time time.Time)

BeginAt set a time that begin job

func (*BuildJob) Duration

func (j *BuildJob) Duration() string

Duration returns job duration

func (*BuildJob) EndAt

func (j *BuildJob) EndAt(time time.Time)

EndAt set a time that end job

type Configuration

type Configuration struct {
	Server *Server `yaml:"server" json:"server"`
	GitHub *GitHub `yaml:"github" json:"github"`
	Job    *Job    `yaml:"job" json:"job"`
}

Configuration of application.

var (
	// Config is a application configuration.
	Config *Configuration
)

func (*Configuration) Addr

func (c *Configuration) Addr() string

Addr returns a string of server port

func (*Configuration) Set

func (c *Configuration) Set(path string) error

Set configuration with file path

func (*Configuration) String

func (c *Configuration) String() string

String returns default config path

func (*Configuration) Timeout

func (c *Configuration) Timeout() time.Duration

Timeout returns timeout duration.

func (*Configuration) Type

func (c *Configuration) Type() string

Type returns value type of itself

type GitHub

type GitHub struct {
	SSHKeyPath string     `yaml:"ssh_key_path" json:"sshKeyPath"`
	APIToken   maskString `yaml:"api_token" json:"apiToken"`
}

GitHub describes a configuration of github.

type Job

type Job struct {
	Timeout     int64 `yaml:"timeout" json:"timeout"`
	Concurrency int   `yaml:"concurrency" json:"concurrency"`
}

Job describes a configuration of each jobs.

type Server

type Server struct {
	WorkDir      string `yaml:"workdir" json:"workdir"`
	Port         int    `yaml:"port" json:"port"`
	DatabasePath string `yaml:"database_path" json:"databasePath"`
}

Server describes a configuration of server.