ergo/irc/config_test.go

// Copyright (c) 2020 Shivaram Lingamneni
// released under the MIT license

package irc

import (
	"reflect"
	"testing"
)

func mungeEnvForTesting(config *Config, env []string, t *testing.T) {
	for _, envPair := range env {
		_, _, err := mungeFromEnvironment(config, envPair)
		if err != nil {
			t.Errorf("couldn't apply override `%s`: %v", envPair, err)
		}
	}
}

func TestEnvironmentOverrides(t *testing.T) {
	var config Config
	config.Server.Compatibility.SendUnprefixedSasl = true
	config.History.Enabled = true
	defaultUserModes := "+i"
	config.Accounts.DefaultUserModes = &defaultUserModes
	config.Server.WebSockets.AllowedOrigins = []string{"https://www.ircv3.net"}
	config.Server.MOTD = "long.motd.txt" // overwrite this
	config.Opers = map[string]*OperConfig{
		"admin": {
			Class:    "server-admin",
			Password: "adminpassword",
		},
	}
	env := []string{
		`USER=shivaram`,        // unrelated var
		`ORAGONO_USER=oragono`, // this should be ignored as well
		`ERGO__NETWORK__NAME=example.com`,
		`ORAGONO__SERVER__COMPATIBILITY__FORCE_TRAILING=false`,
		`ORAGONO__SERVER__COERCE_IDENT="~user"`,
		`ERGO__SERVER__MOTD=short.motd.txt`,
		`ORAGONO__ACCOUNTS__NICK_RESERVATION__ENABLED=true`,
		`ERGO__ACCOUNTS__DEFAULT_USER_MODES="+iR"`,
		`ORAGONO__SERVER__IP_CLOAKING={"enabled": true, "enabled-for-always-on": true, "netname": "irc", "cidr-len-ipv4": 32, "cidr-len-ipv6": 64, "num-bits": 64}`,
		`ERGO__OPERS__ADMIN__PASSWORD="newadminpassword"`,
		`ERGO__OPERS__OPERUSER={"class": "server-admin", "whois-line": "is a server admin", "password": "operpassword"}`,
	}

	mungeEnvForTesting(&config, env, t)

	if config.Network.Name != "example.com" {
		t.Errorf("unexpected value of network.name: %s", config.Network.Name)
	}
	if config.Server.CoerceIdent != "~user" {
		t.Errorf("unexpected value of coerce-ident: %s", config.Server.CoerceIdent)
	}
	if config.Server.MOTD != "short.motd.txt" {
		t.Errorf("unexpected value of motd: %s", config.Server.MOTD)
	}
	if !config.Accounts.NickReservation.Enabled {
		t.Errorf("did not set bool as expected")
	}
	if !config.Server.Compatibility.SendUnprefixedSasl {
		t.Errorf("overwrote unrelated field")
	}
	if !config.History.Enabled {
		t.Errorf("overwrote unrelated field")
	}
	if !reflect.DeepEqual(config.Server.WebSockets.AllowedOrigins, []string{"https://www.ircv3.net"}) {
		t.Errorf("overwrote unrelated field: %#v", config.Server.WebSockets.AllowedOrigins)
	}

	cloakConf := config.Server.Cloaks
	if !(cloakConf.Enabled == true && cloakConf.EnabledForAlwaysOn == true && cloakConf.Netname == "irc" && cloakConf.CidrLenIPv6 == 64) {
		t.Errorf("bad value of Cloaks: %#v", config.Server.Cloaks)
	}

	if *config.Server.Compatibility.ForceTrailing != false {
		t.Errorf("couldn't set unset ptr field to false")
	}

	if *config.Accounts.DefaultUserModes != "+iR" {
		t.Errorf("couldn't override pre-set ptr field")
	}

	if (*config.Opers["admin"]).Password != "newadminpassword" {
		t.Errorf("couldn't index into map and then overwrite")
	}

	if (*config.Opers["operuser"]).Password != "operpassword" {
		t.Errorf("couldn't create new entry in map")
	}
}

func TestEnvironmentInitializeNilMap(t *testing.T) {
	var config Config
	env := []string{
		`ERGO__OPERS__OPERUSER={"class": "server-admin", "whois-line": "is a server admin", "password": "operpassword"}`,
	}

	mungeEnvForTesting(&config, env, t)
	assertEqual((*config.Opers["operuser"]).Password, "operpassword")

	// try with an initialized but empty map:
	config.Opers = make(map[string]*OperConfig)
	mungeEnvForTesting(&config, env, t)
	assertEqual((*config.Opers["operuser"]).Password, "operpassword")
}

func TestEnvironmentCreateNewMap(t *testing.T) {
	var config Config
	env := []string{
		`ERGO__OPERS={"operuser": {"class": "server-admin", "whois-line": "is a server admin", "password": "operpassword"}}`,
	}

	mungeEnvForTesting(&config, env, t)
	assertEqual((*config.Opers["operuser"]).Password, "operpassword")

	// try with an initialized but empty map:
	config.Opers = make(map[string]*OperConfig)
	mungeEnvForTesting(&config, env, t)
	assertEqual((*config.Opers["operuser"]).Password, "operpassword")
}

func TestEnvironmentNonPointerMap(t *testing.T) {
	// edge cases that should not panic, even though the results are unusable
	// since all "field names" get lowercased:
	var config Config
	config.Server.AdditionalISupport = map[string]string{"extban": "a"}
	env := []string{
		`ERGO__SERVER__ADDITIONAL_ISUPPORT__EXTBAN=~,a`,
		`ERGO__FAKELAG__COMMAND_BUDGETS__PRIVMSG=10`,
	}
	mungeEnvForTesting(&config, env, t)
}

func TestEnvironmentOverrideErrors(t *testing.T) {
	var config Config
	config.Server.Compatibility.SendUnprefixedSasl = true
	config.History.Enabled = true

	invalidEnvs := []string{
		`ERGO__=asdf`,
		`ERGO__SERVER__=asdf`,
		`ERGO__SERVER____=asdf`,
		`ERGO__NONEXISTENT_KEY=1`,
		`ERGO__SERVER__NONEXISTENT_KEY=1`,
		// invalid yaml:
		`ERGO__SERVER__IP_CLOAKING__NETNAME="`,
		// invalid type:
		`ERGO__SERVER__IP_CLOAKING__NUM_BITS=asdf`,
		`ERGO__SERVER__STS=[]`,
		// index into non-struct:
		`ERGO__NETWORK__NAME__QUX=1`,
		// private field:
		`ERGO__SERVER__PASSWORDBYTES="asdf"`,
	}

	for _, env := range invalidEnvs {
		success, _, err := mungeFromEnvironment(&config, env)
		if err == nil || success {
			t.Errorf("accepted invalid env override `%s`", env)
		}
	}
}