gitlab

Documentation

Index

• type Client
  • func NewClient(opts ...Option) (*Client, error)
  • func NewClientFromViper() (*Client, error)
  • func (c *Client) AddGroupGuests(courseName string) error
  • func (c *Client) Archive(assignmentCfg *config.AssignmentConfig, unarchive bool) error
  • func (c *Client) CheckCourse(cfg *config.CourseConfig) bool
  • func (c *Client) Delete(assignmentCfg *config.AssignmentConfig) error
  • func (c *Client) Generate(assignmentCfg *config.AssignmentConfig) error
  • func (c *Client) ProtectToBranch(assignmentCfg *config.AssignmentConfig) error
  • func (c *Client) Push(assignmentCfg *config.AssignmentConfig, branchname string) error
  • func (c *Client) Report(assignmentCfg *config.AssignmentConfig, templateFile *string, output *string) error
  • func (c *Client) ReportData(assignmentCfg *config.AssignmentConfig) (*r.Reports, error)
  • func (c *Client) ReportHTML(assignmentCfg *config.AssignmentConfig, templateFile *string, output *string) error
  • func (c *Client) ReportJSON(assignmentCfg *config.AssignmentConfig, output *string) error
  • func (c *Client) Setaccess(assignmentCfg *config.AssignmentConfig) error
  • func (c *Client) Update(assignmentCfg *config.AssignmentConfig) error
• type Option
  • func WithHTTPClient(hc *http.Client) Option
  • func WithHost(host string) Option
  • func WithReporter(r reporter.Reporter) Option
  • func WithToken(token string) Option
  • func WithoutRetries() Option

Types

type Client

type Client struct {
	*gitlab.Client
	// contains filtered or unexported fields
}

func NewClient

func NewClient(opts ...Option) (*Client, error)

NewClient builds a GitLab client from the given options. host and token are required; a bad configuration is an error rather than a panic, so a server can report it instead of dying.

func NewClientFromViper

func NewClientFromViper() (*Client, error)

NewClientFromViper builds a client from the global config. It is the CLI's entry point, keeping the single-token model; the web server uses NewClient with a per-user token instead.

func (*Client) AddGroupGuests

func (c *Client) AddGroupGuests(courseName string) error

AddGroupGuests adds all students from an assignment config as guests to the course subgroup (coursepath/semesterpath). This enables students to use the Dependency-Proxy.

func (*Client) Archive

func (c *Client) Archive(assignmentCfg *config.AssignmentConfig, unarchive bool) error

func (*Client) CheckCourse

func (c *Client) CheckCourse(cfg *config.CourseConfig) bool

func (*Client) Delete

func (c *Client) Delete(assignmentCfg *config.AssignmentConfig) error

func (*Client) Generate

func (c *Client) Generate(assignmentCfg *config.AssignmentConfig) error

func (*Client) ProtectToBranch

func (c *Client) ProtectToBranch(assignmentCfg *config.AssignmentConfig) error

func (*Client) Push

func (c *Client) Push(assignmentCfg *config.AssignmentConfig, branchname string) error

func (*Client) Report

func (c *Client) Report(assignmentCfg *config.AssignmentConfig, templateFile *string, output *string) error

func (*Client) ReportData

func (c *Client) ReportData(assignmentCfg *config.AssignmentConfig) (*r.Reports, error)

ReportData returns the structured report for an assignment without rendering it to text/HTML. It is the data-returning entry point the web server uses; the CLI's Report/ReportHTML render this same data.

func (*Client) ReportHTML

func (c *Client) ReportHTML(assignmentCfg *config.AssignmentConfig, templateFile *string, output *string) error

func (*Client) ReportJSON

func (c *Client) ReportJSON(assignmentCfg *config.AssignmentConfig, output *string) error

func (*Client) Setaccess

func (c *Client) Setaccess(assignmentCfg *config.AssignmentConfig) error

func (*Client) Update

func (c *Client) Update(assignmentCfg *config.AssignmentConfig) error

type Option

type Option func(*clientOptions)

func WithHTTPClient

func WithHTTPClient(hc *http.Client) Option

WithHTTPClient injects the underlying HTTP client.

func WithHost

func WithHost(host string) Option

func WithReporter

func WithReporter(r reporter.Reporter) Option

WithReporter sets where the client's progress goes. Defaults to a ConsoleReporter (spinners on stdout); the web server passes a streaming one.

func WithToken

func WithToken(token string) Option

func WithoutRetries

func WithoutRetries() Option

WithoutRetries disables the client's retry-on-5xx wrapper. The contract tests use it so a mocked 5xx returns immediately instead of retrying with backoff.