File: mod_test.go

package info (click to toggle)
bingo 0.9.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,884 kB
  • sloc: sh: 258; makefile: 117
file content (197 lines) | stat: -rw-r--r-- 6,539 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
186
187
188
189
190
191
192
193
194
195
196
197
// Copyright (c) Bartłomiej Płotka @bwplotka
// Licensed under the Apache License 2.0.

package mod

import (
	"os"
	"path/filepath"
	"testing"

	"github.com/efficientgo/core/testutil"
	"golang.org/x/mod/module"
)

func expectContent(t *testing.T, expected string, file string) {
	t.Helper()

	b, err := os.ReadFile(file)
	testutil.Ok(t, err)
	testutil.Equals(t, expected, string(b))
}

func TestFile(t *testing.T) {
	t.Parallel()

	tmpDir := t.TempDir()

	t.Run("open empty", func(t *testing.T) {
		t.Parallel()

		testFile := filepath.Join(tmpDir, "test.mod")

		_, err := OpenFile(testFile)
		testutil.NotOk(t, err)
		testutil.Equals(t, "open "+testFile+": no such file or directory", err.Error())

		testutil.Ok(t, os.WriteFile(testFile, []byte(``), os.ModePerm))
		mf, err := OpenFile(testFile)
		testutil.Ok(t, err)

		testutil.Equals(t, testFile, mf.Filepath())
		p, comment := mf.Module()
		testutil.Equals(t, "", p)
		testutil.Equals(t, "", comment)
		testutil.Equals(t, []string(nil), mf.Comments())
		testutil.Equals(t, "", mf.GoVersion())
		testutil.Equals(t, 0, len(mf.RequireDirectives()))
		testutil.Equals(t, 0, len(mf.ReplaceDirectives()))
		testutil.Equals(t, 0, len(mf.ExcludeDirectives()))
		testutil.Equals(t, 0, len(mf.RetractDirectives()))
	})
	t.Run("open mod file & modify.", func(t *testing.T) {
		t.Parallel()

		testFile := filepath.Join(tmpDir, "test2.mod")

		testutil.Ok(t, os.WriteFile(testFile, []byte(`module github.com/bwplotka/bingo

go 1.17

// Comment 1.

require (
	github.com/prometheus/prometheus v2.4.3+incompatible // cmd/prometheus yolo
	github.com/Masterminds/semver v1.5.0
	github.com/efficientgo/core v1.0.0-rc.0
	github.com/oklog/run v1.1.0
	golang.org/x/mod v0.5.1
	mvdan.cc/sh/v3 v3.4.3
)

// Comment 2.

require (
	github.com/davecgh/go-spew v1.1.1 // indirect
	golang.org/x/sync v0.0.0-20210220032951-036812b2e83c // indirect
	golang.org/x/sys v0.0.0-20220330033206-e17cdc41300f // indirect
	golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 // indirect
	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
)

replace mvdan.cc/sh/v3 => mvdan.cc/sh/v3 v3.2

retract (
	// Wrongly formatted.
	v1.0.0
)

exclude mvdan.cc/sh/v3 v3.4.4

// Comment 3.


`), os.ModePerm))

		mf, err := OpenFile(testFile)
		testutil.Ok(t, err)

		p, comment := mf.Module()
		testutil.Equals(t, "github.com/bwplotka/bingo", p)
		testutil.Equals(t, "", comment)

		testutil.Equals(t, []string{"Comment 1.", "Comment 2.", "Comment 3."}, mf.Comments())
		testutil.Equals(t, "1.17", mf.GoVersion())

		reqDirectives := mf.RequireDirectives()
		testutil.Equals(t, 11, len(reqDirectives))
		testutil.Equals(t, "github.com/prometheus/prometheus", reqDirectives[0].Module.Path)
		testutil.Equals(t, "v2.4.3+incompatible", reqDirectives[0].Module.Version)
		testutil.Equals(t, "cmd/prometheus yolo", reqDirectives[0].ExtraSuffixComment)
		testutil.Equals(t, false, reqDirectives[0].Indirect)

		testutil.Equals(t, "github.com/Masterminds/semver", reqDirectives[1].Module.Path)
		testutil.Equals(t, "v1.5.0", reqDirectives[1].Module.Version)
		testutil.Equals(t, "", reqDirectives[1].ExtraSuffixComment)
		testutil.Equals(t, false, reqDirectives[1].Indirect)

		testutil.Equals(t, "github.com/davecgh/go-spew", reqDirectives[6].Module.Path)
		testutil.Equals(t, "v1.1.1", reqDirectives[6].Module.Version)
		testutil.Equals(t, "", reqDirectives[6].ExtraSuffixComment)
		testutil.Equals(t, true, reqDirectives[6].Indirect)

		replDirectives := mf.ReplaceDirectives()
		testutil.Equals(t, 1, len(mf.ReplaceDirectives()))
		testutil.Equals(t, "mvdan.cc/sh/v3", replDirectives[0].Old.String())
		testutil.Equals(t, "mvdan.cc/sh/v3@v3.2.0", replDirectives[0].New.String())

		excludeDirectives := mf.ExcludeDirectives()
		testutil.Equals(t, 1, len(excludeDirectives))
		testutil.Equals(t, "mvdan.cc/sh/v3@v3.4.4", excludeDirectives[0].Module.String())

		retractDirectives := mf.RetractDirectives()
		testutil.Equals(t, 1, len(retractDirectives))
		testutil.Equals(t, "v1.0.0", retractDirectives[0].VersionInterval.High)
		testutil.Equals(t, "v1.0.0", retractDirectives[0].VersionInterval.Low)
		testutil.Equals(t, "Wrongly formatted.", retractDirectives[0].Rationale)

		// Modify.
		testutil.Ok(t, mf.SetModule("_", "yolo"))
		testutil.Ok(t, mf.AddComment("Let's go!"))
		testutil.Ok(t, mf.SetGoVersion("1.18"))
		testutil.Ok(t, mf.SetRequireDirectives(RequireDirective{Module: module.Version{Path: "my/module", Version: "v1.0.0"}, ExtraSuffixComment: "yolo"}))
		testutil.Ok(t, mf.SetReplaceDirectives(ReplaceDirective{Old: module.Version{Path: "my/module", Version: "v1.0.0"}, New: module.Version{Path: "my/module", Version: "v1.2.2"}}))
		testutil.Ok(t, mf.SetExcludeDirectives(ExcludeDirective{Module: module.Version{Path: "my/module", Version: "v1.1.0"}}))
		testutil.Ok(t, mf.SetRetractDirectives(RetractDirective{VersionInterval: VersionInterval{High: "v1.0.0", Low: "v0.9.0"}, Rationale: "I don't know"}))

		expectContent(t, `module _ // yolo

go 1.18

// Comment 1.

// Comment 2.

require my/module v1.0.0 // yolo

// Comment 3.

// Let's go!

replace my/module v1.0.0 => my/module v1.2.2

exclude my/module v1.1.0

// I don't know
retract [v0.9.0, v1.0.0]
`, testFile)
		p, comment = mf.Module()
		testutil.Equals(t, "_", p)
		testutil.Equals(t, "yolo", comment)

		testutil.Equals(t, []string{"Comment 1.", "Comment 2.", "Comment 3.", "Let's go!", "I don't know"}, mf.Comments())
		testutil.Equals(t, "1.18", mf.GoVersion())

		reqDirectives = mf.RequireDirectives()
		testutil.Equals(t, 1, len(reqDirectives))
		testutil.Equals(t, "my/module", reqDirectives[0].Module.Path)
		testutil.Equals(t, "v1.0.0", reqDirectives[0].Module.Version)
		testutil.Equals(t, "yolo", reqDirectives[0].ExtraSuffixComment)
		testutil.Equals(t, false, reqDirectives[0].Indirect)

		replDirectives = mf.ReplaceDirectives()
		testutil.Equals(t, 1, len(mf.ReplaceDirectives()))
		testutil.Equals(t, "my/module@v1.0.0", replDirectives[0].Old.String())
		testutil.Equals(t, "my/module@v1.2.2", replDirectives[0].New.String())

		excludeDirectives = mf.ExcludeDirectives()
		testutil.Equals(t, 1, len(excludeDirectives))
		testutil.Equals(t, "my/module@v1.1.0", excludeDirectives[0].Module.String())

		retractDirectives = mf.RetractDirectives()
		testutil.Equals(t, 1, len(retractDirectives))
		testutil.Equals(t, "v1.0.0", retractDirectives[0].VersionInterval.High)
		testutil.Equals(t, "v0.9.0", retractDirectives[0].VersionInterval.Low)
		testutil.Equals(t, "I don't know", retractDirectives[0].Rationale)
	})
}