port

Documentation

Index

• type AdminSettingsAdapter
• type AdminSettingsService
• type AppsHandler
• type AppsService
• type AuthHandler
• type BaselinesAdapter
• type ChecksHandler
• type ChecksService
• type DatabaseHandler
• type DbAdapter
• type DbService
• type DebugHandler
• type DebugService
• type HardwareHandler
• type HardwareService
• type MockAdminSettingsAdapter
  • func (m *MockAdminSettingsAdapter) Get() (types.AdminSettings, error)
  • func (m *MockAdminSettingsAdapter) Update(settings types.AdminSettings) error
• type MockBaselinesAdapter
  • func (m *MockBaselinesAdapter) GetLatest(ctx context.Context, channel types.UpdatesChannel) (types.Baseline, error)
• type MockSshAdapter
  • func (m *MockSshAdapter) Add(key string, username string) error
  • func (m *MockSshAdapter) GetAll() ([]types.PublicKey, error)
  • func (m *MockSshAdapter) GetUsers() ([]user.User, error)
  • func (m *MockSshAdapter) Remove(fingerprint string, username string) error
• type MockSshKernelAdapter
  • func (m *MockSshKernelAdapter) Add(key string, user user.User) error
  • func (m *MockSshKernelAdapter) GetAll(users []user.User) ([]types.PublicKey, error)
  • func (m *MockSshKernelAdapter) GetUsers() ([]user.User, error)
  • func (m *MockSshKernelAdapter) Remove(fingerprint string, user user.User) error
• type SettingsHandler
• type SshAdapter
• type SshHandler
• type SshKernelAdapter
• type SshKernelHandler
• type SshKernelService
• type SshService
• type UpdateHandler
• type UpdateService

Types

type AdminSettingsAdapter

type AdminSettingsAdapter interface {
	Get() (types.AdminSettings, error)
	SetChannel(channel types.UpdatesChannel) error
	SetWebhook(webhook string) error
}

type AdminSettingsService

type AdminSettingsService interface {
	Get() (types.AdminSettings, error)
	Update(settings types.AdminSettings) error
	GetWebhook() (*string, error)
	SetWebhook(webhook string) error
	GetChannel() (types.UpdatesChannel, error)
	SetChannel(channel types.UpdatesChannel) error
}

type AppsHandler

type AppsHandler interface {
	// Get handles the retrieval of all apps.
	Get(c *router.Context)
}

type AppsService

type AppsService interface {
	All() []app.Meta
}

type AuthHandler

type AuthHandler interface {
	// Login handles the login of a user.
	Login(c *router.Context)
	// Register handles the registration of a user.
	Register(c *router.Context)
	// Logout handles the logout of a user.
	Logout(c *router.Context)
}

type BaselinesAdapter

type BaselinesAdapter interface {
	// GetLatest returns the latest available Baseline. This
	// will typically fetch the latest Baseline from a remote source.
	GetLatest(ctx context.Context, channel types.UpdatesChannel) (types.Baseline, error)
}

type ChecksHandler

type ChecksHandler interface {
	// Check handles the check of all components.
	Check(c *router.Context)
}

type ChecksService

type ChecksService interface {
	CheckAll(ctx context.Context) <-chan types.CheckResponse
}

type DatabaseHandler

type DatabaseHandler interface {
	// GetCurrentDbms handles the retrieval of the current database management system
	// that Vertex is using.
	GetCurrentDbms(c *router.Context)
	// MigrateTo handles the migration to the given database management system.
	MigrateTo(c *router.Context)
}

type DbAdapter

type DbAdapter interface {
	Get() *types.DB
	Connect() error
	GetDbConfig() types.DbConfig
	GetDBMSName() types.DbmsName
	SetDBMSName(name types.DbmsName) error
}

type DbService

type DbService interface {
	GetCurrentDbms() types.DbmsName
	MigrateTo(dbms types.DbmsName) error
}

type DebugHandler

type DebugHandler interface {
	// HardReset do a hard reset of Vertex.
	HardReset(c *router.Context)
}

type DebugService

type DebugService interface {
	HardReset()
}

type HardwareHandler

type HardwareHandler interface {
	// GetHost handles the retrieval of the current host.
	GetHost(c *router.Context)
	// GetCPUs handles the retrieval of all CPUs.
	GetCPUs(c *router.Context)
}

