frp/test/e2e/framework/cleanup.go

package framework

import (
	"sync"
)

// CleanupActionHandle is an integer pointer type for handling cleanup action
type CleanupActionHandle *int

type cleanupFuncHandle struct {
	actionHandle CleanupActionHandle
	actionHook   func()
}

var (
	cleanupActionsLock sync.Mutex
	cleanupHookList    = []cleanupFuncHandle{}
)

// AddCleanupAction installs a function that will be called in the event of the
// whole test being terminated.  This allows arbitrary pieces of the overall
// test to hook into SynchronizedAfterSuite().
// The hooks are called in last-in-first-out order.
func AddCleanupAction(fn func()) CleanupActionHandle {
	p := CleanupActionHandle(new(int))
	cleanupActionsLock.Lock()
	defer cleanupActionsLock.Unlock()
	c := cleanupFuncHandle{actionHandle: p, actionHook: fn}
	cleanupHookList = append([]cleanupFuncHandle{c}, cleanupHookList...)
	return p
}

// RemoveCleanupAction removes a function that was installed by
// AddCleanupAction.
func RemoveCleanupAction(p CleanupActionHandle) {
	cleanupActionsLock.Lock()
	defer cleanupActionsLock.Unlock()
	for i, item := range cleanupHookList {
		if item.actionHandle == p {
			cleanupHookList = append(cleanupHookList[:i], cleanupHookList[i+1:]...)
			break
		}
	}
}

// RunCleanupActions runs all functions installed by AddCleanupAction.  It does
// not remove them (see RemoveCleanupAction) but it does run unlocked, so they
// may remove themselves.
func RunCleanupActions() {
	list := []func(){}
	func() {
		cleanupActionsLock.Lock()
		defer cleanupActionsLock.Unlock()
		for _, p := range cleanupHookList {
			list = append(list, p.actionHook)
		}
	}()
	// Run unlocked.
	for _, fn := range list {
		fn()
	}
}