Lowercase readConfig.

Author: sbruens

cmd/outline-ss-server/config.go

@@ -58,8 +58,8 @@ type Config struct {
 	Keys []LegacyKeyService
 }
 
-// Reads a config from a filename and parses it as a [Config].
-func ReadConfig(filename string) (*Config, error) {
+// readConfig attempts to read a config from a filename and parses it as a [Config].
+func readConfig(filename string) (*Config, error) {
 	config := Config{}
 	configData, err := os.ReadFile(filename)
 	if err != nil {

cmd/outline-ss-server/config_test.go

@@ -22,7 +22,7 @@ import (
 )
 
 func TestReadConfig(t *testing.T) {
-	config, err := ReadConfig("./config_example.yml")
+	config, err := readConfig("./config_example.yml")
 
 	require.NoError(t, err)
 	expected := Config{
@@ -52,7 +52,7 @@ func TestReadConfig(t *testing.T) {
 }
 
 func TestReadConfigParsesDeprecatedFormat(t *testing.T) {
-	config, err := ReadConfig("./config_example.deprecated.yml")
+	config, err := readConfig("./config_example.deprecated.yml")
 
 	require.NoError(t, err)
 	expected := Config{
@@ -77,14 +77,14 @@ func TestReadConfigParsesDeprecatedFormat(t *testing.T) {
 func TestReadConfigFromEmptyFile(t *testing.T) {
 	file, _ := os.CreateTemp("", "empty.yaml")
 
-	config, err := ReadConfig(file.Name())
+	config, err := readConfig(file.Name())
 
 	require.NoError(t, err)
 	require.ElementsMatch(t, Config{}, config)
 }
 
 func TestReadConfigFromNonExistingFileFails(t *testing.T) {
-	config, err := ReadConfig("./foo")
+	config, err := readConfig("./foo")
 
 	require.Error(t, err)
 	require.ElementsMatch(t, nil, config)
@@ -94,7 +94,7 @@ func TestReadConfigFromIncorrectFormatFails(t *testing.T) {
 	file, _ := os.CreateTemp("", "empty.yaml")
 	file.WriteString("foo")
 
-	config, err := ReadConfig(file.Name())
+	config, err := readConfig(file.Name())
 
 	require.Error(t, err)
 	require.ElementsMatch(t, Config{}, config)

cmd/outline-ss-server/main.go

@@ -129,7 +129,7 @@ func (s *SSServer) remove(addr string) error {
 }
 
 func (s *SSServer) loadConfig(filename string) error {
-	config, err := ReadConfig(filename)
+	config, err := readConfig(filename)
 	if err != nil {
 		return fmt.Errorf("failed to load config (%v): %w", filename, err)
 	}