x/vuln: create exp/govulncheck and update cmd/govulncheck to use internal/govulncheck #56042

julieqiu · 2022-10-04T19:27:07Z

Move the logic in govulncheck to internal/govulncheck, and refactor cmd/govulncheck to just use internal/govulncheck.Result:

func Run(ctx context.Context, cfg Config) (*Result, error) { ... }

The text was updated successfully, but these errors were encountered:

gopherbot · 2022-10-04T19:33:26Z

Change https://go.dev/cl/437856 mentions this issue: internal/govulncheck: replace vulncheck.Result with Result

gopherbot · 2022-10-05T14:05:22Z

Change https://go.dev/cl/437865 mentions this issue: cmd,exp,internal: add ctx to Run

gopherbot · 2022-10-05T14:05:23Z

Change https://go.dev/cl/437864 mentions this issue: exp/govulncheck: change Run to Main

gopherbot · 2022-10-05T14:18:02Z

Change https://go.dev/cl/439075 mentions this issue: internal/govulncheck: change Run to return Result struct

gopherbot · 2022-10-05T14:30:37Z

Change https://go.dev/cl/439076 mentions this issue: internal/govulncheck: write TODOs where relevant

Create a stable API for exp/govulncheck, for use by gopls. The function signature for exp/govulncheck.Main should not need change in the process of refactoring internal/govulncheck. For golang/go#56042 Change-Id: I3c62d9bc3a3e13d80e5693cf8bcb8f8794721e0e Reviewed-on: https://go-review.googlesource.com/c/vuln/+/437864 TryBot-Result: Gopher Robot <gobot@golang.org> Auto-Submit: Julie Qiu <julieqiu@google.com> Run-TryBot: Julie Qiu <julieqiu@google.com> Reviewed-by: Julie Qiu <julieqiu@google.com> Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>

Run now accepts context.Context as its first argument. For golang/go#56042 Change-Id: I24b3cbb5b28bf4d6ec55fdbe76af2d80480fa7ab Reviewed-on: https://go-review.googlesource.com/c/vuln/+/437865 Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com> Reviewed-by: Julie Qiu <julieqiu@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Run-TryBot: Julie Qiu <julieqiu@google.com>

The function signature for Run is changed to: func Run(ctx context.Context, cfg Config) (*Result, error) {...} At the moment, Result is an empty struct. Fields will be added in subsequent CLs. For golang/go#56042 Change-Id: I4568ca8147809c0c4e26aa83c96440d16ca32ffb Reviewed-on: https://go-review.googlesource.com/c/vuln/+/439075 Run-TryBot: Hyang-Ah Hana Kim <hyangah@gmail.com> Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com> Reviewed-by: Julie Qiu <julieqiu@google.com> TryBot-Result: Gopher Robot <gobot@golang.org>

To make it clearer what is happening in subsequent CLs in this stack, write down TODOs throughout the code. For golang/go#56042 Change-Id: I1ccb38c53f4edd75ec6f6c2fc7de5ee0d0aba1c3 Reviewed-on: https://go-review.googlesource.com/c/vuln/+/439076 Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com> Reviewed-by: Julie Qiu <julie@golang.org> TryBot-Result: Gopher Robot <gobot@golang.org> Run-TryBot: Julie Qiu <julieqiu@google.com> Reviewed-by: Julie Qiu <julieqiu@google.com>

gopherbot · 2022-10-17T17:54:31Z

Change https://go.dev/cl/443070 mentions this issue: internal/govulncheck: add Legacy prefix to legacy structs

gopherbot · 2022-10-17T17:54:32Z

Change https://go.dev/cl/440219 mentions this issue: exp,internal/govulncheck: add govulncheck API

We plan to replace structs with a new API design in a follow up CL. Prefix the legacy structs with Legacy as a first step for this transition, to make renaming easier. Also rename run.go to legacy_run.go, since the current implementation of Run will be replaced by Source and Binary. For golang/go#56042 Change-Id: I2fc80048bd937ad81ee1263aaac83495ea2e0876 Reviewed-on: https://go-review.googlesource.com/c/vuln/+/443070 Run-TryBot: Julie Qiu <julie@golang.org> Reviewed-by: Jonathan Amsterdam <jba@google.com> Reviewed-by: Zvonimir Pavlinovic <zpavlinovic@google.com> Reviewed-by: Julie Qiu <julieqiu@google.com> TryBot-Result: Gopher Robot <gobot@golang.org>

An API is defined for internal/govulncheck. The API in exp/govulncheck is updated to use internal/govulncheck.Config and internal/govulncheck.Source. For golang/go#56042 Change-Id: Ibab2fae0685166e7712b355e2c7c2ab0b4d50c6c Reviewed-on: https://go-review.googlesource.com/c/vuln/+/440219 Reviewed-by: Jonathan Amsterdam <jba@google.com> Reviewed-by: Julie Qiu <julieqiu@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Zvonimir Pavlinovic <zpavlinovic@google.com> Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com> Run-TryBot: Julie Qiu <julie@golang.org>

gopherbot · 2022-10-31T19:22:36Z

Change https://go.dev/cl/446715 mentions this issue: internal/govulncheck: implement new Source and Binary APIs

This is a first in the series of refactoring CLs that implement new govulncheck API. Please see opening message for more details on actual changes. For golang/go#56042 Change-Id: I6ec699204e21e94bf577220bfe040ed6db873d29 Reviewed-on: https://go-review.googlesource.com/c/vuln/+/446715 Run-TryBot: Zvonimir Pavlinovic <zpavlinovic@google.com> Reviewed-by: Jonathan Amsterdam <jba@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>