type HardwareService

type HardwareService interface {
	GetHost() (types.Host, error)
	GetCPUs() ([]types.CPU, error)
}

type MockAdminSettingsAdapter

type MockAdminSettingsAdapter struct {
	mock.Mock
}

func (*MockAdminSettingsAdapter) Get

func (m *MockAdminSettingsAdapter) Get() (types.AdminSettings, error)

func (*MockAdminSettingsAdapter) Update

func (m *MockAdminSettingsAdapter) Update(settings types.AdminSettings) error

type MockBaselinesAdapter

type MockBaselinesAdapter struct {
	mock.Mock
}

func (*MockBaselinesAdapter) GetLatest

func (m *MockBaselinesAdapter) GetLatest(ctx context.Context, channel types.UpdatesChannel) (types.Baseline, error)

type MockSshAdapter

type MockSshAdapter struct {
	mock.Mock
}

func (*MockSshAdapter) Add

func (m *MockSshAdapter) Add(key string, username string) error

func (*MockSshAdapter) GetAll

func (m *MockSshAdapter) GetAll() ([]types.PublicKey, error)

func (*MockSshAdapter) GetUsers

func (m *MockSshAdapter) GetUsers() ([]user.User, error)

func (*MockSshAdapter) Remove

func (m *MockSshAdapter) Remove(fingerprint string, username string) error

type MockSshKernelAdapter

type MockSshKernelAdapter struct {
	mock.Mock
}

func (*MockSshKernelAdapter) Add

func (m *MockSshKernelAdapter) Add(key string, user user.User) error

func (*MockSshKernelAdapter) GetAll

func (m *MockSshKernelAdapter) GetAll(users []user.User) ([]types.PublicKey, error)

func (*MockSshKernelAdapter) GetUsers

func (m *MockSshKernelAdapter) GetUsers() ([]user.User, error)

func (*MockSshKernelAdapter) Remove

func (m *MockSshKernelAdapter) Remove(fingerprint string, user user.User) error

type SettingsHandler

type SettingsHandler interface {
	// Get handles the retrieval of all settings.
	Get(c *router.Context)
	// Patch handles the update of all settings.
	Patch(c *router.Context)
}

type SshAdapter

type SshAdapter interface {
	GetAll() ([]types.PublicKey, error)
	Add(key string, username string) error
	Remove(fingerprint string, username string) error
	GetUsers() ([]user.User, error)
}

type SshHandler

type SshHandler interface {
	// Get handles the retrieval of all SSH keys.
	Get(c *router.Context)
	// Add handles the addition of an SSH key.
	Add(c *router.Context)
	// Delete handles the deletion of an SSH key.
	Delete(c *router.Context)
	// GetUsers handles the retrieval of all users that have can have SSH keys.
	GetUsers(c *router.Context)
}

type SshKernelAdapter

type SshKernelAdapter interface {
	GetAll(users []user.User) ([]types.PublicKey, error)
	Add(key string, user user.User) error
	Remove(fingerprint string, user user.User) error
	GetUsers() ([]user.User, error)
}

type SshKernelHandler

type SshKernelHandler interface {
	// Get handles the retrieval of all SSH keys.
	Get(c *router.Context)
	// Add handles the addition of an SSH key.
	Add(c *router.Context)
	// Delete handles the deletion of an SSH key.
	Delete(c *router.Context)
	// GetUsers handles the retrieval of all users that have can have SSH keys.
	GetUsers(c *router.Context)
}

type SshKernelService

type SshKernelService interface {
	GetAll() ([]types.PublicKey, error)
	Add(key string, username string) error
	Delete(fingerprint string, username string) error
	GetUsers() ([]user.User, error)
}

type SshService

type SshService interface {
	GetAll() ([]types.PublicKey, error)
	Add(key string, username string) error
	Delete(fingerprint string, username string) error
	GetUsers() ([]string, error)
}

type UpdateHandler

type UpdateHandler interface {
	// Get handles the retrieval of an update, if any.
	Get(c *router.Context)
	// Install handles the installation of the update.
	Install(c *router.Context)
}

type UpdateService

type UpdateService interface {
	GetUpdate(channel types.UpdatesChannel) (*types.Update, error)
	InstallLatest(channel types.UpdatesChannel) error
}