task_driver/go/lib/os_steps/os_steps_test.go

package os_steps

import (
	"context"
	"os"
	"path/filepath"
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"

	"go.skia.org/infra/task_driver/go/td"
)

func TestOsSteps(t *testing.T) {
	tr := td.StartTestRun(t)
	defer tr.Cleanup()

	// Root-level step.
	s := tr.Root()

	// We're basically just verifying that the os utils work.
	expect := []td.StepResult{}

	// Stat the nonexistent dir.
	expect = append(expect, td.StepResultException)
	dir1 := filepath.Join(tr.Dir(), "test_dir")
	_, err := Stat(s, dir1)
	require.True(t, os.IsNotExist(err))

	// Try to remove the dir.
	expect = append(expect, td.StepResultSuccess)
	err = RemoveAll(s, dir1)
	require.NoError(t, err) // os.RemoveAll doesn't return error if the dir doesn't exist.

	// Create the dir.
	expect = append(expect, td.StepResultSuccess)
	err = MkdirAll(s, dir1)
	require.NoError(t, err)

	// Stat the dir.
	expect = append(expect, td.StepResultSuccess)
	fi, err := Stat(s, dir1)
	require.NoError(t, err)
	require.True(t, fi.IsDir())

	// Try to create the dir again.
	expect = append(expect, td.StepResultSuccess)
	err = MkdirAll(s, dir1)
	require.NoError(t, err) // os.MkdirAll doesn't return error if the dir already exists.

	// Create a tempDir using a custom function.
	withCustomTempDirFn := context.WithValue(s, TempDirContextKey, func(string, string) (string, error) {
		return "/fake/tmp/dir", nil
	})
	expect = append(expect, td.StepResultSuccess)
	tempDir, err := TempDir(withCustomTempDirFn, "does/not/matter", "this-is-ignored")
	require.NoError(t, err)
	assert.Equal(t, "/fake/tmp/dir", tempDir)

	// Create a tempDir inside the dir.
	expect = append(expect, td.StepResultSuccess)
	tempDir, err = TempDir(s, dir1, "test_prefix_")
	require.NoError(t, err)

	// Verify the tempDir exists.
	expect = append(expect, td.StepResultSuccess)
	fi, err = Stat(s, tempDir)
	require.NoError(t, err)
	require.True(t, fi.IsDir())

	// Rename the tempDir.
	expect = append(expect, td.StepResultSuccess)
	newTempDir := filepath.Join(dir1, "newtmpdir")
	err = Rename(s, tempDir, newTempDir)
	require.NoError(t, err)

	// Stat the renamed tempDir.
	expect = append(expect, td.StepResultSuccess)
	fi, err = Stat(s, newTempDir)
	require.NoError(t, err)
	require.True(t, fi.IsDir())

	// Create a file.
	myFile := filepath.Join(newTempDir, "my-file")
	expect = append(expect, td.StepResultSuccess)
	require.NoError(t, WriteFile(s, myFile, []byte("some contents"), 0640))

	// Stat the file.
	expect = append(expect, td.StepResultSuccess)
	fiFile, err := Stat(s, myFile)
	require.NoError(t, err)
	require.True(t, fiFile.Mode().IsRegular())

	// Copy the file.
	cpFile := filepath.Join(dir1, "copied-file")
	expect = append(expect, td.StepResultSuccess)
	require.NoError(t, CopyFile(s, myFile, cpFile))

	// Stat the file.
	expect = append(expect, td.StepResultSuccess)
	fiCpFile, err := Stat(s, cpFile)
	require.NoError(t, err)
	require.Equal(t, fiFile.Mode(), fiCpFile.Mode())

	// Remove the dir.
	expect = append(expect, td.StepResultSuccess)
	err = RemoveAll(s, dir1)
	require.NoError(t, err)

	// Stat the dir.
	expect = append(expect, td.StepResultException)
	_, err = Stat(s, dir1)
	require.True(t, os.IsNotExist(err))

	// Ensure that we got the expected step results.
	results := tr.EndRun(false, nil)
	require.Equal(t, len(results.Steps), len(expect))
	for idx, stepResult := range results.Steps {
		require.Equal(t, stepResult.Result, expect[idx])
	}
}