coderdenttest
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
- Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Open Source Insights
Documentation¶
Index¶
- Variables
- func AddFullLicense(t *testing.T, client *codersdk.Client) codersdk.License
- func AddLicense(t *testing.T, client *codersdk.Client, options LicenseOptions) codersdk.License
- func CreateOrganization(t *testing.T, client *codersdk.Client, opts CreateOrganizationOptions, ...) codersdk.Organization
- func GenerateLicense(t *testing.T, options LicenseOptions) string
- func New(t *testing.T, options *Options) (*codersdk.Client, codersdk.CreateFirstUserResponse)
- func NewExternalProvisionerDaemon(t testing.TB, client *codersdk.Client, org uuid.UUID, tags map[string]string) io.Closer
- func NewExternalProvisionerDaemonTerraform(t testing.TB, client *codersdk.Client, org uuid.UUID, tags map[string]string) io.Closer
- func NewWithAPI(t *testing.T, options *Options) (*codersdk.Client, io.Closer, *coderd.API, codersdk.CreateFirstUserResponse)
- func NewWithDatabase(t *testing.T, options *Options) (*codersdk.Client, database.Store, codersdk.CreateFirstUserResponse)
- type CreateOrganizationOptions
- type LicenseOptions
- func (opts *LicenseOptions) Expired(now time.Time) *LicenseOptions
- func (opts *LicenseOptions) Feature(name codersdk.FeatureName, value int64) *LicenseOptions
- func (opts *LicenseOptions) FutureTerm(now time.Time) *LicenseOptions
- func (opts *LicenseOptions) Generate(t *testing.T) string
- func (opts *LicenseOptions) GracePeriod(now time.Time) *LicenseOptions
- func (opts *LicenseOptions) UserLimit(limit int64) *LicenseOptions
- func (opts *LicenseOptions) Valid(now time.Time) *LicenseOptions
- type Options
- type ProxyOptions
- type WorkspaceProxy
Constants¶
This section is empty.
Variables¶
var (Keys = map[string]ed25519.PublicKey{})Functions¶
funcAddFullLicense¶
AddFullLicense generates a license with all features enabled.
funcAddLicense¶
AddLicense generates a new license with the options provided and inserts it.
funcCreateOrganization¶added inv2.14.0
func CreateOrganization(t *testing.T, client *codersdk.Client, optsCreateOrganizationOptions, mutators ...func(*codersdk.CreateOrganizationRequest))codersdk.Organization
funcGenerateLicense¶
func GenerateLicense(t *testing.T, optionsLicenseOptions)string
GenerateLicense returns a signed JWT using the test key.
funcNewExternalProvisionerDaemon¶added inv2.14.0
func NewExternalProvisionerDaemon(ttesting.TB, client *codersdk.Client, orguuid.UUID, tags map[string]string)io.Closer
NewExternalProvisionerDaemon runs an external provisioner daemon in agoroutine and returns a closer to stop it. The echo provisioner is usedhere. This is the default provisioner for tests and should be fine formost use cases. If you need to test terraform-specific behaviors, useNewExternalProvisionerDaemonTerraform instead.
funcNewExternalProvisionerDaemonTerraform¶added inv2.18.2
func NewExternalProvisionerDaemonTerraform(ttesting.TB, client *codersdk.Client, orguuid.UUID, tags map[string]string)io.Closer
NewExternalProvisionerDaemonTerraform runs an external provisioner daemon ina goroutine and returns a closer to stop it. The terraform provisioner isused here. Avoid using this unless you need to test terraform-specificbehaviors!
funcNewWithAPI¶
Types¶
typeCreateOrganizationOptions¶added inv2.14.0
type CreateOrganizationOptions struct {// IncludeProvisionerDaemon will spin up an external provisioner for the organization.// This requires enterprise and the feature 'codersdk.FeatureExternalProvisionerDaemons'IncludeProvisionerDaemonbool}typeLicenseOptions¶
type LicenseOptions struct {AccountTypestringAccountIDstringDeploymentIDs []stringTrialboolFeatureSetcodersdk.FeatureSetAllFeaturesbool// GraceAt is the time at which the license will enter the grace period.GraceAttime.Time// ExpiresAt is the time at which the license will hard expire.// ExpiresAt should always be greater then GraceAt.ExpiresAttime.Time// NotBefore is the time at which the license becomes valid. If set to the// zero value, the `nbf` claim on the license is set to 1 minute in the// past.NotBeforetime.TimeFeatureslicense.Features}LicenseOptions is used to generate a license for testing.It supports the builder pattern for easy customization.
func (*LicenseOptions)Expired¶added inv2.14.0
func (opts *LicenseOptions) Expired(nowtime.Time) *LicenseOptions
func (*LicenseOptions)Feature¶added inv2.14.0
func (opts *LicenseOptions) Feature(namecodersdk.FeatureName, valueint64) *LicenseOptions
func (*LicenseOptions)FutureTerm¶added inv2.14.3
func (opts *LicenseOptions) FutureTerm(nowtime.Time) *LicenseOptions
func (*LicenseOptions)Generate¶added inv2.14.0
func (opts *LicenseOptions) Generate(t *testing.T)string
func (*LicenseOptions)GracePeriod¶added inv2.14.0
func (opts *LicenseOptions) GracePeriod(nowtime.Time) *LicenseOptions
func (*LicenseOptions)UserLimit¶added inv2.14.0
func (opts *LicenseOptions) UserLimit(limitint64) *LicenseOptions
func (*LicenseOptions)Valid¶added inv2.14.0
func (opts *LicenseOptions) Valid(nowtime.Time) *LicenseOptions
typeOptions¶
type Options struct {*coderdtest.OptionsAuditLoggingboolBrowserOnlyboolEntitlementsUpdateIntervaltime.DurationSCIMAPIKey []byteUserWorkspaceQuotaintProxyHealthIntervaltime.DurationLicenseOptions *LicenseOptionsDontAddLicenseboolDontAddFirstUserboolReplicaSyncUpdateIntervaltime.DurationReplicaErrorGracePeriodtime.DurationExternalTokenEncryption []dbcrypt.CipherProvisionerDaemonPSKstring}typeProxyOptions¶
type ProxyOptions struct {NamestringExperimentscodersdk.ExperimentsTLSCertificates []tls.CertificateAppHostnamestringDisablePathAppsboolDerpDisabledboolDerpOnlyboolBlockDirectbool// ProxyURL is optionalProxyURL *url.URL// Token is optional. If specified, a new workspace proxy region will not be// created, and the proxy will become a replica of the existing proxy// region.Tokenstring// ReplicaPingCallback is optional.ReplicaPingCallback func(replicas []codersdk.Replica, errstring)// FlushStats is optionalFlushStats chan chan<- struct{}}typeWorkspaceProxy¶added inv2.8.5
funcNewWorkspaceProxyReplica¶added inv2.8.5
func NewWorkspaceProxyReplica(t *testing.T, coderdAPI *coderd.API, owner *codersdk.Client, options *ProxyOptions)WorkspaceProxy
NewWorkspaceProxyReplica will configure a wsproxy.Server with the givenoptions. The new wsproxy replica will register itself with the givencoderd.API instance.
If a token is not provided, a new workspace proxy region is created using theowner client. If a token is provided, the proxy will become a replica of theexisting proxy region.
Source Files