CodeSampleX

Beispiel

github.com/spf13/viper v1.21.0: Pin Viper 1.21.0 string-slice parsing differences across environment values, pflag StringSlice values, and in-memory YAML

Verifiziertes Beispiel für golang github.com/spf13/viper v1.21.0: Pin Viper 1.21.0 string-slice parsing differences across environment values, pflag…

sha256:a8a9630ca346da32b160e5e78bdd2de5b40347a27f3c473d7655f5610be6f6e7

Dieses Netzwerk bietet eine Sache: ein Sample, das baut. Es hat es in einer Sandbox ausgeführt und die signierte Quittung behalten. Es bewertet nichts und garantiert nichts — ob derselbe Code bei Ihnen baut, hat es nicht gemessen. Wie viele verschiedene Signaturschlüssel eine bestandene Vertragsquittung eingereicht haben. Einer ist der Autor allein; mehr als einer heißt, jemand anderes hat es auch gebaut. Ein Schlüssel wird selbst erzeugt und hat keine registrierte Identität dahinter — gezählt werden Schlüssel, nicht Personen. MIT-0

Ausführungsbelege

Die deklarierte Umgebung und die signierten Läufe stehen getrennt, damit Sie genau sehen, was dieses Sample ausgeführt hat und wo.

Beleggrundlage
Signierter Vertrag bestanden
Verifizierungsbelege
3
Signaturschlüssel, die es gebaut haben
2
Deklarierte Umgebung go linux x64 go go go

Umgebungen der Verifizierungsläufe

Umgebung Contract Stufen Lauf
go 1.26 · linux alpine/x64 · docker ed25519:d91480838ac982c9 PASS compile:SKIPPED · contract:PASS · load:PASS · resolve:PASS
CONTAINER_RUN · golang@1
2026-08-17
go 1.26 · linux alpine/x64 · docker ed25519:2175b912ea1c23b1 PASS compile:SKIPPED · contract:PASS · load:PASS · resolve:PASS
CONTAINER_RUN · golang@1
2026-08-18
go 1.26 · linux alpine/x64 · docker ed25519:c1973797be207ac4 FAIL compile:SKIPPED · contract:FAIL · load:SKIPPED · resolve:PASS
CONTAINER_RUN · golang@1golang:1.26-alpine@sha256:28d89ee9cc0f…
2026-09-08

Fall

HOW
Ziel
Pin Viper 1.21.0 string-slice parsing differences across environment values, pflag StringSlice values, and in-memory YAML
Pakete
Symbole
  • viper.GetStringSlice
  • viper.Unmarshal
  • viper.AutomaticEnv
  • viper.SetEnvKeyReplacer
  • viper.SetEnvPrefix
  • viper.BindPFlag
  • viper.ReadConfig
  • viper.SetDefault
Umgebung
go
Erstellt
2026-08-17T03:51:40Z

Contract

  1. assert GetStringSlice returns one comma-containing element for a comma-separated environment value
  2. assert Unmarshal returns two elements for that same comma-separated environment value
  3. assert GetStringSlice splits a whitespace-separated environment value while Unmarshal retains it as one element
  4. assert GetStringSlice and Unmarshal both return two elements when a bound pflag.StringSlice has already parsed the comma
  5. assert a YAML sequence returns two elements for both APIs while a YAML comma-separated scalar remains one element in GetStringSlice and becomes two through Unmarshal

Dateien

  • NOTES.md
  • csx.json
  • go.mod
  • go.sum
  • slice_test.go

Quellartefakt herunterladen (tar.gz)

Quelltext

NOTES.md
# Viper 1.21.0 string-slice inputs

The contract measures Viper 1.21.0 with environment variables, an in-memory
YAML document, and a bound pflag `StringSlice`. For a comma-separated string,
`GetStringSlice` returns one comma-containing element while `Unmarshal` returns
two elements. For a whitespace-separated environment string, the two APIs make
the opposite split choice. A pflag `StringSlice` and a YAML sequence already
provide slice values, so both APIs return two elements in those tested paths.

