Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Get GOPATH with go env #133

Merged
merged 1 commit into from Mar 23, 2024
Merged

Get GOPATH with go env #133

merged 1 commit into from Mar 23, 2024

Conversation

ghost
Copy link

@ghost ghost commented Mar 23, 2024

https://github.com/golang/go/blob/35b1a146d9febca70db87dc4e1f8bac33de857bb/src/go/build/build.go#L289-L306

build.Default.GOPATH is hard-coded ~/go while I use a custom GOPATH in ~/.config/go/env managed by go env.

I don't tend to test goPath because ~/.config/go/env could be read or written by other programs during the test.

Summary by CodeRabbit

  • Refactor
    • Removed unused imports and tests to clean up the codebase.
  • New Features
    • Enhanced the method to retrieve GOPATH, ensuring functionality even when GOPATH is not explicitly set.

Copy link
Contributor

coderabbitai bot commented Mar 23, 2024

Walkthrough

The recent updates streamline the handling of GOPATH and GOBIN within a Go project. Notably, unnecessary imports and functions related to environment variable checks have been removed, simplifying the codebase. A significant enhancement includes a new method for dynamically retrieving the GOPATH, ensuring greater flexibility and reliability in environments where this path is not explicitly set.

Changes

File Path Change Summary
cmd/remove_test.go - Removed go/build import
- Removed Test_remove_gobin_is_empty function
internal/goutil/... - Added dynamic GOPATH retrieval in goPath function
internal/goutil/... - Removed tests related to GOBIN and GOPATH retrieval

🐰✨
A hop, a skip, in the code we dive,
Cleaning, refining, making it thrive.
Gone are the lines we no longer need,
In their place, a solution, indeed.
Through fields of code, our journey we weave,
With every commit, we believe.
🌟📦

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 75be3f2 and b8571d7.
Files selected for processing (3)
  • cmd/remove_test.go (2 hunks)
  • internal/goutil/goutil.go (1 hunks)
  • internal/goutil/goutil_test.go (2 hunks)
Files skipped from review due to trivial changes (1)
  • cmd/remove_test.go
Additional comments: 2
internal/goutil/goutil.go (1)
  • 247-250: The addition of exec.Command to dynamically retrieve the GOPATH is a welcome improvement for flexibility. However, consider handling the case where the go command is not available or fails unexpectedly. It might be beneficial to log the error or provide a fallback mechanism.
internal/goutil/goutil_test.go (1)
  • 191-196: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]

The removal of tests related to GOPATH handling suggests a shift in testing strategy. Ensure that the new approach for dynamically retrieving GOPATH is adequately tested, possibly by mocking exec.Command to simulate different scenarios.

@nao1215
Copy link
Owner

nao1215 commented Mar 23, 2024

@rkscv
Thank you for this PR as well.
If you merge the changes from the main branch and the tests for this PR pass, I will merge the PR.

@ghost
Copy link
Author

ghost commented Mar 23, 2024

Do you mind if I delete these tests? Or any suggestions?

@nao1215
Copy link
Owner

nao1215 commented Mar 23, 2024

@rkscv
What do you think of test code like the following?

func TestGetPackageVersion_getting_error_from_gobin(t *testing.T) {
	// Set env variable to temporary value and defer restore on Cleanup
	t.Setenv("GOBIN", "")
	t.Setenv("GOPATH", "")

	// Backup and defer restore
	oldKeyGoPath := keyGoPath
	defer func() {
		keyGoPath = oldKeyGoPath
	}()

	// Mock the value
	keyGoPath = t.Name()

	// Setting GOBIN, GOPATH and build.Default.GOPATH to empty string
	// should be an error internally and return "unknown" as a version.
	got := GetPackageVersion(".")

	want := "unknown"
	if want != got {
		t.Errorf("GetPackageVersion() should return %v. got: %v", want, got)
	}
}

@ghost
Copy link
Author

ghost commented Mar 23, 2024

Thanks, it looks fine. But keyGoPath is not public so we can't mock it in Test_remove_gobin_is_empty. And we still need to run go env to get results in Test_goPath_get_from_build_default_gopath.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 7a4a982 and b78ea8b.
Files selected for processing (3)
  • cmd/remove_test.go (2 hunks)
  • internal/goutil/goutil.go (1 hunks)
  • internal/goutil/goutil_test.go (4 hunks)
Files skipped from review as they are similar to previous changes (3)
  • cmd/remove_test.go
  • internal/goutil/goutil.go
  • internal/goutil/goutil_test.go

@nao1215
Copy link
Owner

nao1215 commented Mar 23, 2024

@rkscv
Thank you for the corrections. I will merge this PR.

@nao1215 nao1215 merged commit 7f46f0d into nao1215:main Mar 23, 2024
11 checks passed
@ghost ghost deleted the use-go-env branch March 23, 2024 14:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant