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

Fix loading packages with Go modules disabled #291

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

n-peugnet
Copy link

@n-peugnet n-peugnet commented Mar 16, 2025

While packaging the v2 of this library in Debian, most of the tests were failing. This is because we use the GOPATH mode (so with Go modules disabled) to build and test packages.

This allows the parser to load packages even when Go modules are disabled, and when GOPATH mode is used.

I am not sure if this is the best way to handle this, but at least it works with Go modules either disabled or enabled. I don't really know either why the PkgPath looks like this in GOPATH mode, I didn't find in golang.org/x/tools's code where exactly this string is constructed from a quick search. So feel free to suggest a better way to solve this.

For the record, here is the kind of error that we got from running the tests in GOPATH mode:

=== RUN   TestSnippetWriter
    snippet_writer_test.go:33: unexpected error: error(s) in "_/home/nicolas/debian/golang-github-kubernetes-gengo/golang-github-kubernetes-gengo/obj-x86_64-linux-gnu/src/k8s.io/gengo/v2/generator/testdata/snippet_writer":
        -: cannot find package "_/home/nicolas/debian/golang-github-kubernetes-gengo/golang-github-kubernetes-gengo/obj-x86_64-linux-gnu/src/k8s.io/gengo/v2/generator/testdata/snippet_writer" in any of:
        	/usr/lib/go-1.24/src/_/home/nicolas/debian/golang-github-kubernetes-gengo/golang-github-kubernetes-gengo/obj-x86_64-linux-gnu/src/k8s.io/gengo/v2/generator/testdata/snippet_writer (from $GOROOT)
        	/home/nicolas/debian/golang-github-kubernetes-gengo/golang-github-kubernetes-gengo/obj-x86_64-linux-gnu/src/_/home/nicolas/debian/golang-github-kubernetes-gengo/golang-github-kubernetes-gengo/obj-x86_64-linux-gnu/src/k8s.io/gengo/v2/generator/testdata/snippet_writer (from $GOPATH)
--- FAIL: TestSnippetWriter (0.02s)
FAIL
FAIL	k8s.io/gengo/v2/generator	0.033s
[...]
=== RUN   TestFindPackages
    parse_test.go:161: wrong pkgs:
        want: [
          "k8s.io/gengo/v2/parser/testdata/root1",
          "k8s.io/gengo/v2/parser/testdata/root2",
          "k8s.io/gengo/v2/parser/testdata/roots345/root3",
          "k8s.io/gengo/v2/parser/testdata/roots345/root3/lib3",
          "k8s.io/gengo/v2/parser/testdata/roots345/root4",
          "k8s.io/gengo/v2/parser/testdata/roots345/root4/lib4",
          "k8s.io/gengo/v2/parser/testdata/roots345/root5",
          "k8s.io/gengo/v2/parser/testdata/roots345/root5/lib5"
        ]
        got:  [
          "_/home/nicolas/debian/golang-github-kubernetes-gengo/golang-github-kubernetes-gengo/obj-x86_64-linux-gnu/src/k8s.io/gengo/v2/parser/testdata/root1",
          "_/home/nicolas/debian/golang-github-kubernetes-gengo/golang-github-kubernetes-gengo/obj-x86_64-linux-gnu/src/k8s.io/gengo/v2/parser/testdata/root2",
          "_/home/nicolas/debian/golang-github-kubernetes-gengo/golang-github-kubernetes-gengo/obj-x86_64-linux-gnu/src/k8s.io/gengo/v2/parser/testdata/roots345/root3",
          "_/home/nicolas/debian/golang-github-kubernetes-gengo/golang-github-kubernetes-gengo/obj-x86_64-linux-gnu/src/k8s.io/gengo/v2/parser/testdata/roots345/root3/lib3",
          "_/home/nicolas/debian/golang-github-kubernetes-gengo/golang-github-kubernetes-gengo/obj-x86_64-linux-gnu/src/k8s.io/gengo/v2/parser/testdata/roots345/root4",
          "_/home/nicolas/debian/golang-github-kubernetes-gengo/golang-github-kubernetes-gengo/obj-x86_64-linux-gnu/src/k8s.io/gengo/v2/parser/testdata/roots345/root4/lib4",
          "_/home/nicolas/debian/golang-github-kubernetes-gengo/golang-github-kubernetes-gengo/obj-x86_64-linux-gnu/src/k8s.io/gengo/v2/parser/testdata/roots345/root5",
          "_/home/nicolas/debian/golang-github-kubernetes-gengo/golang-github-kubernetes-gengo/obj-x86_64-linux-gnu/src/k8s.io/gengo/v2/parser/testdata/roots345/root5/lib5"
        ]
    parse_test.go:186: wrong pkgs:
        want: ["k8s.io/gengo/v2/parser/testdata/does-not-parse"]
        got:  [
          "_/home/nicolas/debian/golang-github-kubernetes-gengo/golang-github-kubernetes-gengo/obj-x86_64-linux-gnu/src/k8s.io/gengo/v2/parser/testdata/does-not-parse"
        ]
--- FAIL: TestFindPackages (0.04s)
[...]
FAIL	k8s.io/gengo/v2/parser	0.297s

This allows the parser to load packages even when Go modules are
disabled, and when GOPATH mode is used.
This is especially useful in Debian as we build Go packages in GOPATH
mode, and the tests are also run in this mode.
Copy link

linux-foundation-easycla bot commented Mar 16, 2025

CLA Signed


The committers listed above are authorized under a signed CLA.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: n-peugnet
Once this PR has been reviewed and has the lgtm label, please assign sttts for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot requested review from jpbetz and wojtek-t March 16, 2025 17:48
@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Mar 16, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @n-peugnet!

It looks like this is your first PR to kubernetes/gengo 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/gengo has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @n-peugnet. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Mar 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants