suites

README

Authelia Suites

A suite is a kind of virtual environment for Authelia. Please read the related documentation here to get more details.

Documentation

Index

• Variables
• func ConfigureDuo(t *testing.T, allowDeny DuoPolicy)
• func ConfigureDuoPreAuth(t *testing.T, response duo.PreAuthResponse)
• func GetLoginBaseURL() string
• func NewHTTPClient() *http.Client
• type CommandSuite
• type DockerEnvironment
  • func NewDockerEnvironment(files []string) *DockerEnvironment
  • func (de *DockerEnvironment) Down() error
  • func (de *DockerEnvironment) Exec(service string, command []string) (string, error)
  • func (de *DockerEnvironment) Logs(service string, flags []string) (string, error)
  • func (de *DockerEnvironment) Pull(images ...string) error
  • func (de *DockerEnvironment) Restart(service string) error
  • func (de *DockerEnvironment) Start(service string) error
  • func (de *DockerEnvironment) Stop(service string) error
  • func (de *DockerEnvironment) Up() error
• type DuoPolicy
• type K3D
  • func (k K3D) ClusterExists() (bool, error)
  • func (k K3D) CreateCluster() error
  • func (k K3D) DeleteCluster() error
  • func (k K3D) LoadImage(imageName string) error
• type Kubectl
  • func (k Kubectl) GetDashboardToken() error
  • func (k Kubectl) WaitPodsReady(namespace string, timeout time.Duration) error
• type Registry
  • func NewSuitesRegistry() *Registry
  • func (sr *Registry) Get(name string) Suite
  • func (sr *Registry) Register(name string, suite Suite)
  • func (sr *Registry) Suites() []string
• type RodSession
  • func StartRod() (*RodSession, error)
  • func StartRodWithProxy(proxy string) (*RodSession, error)
  • func (rs *RodSession) Stop() error
  • func (rs *RodSession) WaitElementLocatedByClassName(t *testing.T, page *rod.Page, className string) *rod.Element
  • func (rs *RodSession) WaitElementLocatedByID(t *testing.T, page *rod.Page, cssSelector string) *rod.Element
  • func (rs *RodSession) WaitElementsLocatedByID(t *testing.T, page *rod.Page, cssSelector string) rod.Elements
• type RodSuite
• type Suite

Variables

var AdminBaseURL = fmt.Sprintf("https://admin.%s", BaseDomain)

AdminBaseURL the base URL of the admin domain.

var AutheliaBaseURL = "https://authelia.example.com:9091"

AutheliaBaseURL the base URL of Authelia service.

var BaseDomain = "example.com:8080"

BaseDomain the base domain.

var DevBaseURL = fmt.Sprintf("https://dev.%s", BaseDomain)

DevBaseURL the base URL of the dev domain.

var DuoBaseURL = "https://duo.example.com"

DuoBaseURL the base URL of the Duo configuration API.

var HomeBaseURL = fmt.Sprintf("https://home.%s", BaseDomain)

HomeBaseURL the base URL of the home domain.

var LoginBaseURL = fmt.Sprintf("https://login.%s", BaseDomain)

LoginBaseURL the base URL of the login portal.

var MX1MailBaseURL = fmt.Sprintf("https://mx1.mail.%s", BaseDomain)

MX1MailBaseURL the base URL of the mx1.mail domain.

var MX2MailBaseURL = fmt.Sprintf("https://mx2.mail.%s", BaseDomain)

MX2MailBaseURL the base URL of the mx2.mail domain.

var MailBaseURL = fmt.Sprintf("https://mail.%s", BaseDomain)

MailBaseURL the base URL of the mail domain.

var OIDCBaseURL = fmt.Sprintf("https://oidc.%s", BaseDomain)

OIDCBaseURL the base URL of the oidc domain.

var PathPrefix = os.Getenv("PathPrefix")

PathPrefix the prefix/url_base of the login portal.

var PublicBaseURL = fmt.Sprintf("https://public.%s", BaseDomain)

PublicBaseURL the base URL of the public domain.

var SecureBaseURL = fmt.Sprintf("https://secure.%s", BaseDomain)

SecureBaseURL the base URL of the secure domain.

var SingleFactorBaseURL = fmt.Sprintf("https://singlefactor.%s", BaseDomain)

SingleFactorBaseURL the base URL of the singlefactor domain.

Functions

func ConfigureDuo

func ConfigureDuo(t *testing.T, allowDeny DuoPolicy)

ConfigureDuo configure duo api to allow or block auth requests.

func ConfigureDuoPreAuth

func ConfigureDuoPreAuth(t *testing.T, response duo.PreAuthResponse)

ConfigureDuoPreAuth configure duo api to respond with available devices or enrollment Url.

func GetLoginBaseURL

func GetLoginBaseURL() string

GetLoginBaseURL returns the URL of the login portal and the path prefix if specified.

func NewHTTPClient

func NewHTTPClient() *http.Client

NewHTTPClient create a new client skipping TLS verification and not redirecting.

Types

type CommandSuite

type CommandSuite struct {
	suite.Suite

	*DockerEnvironment
	// contains filtered or unexported fields
}

CommandSuite is a command line interface suite.

type DockerEnvironment

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

DockerEnvironment represent a docker environment.

func NewDockerEnvironment

func NewDockerEnvironment(files []string) *DockerEnvironment

NewDockerEnvironment create a new docker environment.

func (*DockerEnvironment) Down

func (de *DockerEnvironment) Down() error

Down destroy a docker environment.

func (*DockerEnvironment) Exec

func (de *DockerEnvironment) Exec(service string, command []string) (string, error)

Exec execute a command within a given service of the environment.

func (*DockerEnvironment) Logs

func (de *DockerEnvironment) Logs(service string, flags []string) (string, error)

Logs get logs of a given service of the environment.

func (*DockerEnvironment) Pull

func (de *DockerEnvironment) Pull(images ...string) error

Pull pull all images of needed in the environment.

func (*DockerEnvironment) Restart

func (de *DockerEnvironment) Restart(service string) error

Restart restarts a service.

func (*DockerEnvironment) Start

func (de *DockerEnvironment) Start(service string) error

Start a docker service.

func (*DockerEnvironment) Stop

func (de *DockerEnvironment) Stop(service string) error

Stop a docker service.

func (*DockerEnvironment) Up

func (de *DockerEnvironment) Up() error

Up spawn a docker environment.

type DuoPolicy

type DuoPolicy int32

DuoPolicy a type of policy.

const (
	// Deny deny policy.
	Deny DuoPolicy = iota
	// Allow allow policy.
	Allow DuoPolicy = iota
)

type K3D

type K3D struct{}

K3D used for running kind commands.

func (K3D) ClusterExists

func (k K3D) ClusterExists() (bool, error)

ClusterExists check whether a cluster exists.

func (K3D) CreateCluster

func (k K3D) CreateCluster() error

CreateCluster create a new Kubernetes cluster.

func (K3D) DeleteCluster

func (k K3D) DeleteCluster() error

DeleteCluster delete a Kubernetes cluster.

func (K3D) LoadImage

func (k K3D) LoadImage(imageName string) error

LoadImage load an image in the Kubernetes container.

type Kubectl

type Kubectl struct{}

Kubectl used for running kubectl commands.

func (Kubectl) GetDashboardToken

func (k Kubectl) GetDashboardToken() error

GetDashboardToken generates bearer token for Kube Dashboard.

func (Kubectl) WaitPodsReady

func (k Kubectl) WaitPodsReady(namespace string, timeout time.Duration) error

WaitPodsReady wait for all pods to be ready.

type Registry

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

Registry represent a registry of suite by name.

var GlobalRegistry *Registry

GlobalRegistry a global registry used by Authelia tooling.

func NewSuitesRegistry

func NewSuitesRegistry() *Registry

NewSuitesRegistry create a suites registry.

func (*Registry) Get

func (sr *Registry) Get(name string) Suite

Get return a suite by name.

func (*Registry) Register

func (sr *Registry) Register(name string, suite Suite)

Register register a suite by name.

func (*Registry) Suites

func (sr *Registry) Suites() []string

Suites list available suites.

type RodSession

type RodSession struct {
	Launcher  *launcher.Launcher
	WebDriver *rod.Browser
}

RodSession binding a chrome session with devtool protocol.

func StartRod

func StartRod() (*RodSession, error)

StartRod create a rod/chromedp session.

func StartRodWithProxy

func StartRodWithProxy(proxy string) (*RodSession, error)

StartRodWithProxy create a rod/chromedp session.

func (*RodSession) Stop

func (rs *RodSession) Stop() error

Stop stop the rod/chromedp session.

func (*RodSession) WaitElementLocatedByClassName

func (rs *RodSession) WaitElementLocatedByClassName(t *testing.T, page *rod.Page, className string) *rod.Element

WaitElementLocatedByClassName wait an element is located by class name.

func (*RodSession) WaitElementLocatedByID

func (rs *RodSession) WaitElementLocatedByID(t *testing.T, page *rod.Page, cssSelector string) *rod.Element

WaitElementLocatedByID waits for an element located by an id.

func (*RodSession) WaitElementsLocatedByID

func (rs *RodSession) WaitElementsLocatedByID(t *testing.T, page *rod.Page, cssSelector string) rod.Elements

WaitElementsLocatedByID waits for an elements located by an id.

type RodSuite

type RodSuite struct {
	suite.Suite

	*RodSession
	*rod.Page
}

RodSuite is a go-rod suite.

type Suite

type Suite struct {
	SetUp        func(tmpPath string) error
	SetUpTimeout time.Duration

	// Callback called when an error occur during setup phase.
	OnSetupTimeout func() error

	// Callback called when at least one test fail.
	OnError func() error

	TestTimeout time.Duration

	TearDown        func(tmpPath string) error
	TearDownTimeout time.Duration

	// A textual description of the suite purpose.
	Description string
}

Suite the definition of a suite.