test: use T.TempDir to create temporary test directory

[Juneezee]

Description

A testing cleanup.

This pull request replaces ioutil.TempDir with t.TempDir. We can use the T.TempDir function from the testing package to create temporary directory. The directory created by T.TempDir is automatically removed when the test and all its subtests complete.

Reference: https://pkg.go.dev/testing#T.TempDir

func TestFoo(t *testing.T) {
	// before
	tmpDir, err := ioutil.TempDir("", "")
	assert.NoError(t, err)
	defer os.RemoveAll(tmpDir)

	// now
	tmpDir := t.TempDir()
}

Checklist

• I have added tests that prove my fix is effective or that my feature works: Tests refactoring only, no new features added.

• I have updated the CHANGELOG-PENDING file with my change: This PR is a non user-facing change.

• Yes, there are changes in this PR that warrants bumping the Pulumi Service API version: N/A

[github-actions]

PR is now waiting for a maintainer to take action.

Note for the maintainer: Commands available:

• /run-acceptance-tests - used to test run the acceptance tests for the project
• /run-codegen - used to test the Pull Request against downstream codegen
• /run-docs-gen - used to test the Pull Request against documentation generation

[pulumi-bot]

Changelog

[uncommitted] (2022-12-03)

[Frassle]

bors merge

[bors]

Build failed:

• bors-ok

[Juneezee]

@Frassle The failing test (logs ¹) may indicate a potential bug in writing / reading the content of Pulumi.yaml.

=== FAIL: cmd/pulumi TestCreatingStackWithArgsSpecifiedName (1.17s)
Logging in using access token from PULUMI_ACCESS_TOKEN
Created project '001'

    new_smoke_test.go:59: 
        	Error Trace:	/tmp/TestCreatingStackWithArgsSpecifiedName663333332/001/new_smoke_test.go:59
        	Error:      	Received unexpected error:
        	            	failed to load Pulumi project located at "/tmp/TestCreatingStackWithArgsSpecifiedName663333332/001/Pulumi.yaml": could not validate '/tmp/TestCreatingStackWithArgsSpecifiedName663333332/001/Pulumi.yaml': project is missing a non-empty string 'name' attribute
        	Test:       	TestCreatingStackWithArgsSpecifiedName
    new_smoke_test.go:192: 
        	Error Trace:	/tmp/TestCreatingStackWithArgsSpecifiedName663333332/001/new_smoke_test.go:192
        	            				/tmp/TestCreatingStackWithArgsSpecifiedName663333332/001/new_smoke_test.go:61
        	Error:      	Received unexpected error:
        	            	could not validate '/tmp/TestCreatingStackWithArgsSpecifiedName663333332/001/Pulumi.yaml': project is missing a non-empty string 'name' attribute
        	Test:       	TestCreatingStackWithArgsSpecifiedName

The format of the directory name returned by t.TempDir() is /tmp/<test-name><random-number>/<sequence-number>, e.g. /tmp/TestCreatingStackWithArgsSpecifiedName663333332/001. We didn't specify the project name in TestCreatingStackWithArgsSpecifiedName, so the default project name will be "001".

However, when we write the project name "001" into Pulumi.yaml, the string "001" is not quoted. This is the content of the file Pulumi.yaml.

When we read the project, the project name 001 is unmarshalled as a number, not a string. I have attached two debugging screenshots below.

pulumi/sdk/go/common/workspace/loaders.go

Lines 88 to 107 in 712145c

	marshaller, err := marshallerForPath(path)
	if err != nil {
	return nil, fmt.Errorf("can not read '%s': %w", path, err)
	}
	b, err := readFileStripUTF8BOM(path)
	if err != nil {
	return nil, fmt.Errorf("could not read '%s': %w", path, err)
	}
	var raw interface{}
	err = marshaller.Unmarshal(b, &raw)
	if err != nil {
	return nil, fmt.Errorf("could not unmarshal '%s': %w", path, err)
	}
	err = ValidateProject(raw)
	if err != nil {
	return nil, fmt.Errorf("could not validate '%s': %w", path, err)
	}

This could be a bug because "001" is a valid project name, according to this regular expression:

pulumi/sdk/go/common/workspace/templates.go

Lines 594 to 599 in 712145c

	// Naming rules are backend-specific. However, we provide baseline sanitization for project names
	// in this file. Though the backend may enforce stronger restrictions for a project name or description
	// further down the line.
	var (
	validProjectNameRegexp = regexp.MustCompile("^[A-Za-z0-9_.-]{1,100}$")
	)

---

Debugging screenshots:

Footnotes

1. https://github.com/pulumi/pulumi/actions/runs/3607842843/jobs/6080197819#step:36:43 ↩

[Juneezee]

Reverted pkg/cmd/pulumi/new_smoke_test.go and pkg/cmd/pulumi/new_test.go because of #11524 (comment)

[Frassle]

Sigh YAML
Whatever is writing out the YAML with unquoted numbers is what's wrong here, something to dig into but I'm fine with us merging this now to fix up all the other use cases.

[Frassle]

bors merge

[bors]

Build succeeded:

• bors-ok