public/atlantis
1
0
Fork 0
mirror of https://git.vectorsigma.ru/public/atlantis.git synced 2026-08-07 01:18:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
7dfab213e8d84a1984da7ff75abf26fe55fc71d2
atlantis/server/events/repoconfig/reader_test.go
Luke Kysow 42b6646cbe Implement config reader and parser
2018-06-05 17:12:19 +01:00

613 lines
12 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
package repoconfig_test
import (
"io/ioutil"
"path/filepath"
"testing"
"github.com/runatlantis/atlantis/server/events/repoconfig"
. "github.com/runatlantis/atlantis/testing"
)
func TestReadConfig_DirDoesNotExist(t *testing.T) {
r := repoconfig.Reader{}
conf, err := r.ReadConfig("/not/exist")
Ok(t, err)
Assert(t, conf == nil, "exp nil ptr")
}
func TestReadConfig_FileDoesNotExist(t *testing.T) {
tmpDir, cleanup := TempDir(t)
defer cleanup()
r := repoconfig.Reader{}
conf, err := r.ReadConfig(tmpDir)
Ok(t, err)
Assert(t, conf == nil, "exp nil ptr")
}
func TestReadConfig_BadPermissions(t *testing.T) {
tmpDir, cleanup := TempDir(t)
defer cleanup()
err := ioutil.WriteFile(filepath.Join(tmpDir, "atlantis.yaml"), nil, 0000)
Ok(t, err)
r := repoconfig.Reader{}
_, err = r.ReadConfig(tmpDir)
ErrContains(t, "unable to read atlantis.yaml file: ", err)
}
func TestReadConfig_UnmarshalErrors(t *testing.T) {
// We only have a few cases here because we assume the YAML library to be
// well tested. See https://github.com/go-yaml/yaml/blob/v2/decode_test.go#L810.
cases := []struct {
description string
input string
expErr string
}{
{
"random characters",
"slkjds",
"parsing atlantis.yaml: yaml: unmarshal errors:\n line 1: cannot unmarshal !!str `slkjds`",
},
{
"just a colon",
":",
"parsing atlantis.yaml: yaml: did not find expected key",
},
}
tmpDir, cleanup := TempDir(t)
defer cleanup()
for _, c := range cases {
t.Run(c.description, func(t *testing.T) {
err := ioutil.WriteFile(filepath.Join(tmpDir, "atlantis.yaml"), []byte(c.input), 0600)
Ok(t, err)
r := repoconfig.Reader{}
_, err = r.ReadConfig(tmpDir)
ErrEquals(t, c.expErr, err)
})
}
}
func TestReadConfig_Invalid(t *testing.T) {
cases := []struct {
description string
input string
expErr string
}{
// Invalid version.
{
description: "no version",
input: `projects:
- dir: "."
`,
expErr: "unknown version: must have \"version: 2\" set",
},
{
description: "unsupported version",
input: `version: 0
projects:
- dir: "."
`,
expErr: "unknown version: must have \"version: 2\" set",
},
{
description: "empty version",
input: `version: ~
projects:
- dir: "."
`,
expErr: "unknown version: must have \"version: 2\" set",
},
// No projects specified.
{
description: "no projects key",
input: `version: 2`,
expErr: "'projects' key must exist and contain at least one element",
},
{
description: "empty projects list",
input: `version: 2
projects:`,
expErr: "'projects' key must exist and contain at least one element",
},
// Project must have dir set.
{
description: "project with no config",
input: `version: 2
projects:
-`,
expErr: "project at index 0 invalid: dir key must be set and non-empty",
},
{
description: "project without dir set",
input: `version: 2
projects:
- workspace: "staging"`,
expErr: "project at index 0 invalid: dir key must be set and non-empty",
},
{
description: "project with dir set to empty string",
input: `version: 2
projects:
- dir: ""`,
expErr: "project at index 0 invalid: dir key must be set and non-empty",
},
{
description: "project with no config at index 1",
input: `version: 2
projects:
- dir: "."
-`,
expErr: "project at index 1 invalid: dir key must be set and non-empty",
},
// {
// "project with unknown key",
// `version: 2
//projects:
//- unknown: value`,
// // todo: fix this test case
// "project at index 1 invalid: dir key must be set and non-empty",
// },
// todo: more test cases
// project workflow doesn't exist
// workflow has plan and apply keys (otherwise no point specifying it)
// plan/apply stages must have non-empty steps key
// Test the steps key.
{
description: "unsupported step type",
input: `
version: 2
projects:
- dir: "."
workflows:
default:
plan:
steps:
- unsupported`,
expErr: "unsupported step type: \"unsupported\"",
},
// Init step.
{
description: "unsupported arg to init step",
input: `
version: 2
projects:
- dir: "."
workflows:
default:
plan:
steps:
- init:
extra_args: ["hi"]
hi: bye
`,
expErr: "unsupported key \"hi\" for step init – the only supported key is extra_args",
},
{
description: "invalid value type to init step's extra_args",
input: `
version: 2
projects:
- dir: "."
workflows:
default:
plan:
steps:
- init:
extra_args: arg
`,
expErr: "expected array of strings as value of extra_args, not \"arg\"",
},
// Plan step.
{
description: "unsupported arg to plan step",
input: `
version: 2
projects:
- dir: "."
workflows:
default:
plan:
steps:
- plan:
extra_args: ["hi"]
hi: bye
`,
expErr: "unsupported key \"hi\" for step plan – the only supported key is extra_args",
},
{
description: "invalid value type to plan step's extra_args",
input: `
version: 2
projects:
- dir: "."
workflows:
default:
plan:
steps:
- plan:
extra_args: arg
`,
expErr: "expected array of strings as value of extra_args, not \"arg\"",
},
// Apply step.
{
description: "unsupported arg to apply step",
input: `
version: 2
projects:
- dir: "."
workflows:
default:
plan:
steps:
- apply:
extra_args: ["hi"]
hi: bye
`,
expErr: "unsupported key \"hi\" for step apply – the only supported key is extra_args",
},
{
description: "invalid value type to apply step's extra_args",
input: `
version: 2
projects:
- dir: "."
workflows:
default:
plan:
steps:
- apply:
extra_args: arg
`,
expErr: "expected array of strings as value of extra_args, not \"arg\"",
},
}
tmpDir, cleanup := TempDir(t)
defer cleanup()
for _, c := range cases {
t.Run(c.description, func(t *testing.T) {
err := ioutil.WriteFile(filepath.Join(tmpDir, "atlantis.yaml"), []byte(c.input), 0600)
Ok(t, err)
r := repoconfig.Reader{}
_, err = r.ReadConfig(tmpDir)
ErrEquals(t, "parsing atlantis.yaml: "+c.expErr, err)
})
}
}
func TestReadConfig_Successes(t *testing.T) {
basicProjects := []repoconfig.Project{
{
AutoPlan: &repoconfig.AutoPlan{
Enabled: true,
WhenModified: []string{"**/*.tf"},
},
Workspace: "default",
TerraformVersion: "",
ApplyRequirements: nil,
Workflow: "",
Dir: ".",
},
}
cases := []struct {
description string
input string
expOutput repoconfig.RepoConfig
}{
{
description: "uses project defaults",
input: `version: 2
projects:
- dir: "."`,
expOutput: repoconfig.RepoConfig{
Version: 2,
Projects: basicProjects,
},
},
{
description: "autoplan is enabled by default",
input: `version: 2
projects:
- dir: "."
auto_plan:
when_modified: ["**/*.tf"]
`,
expOutput: repoconfig.RepoConfig{
Version: 2,
Projects: basicProjects,
},
},
{
description: "if workflows not defined, there are none",
input: `version: 2
projects:
- dir: "."
`,
expOutput: repoconfig.RepoConfig{
Version: 2,
Projects: basicProjects,
},
},
{
description: "if workflows key set but with no workflows there are none",
input: `version: 2
projects:
- dir: "."
workflows: ~
`,
expOutput: repoconfig.RepoConfig{
Version: 2,
Projects: basicProjects,
},
},
{
description: "if a workflow is defined but set to null we use the defaults",
input: `version: 2
projects:
- dir: "."
workflows:
default: ~
`,
expOutput: repoconfig.RepoConfig{
Version: 2,
Projects: basicProjects,
Workflows: map[string]repoconfig.Workflow{
"default": {
Plan: &repoconfig.Stage{
Steps: []repoconfig.StepConfig{
{
StepType: "init",
},
{
StepType: "plan",
},
},
},
Apply: &repoconfig.Stage{
Steps: []repoconfig.StepConfig{
{
StepType: "apply",
},
},
},
},
},
},
},
{
description: "if a plan or apply has no steps defined then we use the defaults",
input: `version: 2
projects:
- dir: "."
workflows:
default:
plan:
apply:
`,
expOutput: repoconfig.RepoConfig{
Version: 2,
Projects: basicProjects,
Workflows: map[string]repoconfig.Workflow{
"default": {
Plan: &repoconfig.Stage{
Steps: []repoconfig.StepConfig{
{
StepType: "init",
},
{
StepType: "plan",
},
},
},
Apply: &repoconfig.Stage{
Steps: []repoconfig.StepConfig{
{
StepType: "apply",
},
},
},
},
},
},
},
{
description: "if a plan or apply has no steps defined then we use the defaults",
input: `version: 2
projects:
- dir: "."
workflows:
default:
plan:
apply:
`,
expOutput: repoconfig.RepoConfig{
Version: 2,
Projects: basicProjects,
Workflows: map[string]repoconfig.Workflow{
"default": {
Plan: &repoconfig.Stage{
Steps: []repoconfig.StepConfig{
{
StepType: "init",
},
{
StepType: "plan",
},
},
},
Apply: &repoconfig.Stage{
Steps: []repoconfig.StepConfig{
{
StepType: "apply",
},
},
},
},
},
},
},
{
description: "if a plan or apply explicitly defines an empty steps key then there are no steps",
input: `version: 2
projects:
- dir: "."
workflows:
default:
plan:
steps:
apply:
steps:
`,
expOutput: repoconfig.RepoConfig{
Version: 2,
Projects: basicProjects,
Workflows: map[string]repoconfig.Workflow{
"default": {
Plan: &repoconfig.Stage{
Steps: nil,
},
Apply: &repoconfig.Stage{
Steps: nil,
},
},
},
},
},
{
description: "if a plan or apply explicitly defines an empty steps key then there are no steps",
input: `version: 2
projects:
- dir: "."
workflows:
default:
plan:
steps:
apply:
steps:
`,
expOutput: repoconfig.RepoConfig{
Version: 2,
Projects: basicProjects,
Workflows: map[string]repoconfig.Workflow{
"default": {
Plan: &repoconfig.Stage{
Steps: nil,
},
Apply: &repoconfig.Stage{
Steps: nil,
},
},
},
},
},
{
description: "if steps are set then we parse them properly",
input: `version: 2
projects:
- dir: "."
workflows:
default:
plan:
steps:
- init
apply:
steps:
- plan # we don't validate if they make sense
`,
expOutput: repoconfig.RepoConfig{
Version: 2,
Projects: basicProjects,
Workflows: map[string]repoconfig.Workflow{
"default": {
Plan: &repoconfig.Stage{
Steps: []repoconfig.StepConfig{
{
StepType: "init",
},
},
},
Apply: &repoconfig.Stage{
Steps: []repoconfig.StepConfig{
{
StepType: "plan",
},
},
},
},
},
},
},
{
description: "we parse extra_args for the steps",
input: `version: 2
projects:
- dir: "."
workflows:
default:
plan:
steps:
- init:
extra_args: []
apply:
steps:
- plan:
extra_args: ["a", "b"]
`,
expOutput: repoconfig.RepoConfig{
Version: 2,
Projects: basicProjects,
Workflows: map[string]repoconfig.Workflow{
"default": {
Plan: &repoconfig.Stage{
Steps: []repoconfig.StepConfig{
{
StepType: "init",
ExtraArgs: nil,
},
},
},
Apply: &repoconfig.Stage{
Steps: []repoconfig.StepConfig{
{
StepType: "plan",
ExtraArgs: []string{"a", "b"},
},
},
},
},
},
},
},
}
tmpDir, cleanup := TempDir(t)
defer cleanup()
for _, c := range cases {
t.Run(c.description, func(t *testing.T) {
err := ioutil.WriteFile(filepath.Join(tmpDir, "atlantis.yaml"), []byte(c.input), 0600)
Ok(t, err)
r := repoconfig.Reader{}
act, err := r.ReadConfig(tmpDir)
Ok(t, err)
Equals(t, &c.expOutput, act)
})
}
}
Reference in New Issue View Git Blame Copy Permalink