File: forge_compliance.go

package info (click to toggle)
golang-code.forgejo-f3-gof3 3.11.0-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 1,952 kB
  • sloc: sh: 100; makefile: 65
file content (311 lines) | stat: -rw-r--r-- 11,358 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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
// Copyright Earl Warren <contact@earl-warren.org>
// Copyright Loïc Dachary <loic@dachary.org>
// SPDX-License-Identifier: MIT

package f3

import (
	"context"
	"slices"
	"testing"
	"time"

	"code.forgejo.org/f3/gof3/v3/f3"
	filesystem_options "code.forgejo.org/f3/gof3/v3/forges/filesystem/options"
	tests_repository "code.forgejo.org/f3/gof3/v3/forges/helpers/tests/repository"
	"code.forgejo.org/f3/gof3/v3/id"
	"code.forgejo.org/f3/gof3/v3/kind"
	"code.forgejo.org/f3/gof3/v3/path"
	f3_tree "code.forgejo.org/f3/gof3/v3/tree/f3"
	"code.forgejo.org/f3/gof3/v3/tree/generic"
	tests_forge "code.forgejo.org/f3/gof3/v3/tree/tests/f3/forge"

	"github.com/google/go-cmp/cmp"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

type remapper func(path string) path.Path

func ForgeCompliance(t *testing.T, name string) {
	testForge := tests_forge.GetFactory(name)()

	ctx := context.Background()

	forgeOptions := testForge.NewOptions(t)
	forgeTree := generic.GetFactory("f3")(ctx, forgeOptions)

	forgeTree.Trace("======= build fixture")
	fixtureTree := generic.GetFactory("f3")(ctx, tests_forge.GetFactory(filesystem_options.Name)().NewOptions(t))
	TreeBuildPartial(t, name, testForge.GetKindExceptions(), forgeOptions, fixtureTree)

	forgeTree.Trace("======= mirror fixture to forge")

	generic.TreeMirror(ctx, fixtureTree, forgeTree, generic.NewPathFromString(""), generic.NewMirrorOptions())

	forgeTree.Trace("======= run compliance tests")

	remap := func(p string) path.Path {
		return generic.TreePathRemap(ctx, fixtureTree, generic.NewPathFromString(p), forgeTree)
	}

	kindToForgePath := make(map[kind.Kind]string, len(KindToFixturePath))
	for kind, path := range KindToFixturePath {
		remappedPath := remap(path)
		if remappedPath.Empty() {
			forgeTree.Trace("%s was not mirrored, ignored", path)
			continue
		}
		kindToForgePath[kind] = remappedPath.String()
	}

	ComplianceKindTests(t, name, forgeTree.(f3_tree.TreeInterface), kindToForgePath, testForge.GetKindExceptions())
	ComplianceNameTests(t, name, forgeTree.(f3_tree.TreeInterface), remap, kindToForgePath, testForge.GetNameExceptions())

	if testForge.DeleteAfterCompliance() {
		TreeDelete(t, testForge.GetNonTestUsers(), forgeOptions, forgeTree)
	}
}

func ComplianceNameTests(t *testing.T, name string, tree f3_tree.TreeInterface, remap remapper, kindToForgePath map[kind.Kind]string, exceptions []string) {
	t.Helper()
	ctx := context.Background()
	t.Run("PullRequests", func(t *testing.T) {
		for _, variant := range []struct {
			name    string
			builder func(t *testing.T, tree f3_tree.TreeInterface, remap remapper, pullRequest *f3.PullRequest, parent path.Path) *f3.PullRequest
		}{
			{
				name:    tests_forge.ComplianceNameForkedPullRequest,
				builder: ComplianceForkedPullRequest,
			},
			{
				name:    tests_forge.ComplianceNameNoBranchPullRequest,
				builder: ComplianceNoBranchPullRequest,
			},
		} {
			if !slices.Contains(exceptions, variant.name) {
				t.Run(variant.name, func(t *testing.T) {
					kind := kind.Kind(f3_tree.KindPullRequests)
					p := kindToForgePath[kind]
					parent := tree.Find(generic.NewPathFromString(p))
					require.NotEqualValues(t, generic.NilNode, parent, p)
					child := tree.Factory(ctx, tree.GetChildrenKind(kind))
					childFormat := variant.builder(t, tree, remap, child.NewFormat().(*f3.PullRequest), parent.GetCurrentPath())

					child.FromFormat(childFormat)
					tree.Trace("'Upsert' the new pull request in the parent and store it in the forge")
					child.SetParent(parent)
					child.Upsert(ctx)
				})
			}
		}
	})
}

func ComplianceForkedPullRequest(t *testing.T, tree f3_tree.TreeInterface, remap remapper, pullRequest *f3.PullRequest, parent path.Path) *f3.PullRequest {
	user := f3_tree.GetFirstFormat[*f3.User](parent.Last().(generic.NodeInterface))
	projectNode := f3_tree.GetFirstNodeKind(parent.Last().(generic.NodeInterface), f3_tree.KindProject)
	repositoryNode := projectNode.Find(generic.NewPathFromString("repositories/vcs"))
	repositoryNode.Get(context.Background())
	repositoryHelper := tests_repository.NewTestHelper(t, "", repositoryNode)

	mainRef := "master"
	mainSha := repositoryHelper.GetRepositorySha(mainRef)

	tree.Trace("create a feature branch in the /forge/users/20222/projects/99099 fork")
	forkedRepositoryPath := remap("/forge/users/20222/projects/99099/repositories/vcs")
	forkedRepositoryNode := tree.Find(forkedRepositoryPath)
	require.NotEqual(t, forkedRepositoryNode, generic.NilNode)
	forkedRepositoryHelper := tests_repository.NewTestHelper(t, "", forkedRepositoryNode)
	featureRef := "generatedforkfeature"
	forkedRepositoryHelper.InternalBranchRepositoryFeature(featureRef, featureRef+" content")
	featureSha := forkedRepositoryHelper.GetRepositorySha(featureRef)
	forkedRepositoryHelper.PushMirror()

	now := now()
	prCreated := tick(&now)
	prUpdated := tick(&now)

	pullRequest.PosterID = f3_tree.NewUserReference(user.GetID())
	pullRequest.Title = featureRef + " pr title"
	pullRequest.Content = featureRef + " pr content"
	pullRequest.State = f3.PullRequestStateOpen
	pullRequest.IsLocked = false
	pullRequest.Created = prCreated
	pullRequest.Updated = prUpdated
	pullRequest.Closed = nil
	pullRequest.Merged = false
	pullRequest.MergedTime = nil
	pullRequest.MergeCommitSHA = ""
	pullRequest.Head = f3.PullRequestBranch{
		Ref:        featureRef,
		SHA:        featureSha,
		Repository: f3.NewReference(forkedRepositoryPath.String()),
	}
	pullRequest.Base = f3.PullRequestBranch{
		Ref:        mainRef,
		SHA:        mainSha,
		Repository: f3.NewReference("../../repository/vcs"),
	}
	return pullRequest
}

func ComplianceNoBranchPullRequest(t *testing.T, tree f3_tree.TreeInterface, remap remapper, pullRequest *f3.PullRequest, parent path.Path) *f3.PullRequest {
	user := f3_tree.GetFirstFormat[*f3.User](parent.Last().(generic.NodeInterface))
	projectNode := f3_tree.GetFirstNodeKind(parent.Last().(generic.NodeInterface), f3_tree.KindProject)
	repositoryNode := projectNode.Find(generic.NewPathFromString("repositories/vcs"))
	repositoryNode.Get(context.Background())
	repositoryHelper := tests_repository.NewTestHelper(t, "", repositoryNode)

	mainRef := "master"
	mainSha := repositoryHelper.GetRepositorySha(mainRef)

	tree.Trace("create a pull request from the SHA when the branch does not exist, for instance for closed pull requests for which the branch was deleted")
	featureRef := "nobranchfeature"
	repositoryHelper.InternalBranchRepositoryFeature(featureRef, featureRef+" content")
	featureSha := repositoryHelper.GetRepositorySha(featureRef)
	repositoryHelper.PushMirror()

	now := now()
	prCreated := tick(&now)
	prUpdated := tick(&now)

	pullRequest.PosterID = f3_tree.NewUserReference(user.GetID())
	pullRequest.Title = featureRef + " pr title"
	pullRequest.Content = featureRef + " pr content"
	pullRequest.State = f3.PullRequestStateOpen
	pullRequest.IsLocked = false
	pullRequest.Created = prCreated
	pullRequest.Updated = prUpdated
	pullRequest.Closed = nil
	pullRequest.Merged = false
	pullRequest.MergedTime = nil
	pullRequest.MergeCommitSHA = ""
	pullRequest.Head = f3.PullRequestBranch{
		Ref:        "nonexistentbranch",
		SHA:        featureSha,
		Repository: f3.NewReference("../../repository/vcs"),
	}
	pullRequest.Base = f3.PullRequestBranch{
		Ref:        mainRef,
		SHA:        mainSha,
		Repository: f3.NewReference("../../repository/vcs"),
	}
	return pullRequest
}

func ComplianceKindTests(t *testing.T, name string, tree f3_tree.TreeInterface, kindToForgePath map[kind.Kind]string, exceptions []kind.Kind) {
	t.Helper()
	exceptions = append(exceptions, f3_tree.KindRepositories)

	for _, kind := range KindWithFixturePath {
		path := kindToForgePath[kind]
		if !tree.IsContainer(kind) {
			continue
		}
		if slices.Contains(exceptions, kind) {
			continue
		}
		t.Run(string(kind), func(t *testing.T) {
			Compliance(t, name, tree, path, kind, GeneratorSetRandom, GeneratorModify)
		})
	}
}

func Compliance(t *testing.T, name string, tree f3_tree.TreeInterface, p string, kind kind.Kind, generator GeneratorFunc, modificator ModificatorFunc) {
	t.Helper()
	ctx := context.Background()

	tree.Trace("%s", p)
	parent := tree.Find(generic.NewPathFromString(p))
	require.NotEqualValues(t, generic.NilNode, parent, p)
	tree.Trace("create a new child in memory")
	child := tree.Factory(ctx, tree.GetChildrenKind(kind))
	childFormat := generator(t, name, child.NewFormat(), parent.GetCurrentPath())
	child.FromFormat(childFormat)
	if i := child.GetID(); i != id.NilID {
		tree.Trace("about to insert child %s", i)
		assert.EqualValues(t, generic.NilNode, parent.GetChild(child.GetID()))
	} else {
		tree.Trace("about to insert child with nil ID")
	}
	if child.GetDriver().IsNull() {
		t.Skip("no driver, skipping")
	}

	tree.Trace("'Upsert' the new child in the parent and store it in the forge")
	child.SetParent(parent)
	child.Upsert(ctx)
	tree.Trace("done inserting child '%s'", child.GetID())
	before := child.ToFormat()
	require.EqualValues(t, before.GetID(), child.GetID().String())
	tree.Trace("'Get' the child '%s' from the forge", child.GetID())
	child.Get(ctx)
	after := child.ToFormat()
	tree.Trace("check the F3 representations Upsert & Get to/from the forge are equivalent")
	require.True(t, cmp.Equal(before, after), cmp.Diff(before, after))

	tree.Trace("check the F3 representation FromFormat/ToFormat are identical")
	{
		saved := after

		a := childFormat.Clone()
		if tree.AllocateID() {
			a.SetID("123456")
		}
		child.FromFormat(a)
		b := child.ToFormat()
		require.True(t, cmp.Equal(a, b), cmp.Diff(a, b))

		child.FromFormat(saved)
	}

	if childFormat.GetName() != childFormat.GetID() {
		tree.Trace("'GetIDFromName' %s %s", kind, childFormat.GetName())
		id := parent.GetIDFromName(ctx, childFormat.GetName())
		assert.EqualValues(t, child.GetID(), id)
	}

	for i, modified := range modificator(t, after, parent.GetCurrentPath()) {
		tree.Trace("%d: %s 'Upsert' a modified child %v", i, kind, modified)
		child.FromFormat(modified)
		child.Upsert(ctx)
		tree.Trace("%d: 'Get' the modified child '%s' from the forge", i, child.GetID())
		child.Get(ctx)
		after = child.ToFormat()
		tree.Trace("%d: check the F3 representations Upsert & Get to/from the forge of the modified child are equivalent", i)
		require.True(t, cmp.Equal(modified, after), cmp.Diff(modified, after))
	}

	nodeChildren := parent.GetNodeChildren()
	tree.Trace("'ListPage' and only 'Get' known %d children of %s", len(nodeChildren), parent.GetKind())
	if len(nodeChildren) > 0 {
		parent.List(ctx)
		for _, child := range parent.GetChildren() {
			if _, ok := nodeChildren[child.GetID()]; ok {
				tree.Trace("'WalkAndGet' %s child %s %s", parent.GetCurrentPath().ReadableString(), child.GetKind(), child.GetID())
				child.WalkAndGet(ctx, parent.GetCurrentPath(), generic.NewWalkOptions(nil))
			}
		}
	}

	tree.Trace("'Delete' child '%s' from the forge", child.GetID())
	child.Delete(ctx)
	assert.EqualValues(t, generic.NilNode, parent.GetChild(child.GetID()))

	assert.True(t, child.GetIsSync())
	loop := 100
	for i := 0; i < loop; i++ {
		child.SetIsSync(false)
		child.Get(ctx)
		if !child.GetIsSync() {
			break
		}
		tree.Trace("waiting for asynchronous child deletion (%d/%d)", i, loop)
		time.Sleep(5 * time.Second)
	}
	assert.False(t, child.GetIsSync())

	tree.Trace("%s did something %s", kind, child)
}