🎧 Your Personal Streaming Service
Go airsonicmadsonicmedia-servermusicmusic-servernavidromeopensubsonicraspberry-piself-hostedstreamerstreaming-apistreaming-audiosubsonicsubsonic-server
chore(deps): upgrade viper to 1.20.0, add tests for the supported config formats
Deluan0147bb5f12a6
diff --git a/conf/configuration.go b/conf/configuration.goindex e1e6b2f67..9abb7e163 100644--- a/conf/configuration.go+++ b/conf/configuration.go@@ -10,6 +10,7 @@ import ("time""github.com/bmatcuk/doublestar/v4"+ "github.com/go-viper/encoding/ini""github.com/kr/pretty""github.com/navidrome/navidrome/consts""github.com/navidrome/navidrome/log"@@ -549,6 +550,10 @@ func init() {}func InitConfig(cfgFile string) {+ codecRegistry := viper.NewCodecRegistry()+ _ = codecRegistry.RegisterCodec("ini", ini.Codec{})+ viper.SetOptions(viper.WithCodecRegistry(codecRegistry))+cfgFile = getConfigFile(cfgFile)if cfgFile != "" {// Use config file from the flag.diff --git a/conf/configuration_test.go b/conf/configuration_test.gonew file mode 100644index 000000000..f57764709--- /dev/null+++ b/conf/configuration_test.go@@ -0,0 +1,50 @@+package conf_test++import (+ "fmt"+ "path/filepath"+ "testing"++ . "github.com/navidrome/navidrome/conf"+ . "github.com/onsi/ginkgo/v2"+ . "github.com/onsi/gomega"+ "github.com/spf13/viper"+)++func TestConfiguration(t *testing.T) {+ RegisterFailHandler(Fail)+ RunSpecs(t, "Configuration Suite")+}++var _ = Describe("Configuration", func() {+ BeforeEach(func() {+ // Reset viper configuration+ viper.Reset()+ viper.SetDefault("datafolder", GinkgoT().TempDir())+ viper.SetDefault("loglevel", "error")+ ResetConf()+ })++ DescribeTable("should load configuration from",+ func(format string) {+ filename := filepath.Join("testdata", "cfg."+format)++ // Initialize config with the test file+ InitConfig(filename)+ // Load the configuration (with noConfigDump=true)+ Load(true)++ // Execute the format-specific assertions+ Expect(Server.MusicFolder).To(Equal(fmt.Sprintf("/%s/music", format)))+ Expect(Server.UIWelcomeMessage).To(Equal("Welcome " + format))+ Expect(Server.Tags["custom"].Aliases).To(Equal([]string{format, "test"}))++ // The config file used should be the one we created+ Expect(Server.ConfigFile).To(Equal(filename))+ },+ Entry("TOML format", "toml"),+ Entry("YAML format", "yaml"),+ Entry("INI format", "ini"),+ Entry("JSON format", "json"),+ )+})diff --git a/conf/export_test.go b/conf/export_test.gonew file mode 100644index 000000000..0bd7819eb--- /dev/null+++ b/conf/export_test.go@@ -0,0 +1,5 @@+package conf++func ResetConf() {+ Server = &configOptions{}+}diff --git a/conf/testdata/cfg.ini b/conf/testdata/cfg.ininew file mode 100644index 000000000..cec7d3c70--- /dev/null+++ b/conf/testdata/cfg.ini@@ -0,0 +1,6 @@+[default]+MusicFolder = /ini/music+UIWelcomeMessage = Welcome ini++[Tags]+Custom.Aliases = ini,test\ No newline at end of filediff --git a/conf/testdata/cfg.json b/conf/testdata/cfg.jsonnew file mode 100644index 000000000..37cf74f08--- /dev/null+++ b/conf/testdata/cfg.json@@ -0,0 +1,12 @@+{+ "musicFolder": "/json/music",+ "uiWelcomeMessage": "Welcome json",+ "Tags": {+ "custom": {+ "aliases": [+ "json",+ "test"+ ]+ }+ }+}\ No newline at end of filediff --git a/conf/testdata/cfg.toml b/conf/testdata/cfg.tomlnew file mode 100644index 000000000..1dc852b18--- /dev/null+++ b/conf/testdata/cfg.toml@@ -0,0 +1,5 @@+musicFolder = "/toml/music"+uiWelcomeMessage = "Welcome toml"++[Tags.custom]+aliases = ["toml", "test"]diff --git a/conf/testdata/cfg.yaml b/conf/testdata/cfg.yamlnew file mode 100644index 000000000..38b98d4aa--- /dev/null+++ b/conf/testdata/cfg.yaml@@ -0,0 +1,7 @@+musicFolder: "/yaml/music"+uiWelcomeMessage: "Welcome yaml"+Tags:+ custom:+ aliases:+ - yaml+ - testdiff --git a/go.mod b/go.modindex f88a05abc..158409f53 100644--- a/go.mod+++ b/go.mod@@ -26,6 +26,7 @@ require (github.com/go-chi/cors v1.2.1github.com/go-chi/httprate v0.14.1github.com/go-chi/jwtauth/v5 v5.3.2+ github.com/go-viper/encoding/ini v0.1.1github.com/gohugoio/hashstructure v0.5.0github.com/google/go-pipeline v0.0.0-20230411140531-6cbedfc1d3fcgithub.com/google/uuid v1.6.0@@ -50,7 +51,7 @@ require (github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06github.com/sirupsen/logrus v1.9.3github.com/spf13/cobra v1.9.1- github.com/spf13/viper v1.19.0+ github.com/spf13/viper v1.20.0github.com/stretchr/testify v1.10.0github.com/unrolled/secure v1.17.0github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1@@ -76,13 +77,13 @@ require (github.com/fsnotify/fsnotify v1.8.0 // indirectgithub.com/go-logr/logr v1.4.2 // indirectgithub.com/go-task/slim-sprig/v3 v3.0.0 // indirect+ github.com/go-viper/mapstructure/v2 v2.2.1 // indirectgithub.com/goccy/go-json v0.10.5 // indirectgithub.com/google/go-cmp v0.7.0 // indirectgithub.com/google/pprof v0.0.0-20250302191652-9094ed2288e7 // indirectgithub.com/google/subcommands v1.2.0 // indirectgithub.com/gorilla/css v1.0.1 // indirectgithub.com/hashicorp/errwrap v1.1.0 // indirect- github.com/hashicorp/hcl v1.0.0 // indirectgithub.com/inconshreveable/mousetrap v1.1.0 // indirectgithub.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 // indirectgithub.com/klauspost/compress v1.17.11 // indirect@@ -94,9 +95,7 @@ require (github.com/lestrrat-go/httprc v1.0.6 // indirectgithub.com/lestrrat-go/iter v1.0.2 // indirectgithub.com/lestrrat-go/option v1.0.1 // indirect- github.com/magiconair/properties v1.8.9 // indirectgithub.com/mfridman/interpolate v0.0.2 // indirect- github.com/mitchellh/mapstructure v1.5.0 // indirectgithub.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirectgithub.com/ogier/pflag v0.0.1 // indirectgithub.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect@@ -105,7 +104,6 @@ require (github.com/prometheus/procfs v0.15.1 // indirectgithub.com/rogpeppe/go-internal v1.14.1 // indirectgithub.com/sagikazarmark/locafero v0.7.0 // indirect- github.com/sagikazarmark/slog-shim v0.1.0 // indirectgithub.com/segmentio/asm v1.2.0 // indirectgithub.com/sethvargo/go-retry v0.3.0 // indirectgithub.com/sourcegraph/conc v0.3.0 // indirectdiff --git a/go.sum b/go.sumindex 61d6ab157..b4d8b72aa 100644--- a/go.sum+++ b/go.sum@@ -70,6 +70,10 @@ github.com/go-sql-driver/mysql v1.8.1 h1:LedoTUt/eveggdHS9qUFC1EFSa8bU2+1pZjSRpvgithub.com/go-sql-driver/mysql v1.8.1/go.mod h1:wEBSXgmK//2ZFJyE+qWnIsVGmvmEKlqwuVSjsCm7DZg=github.com/go-task/slim-sprig/v3 v3.0.0 h1:sUs3vkvUymDpBKi3qH1YSqBQk9+9D/8M2mN1vB6EwHI=github.com/go-task/slim-sprig/v3 v3.0.0/go.mod h1:W848ghGpv3Qj3dhTPRyJypKRiqCdHZiAzKg9hl15HA8=+github.com/go-viper/encoding/ini v0.1.1 h1:MVWY7B2XNw7lnOqHutGRc97bF3rP7omOdgjdMPAJgbs=+github.com/go-viper/encoding/ini v0.1.1/go.mod h1:Pfi4M2V1eAGJVZ5q6FrkHPhtHED2YgLlXhvgMVrB+YQ=+github.com/go-viper/mapstructure/v2 v2.2.1 h1:ZAaOCxANMuZx5RCeg0mBdEZk7DZasvvZIxtHqx8aGss=+github.com/go-viper/mapstructure/v2 v2.2.1/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=github.com/goccy/go-json v0.10.5 h1:Fq85nIqj+gXn/S5ahsiTlK3TmC85qgirsdTP/+DeaC4=github.com/goccy/go-json v0.10.5/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M=github.com/gohugoio/hashstructure v0.5.0 h1:G2fjSBU36RdwEJBWJ+919ERvOVqAg9tfcYp47K9swqg=@@ -98,11 +102,8 @@ github.com/hashicorp/errwrap v1.1.0 h1:OxrOeh75EUXMY8TBjag2fzXGZ40LB6IKw45YeGUDYgithub.com/hashicorp/errwrap v1.1.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=github.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+lD48awMYo=github.com/hashicorp/go-multierror v1.1.1/go.mod h1:iw975J/qwKPdAO1clOe2L8331t/9/fmwbPZ6JB6eMoM=-github.com/hashicorp/golang-lru v0.5.4 h1:YDjusn29QI/Das2iO9M0BHnIbxPeyuCHsjMW+lJfyTc=github.com/hashicorp/golang-lru/v2 v2.0.7 h1:a+bsQ5rvGLjzHuww6tVxozPZFVghXaHOwFs4luLUK2k=github.com/hashicorp/golang-lru/v2 v2.0.7/go.mod h1:QeFd9opnmA6QUJc5vARoKUSoFhyfM2/ZepoAG6RGpeM=-github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4=-github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=github.com/jellydator/ttlcache/v3 v3.3.0 h1:BdoC9cE81qXfrxeb9eoJi9dWrdhSuwXMAnHTbnBm4Wc=@@ -141,8 +142,6 @@ github.com/lestrrat-go/jwx/v2 v2.1.4 h1:uBCMmJX8oRZStmKuMMOFb0Yh9xmEMgNJLgjuKKt4github.com/lestrrat-go/jwx/v2 v2.1.4/go.mod h1:nWRbDFR1ALG2Z6GJbBXzfQaYyvn751KuuyySN2yR6is=github.com/lestrrat-go/option v1.0.1 h1:oAzP2fvZGQKWkvHa1/SAcFolBEca1oN+mQ7eooNBEYU=github.com/lestrrat-go/option v1.0.1/go.mod h1:5ZHFbivi4xwXxhxY9XHDe2FHo6/Z7WWmtT7T5nBBp3I=-github.com/magiconair/properties v1.8.9 h1:nWcCbLq1N2v/cpNsy5WvQ37Fb+YElfq20WJ/a8RkpQM=-github.com/magiconair/properties v1.8.9/go.mod h1:Dhd985XPs7jluiymwWYZ0G4Z61jb3vdS329zhj2hYo0=github.com/matoous/go-nanoid/v2 v2.1.0 h1:P64+dmq21hhWdtvZfEAofnvJULaRR1Yib0+PnU669bE=github.com/matoous/go-nanoid/v2 v2.1.0/go.mod h1:KlbGNQ+FhrUNIHUxZdL63t7tl4LaPkZNpUULS8H4uVM=github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=@@ -155,8 +154,6 @@ github.com/microcosm-cc/bluemonday v1.0.27 h1:MpEUotklkwCSLeH+Qdx1VJgNqLlpY2KXwXgithub.com/microcosm-cc/bluemonday v1.0.27/go.mod h1:jFi9vgW+H7c3V0lb6nR74Ib/DIB5OBs92Dimizgw2cA=github.com/mileusna/useragent v1.3.5 h1:SJM5NzBmh/hO+4LGeATKpaEX9+b4vcGg2qXGLiNGDws=github.com/mileusna/useragent v1.3.5/go.mod h1:3d8TOmwL/5I8pJjyVDteHtgDGcefrFUX4ccGOMKNYYc=-github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=-github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq1c1nUAm88MOHcQC9l5mIlSMApZMrHA=github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ=github.com/ncruces/go-strftime v0.1.9 h1:bY0MQC28UADQmHmaF5dgpLmImcShSi2kHU9XLdhx/f4=@@ -199,8 +196,6 @@ github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjgithub.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs=github.com/sagikazarmark/locafero v0.7.0 h1:5MqpDsTGNDhY8sGp0Aowyf0qKsPrhewaLSsFaodPcyo=github.com/sagikazarmark/locafero v0.7.0/go.mod h1:2za3Cg5rMaTMoG/2Ulr9AwtFaIppKXTRYnozin4aB5k=-github.com/sagikazarmark/slog-shim v0.1.0 h1:diDBnUNK9N/354PgrxMywXnAwEr1QZcOr6gto+ugjYE=-github.com/sagikazarmark/slog-shim v0.1.0/go.mod h1:SrcSrq8aKtyuqEI1uvTDTK1arOWRIczQRv+GVI1AkeQ=github.com/segmentio/asm v1.2.0 h1:9BQrFxC+YOHJlTlHGkTrFWf59nbL3XnCoFLTwDCI7ys=github.com/segmentio/asm v1.2.0/go.mod h1:BqMnlJP91P8d+4ibuonYZw9mfnzI9HfxselHZr5aAcs=github.com/sethvargo/go-retry v0.3.0 h1:EEt31A35QhrcRZtrYFDTBg91cqZVnFL2navjDrah2SE=@@ -222,8 +217,8 @@ github.com/spf13/cobra v1.9.1 h1:CXSaggrXdbHK9CF+8ywj8Amf7PBRmPCOJugH954Nnlo=github.com/spf13/cobra v1.9.1/go.mod h1:nDyEzZ8ogv936Cinf6g1RU9MRY64Ir93oCnqb9wxYW0=github.com/spf13/pflag v1.0.6 h1:jFzHGLGAlb3ruxLB8MhbI6A8+AQX/2eW4qeyNZXNp2o=github.com/spf13/pflag v1.0.6/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=-github.com/spf13/viper v1.19.0 h1:RWq5SEjt8o25SROyN3z2OrDB9l7RPd3lwTWU8EcEdcI=-github.com/spf13/viper v1.19.0/go.mod h1:GQUN9bilAbhU/jgc1bKs99f/suXKeUMct8Adx5+Ntkg=+github.com/spf13/viper v1.20.0 h1:zrxIyR3RQIOsarIrgL8+sAvALXul9jeEPa06Y0Ph6vY=+github.com/spf13/viper v1.20.0/go.mod h1:P9Mdzt1zoHIG8m2eZQinpiBjo6kCmZSKBClNNqjJvu4=github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY=