init

func Backend ¶

func Backend(name string) (backend.InitFn, string)

Backend returns the initialization factory for the given backend, or nil if none exists.

The second return value is the canonical name for the selected backend, if any, which should be used in the UI and in OpenTofu's records of which backend is active in a particular working directory.

func Init ¶

func Init(services *disco.Disco)

Init initializes the backends map with all our hardcoded backends.

func RegisterTemp ¶

func RegisterTemp(name string, f backend.InitFn) func()

RegisterTemp adds a new entry to the table of backends and returns a function that will deregister it once called.

This is essentially a workaround for the fact that the Ghoten CLI layer expects backends to always come from a centrally-maintained table and doesn't have any way to directly pass an anonymous backend implementation.

The given name MUST start with an underscore, to ensure that it cannot collide with any "real" backend. If the given name does not start with an underscore then this function will panic. If we introduce plugin-based backends in future then we might consider reserving part of the plugin address namespace to represent temporary backends for test purposes only, which would then replace this special underscore prefix as the differentiator.

This is intended for unit tests that use MockBackend, or a derivative thereof. A typical usage pattern from a unit test would be:

// ("backendInit" represents _this_ package)
t.Cleanup(backendInit.RegisterTemp("_test", func (enc encryption.StateEncryption) Backend {
	return &backendInit.MockBackend{
		// (and then whichever mock settings your test case needs)
	}
}))

Because this function modifies global state observable throughout the program, any test using this function MUST NOT use t.Parallel. If a single test needs to register multiple temporary backends for some reason then it must select a different name for each one.

func Set ¶

func Set(name string, f backend.InitFn)

Set sets a new backend in the list of backends. If f is nil then the backend will be removed from the map. If this backend already exists then it will be overwritten.

This method sets this backend globally and care should be taken to do this only before OpenTofu is executing to prevent odd behavior of backends changing mid-execution.

NOTE: Underscore-prefixed named are reserved for unit testing use via the RegisterTemp function. Do not add any underscore-prefixed names using this function.