No implementation-detail or other-version behavior is asserted.
csx.json
{"case":{"believed":"viper.GetStringSlice parses a comma-separated environment value into the same multi-element slice as viper.Unmarshal.","caseId":"case:sha256:0c7b337e95cc922f6627908d092793c4250daeea255d7465bec10001e2924866","contract":["assert GetStringSlice returns one comma-containing element for a comma-separated environment value","assert Unmarshal returns two elements for that same comma-separated environment value","assert GetStringSlice splits a whitespace-separated environment value while Unmarshal retains it as one element","assert GetStringSlice and Unmarshal both return two elements when a bound pflag.StringSlice has already parsed the comma","assert a YAML sequence returns two elements for both APIs while a YAML comma-separated scalar remains one element in GetStringSlice and becomes two through Unmarshal"],"goal":"Pin Viper 1.21.0 string-slice parsing differences across environment values, pflag StringSlice values, and in-memory YAML","kind":"HOW","packages":["pkg:golang/github.com/spf13/viper@v1.21.0","pkg:golang/github.com/spf13/pflag@v1.0.10"],"schemaVersion":1,"symbols":["viper.GetStringSlice","viper.Unmarshal","viper.AutomaticEnv","viper.SetEnvKeyReplacer","viper.SetEnvPrefix","viper.BindPFlag","viper.ReadConfig","viper.SetDefault"]},"contractCommand":["go","test","./..."],"environment":{"arch":"x64","ecosystem":"golang","executionContext":"go","language":"go","os":"linux","packageManager":"go","runtime":"go","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/github.com/spf13/viper@v1.21.0","pkg:golang/github.com/spf13/pflag@v1.0.10"],"schemaVersion":1,"symbols":["viper.GetStringSlice","viper.Unmarshal","viper.AutomaticEnv","viper.SetEnvKeyReplacer","viper.SetEnvPrefix","viper.BindPFlag","viper.ReadConfig","viper.SetDefault"],"verifierAdapter":"golang@1"}
go.mod
module example.com/goviperslice

go 1.24

require (
	github.com/spf13/pflag v1.0.10
	github.com/spf13/viper v1.21.0
)

require (
	github.com/fsnotify/fsnotify v1.9.0 // indirect
	github.com/go-viper/mapstructure/v2 v2.4.0 // indirect
	github.com/pelletier/go-toml/v2 v2.2.4 // indirect
	github.com/sagikazarmark/locafero v0.11.0 // indirect
	github.com/sourcegraph/conc v0.3.1-0.20240121214520-5f936abd7ae8 // indirect
	github.com/spf13/afero v1.15.0 // indirect
	github.com/spf13/cast v1.10.0 // indirect
	github.com/subosito/gotenv v1.6.0 // indirect
	go.yaml.in/yaml/v3 v3.0.4 // indirect
	golang.org/x/sys v0.29.0 // indirect
	golang.org/x/text v0.28.0 // indirect
)
go.sum
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/frankban/quicktest v1.14.6 h1:7Xjx+VpznH+oBnejlPUj8oUpdxnVs4f8XU8WnHkI4W8=
github.com/frankban/quicktest v1.14.6/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7zb5vbUoiM6w0=
github.com/fsnotify/fsnotify v1.9.0 h1:2Ml+OJNzbYCTzsxtv8vKSFD9PbJjmhYF14k/jKC7S9k=
github.com/fsnotify/fsnotify v1.9.0/go.mod h1:8jBTzvmWwFyi3Pb8djgCCO5IBqzKJ/Jwo8TRcHyHii0=
github.com/go-viper/mapstructure/v2 v2.4.0 h1:EBsztssimR/CONLSZZ04E8qAkxNYq4Qp9LvH92wZUgs=
github.com/go-viper/mapstructure/v2 v2.4.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
github.com/pelletier/go-toml/v2 v2.2.4 h1:mye9XuhQ6gvn5h28+VilKrrPoQVanw5PMw/TB0t5Ec4=
github.com/pelletier/go-toml/v2 v2.2.4/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8=
github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
github.com/sagikazarmark/locafero v0.11.0 h1:1iurJgmM9G3PA/I+wWYIOw/5SyBtxapeHDcg+AAIFXc=
github.com/sagikazarmark/locafero v0.11.0/go.mod h1:nVIGvgyzw595SUSUE6tvCp3YYTeHs15MvlmU87WwIik=
github.com/sourcegraph/conc v0.3.1-0.20240121214520-5f936abd7ae8 h1:+jumHNA0Wrelhe64i8F6HNlS8pkoyMv5sreGx2Ry5Rw=
github.com/sourcegraph/conc v0.3.1-0.20240121214520-5f936abd7ae8/go.mod h1:3n1Cwaq1E1/1lhQhtRK2ts/ZwZEhjcQeJQ1RuC6Q/8U=
github.com/spf13/afero v1.15.0 h1:b/YBCLWAJdFWJTN9cLhiXXcD7mzKn9Dm86dNnfyQw1I=
github.com/spf13/afero v1.15.0/go.mod h1:NC2ByUVxtQs4b3sIUphxK0NioZnmxgyCrfzeuq8lxMg=
github.com/spf13/cast v1.10.0 h1:h2x0u2shc1QuLHfxi+cTJvs30+ZAHOGRic8uyGTDWxY=
github.com/spf13/cast v1.10.0/go.mod h1:jNfB8QC9IA6ZuY2ZjDp0KtFO2LZZlg4S/7bzP6qqeHo=
github.com/spf13/pflag v1.0.10 h1:4EBh2KAYBwaONj6b2Ye1GiHfwjqyROoF4RwYO+vPwFk=
github.com/spf13/pflag v1.0.10/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
github.com/spf13/viper v1.21.0 h1:x5S+0EU27Lbphp4UKm1C+1oQO+rKx36vfCoaVebLFSU=
github.com/spf13/viper v1.21.0/go.mod h1:P0lhsswPGWD/1lZJ9ny3fYnVqxiegrlNrEmgLjbTCAY=
github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8=
github.com/subosito/gotenv v1.6.0/go.mod h1:Dk4QP5c2W3ibzajGcXpNraDfq2IrhjMIvMSWPKKo0FU=
go.yaml.in/yaml/v3 v3.0.4 h1:tfq32ie2Jv2UxXFdLJdh3jXuOzWiL1fo0bu/FbuKpbc=
go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
golang.org/x/sys v0.29.0 h1:TPYlXGxvx1MGTn2GiZDhnjPA9wZzZeGKHHmKhHYvgaU=
golang.org/x/sys v0.29.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/text v0.28.0 h1:rhazDwis8INMIwQ4tpjLDzUhx6RlXqZNPEM0huQojng=
golang.org/x/text v0.28.0/go.mod h1:U8nCwOR8jO/marOQ0QbDiOngZVEBB7MAiitBuMjXiNU=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo=
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
slice_test.go
package viperslice_test

