File: config_test.go

package info (click to toggle)
golang-github-mmcloughlin-avo 0.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 15,024 kB
  • sloc: xml: 71,029; asm: 14,862; sh: 194; makefile: 21; ansic: 11
file content (185 lines) | stat: -rw-r--r-- 3,945 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
package thirdparty

import (
	"bytes"
	"reflect"
	"strings"
	"testing"
)

func TestValidateErrors(t *testing.T) {
	cases := []struct {
		Name           string
		Item           interface{ Validate() error }
		ErrorSubstring string
	}{
		{
			Name:           "step_missing_name",
			Item:           &Step{},
			ErrorSubstring: "missing name",
		},
		{
			Name: "step_missing_commands",
			Item: &Step{
				Name: "Setup",
			},
			ErrorSubstring: "missing commands",
		},
		{
			Name: "project_missing_default_branch",
			Item: &Project{
				Repository: GithubRepository{Owner: "octocat", Name: "hello-world"},
			},
			ErrorSubstring: "missing default branch",
		},
		{
			Name: "project_missing_version",
			Item: &Project{
				Repository:    GithubRepository{Owner: "octocat", Name: "hello-world"},
				DefaultBranch: "main",
			},
			ErrorSubstring: "missing version",
		},
		{
			Name: "project_missing_packages",
			Item: &Project{
				Repository:    GithubRepository{Owner: "octocat", Name: "hello-world"},
				DefaultBranch: "main",
				Version:       "v0.1.1",
			},
			ErrorSubstring: "missing packages",
		},
		{
			Name: "project_package_error",
			Item: &Project{
				Repository:    GithubRepository{Owner: "octocat", Name: "hello-world"},
				DefaultBranch: "main",
				Version:       "v0.1.1",
				Packages: []*Package{
					{},
				},
			},
			ErrorSubstring: "package root: missing module",
		},
		{
			Name:           "package_missing_module",
			Item:           &Package{},
			ErrorSubstring: "missing module",
		},
		{
			Name: "package_no_generate_commands",
			Item: &Package{
				Module: "avo/go.mod",
			},
			ErrorSubstring: "no generate commands",
		},
		{
			Name: "package_invalid_generate_commands",
			Item: &Package{
				Module: "avo/go.mod",
				Generate: []*Step{
					{},
				},
			},
			ErrorSubstring: "generate step: missing name",
		},
		{
			Name: "projects_invalid_package",
			Item: Projects{
				{
					Repository: GithubRepository{Owner: "octocat", Name: "hello-world"},
				},
			},
			ErrorSubstring: "missing default branch",
		},
	}
	for _, c := range cases {
		c := c // scopelint
		t.Run(c.Name, func(t *testing.T) {
			err := c.Item.Validate()
			if err == nil {
				t.Fatal("expected error; got nil")
			}
			if !strings.Contains(err.Error(), c.ErrorSubstring) {
				t.Fatalf("expected error message to contain %q; got %q", c.ErrorSubstring, err)
			}
		})
	}
}

func TestLoadSuiteBad(t *testing.T) {
	r := strings.NewReader(`[{"unknown_field": "value"}]`)
	_, err := LoadSuite(r)
	if err == nil {
		t.Fatal("expected non-nil error")
	}
}

func TestLoadSuiteFileNotExist(t *testing.T) {
	s, err := LoadSuiteFile("does_not_exist")
	if s != nil {
		t.Fatal("expected nil return")
	}
	if err == nil {
		t.Fatal("expected non-nil error")
	}
}

func TestSuiteFileValid(t *testing.T) {
	s, err := LoadSuiteFile("suite.json")
	if err != nil {
		t.Fatal(err)
	}
	for _, prj := range s.Projects {
		t.Logf("read: %s", prj.ID())
	}
	if len(s.Projects) == 0 {
		t.Fatal("no packages loaded")
	}
	if err := s.Validate(); err != nil {
		t.Fatal(err)
	}
}

func TestSuiteFileStepsValid(t *testing.T) {
	suite, err := LoadSuiteFile("suite.json")
	if err != nil {
		t.Fatal(err)
	}
	c := &Context{
		AvoDirectory:        "avo",
		RepositoryDirectory: "repo",
	}
	for _, prj := range suite.Projects {
		for _, pkg := range prj.Packages {
			for _, s := range pkg.Steps(c) {
				if err := s.Validate(); err != nil {
					t.Errorf("project %s: package %s: %s", prj.ID(), pkg.Name(), err)
				}
			}
		}
	}
}

func TestSuiteFileRoundtrip(t *testing.T) {
	s, err := LoadSuiteFile("suite.json")
	if err != nil {
		t.Fatal(err)
	}

	// Write and read back.
	buf := bytes.NewBuffer(nil)
	if err := StoreSuite(buf, s); err != nil {
		t.Fatal(err)
	}

	roundtrip, err := LoadSuite(buf)
	if err != nil {
		t.Fatal(err)
	}

	// Should be identical.
	if !reflect.DeepEqual(s, roundtrip) {
		t.Fatal("roundtrip mismatch")
	}
}