gengo icon indicating copy to clipboard operation
gengo copied to clipboard

Fix loading packages with Go modules disabled

Open n-peugnet opened this issue 9 months ago • 4 comments

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

n-peugnet avatar Mar 16 '25 17:03 n-peugnet

[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 avatar Mar 16 '25 17:03 k8s-ci-robot

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. :smiley:

k8s-ci-robot avatar Mar 16 '25 17:03 k8s-ci-robot

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 avatar Mar 16 '25 17:03 k8s-ci-robot

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot avatar Jun 14 '25 23:06 k8s-triage-robot

/remove-lifecycle stale

This pull request is still relevant. We include this patch in Debian but it would be good if this problem was fixed upstream.

n-peugnet avatar Jun 16 '25 10:06 n-peugnet

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot avatar Sep 14 '25 11:09 k8s-triage-robot

The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle rotten
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot avatar Oct 14 '25 12:10 k8s-triage-robot

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Reopen this PR with /reopen
  • Mark this PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

k8s-triage-robot avatar Nov 13 '25 12:11 k8s-triage-robot

@k8s-triage-robot: Closed this PR.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Reopen this PR with /reopen
  • Mark this PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

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 avatar Nov 13 '25 12:11 k8s-ci-robot