example_test.go

Documentation: gotest.tools/v3/fs

     1  package fs_test
     2  
     3  import (
     4  	"os"
     5  	"testing"
     6  
     7  	"gotest.tools/v3/assert"
     8  	"gotest.tools/v3/assert/cmp"
     9  	"gotest.tools/v3/fs"
    10  	"gotest.tools/v3/golden"
    11  )
    12  
    13  var t = &testing.T{}
    14  
    15  // Create a temporary directory which contains a single file
    16  func ExampleNewDir() {
    17  	dir := fs.NewDir(t, "test-name", fs.WithFile("file1", "content\n"))
    18  	defer dir.Remove()
    19  
    20  	files, err := os.ReadDir(dir.Path())
    21  	assert.NilError(t, err)
    22  	assert.Assert(t, cmp.Len(files, 0))
    23  }
    24  
    25  // Create a new file with some content
    26  func ExampleNewFile() {
    27  	file := fs.NewFile(t, "test-name", fs.WithContent("content\n"), fs.AsUser(0, 0))
    28  	defer file.Remove()
    29  
    30  	content, err := os.ReadFile(file.Path())
    31  	assert.NilError(t, err)
    32  	assert.Equal(t, "content\n", content)
    33  }
    34  
    35  // Create a directory and subdirectory with files
    36  func ExampleWithDir() {
    37  	dir := fs.NewDir(t, "test-name",
    38  		fs.WithDir("subdir",
    39  			fs.WithMode(os.FileMode(0700)),
    40  			fs.WithFile("file1", "content\n")),
    41  	)
    42  	defer dir.Remove()
    43  }
    44  
    45  // Test that a directory contains the expected files, and all the files have the
    46  // expected properties.
    47  func ExampleEqual() {
    48  	path := operationWhichCreatesFiles()
    49  	expected := fs.Expected(t,
    50  		fs.WithFile("one", "",
    51  			fs.WithBytes(golden.Get(t, "one.golden")),
    52  			fs.WithMode(0600)),
    53  		fs.WithDir("data",
    54  			fs.WithFile("config", "", fs.MatchAnyFileContent)))
    55  
    56  	assert.Assert(t, fs.Equal(path, expected))
    57  }
    58  
    59  func operationWhichCreatesFiles() string {
    60  	return "example-path"
    61  }
    62  
    63  // Add a file to an existing directory
    64  func ExampleApply() {
    65  	dir := fs.NewDir(t, "test-name")
    66  	defer dir.Remove()
    67  
    68  	fs.Apply(t, dir, fs.WithFile("file1", "content\n"))
    69  }
    70
View as plain text