gopherbot · 2022-11-03T17:22:02Z

Change https://go.dev/cl/447675 mentions this issue: cmd/govulncheck: update documentation for json flag

Make it point to the new Result data structure. For golang/go#56042 Change-Id: I4eb1d319c958fef8adcb57adb20840e14f8ca3fa Reviewed-on: https://go-review.googlesource.com/c/vuln/+/447675 TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com> Run-TryBot: Zvonimir Pavlinovic <zpavlinovic@google.com>

gopherbot · 2022-11-04T00:30:12Z

Change https://go.dev/cl/447855 mentions this issue: cmd/govulncheck: inline LegacyRun into govulncheck main

The function signature for Run is changed to: func Run(ctx context.Context, cfg Config) (*Result, error) {...} At the moment, Result is an empty struct. Fields will be added in subsequent CLs. For golang/go#56042 Change-Id: I4568ca8147809c0c4e26aa83c96440d16ca32ffb Reviewed-on: https://go-review.googlesource.com/c/vuln/+/439075 Run-TryBot: Hyang-Ah Hana Kim <hyangah@gmail.com> Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com> Reviewed-by: Julie Qiu <julieqiu@google.com> TryBot-Result: Gopher Robot <gobot@golang.org>

To make it clearer what is happening in subsequent CLs in this stack, write down TODOs throughout the code. For golang/go#56042 Change-Id: I1ccb38c53f4edd75ec6f6c2fc7de5ee0d0aba1c3 Reviewed-on: https://go-review.googlesource.com/c/vuln/+/439076 Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com> Reviewed-by: Julie Qiu <julie@golang.org> TryBot-Result: Gopher Robot <gobot@golang.org> Run-TryBot: Julie Qiu <julieqiu@google.com> Reviewed-by: Julie Qiu <julieqiu@google.com>

We plan to replace structs with a new API design in a follow up CL. Prefix the legacy structs with Legacy as a first step for this transition, to make renaming easier. Also rename run.go to legacy_run.go, since the current implementation of Run will be replaced by Source and Binary. For golang/go#56042 Change-Id: I2fc80048bd937ad81ee1263aaac83495ea2e0876 Reviewed-on: https://go-review.googlesource.com/c/vuln/+/443070 Run-TryBot: Julie Qiu <julie@golang.org> Reviewed-by: Jonathan Amsterdam <jba@google.com> Reviewed-by: Zvonimir Pavlinovic <zpavlinovic@google.com> Reviewed-by: Julie Qiu <julieqiu@google.com> TryBot-Result: Gopher Robot <gobot@golang.org>

An API is defined for internal/govulncheck. The API in exp/govulncheck is updated to use internal/govulncheck.Config and internal/govulncheck.Source. For golang/go#56042 Change-Id: Ibab2fae0685166e7712b355e2c7c2ab0b4d50c6c Reviewed-on: https://go-review.googlesource.com/c/vuln/+/440219 Reviewed-by: Jonathan Amsterdam <jba@google.com> Reviewed-by: Julie Qiu <julieqiu@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Zvonimir Pavlinovic <zpavlinovic@google.com> Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com> Run-TryBot: Julie Qiu <julie@golang.org>

This is a first in the series of refactoring CLs that implement new govulncheck API. Please see opening message for more details on actual changes. For golang/go#56042 Change-Id: I6ec699204e21e94bf577220bfe040ed6db873d29 Reviewed-on: https://go-review.googlesource.com/c/vuln/+/446715 Run-TryBot: Zvonimir Pavlinovic <zpavlinovic@google.com> Reviewed-by: Jonathan Amsterdam <jba@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>

Make it point to the new Result data structure. For golang/go#56042 Change-Id: I4eb1d319c958fef8adcb57adb20840e14f8ca3fa Reviewed-on: https://go-review.googlesource.com/c/vuln/+/447675 TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com> Run-TryBot: Zvonimir Pavlinovic <zpavlinovic@google.com>

This is the second in the series of CLs that attempts to refactor govulncheck. The changes in this CL are: - inline the logic of LegacyRun into cmd/govulncheck/main.go - delete LegacyConfig and related data structures - move all the accompanying logic to cmd/govulncheck - expose db caching logic This effectively results in the following structure. internal/govulncheck contains the core logic for Source and Binary analysis (including db caching). cmd/govulncheck contains the logic for parsing the flags and printing the results. The follow-up refactoring CLs will mainly focus on renaming of things and addressing TODOs. For golang/go#56042 Change-Id: Ib1fc26951420ae6d04e48205765a1019d117946f Reviewed-on: https://go-review.googlesource.com/c/vuln/+/447855 Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com> TryBot-Result: Gopher Robot <gobot@golang.org> Run-TryBot: Zvonimir Pavlinovic <zpavlinovic@google.com> Reviewed-by: Jonathan Amsterdam <jba@google.com>

This CL does not add any new code. It simply - renames files and moves code accordingly - makes private those symbols that do not need to be public anymore For golang/go#56042 Change-Id: I827a84540f0c7200f4d68bf59ce1f6a59a52877f Reviewed-on: https://go-review.googlesource.com/c/vuln/+/448775 Run-TryBot: Zvonimir Pavlinovic <zpavlinovic@google.com> Reviewed-by: Jonathan Amsterdam <jba@google.com> TryBot-Result: Gopher Robot <gobot@golang.org>