From 884b3c0f4bbdccb3d2dcb76ff323697375cda5ae Mon Sep 17 00:00:00 2001
From: Earl Warren <contact@earl-warren.org>
Date: Wed, 29 May 2024 19:47:15 +0200
Subject: [PATCH] test(util): MockProtect when mocking multiple times

It is fine to use MockVariableValue to change a setting such as:

defer test.MockVariableValue(&setting.Mirror.Enabled, true)()

But when testing for errors and mocking a function, multiple variants
of the functions will be used, not just one. MockProtect a function
will make sure that when the test fails it always restores a sane
version of the function. For instance:

defer test.MockProtect(&mirror_service.AddPushMirrorRemote)()

mirror_service.AddPushMirrorRemote = mockOne
do some tests that may fail

mirror_service.AddPushMirrorRemote = mockTwo
do more tests that may fail
---
 modules/test/utils.go      |  7 +++++++
 modules/test/utils_test.go | 18 ++++++++++++++++++
 2 files changed, 25 insertions(+)
 create mode 100644 modules/test/utils_test.go

diff --git a/modules/test/utils.go b/modules/test/utils.go
index 4a0c2f1b3b..3d884b6cbe 100644
--- a/modules/test/utils.go
+++ b/modules/test/utils.go
@@ -34,8 +34,15 @@ func IsNormalPageCompleted(s string) bool {
 	return strings.Contains(s, `<footer class="page-footer"`) && strings.Contains(s, `</html>`)
 }
 
+// use for global variables only
 func MockVariableValue[T any](p *T, v T) (reset func()) {
 	old := *p
 	*p = v
 	return func() { *p = old }
 }
+
+// use for global variables only
+func MockProtect[T any](p *T) (reset func()) {
+	old := *p
+	return func() { *p = old }
+}
diff --git a/modules/test/utils_test.go b/modules/test/utils_test.go
new file mode 100644
index 0000000000..a3be74ee94
--- /dev/null
+++ b/modules/test/utils_test.go
@@ -0,0 +1,18 @@
+// Copyright 2024 The Forgejo Authors
+// SPDX-License-Identifier: MIT
+
+package test
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestMockProtect(t *testing.T) {
+	mockable := "original"
+	restore := MockProtect(&mockable)
+	mockable = "tainted"
+	restore()
+	assert.Equal(t, "original", mockable)
+}