biscepter

type Healthcheck struct {
	Port      int             // The port on which the healthcheck should be performed
	CheckType HealthcheckType // The type of healthcheck to be performed

	Data   string            // Additional data for a given check type. Functionality depends on check type
	Config HealthcheckConfig // The config for this healthcheck
}

type HealthcheckConfig struct {
	Retries int // How many times this healthcheck should be retried until it is considered to have failed

	Backoff time.Duration // How long to wait between each healthcheck retry

	BackoffIncrement time.Duration // By how much to increment the backoff on each failed attempt
	MaxBackoff       time.Duration // The maximum duration the backoff may reach after incrementing. When the backoff has reached this value, it won't increase any further
}

type HealthcheckType int

type Job struct {
	ReplicasCount int // How many replicas of itself this job should spawn simultaneously. Each replica is to be used for bisecting one issue.

	// The cost multiplier of building a commit compared to running an already built commit.
	// A build cost of 100 means building a commit is 100 times more expensive than running a built commit.
	// A build cost of less than 1 results in biscepter always building the middle commit (if it was not built yet) and not using nearby, cached, builds.
	BuildCost float64

	Ports        []int         // The ports which this job needs
	Healthchecks []Healthcheck // The healthchecks for this job

	GoodCommit string // The hash of the good commit, i.e. the commit which does not exhibit any issues
	BadCommit  string // The hash of the bad commit, i.e. the commit which exhibits the issue(s) to be bisected

	Dockerfile     string // The contents of the dockerfile.
	DockerfilePath string // The path to the dockerfile relative to the present working directory. Only gets used if Dockerfile is empty.

	Log *logrus.Logger // The log to which information gets printed to

	MaxConcurrentReplicas uint // The max amount of replicas that can run concurrently, or 0 if no limit

	Repository string // The repository URL

	// Path to the file where commit replacements are written to and stored for subsequent runs. Defaults to "$(PWD)/.biscepter-replacements~"
	CommitReplacementsBackup string
	// contains filtered or unexported fields
}

type OffendingCommit struct {
	ReplicaIndex int // The index of the bisected replica

	Commit       string // The commit which introduced the issue. I.e. the oldest bad commit
	CommitOffset int    // The offset to the initial commit of the commit which introduced the issue. I.e. the offset of the oldest bad commit

	CommitMessage string // The message of the offending commit
	CommitDate    string // The date of the offending commit
	CommitAuthor  string // The author of the offending commit
}

type RunningSystem struct {
	ReplicaIndex int // The index of this system's parent replica

	Ports map[int]int // A mapping of the ports specified for the system under test to the ones they were mapped to locally
	// contains filtered or unexported fields
}