import (
	"bytes"
	"os"
	"reflect"
	"strings"
	"testing"

	"github.com/spf13/pflag"
	"github.com/spf13/viper"
)

func TestCommaSeparatedEnvDivergence(t *testing.T) {
	envKey := "CSX_CORS_ORIGINS"
	envVal := "app.test,api.test"
	if err := os.Setenv(envKey, envVal); err != nil {
		t.Fatalf("failed to set env var: %v", err)
	}
	defer os.Unsetenv(envKey)

	v := viper.New()
	v.SetEnvPrefix("CSX")
	v.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
	v.AutomaticEnv()

	// 1. GetStringSlice on comma-separated env var returns a single-element slice keeping the comma
	gotSlice := v.GetStringSlice("cors.origins")
	wantSlice := []string{"app.test,api.test"}
	if !reflect.DeepEqual(gotSlice, wantSlice) {
		t.Fatalf("GetStringSlice should not split on commas; got %v (len %d), want %v", gotSlice, len(gotSlice), wantSlice)
	}

	// 2. Unmarshal into struct string slice splits on comma via mapstructure hook
	type AppConfig struct {
		Cors struct {
			Origins []string `mapstructure:"origins"`
		} `mapstructure:"cors"`
	}

	v.SetDefault("cors.origins", []string{})
	var cfg AppConfig
	if err := v.Unmarshal(&cfg); err != nil {
		t.Fatalf("Unmarshal failed: %v", err)
	}

	wantUnmarshaled := []string{"app.test", "api.test"}
	if !reflect.DeepEqual(cfg.Cors.Origins, wantUnmarshaled) {
		t.Fatalf("Unmarshal should split comma strings; got %v, want %v", cfg.Cors.Origins, wantUnmarshaled)
	}
}

