Skip to content

Conversation

@r-hang
Copy link
Contributor

@r-hang r-hang commented Oct 8, 2025

When using the Bazel gopackagesdriver to analyze a rules_go project it's possible to run into missing packages errors that look like

/home/user/go/bazel-pkgdrv/execroot/__main__/bazel-out/
k8-fastbuild/example.go:8:7: could not import example.org/mock (missing package: "@//src/example.org/mock:go_default_library")

The root cause is that the gopackagesdriver aspect only traverses target's deps field to populate the package information in the driver registry. In cases where a target depends on another target that is not declared in the "deps" field this packages will be missing from the gopackagesdriver response.

ref: https://github.com/bazel-contrib/rules_go/blob/master/go/tools/gopackagesdriver/aspect.bzl#L30

An example of this edge case is on-the-fly generated go code produced by a bazel rule where the bazel rule provides a static dependency in the rule implementation instead of relying soley on the deps attribute. In this situation, this package is still required for the package analysis to complete but it is missing from the gopackagesdriver response.

This change adds a mechanism to the gopackagesdriver to specify packages that should always be added.

ref #4473

What type of PR is this?

Uncomment one line below and remove others.

Bug fix
Feature
Documentation
Other

What does this PR do? Why is it needed?

Which issues(s) does this PR fix?

Fixes #

Other notes for review

r-hang added 2 commits October 8, 2025 00:18
When using the Bazel gopackagesdriver to analyze a rules_go project it's
possible to run into missing packages errors that look like
```
/home/user/go/bazel-pkgdrv/execroot/__main__/bazel-out/
k8-fastbuild/example.go:8:7: could not import example.org/mock (missing package: "@//src/example.org/mock:go_default_library")
```

The root cause is that the gopackagesdriver aspect only traverses
target's deps field to populate the package information in the
driver registry. In cases where a target depends on another target
that is not declared in the "deps" field this packages will be missing
from the gopackagesdriver response.

ref: https://github.com/bazel-contrib/rules_go/blob/master/go/tools/gopackagesdriver/aspect.bzl#L30

An example of this edge case is on-the-fly generated go code produced
by a bazel rule where the bazel rule provides a static dependency in
the rule implementation instead of relying soley on the deps attribute.
In this situation, this package is still required for the package
analysis to complete but it is missing from the gopackagesdriver
response.

This change adds a mechanism to the gopackagesdriver to specify packages
that should always be added.

ref bazel-contrib#4473
buildWorkingDirectory = os.Getenv("BUILD_WORKING_DIRECTORY")
additionalAspects = strings.Fields(os.Getenv("GOPACKAGESDRIVER_BAZEL_ADDTL_ASPECTS"))
additionalKinds = strings.Fields(os.Getenv("GOPACKAGESDRIVER_BAZEL_KINDS"))
additionalLabels = strings.Fields(os.Getenv("GOPACKAGESDRIVER_BAZEL_ADDTL_LABELS"))
Copy link
Member

Choose a reason for hiding this comment

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

Let's write this out, the abbreviation isn't that commonly used

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.

2 participants