mirror of
https://github.com/0rangebananaspy/authelia.git
synced 2024-09-14 22:47:21 +07:00
b4e570358e
* build: include major in go.mod module directive * fix: xflags * revert: cobra changes * fix: mock doc
222 lines
7.5 KiB
Go
222 lines
7.5 KiB
Go
package validator
|
|
|
|
import (
|
|
"fmt"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/authelia/authelia/v4/internal/configuration/schema"
|
|
)
|
|
|
|
func TestShouldSetDefaultServerValues(t *testing.T) {
|
|
validator := schema.NewStructValidator()
|
|
config := &schema.Configuration{}
|
|
|
|
ValidateServer(config, validator)
|
|
|
|
assert.Len(t, validator.Errors(), 0)
|
|
assert.Len(t, validator.Warnings(), 0)
|
|
|
|
assert.Equal(t, schema.DefaultServerConfiguration.Host, config.Server.Host)
|
|
assert.Equal(t, schema.DefaultServerConfiguration.Port, config.Server.Port)
|
|
assert.Equal(t, schema.DefaultServerConfiguration.ReadBufferSize, config.Server.ReadBufferSize)
|
|
assert.Equal(t, schema.DefaultServerConfiguration.WriteBufferSize, config.Server.WriteBufferSize)
|
|
assert.Equal(t, schema.DefaultServerConfiguration.TLS.Key, config.Server.TLS.Key)
|
|
assert.Equal(t, schema.DefaultServerConfiguration.TLS.Certificate, config.Server.TLS.Certificate)
|
|
assert.Equal(t, schema.DefaultServerConfiguration.Path, config.Server.Path)
|
|
assert.Equal(t, schema.DefaultServerConfiguration.EnableExpvars, config.Server.EnableExpvars)
|
|
assert.Equal(t, schema.DefaultServerConfiguration.EnablePprof, config.Server.EnablePprof)
|
|
}
|
|
|
|
// TODO: DEPRECATED TEST. Remove in 4.33.0.
|
|
func TestShouldNotOverrideNewValuesWithDeprecatedValues(t *testing.T) {
|
|
validator := schema.NewStructValidator()
|
|
config := &schema.Configuration{Host: "123.0.0.1", Port: 9101, TLSKey: "/tmp/key.pem", TLSCert: "/tmp/cert.pem"}
|
|
config.Server.Host = "192.168.0.2"
|
|
config.Server.Port = 80
|
|
config.Server.TLS.Key = "/tmp/new/key.pem"
|
|
config.Server.TLS.Certificate = "/tmp/new/cert.pem"
|
|
|
|
ValidateServer(config, validator)
|
|
|
|
require.Len(t, validator.Errors(), 0)
|
|
require.Len(t, validator.Warnings(), 4)
|
|
|
|
assert.EqualError(t, validator.Warnings()[0], fmt.Sprintf(errFmtDeprecatedConfigurationKey, "host", "4.33.0", "server.host"))
|
|
assert.EqualError(t, validator.Warnings()[1], fmt.Sprintf(errFmtDeprecatedConfigurationKey, "port", "4.33.0", "server.port"))
|
|
assert.EqualError(t, validator.Warnings()[2], fmt.Sprintf(errFmtDeprecatedConfigurationKey, "tls_cert", "4.33.0", "server.tls_cert"))
|
|
assert.EqualError(t, validator.Warnings()[3], fmt.Sprintf(errFmtDeprecatedConfigurationKey, "tls_key", "4.33.0", "server.tls_key"))
|
|
|
|
assert.Equal(t, "192.168.0.2", config.Server.Host)
|
|
assert.Equal(t, 80, config.Server.Port)
|
|
assert.Equal(t, "/tmp/new/key.pem", config.Server.TLS.Key)
|
|
assert.Equal(t, "/tmp/new/cert.pem", config.Server.TLS.Certificate)
|
|
}
|
|
|
|
// TODO: DEPRECATED TEST. Remove in 4.33.0.
|
|
func TestShouldSetDeprecatedValues(t *testing.T) {
|
|
validator := schema.NewStructValidator()
|
|
config := &schema.Configuration{}
|
|
|
|
config.Host = "192.168.0.1"
|
|
config.Port = 80
|
|
config.TLSCert = "/tmp/cert.pem"
|
|
config.TLSKey = "/tmp/key.pem"
|
|
|
|
ValidateServer(config, validator)
|
|
|
|
assert.Len(t, validator.Errors(), 0)
|
|
require.Len(t, validator.Warnings(), 4)
|
|
|
|
assert.Equal(t, "192.168.0.1", config.Server.Host)
|
|
assert.Equal(t, 80, config.Server.Port)
|
|
assert.Equal(t, "/tmp/cert.pem", config.Server.TLS.Certificate)
|
|
assert.Equal(t, "/tmp/key.pem", config.Server.TLS.Key)
|
|
|
|
assert.EqualError(t, validator.Warnings()[0], fmt.Sprintf(errFmtDeprecatedConfigurationKey, "host", "4.33.0", "server.host"))
|
|
assert.EqualError(t, validator.Warnings()[1], fmt.Sprintf(errFmtDeprecatedConfigurationKey, "port", "4.33.0", "server.port"))
|
|
assert.EqualError(t, validator.Warnings()[2], fmt.Sprintf(errFmtDeprecatedConfigurationKey, "tls_cert", "4.33.0", "server.tls_cert"))
|
|
assert.EqualError(t, validator.Warnings()[3], fmt.Sprintf(errFmtDeprecatedConfigurationKey, "tls_key", "4.33.0", "server.tls_key"))
|
|
}
|
|
|
|
func TestShouldSetDefaultConfig(t *testing.T) {
|
|
validator := schema.NewStructValidator()
|
|
config := &schema.Configuration{}
|
|
|
|
ValidateServer(config, validator)
|
|
|
|
assert.Len(t, validator.Errors(), 0)
|
|
assert.Len(t, validator.Warnings(), 0)
|
|
|
|
assert.Equal(t, schema.DefaultServerConfiguration.ReadBufferSize, config.Server.ReadBufferSize)
|
|
assert.Equal(t, schema.DefaultServerConfiguration.WriteBufferSize, config.Server.WriteBufferSize)
|
|
}
|
|
|
|
func TestShouldParsePathCorrectly(t *testing.T) {
|
|
validator := schema.NewStructValidator()
|
|
config := &schema.Configuration{
|
|
Server: schema.ServerConfiguration{
|
|
Path: "apple",
|
|
},
|
|
}
|
|
|
|
ValidateServer(config, validator)
|
|
|
|
assert.Len(t, validator.Errors(), 0)
|
|
assert.Len(t, validator.Warnings(), 0)
|
|
|
|
assert.Equal(t, "/apple", config.Server.Path)
|
|
}
|
|
|
|
func TestShouldRaiseOnNegativeValues(t *testing.T) {
|
|
validator := schema.NewStructValidator()
|
|
config := &schema.Configuration{
|
|
Server: schema.ServerConfiguration{
|
|
ReadBufferSize: -1,
|
|
WriteBufferSize: -1,
|
|
},
|
|
}
|
|
|
|
ValidateServer(config, validator)
|
|
|
|
require.Len(t, validator.Errors(), 2)
|
|
|
|
assert.EqualError(t, validator.Errors()[0], "server read buffer size must be above 0")
|
|
assert.EqualError(t, validator.Errors()[1], "server write buffer size must be above 0")
|
|
}
|
|
|
|
func TestShouldRaiseOnNonAlphanumericCharsInPath(t *testing.T) {
|
|
validator := schema.NewStructValidator()
|
|
config := &schema.Configuration{
|
|
Server: schema.ServerConfiguration{
|
|
Path: "app le",
|
|
},
|
|
}
|
|
|
|
ValidateServer(config, validator)
|
|
|
|
require.Len(t, validator.Errors(), 1)
|
|
|
|
assert.Error(t, validator.Errors()[0], "server path must only be alpha numeric characters")
|
|
}
|
|
|
|
func TestShouldRaiseOnForwardSlashInPath(t *testing.T) {
|
|
validator := schema.NewStructValidator()
|
|
config := &schema.Configuration{
|
|
Server: schema.ServerConfiguration{
|
|
Path: "app/le",
|
|
},
|
|
}
|
|
|
|
ValidateServer(config, validator)
|
|
|
|
assert.Len(t, validator.Errors(), 1)
|
|
|
|
assert.Error(t, validator.Errors()[0], "server path must not contain any forward slashes")
|
|
}
|
|
|
|
func TestShouldValidateAndUpdateHost(t *testing.T) {
|
|
validator := schema.NewStructValidator()
|
|
config := newDefaultConfig()
|
|
config.Server.Host = ""
|
|
|
|
ValidateServer(&config, validator)
|
|
|
|
require.Len(t, validator.Errors(), 0)
|
|
assert.Equal(t, "0.0.0.0", config.Server.Host)
|
|
}
|
|
|
|
func TestShouldRaiseErrorWhenTLSCertWithoutKeyIsProvided(t *testing.T) {
|
|
validator := schema.NewStructValidator()
|
|
config := newDefaultConfig()
|
|
config.Server.TLS.Certificate = testTLSCert
|
|
|
|
ValidateServer(&config, validator)
|
|
require.Len(t, validator.Errors(), 1)
|
|
assert.EqualError(t, validator.Errors()[0], "server: no TLS key provided to accompany the TLS certificate, please configure the 'server.tls.key' option")
|
|
}
|
|
|
|
func TestShouldRaiseErrorWhenTLSKeyWithoutCertIsProvided(t *testing.T) {
|
|
validator := schema.NewStructValidator()
|
|
config := newDefaultConfig()
|
|
config.Server.TLS.Key = testTLSKey
|
|
|
|
ValidateServer(&config, validator)
|
|
require.Len(t, validator.Errors(), 1)
|
|
assert.EqualError(t, validator.Errors()[0], "server: no TLS certificate provided to accompany the TLS key, please configure the 'server.tls.certificate' option")
|
|
}
|
|
|
|
func TestShouldNotRaiseErrorWhenBothTLSCertificateAndKeyAreProvided(t *testing.T) {
|
|
validator := schema.NewStructValidator()
|
|
config := newDefaultConfig()
|
|
config.Server.TLS.Certificate = testTLSCert
|
|
config.Server.TLS.Key = testTLSKey
|
|
|
|
ValidateServer(&config, validator)
|
|
require.Len(t, validator.Errors(), 0)
|
|
}
|
|
|
|
func TestShouldNotUpdateConfig(t *testing.T) {
|
|
validator := schema.NewStructValidator()
|
|
config := newDefaultConfig()
|
|
|
|
ValidateServer(&config, validator)
|
|
|
|
require.Len(t, validator.Errors(), 0)
|
|
assert.Equal(t, 9090, config.Server.Port)
|
|
assert.Equal(t, loopback, config.Server.Host)
|
|
}
|
|
|
|
func TestShouldValidateAndUpdatePort(t *testing.T) {
|
|
validator := schema.NewStructValidator()
|
|
config := newDefaultConfig()
|
|
config.Server.Port = 0
|
|
|
|
ValidateServer(&config, validator)
|
|
|
|
require.Len(t, validator.Errors(), 0)
|
|
assert.Equal(t, 9091, config.Server.Port)
|
|
}
|