filesnapshot

package

v0.0.0-...-683b059 Latest Latest Go to latest Published: Apr 23, 2022 License: BSD-3-Clause Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package filesnapshot provides functions that store/restore the snapshot (i.e. the content) of important files during integration test.

This section is empty.

This section is empty.

This section is empty.

type Snapshot struct {
	// contains filtered or unexported fields
}

Snapshot mentions the lookup table from the filename to the corresponding stored snapshot, and it supports the operations that are defined below.

func NewSnapshot() *Snapshot

NewSnapshot creates a new Snapshot of which lookup table is initialized.

func (s *Snapshot) Pop(filename string) error

Pop restores and the file content and delete the snapshot for restoration as well.

func (s *Snapshot) Remove(filename string)

Remove removes the entry of filename from the snapshot lookup table; if the snapshot doesn't exist, performs no-ops.

func (s *Snapshot) Restore(filename string) error

Restore restores the snapshot of "filename". Note that the snapshot entry is not removed after the operation.

func (s *Snapshot) Save(filename string) error

Save reads the snapshot of filename, and stores it associated with the filename. If the snapshot is been saved before, overrides it.

func (s *Snapshot) Stash(filename string) error

Stash stores the snapshot and delete the file.