Improve ProgramTest errors and path handling for Go programs #11611
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Changelog[uncommitted] (2022-12-13) |
justinvp
reviewed
Dec 10, 2022
AaronFriel
force-pushed
the
friel/robust-go-deps
branch
from
3ae90fd
to
79735a1
Compare
AaronFriel
added
the
impact/no-changelog-required
danielrbradley
requested changes
Dec 12, 2022
| pkgModPath := filepath.Join(dir, "go.mod") | ||
| pkgModData, err := os.ReadFile(pkgModPath) | ||
| if err != nil { | ||
| return "", fmt.Errorf("error reading go.mod at %s: %w", dir, err) |
There was a problem hiding this comment.
A little more detail in the error message directing the user to be able to resolve the issue would be helpful. E.g. something along the lines of:
Suggested change
| return "", fmt.Errorf("error reading go.mod at %s: %w", dir, err) | |
| return "", fmt.Errorf("error reading go.mod at %s. This can be set explicitly by specifying the path to the replacement, otherwise the environment variable PULUMI_GO_DEP_ROOT or GOPATH will be used: %w", dir, err) |
There was a problem hiding this comment.
Added to a parent function to handle both of the errors in this method
AaronFriel
force-pushed
the
friel/robust-go-deps
branch
from
79735a1
to
f79621a
Compare
AaronFriel
force-pushed
the
friel/robust-go-deps
branch
from
f79621a
to
2594058
Compare
justinvp
approved these changes
Dec 13, 2022
pkg/testing/integration/program.go
Outdated
| for _, dep := range pt.opts.Dependencies { | ||
| // when we load a package from a relative dir string, we read the package name from go.mod | ||
| // Use a literal replacement path. | ||
| /* pkg is a directory path, create a replace edit string from it */ |
There was a problem hiding this comment.
Nit: Why the different comment style?
There was a problem hiding this comment.
Deleted, this comment doesn't make sense after the refactoring.
|
bors merge |
AaronFriel
force-pushed
the
friel/robust-go-deps
branch
from
2594058
to
6642fb5
Compare
|
🕐 Waiting for PR status (GitHub check) to be set, probably by CI. Bors will automatically try to run when all required PR statuses are set. |
|
Build succeeded: |
bors bot
added a commit
that referenced
this pull request
Dec 14, 2022
11647: Fix test failure on Windows r=AaronFriel a=AaronFriel PR #11611 assumed a unix-y error message in one of the failure cases of the test `TestGoModEdits`. This case did not match on Windows: ``` === FAIL: testing/integration TestGoModEdits/invalid-path-non-existent (0.00s) program_test.go:170: Error Trace: C:\a\pulumi\pulumi\pkg\testing\integration\program_test.go:170 Error: Error "error reading go.mod at ../../../.tmp.non-existent-dir: open ..\\..\\..\\.tmp.non-existent-dir\\go.mod: The system cannot find the path specified." does not contain "open ../../../.tmp.non-existent-dir/go.mod: no such file or directory" Test: TestGoModEdits/invalid-path-non-existent --- FAIL: TestGoModEdits/invalid-path-non-existent (0.00s) ``` Co-authored-by: Aaron Friel <mayreply@aaronfriel.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This improves and expands on ProgramTest behavior for initializing Go programs, enabling better relative path handling and adding some safeguards. These are documented in
TestGoModEdits.