fix: reject non-YAML extensions for --sqlconfig flag

Author: dlevy-msft-sql

README.md

@@ -84,6 +84,17 @@ sqlcmd config connection-strings
 sqlcmd config view
 ```
 
+#### Custom Configuration Files
+
+The `--sqlconfig` flag specifies a custom configuration file. Files must be **YAML format** with a `.yaml` or `.yml` extension:
+
+```
+sqlcmd config --sqlconfig ./myproject.yaml add-endpoint --name ep1434 --address localhost --port 1434
+sqlcmd config --sqlconfig ./myproject.yaml view
+```
+
+The default file (`~/.sqlcmd/sqlconfig`) has no extension but is also YAML.
+
 ### Versions
 
 To see all version tags to choose from (2017, 2019, 2022 etc.), and install a specific version, run:

cmd/modern/root.go

@@ -121,7 +121,7 @@ func (c *Root) addGlobalFlags() {
 		String:        &c.configFilename,
 		DefaultString: config.DefaultFileName(),
 		Name:          "sqlconfig",
-		Usage:         localizer.Sprintf("configuration file"),
+		Usage:         localizer.Sprintf("YAML configuration file (.yaml or .yml extension)"),
 	})
 
 	/* BUG(stuartpa): - At the moment this is a top level flag, but it doesn't

internal/config/config.go

@@ -4,13 +4,16 @@
 package config
 
 import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"strings"
+	"testing"
+
 	. "github.com/microsoft/go-sqlcmd/cmd/modern/sqlconfig"
 	"github.com/microsoft/go-sqlcmd/internal/io/file"
 	"github.com/microsoft/go-sqlcmd/internal/io/folder"
 	"github.com/microsoft/go-sqlcmd/internal/pal"
-	"os"
-	"path/filepath"
-	"testing"
 )
 
 var config Sqlconfig
@@ -24,6 +27,14 @@ func SetFileName(name string) {
 		panic("name is empty")
 	}
 
+	ext := strings.ToLower(filepath.Ext(name))
+	if ext != "" && ext != ".yaml" && ext != ".yml" {
+		checkErr(fmt.Errorf(
+			"configuration file %q has unsupported extension %q (must be .yaml or .yml)",
+			name, ext))
+		return
+	}
+
 	filename = name
 
 	file.CreateEmptyIfNotExists(filename)

internal/config/config_test.go

@@ -4,15 +4,16 @@
 package config
 
 import (
+	"os"
+	"reflect"
+	"strings"
+	"testing"
+
 	. "github.com/microsoft/go-sqlcmd/cmd/modern/sqlconfig"
 	"github.com/microsoft/go-sqlcmd/internal/output"
 	"github.com/microsoft/go-sqlcmd/internal/pal"
 	"github.com/microsoft/go-sqlcmd/internal/secret"
 	"github.com/stretchr/testify/assert"
-	"os"
-	"reflect"
-	"strings"
-	"testing"
 )
 
 func TestConfig(t *testing.T) {
@@ -392,6 +393,13 @@ func TestNegConfig_SetFileName(t *testing.T) {
 	})
 }
 
+func TestNegConfig_SetFileNameBadExtension(t *testing.T) {
+	assert.Panics(t, func() { SetFileName("foo.json") })
+	assert.Panics(t, func() { SetFileName("config.toml") })
+	assert.NotPanics(t, func() { SetFileName(pal.FilenameInUserHomeDotDirectory(".sqlcmd", "sqlconfig-test-yaml.yaml")) })
+	assert.NotPanics(t, func() { SetFileName(pal.FilenameInUserHomeDotDirectory(".sqlcmd", "sqlconfig-test-yml.yml")) })
+}
+
 func TestNegConfig_SetCurrentContextName(t *testing.T) {
 	assert.Panics(t, func() {
 		SetCurrentContextName("does not exist")

internal/translations/catalog.go

@@ -47,11 +47,9 @@
             "fuzzy": true
         },
         {
-            "id": "configuration file",
-            "message": "configuration file",
-            "translation": "Konfigurationsdatei",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
+            "id": "YAML configuration file (.yaml or .yml extension)",
+            "message": "YAML configuration file (.yaml or .yml extension)",
+            "translation": ""
         },
         {
             "id": "log level, error=0, warn=1, info=2, debug=3, trace=4",

internal/translations/locales/de-DE/out.gotext.json

@@ -47,9 +47,9 @@
             "fuzzy": true
         },
         {
-            "id": "configuration file",
-            "message": "configuration file",
-            "translation": "configuration file",
+            "id": "YAML configuration file (.yaml or .yml extension)",
+            "message": "YAML configuration file (.yaml or .yml extension)",
+            "translation": "YAML configuration file (.yaml or .yml extension)",
             "translatorComment": "Copied from source.",
             "fuzzy": true
         },

internal/translations/locales/en-US/out.gotext.json

@@ -47,11 +47,9 @@
             "fuzzy": true
         },
         {
-            "id": "configuration file",
-            "message": "configuration file",
-            "translation": "archivo de configuración",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
+            "id": "YAML configuration file (.yaml or .yml extension)",
+            "message": "YAML configuration file (.yaml or .yml extension)",
+            "translation": ""
         },
         {
             "id": "log level, error=0, warn=1, info=2, debug=3, trace=4",

internal/translations/locales/es-ES/out.gotext.json

@@ -47,11 +47,9 @@
             "fuzzy": true
         },
         {
-            "id": "configuration file",
-            "message": "configuration file",
-            "translation": "fichier de configuration",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
+            "id": "YAML configuration file (.yaml or .yml extension)",
+            "message": "YAML configuration file (.yaml or .yml extension)",
+            "translation": ""
         },
         {
             "id": "log level, error=0, warn=1, info=2, debug=3, trace=4",

internal/translations/locales/fr-FR/out.gotext.json

@@ -47,11 +47,9 @@
             "fuzzy": true
         },
         {
-            "id": "configuration file",
-            "message": "configuration file",
-            "translation": "file di configurazione",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
+            "id": "YAML configuration file (.yaml or .yml extension)",
+            "message": "YAML configuration file (.yaml or .yml extension)",
+            "translation": ""
         },
         {
             "id": "log level, error=0, warn=1, info=2, debug=3, trace=4",