fix: validate config file extension before use#705
Open
dlevy-msft-sql wants to merge 2 commits intomicrosoft:mainfrom
Open
fix: validate config file extension before use#705dlevy-msft-sql wants to merge 2 commits intomicrosoft:mainfrom
dlevy-msft-sql wants to merge 2 commits intomicrosoft:mainfrom
Conversation
Provide clear error message when user specifies a config file with unsupported extension (e.g., .txt, .json). Only .yaml, .yml, and no extension are allowed.
13 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
When users specify a config file with an unsupported extension (e.g.,
--sqlconfig myfile.txt), they receive a confusing Viper error:Unsupported Config Type 'txt'.Root Cause
No validation of the file extension before passing to Viper.
Code Change
Added
validateConfigFileExtension()that provides a clear error message:Allowed extensions:
.yaml/.yml(case-insensitive)~/.sqlcmd/sqlconfig)The validation runs before creating the file, preventing creation of unusable config files.
Testing
go build ./...internal/configtests pass including new tests:Test_configureViperValidExtensionsTest_configureViperInvalidExtensionTest_validateConfigFileExtensionFixes #690