package yqlib import ( "testing" ) var envOperatorScenarios = []expressionScenario{ { description: "Read string environment variable", environmentVariables: map[string]string{"myenv": "cat meow"}, expression: `.a = env(myenv)`, expected: []string{ "D0, P[], ()::a: cat meow\n", }, }, { description: "Read boolean environment variable", environmentVariables: map[string]string{"myenv": "true"}, expression: `.a = env(myenv)`, expected: []string{ "D0, P[], ()::a: true\n", }, }, { description: "Read numeric environment variable", environmentVariables: map[string]string{"myenv": "12"}, expression: `.a = env(myenv)`, expected: []string{ "D0, P[], ()::a: 12\n", }, }, { description: "Read yaml environment variable", environmentVariables: map[string]string{"myenv": "{b: fish}"}, expression: `.a = env(myenv)`, expected: []string{ "D0, P[], ()::a: {b: fish}\n", }, }, { description: "Read boolean environment variable as a string", environmentVariables: map[string]string{"myenv": "true"}, expression: `.a = strenv(myenv)`, expected: []string{ "D0, P[], ()::a: \"true\"\n", }, }, { description: "Read numeric environment variable as a string", environmentVariables: map[string]string{"myenv": "12"}, expression: `.a = strenv(myenv)`, expected: []string{ "D0, P[], ()::a: \"12\"\n", }, }, { description: "Dynamically update a path from an environment variable", subdescription: "The env variable can be any valid yq expression.", document: `{a: {b: [{name: dog}, {name: cat}]}}`, environmentVariables: map[string]string{"pathEnv": ".a.b[0].name", "valueEnv": "moo"}, expression: `eval(strenv(pathEnv)) = strenv(valueEnv)`, expected: []string{ "D0, P[], (!!map)::{a: {b: [{name: moo}, {name: cat}]}}\n", }, }, { description: "Dynamic key lookup with environment variable", environmentVariables: map[string]string{"myenv": "cat"}, document: `{cat: meow, dog: woof}`, expression: `.[env(myenv)]`, expected: []string{ "D0, P[cat], (!!str)::meow\n", }, }, { description: "Replace strings with envsubst", environmentVariables: map[string]string{"myenv": "cat"}, expression: `"the ${myenv} meows" | envsubst`, expected: []string{ "D0, P[], (!!str)::the cat meows\n", }, }, { description: "Replace strings with envsubst, missing variables", expression: `"the ${myenvnonexisting} meows" | envsubst`, expected: []string{ "D0, P[], (!!str)::the meows\n", }, }, { description: "Replace strings with envsubst(nu), missing variables", subdescription: "(nu) not unset, will fail if there are unset (missing) variables", expression: `"the ${myenvnonexisting} meows" | envsubst(nu)`, expectedError: "variable ${myenvnonexisting} not set", }, { description: "Replace strings with envsubst(ne), missing variables", subdescription: "(ne) not empty, only validates set variables", expression: `"the ${myenvnonexisting} meows" | envsubst(ne)`, expected: []string{ "D0, P[], (!!str)::the meows\n", }, }, { description: "Replace strings with envsubst(ne), empty variable", subdescription: "(ne) not empty, will fail if a references variable is empty", environmentVariables: map[string]string{"myenv": ""}, expression: `"the ${myenv} meows" | envsubst(ne)`, expectedError: "variable ${myenv} set but empty", }, { description: "Replace strings with envsubst, missing variables with defaults", expression: `"the ${myenvnonexisting-dog} meows" | envsubst`, expected: []string{ "D0, P[], (!!str)::the dog meows\n", }, }, { description: "Replace strings with envsubst(nu), missing variables with defaults", subdescription: "Having a default specified skips over the missing variable.", expression: `"the ${myenvnonexisting-dog} meows" | envsubst(nu)`, expected: []string{ "D0, P[], (!!str)::the dog meows\n", }, }, { description: "Replace strings with envsubst(ne), missing variables with defaults", subdescription: "Fails, because the variable is explicitly set to blank.", environmentVariables: map[string]string{"myEmptyEnv": ""}, expression: `"the ${myEmptyEnv-dog} meows" | envsubst(ne)`, expectedError: "variable ${myEmptyEnv} set but empty", }, { description: "Replace string environment variable in document", environmentVariables: map[string]string{"myenv": "cat meow"}, document: "{v: \"${myenv}\"}", expression: `.v |= envsubst`, expected: []string{ "D0, P[], (!!map)::{v: \"cat meow\"}\n", }, }, { description: "(Default) Return all envsubst errors", subdescription: "By default, all errors are returned at once.", expression: `"the ${notThere} ${alsoNotThere}" | envsubst(nu)`, expectedError: "variable ${notThere} not set\nvariable ${alsoNotThere} not set", }, { description: "Fail fast, return the first envsubst error (and abort)", expression: `"the ${notThere} ${alsoNotThere}" | envsubst(nu,ff)`, expectedError: "variable ${notThere} not set", }, { description: "with header/footer", skipDoc: true, environmentVariables: map[string]string{"myenv": "cat meow"}, document: "# abc\n{v: \"${myenv}\"}\n# xyz\n", expression: `(.. | select(tag == "!!str")) |= envsubst`, expected: []string{ "D0, P[], (!!map)::# abc\n{v: \"cat meow\"}\n# xyz\n", }, }, } func TestEnvOperatorScenarios(t *testing.T) { for _, tt := range envOperatorScenarios { testScenario(t, &tt) } documentOperatorScenarios(t, "env-variable-operators", envOperatorScenarios) }