func TestWhitespaceSeparatedEnvDivergence(t *testing.T) {
	envKey := "CSX_ALLOWED_HOSTS"
	envVal := "host1.example.com host2.example.com"
	if err := os.Setenv(envKey, envVal); err != nil {
		t.Fatalf("failed to set env var: %v", err)
	}
	defer os.Unsetenv(envKey)

	v := viper.New()
	v.SetEnvPrefix("CSX")
	v.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
	v.AutomaticEnv()

	// 1. GetStringSlice splits whitespace strings via cast.ToStringSlice / strings.Fields
	gotSlice := v.GetStringSlice("allowed.hosts")
	wantSlice := []string{"host1.example.com", "host2.example.com"}
	if !reflect.DeepEqual(gotSlice, wantSlice) {
		t.Fatalf("GetStringSlice should split whitespace; got %v, want %v", gotSlice, wantSlice)
	}

	// 2. Unmarshal does NOT split whitespace because default hook only looks for commas
	type HostsConfig struct {
		Allowed struct {
			Hosts []string `mapstructure:"hosts"`
		} `mapstructure:"allowed"`
	}

	v.SetDefault("allowed.hosts", []string{})
	var cfg HostsConfig
	if err := v.Unmarshal(&cfg); err != nil {
		t.Fatalf("Unmarshal failed: %v", err)
	}

	wantUnmarshaled := []string{"host1.example.com host2.example.com"}
	if !reflect.DeepEqual(cfg.Allowed.Hosts, wantUnmarshaled) {
		t.Fatalf("Unmarshal on whitespace string should remain 1 element; got %v, want %v", cfg.Allowed.Hosts, wantUnmarshaled)
	}
}

func TestPFlagStringSliceAgreement(t *testing.T) {
	v := viper.New()

	fs := pflag.NewFlagSet("testflags", pflag.ContinueOnError)
	fs.StringSlice("endpoints", []string{}, "comma separated endpoints")
	if err := fs.Parse([]string{"--endpoints=app.test,api.test"}); err != nil {
		t.Fatalf("pflag parse failed: %v", err)
	}

	if err := v.BindPFlag("service.endpoints", fs.Lookup("endpoints")); err != nil {
		t.Fatalf("BindPFlag failed: %v", err)
	}
	v.SetDefault("service.endpoints", []string{})

	// Both GetStringSlice and Unmarshal agree on 2 elements because pflag parsed into []string
	gotSlice := v.GetStringSlice("service.endpoints")
	want := []string{"app.test", "api.test"}
	if !reflect.DeepEqual(gotSlice, want) {
		t.Fatalf("GetStringSlice with bound pflag.StringSlice: got %v, want %v", gotSlice, want)
	}

	type SvcConfig struct {
		Service struct {
			Endpoints []string `mapstructure:"endpoints"`
		} `mapstructure:"service"`
	}

	var cfg SvcConfig
	if err := v.Unmarshal(&cfg); err != nil {
		t.Fatalf("Unmarshal failed: %v", err)
	}

	if !reflect.DeepEqual(cfg.Service.Endpoints, want) {
		t.Fatalf("Unmarshal with bound pflag.StringSlice: got %v, want %v", cfg.Service.Endpoints, want)
	}
}

func TestYAMLConfigScalarVsSequence(t *testing.T) {
	v := viper.New()
	v.SetConfigType("yaml")

	doc := `
endpoints:
  sequence:
    - "app.test"
    - "api.test"
  scalar_csv: "app.test,api.test"
`
	if err := v.ReadConfig(bytes.NewBufferString(doc)); err != nil {
		t.Fatalf("ReadConfig failed: %v", err)
	}

	// Sequence produces 2 elements for both
	wantMulti := []string{"app.test", "api.test"}
	if got := v.GetStringSlice("endpoints.sequence"); !reflect.DeepEqual(got, wantMulti) {
		t.Fatalf("GetStringSlice on sequence: got %v, want %v", got, wantMulti)
	}

	// Scalar CSV in YAML produces 1 element in GetStringSlice
	wantSingle := []string{"app.test,api.test"}
	if got := v.GetStringSlice("endpoints.scalar_csv"); !reflect.DeepEqual(got, wantSingle) {
		t.Fatalf("GetStringSlice on scalar CSV: got %v, want %v", got, wantSingle)
	}

	// Scalar CSV in YAML produces 2 elements in Unmarshal
	type EndpointsConfig struct {
		Endpoints struct {
			Sequence  []string `mapstructure:"sequence"`
			ScalarCSV []string `mapstructure:"scalar_csv"`
		} `mapstructure:"endpoints"`
	}

	var cfg EndpointsConfig
	if err := v.Unmarshal(&cfg); err != nil {
		t.Fatalf("Unmarshal failed: %v", err)
	}

	if !reflect.DeepEqual(cfg.Endpoints.ScalarCSV, wantMulti) {
		t.Fatalf("Unmarshal on scalar CSV should split on comma: got %v, want %v", cfg.Endpoints.ScalarCSV, wantMulti)
	}
}

Ursprungs-Seeder

csx-seed