internal/cleanup/multi.go

// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you under
// the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

package cleanup

// FailClean keeps track of functions to be executed of FailClean did
// not receive a success signal.
type FailClean struct {
	success bool
	fns     []func()
}

// Signal sends a success or fail signal to FailClean.
func (f *FailClean) Signal(success bool) {
	f.success = success
}

// Add adds another cleanup handler. The last added handler will be run first.
func (f *FailClean) Add(fn func()) {
	f.fns = append(f.fns, fn)
}

// Cleanup runs all cleanup handlers in reverse order.
func (f *FailClean) Cleanup() {
	if f.success {
		return
	}

	for i := len(f.fns) - 1; i >= 0; i-- {
		f.fns[i]()
	}
}