infra

Documentation

Index

• Constants
• Variables
• func MonitorTtySize(ctx context.Context, out *streams.Out, cli *client.Client, id string, ...) error
• func Run(params RunParams) error
• type BasicAuthCredentials
• type CertificateAuthority
  • func GenerateCertificateAuthority() (CertificateAuthority, error)
• type Collector
  • func NewCollector(ctx context.Context, cli *client.Client, net *Networks, params *RunParams, ...) (*Collector, error)
  • func (c *Collector) Close() error
• type Config
• type JobFile
  • func (j JobFile) ToJSON() (string, error)
• type Networks
  • func NewNetworks(ctx context.Context, cli *client.Client) (*Networks, error)
  • func (n *Networks) Close() error
• type Proxy
  • func NewProxy(ctx context.Context, cli *client.Client, params *RunParams, nets *Networks) (*Proxy, error)
  • func (p *Proxy) Close() (err error)
  • func (p *Proxy) TailLogs(ctx context.Context, cli *client.Client)
• type RunParams
  • func (p *RunParams) Validate() error
• type Updater
  • func NewUpdater(ctx context.Context, cli *client.Client, net *Networks, params *RunParams, ...) (*Updater, error)
  • func (u *Updater) Close() (err error)
  • func (u *Updater) RunCmd(ctx context.Context, cmd, user string, env ...string) error
  • func (u *Updater) RunShell(ctx context.Context, proxyURL string, apiUrl string) error
  • func (u *Updater) Wait(ctx context.Context, condition container.WaitCondition) error

Constants

const CollectorConfigPath = "/etc/otelcol-contrib/config.yaml"

const CollectorImageName = "ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-contrib:latest"

CollectorImageName is the default Docker image used

const ConfigFilePath = "/config.json"

ConfigFilePath is the path to proxy config file.

const ProxyImageName = "ghcr.io/github/dependabot-update-job-proxy/dependabot-update-job-proxy:latest"

ProxyImageName is the default Docker image used by the proxy

Variables

var CertSubject = pkix.Name{
	CommonName:         "Dependabot Internal CA",
	OrganizationalUnit: []string{"Dependabot"},
	Organization:       []string{"GitHub Inc."},
	Locality:           []string{"San Francisco"},
	Province:           []string{"California"},
	Country:            []string{"US"},
}

var ErrInvalidVolume = fmt.Errorf("invalid volume syntax")

var (
	ErrWriteAccess = fmt.Errorf("for security, credentials used in update are not allowed to have write access to GitHub API")
)

Functions

func MonitorTtySize

func MonitorTtySize(ctx context.Context, out *streams.Out, cli *client.Client, id string, isExec bool) error

MonitorTtySize updates the container tty size when the terminal tty changes size

func Run

func Run(params RunParams) error

Types

type BasicAuthCredentials

type BasicAuthCredentials struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

BasicAuthCredentials represents credentials required for HTTP basic auth

type CertificateAuthority

type CertificateAuthority struct {
	Cert string `json:"cert"`
	Key  string `json:"key"`
}

CertificateAuthority includes the MITM CA certificate and private key

func GenerateCertificateAuthority

func GenerateCertificateAuthority() (CertificateAuthority, error)

GenerateCertificateAuthority generates a new proxy keypair CA

type Collector

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

func NewCollector

func NewCollector(ctx context.Context, cli *client.Client, net *Networks, params *RunParams, proxy *Proxy) (*Collector, error)

NewCollector starts the OpenTelemetry collector container.

func (*Collector) Close

func (c *Collector) Close() error

Close stops and removes the container.

type Config

type Config struct {
	Credentials []model.Credential   `json:"all_credentials"`
	CA          CertificateAuthority `json:"ca"`
}

Config is the structure of the proxy's config file

type JobFile

type JobFile struct {
	Job *model.Job `json:"job"`
}

JobFile is the payload passed to file updater containers.

func (JobFile) ToJSON

func (j JobFile) ToJSON() (string, error)

type Networks

type Networks struct {
	NoInternet types.NetworkCreateResponse
	Internet   types.NetworkCreateResponse
	// contains filtered or unexported fields
}

func NewNetworks

func NewNetworks(ctx context.Context, cli *client.Client) (*Networks, error)

func (*Networks) Close

func (n *Networks) Close() error

type Proxy

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

func NewProxy

func NewProxy(ctx context.Context, cli *client.Client, params *RunParams, nets *Networks) (*Proxy, error)

func (*Proxy) Close

func (p *Proxy) Close() (err error)

func (*Proxy) TailLogs

func (p *Proxy) TailLogs(ctx context.Context, cli *client.Client)

type RunParams

type RunParams struct {
	// Input file
	Input string
	// job definition passed to the updater
	Job *model.Job
	// expectations asserted at the end of a test
	Expected []model.Output
	// directory to copy into the updater container as the repo
	LocalDir string
	// credentials passed to the proxy
	Creds []model.Credential
	// local directory used for caching
	CacheDir string
	// write output to a file
	Output string
	// ProxyCertPath is the path to a cert for the proxy to trust
	ProxyCertPath string
	// attempt to pull images if they aren't local?
	PullImages bool
	// run an interactive shell?
	Debug bool
	// generate performance metrics?
	Flamegraph bool
	// Volumes are used to mount directories in Docker
	Volumes []string
	// Timeout specifies an optional maximum duration the CLI will run an update.
	// If Timeout is <= 0 it will never time out.
	Timeout time.Duration
	// ExtraHosts adds /etc/hosts entries to the proxy for testing.
	ExtraHosts []string
	// UpdaterImage is the image to use for the updater
	UpdaterImage string
	// ProxyImage is the image to use for the proxy
	ProxyImage string
	// CollectorImage is the image to use for the OpenTelemetry collector
	CollectorImage string
	// CollectorConfigPath is the path to the OpenTelemetry collector configuration file
	CollectorConfigPath string
	// Writer is where API calls will be written to
	Writer    io.Writer
	InputName string
	InputRaw  []byte
	ApiUrl    string
}

func (*RunParams) Validate

func (p *RunParams) Validate() error

type Updater

type Updater struct {

	// ExitCode is set once an Updater command has completed.
	ExitCode *int
	// contains filtered or unexported fields
}

func NewUpdater

func NewUpdater(ctx context.Context, cli *client.Client, net *Networks, params *RunParams, prox *Proxy, collector *Collector) (*Updater, error)

NewUpdater starts the update container interactively running /bin/sh, so it does not stop.

func (*Updater) Close

func (u *Updater) Close() (err error)

Close kills and deletes the container and deletes updater mount paths related to the run.

func (*Updater) RunCmd

func (u *Updater) RunCmd(ctx context.Context, cmd, user string, env ...string) error

RunCmd executes the update scripts as the dependabot user, blocks until complete.

func (*Updater) RunShell

func (u *Updater) RunShell(ctx context.Context, proxyURL string, apiUrl string) error

RunShell executes an interactive shell, blocks until complete.

func (*Updater) Wait

func (u *Updater) Wait(ctx context.Context, condition container.WaitCondition) error

Wait blocks until the condition is true.