hack: add script to sync common dependiences with core to the version core uses

[roobre]

Description

Dependencies getting out of sync can be problematic given that xk6-disruptor is typically built together with k6 core. We've always anticipated goja to be a potential dependency to watch for, but as #330 proves, others may also cause problems as well.

This PR adds a (go) script that looks for overlapping dependencies with k6 core which do not match the version used in core. Those dependencies are logged to stderr, and go get commands are generated to stdout to download the version k6 core is using.

That way, by running go run ./hack/depsync > /dev/null, one can easily get a list of unsynced dependencies. By running go run ./hack/depsync | bash, dependencies are synced to core.

Checklist:

• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have added tests that prove my fix is effective or that my feature works.
• I have run linter locally (make lint) and all checks pass.
• I have run tests locally (make test) and all tests pass.
• I have run relevant e2e test locally (make e2e-xxx for agent, disruptors, kubernetes or cluster related changes)
• Any dependent changes have been merged and published in downstream modules
  

[roobre]

Running this right now breaks builds as the cobra downgrade removes a method we currently use.

As a workaround, go run ./hack/depsync | grep -ve cobra | bash should work fine.

[pablochacin]

Running this right now breaks builds as the cobra downgrade removes a method we currently use

@roobre Could you please elaborate on which cobra downgrade you refer to?

[roobre]

@pablochacin Sure. k6 core is using cobra v1.4.0:

13:08:00 ~/Devel/xk6-disruptor $> go run ./hack/depsync > /dev/null
2023/09/12 13:08:11 detected k6 core version v0.46.0
2023/09/12 13:08:11 Mismatched versions for github.com/spf13/cobra:
Ours:v1.5.0
Core:v1.4.0

If I attempt to build with cobra v1.4.0, I get the following error:

13:09:16 ~/Devel/xk6-disruptor $> make
go test -race  ./...
# github.com/grafana/xk6-disruptor/cmd/agent/commands
cmd/agent/commands/root.go:41:8: c.cmd.SetContext undefined (type *cobra.Command has no field or method SetContext)

This makes sense as adding Command.SetContext is mentioned in the v1.5.0 changelog: https://github.com/spf13/cobra/releases/tag/v1.5.0

This is currently being used only in one place:

xk6-disruptor/cmd/agent/commands/root.go

Lines 41 to 44 in 905c1cf

	c.cmd.SetContext(ctx)
	return c.cmd.Execute()
	}

From what I can see from the cobra code/docs, it should be fairly easy to change those lines to:

return c.cmd.ExecuteContext(ctx)

Which should work in v1.4.0

[pablochacin]

Thanks for the explanation. I suggest opening a followup PR for using ExecuteContext instead of SetContext in our code to maintain compatibility with k6 without any workaround.

[pablochacin]

LGTM. Great work.