authelia/internal/configuration/validator/keys_test.go
James Elliott 2c42464fc8
refactor(configuration): use key log instead of logging (#2072)
* refactor: logging config key to log

This refactors the recent pre-release change adding log options to their own configuration section in favor of a log section (from logging).

* docs: add step to getting started to get the latest tagged commit

This is so we avoid issues with changes on master having differences that don't work on the latest docker tag.

* test: adjust tests

* docs: adjust doc strings
2021-06-08 23:15:43 +10:00

127 lines
4.0 KiB
Go

package validator
import (
"fmt"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/authelia/authelia/internal/configuration/schema"
"github.com/authelia/authelia/internal/utils"
)
func TestShouldValidateGoodKeys(t *testing.T) {
configKeys := validKeys
val := schema.NewStructValidator()
ValidateKeys(val, configKeys)
require.Len(t, val.Errors(), 0)
}
func TestShouldNotValidateBadKeys(t *testing.T) {
configKeys := validKeys
configKeys = append(configKeys, "bad_key")
configKeys = append(configKeys, "totp.skewy")
val := schema.NewStructValidator()
ValidateKeys(val, configKeys)
errs := val.Errors()
require.Len(t, errs, 2)
assert.EqualError(t, errs[0], "config key not expected: bad_key")
assert.EqualError(t, errs[1], "config key not expected: totp.skewy")
}
func TestAllSpecificErrorKeys(t *testing.T) {
var configKeys []string //nolint:prealloc // This is because the test is dynamic based on the keys that exist in the map.
var uniqueValues []string
// Setup configKeys and uniqueValues expected.
for key, value := range specificErrorKeys {
configKeys = append(configKeys, key)
if !utils.IsStringInSlice(value, uniqueValues) {
uniqueValues = append(uniqueValues, value)
}
}
val := schema.NewStructValidator()
ValidateKeys(val, configKeys)
errs := val.Errors()
// Check only unique errors are shown. Require because if we don't the next test panics.
require.Len(t, errs, len(uniqueValues))
// Dynamically check all specific errors.
for i, value := range uniqueValues {
assert.EqualError(t, errs[i], value)
}
}
func TestSpecificErrorKeys(t *testing.T) {
configKeys := []string{
"notifier.smtp.trusted_cert",
"google_analytics",
"authentication_backend.file.password_options.algorithm",
"authentication_backend.file.password_options.iterations", // This should not show another error since our target for the specific error is password_options.
"authentication_backend.file.password_hashing.algorithm",
"authentication_backend.file.hashing.algorithm",
}
val := schema.NewStructValidator()
ValidateKeys(val, configKeys)
errs := val.Errors()
require.Len(t, errs, 5)
assert.EqualError(t, errs[0], specificErrorKeys["notifier.smtp.trusted_cert"])
assert.EqualError(t, errs[1], specificErrorKeys["google_analytics"])
assert.EqualError(t, errs[2], specificErrorKeys["authentication_backend.file.password_options.iterations"])
assert.EqualError(t, errs[3], specificErrorKeys["authentication_backend.file.password_hashing.algorithm"])
assert.EqualError(t, errs[4], specificErrorKeys["authentication_backend.file.hashing.algorithm"])
}
func TestReplacedErrors(t *testing.T) {
configKeys := []string{
"authentication_backend.ldap.skip_verify",
"authentication_backend.ldap.minimum_tls_version",
"notifier.smtp.disable_verify_cert",
"logs_file_path",
"logs_level",
}
val := schema.NewStructValidator()
ValidateKeys(val, configKeys)
warns := val.Warnings()
errs := val.Errors()
assert.Len(t, warns, 0)
require.Len(t, errs, 5)
assert.EqualError(t, errs[0], fmt.Sprintf(errFmtReplacedConfigurationKey, "authentication_backend.ldap.skip_verify", "authentication_backend.ldap.tls.skip_verify"))
assert.EqualError(t, errs[1], fmt.Sprintf(errFmtReplacedConfigurationKey, "authentication_backend.ldap.minimum_tls_version", "authentication_backend.ldap.tls.minimum_version"))
assert.EqualError(t, errs[2], fmt.Sprintf(errFmtReplacedConfigurationKey, "notifier.smtp.disable_verify_cert", "notifier.smtp.tls.skip_verify"))
assert.EqualError(t, errs[3], fmt.Sprintf(errFmtReplacedConfigurationKey, "logs_file_path", "log.file_path"))
assert.EqualError(t, errs[4], fmt.Sprintf(errFmtReplacedConfigurationKey, "logs_level", "log.level"))
}
func TestSecretKeysDontRaiseErrors(t *testing.T) {
configKeys := []string{}
for _, key := range SecretNames {
configKeys = append(configKeys, SecretNameToEnvName(key))
configKeys = append(configKeys, key)
}
val := schema.NewStructValidator()
ValidateKeys(val, configKeys)
assert.Len(t, val.Warnings(), 0)
assert.Len(t, val.Errors(), 0)
}