How do I debug gauge with debugger #1936

jtong · 2021-03-16T07:20:43Z

jtong
Mar 16, 2021

I am trying make the old plugin gauge-rust works because our project coco write with rust and I want to add some living document for it and more than that.

I forked the gauge-rust repo and change some code to make it running now. It can be compiled successfully and install as a plugin. But I am stuck on the step gauge core connecting to plugin's grpc server.

I got logs like these:

Plugin rust is already installed.
Parsing started.
Started concepts parsing.
0 concepts parsing completed.
Started specifications parsing.
1 specifications parsing completed.
Parsing completed.
Checking updates...
Downloading https://downloads.gauge.org/plugin/html-report?l=rust&p=html-report,js,python,rust,screenshot&o=darwin&a=amd64
Downloading https://downloads.gauge.org/plugin/js?l=rust&p=html-report,js,python,rust,screenshot&o=darwin&a=amd64
Downloading https://downloads.gauge.org/plugin/python?l=rust&p=html-report,js,python,rust,screenshot&o=darwin&a=amd64
Downloading https://downloads.gauge.org/plugin/rust?l=rust&p=html-report,js,python,rust,screenshot&o=darwin&a=amd64
Failed to download rust-install.json file: Error downloading file: https://downloads.gauge.org/plugin/rust?l=rust&p=html-report,js,python,rust,screenshot&o=darwin&a=amd64.
404 Not Found
Downloading https://downloads.gauge.org/plugin/screenshot?l=rust&p=html-report,js,python,rust,screenshot&o=darwin&a=amd64
Error ----------------------------------

[Gauge]
Failed to start gauge API: Timed out connecting to rust

Get Support ----------------------------
        Docs:          https://docs.gauge.org
        Bugs:          https://github.com/getgauge/gauge/issues
        Chat:          https://github.com/getgauge/gauge/discussions

Your Environment Information -----------
        darwin, 1.1.7
        html-report (4.0.12), js (2.3.15), python (0.3.14), rust (0.0.1), screenshot (0.0.1)

I want to get more information to find a way to make my application work, so could anyone tell me how to debug gauge's golang code?

zabil · 2021-03-16T11:35:59Z

zabil
Mar 16, 2021
Maintainer

You can set the debug level using the --log-level flag to get more info for example.

gauge run spec --log-level debug

From what I know, The rust plugin was not ported to use grpc yet. So it is quite out of date.

0 replies

sriv · 2021-03-24T03:34:55Z

sriv
Mar 24, 2021
Maintainer

hi @jtong - I tried your repo, and was able to install the plugin.

I get a different error when I run a sample project:

/tmp/foo$ gauge validate
Scanning: "/tmp/foo/tests"
Error ----------------------------------

[Gauge]
Error: runtime error: invalid memory address or nil pointer dereference
goroutine 1 [running]:
runtime/debug.Stack(0xc0001ef588, 0xb68260, 0x128ead0)
	/opt/hostedtoolcache/go/1.13.15/x64/src/runtime/debug/stack.go:24 +0x9d
main.recoverPanic()
	/home/runner/work/gauge/gauge/gauge.go:27 +0x57
panic(0xb68260, 0x128ead0)
	/opt/hostedtoolcache/go/1.13.15/x64/src/runtime/panic.go:679 +0x1b2
github.com/getgauge/gauge/runner.(*GrpcRunner).ExecuteMessageWithTimeout(0x0, 0xc00038e000, 0x7fa27073a800, 0xc00036c0c0, 0x0)
	/home/runner/work/gauge/gauge/runner/grpcRunner.go:195 +0x22
github.com/getgauge/gauge/validation.(*SpecValidator).validateStep(0xc00036c000, 0xc00026a300, 0xc000244600, 0x22)
	/home/runner/work/gauge/gauge/validation/validate.go:345 +0x1a4
github.com/getgauge/gauge/validation.(*SpecValidator).Step(0xc00036c000, 0xc00026a300)
	/home/runner/work/gauge/gauge/validation/validate.go:313 +0x5f1
github.com/getgauge/gauge/gauge.(*Specification).Traverse(0xc0002de000, 0xd881a0, 0xc00036c000, 0xc0001efa60)
	/home/runner/work/gauge/gauge/gauge/specification.go:261 +0x256
github.com/getgauge/gauge/validation.(*SpecValidator).validate(0xc00036c000, 0xc00036c000, 0x13, 0x0)
	/home/runner/work/gauge/gauge/validation/validate.go:298 +0x8d
github.com/getgauge/gauge/validation.(*validator).Validate(0xc0001efc08, 0xd87780)
	/home/runner/work/gauge/gauge/validation/validate.go:284 +0x115
github.com/getgauge/gauge/validation.ValidateSpecs(0xc000248350, 0x1, 0x1, 0x0, 0xc000248340)
	/home/runner/work/gauge/gauge/validation/validate.go:174 +0x227
github.com/getgauge/gauge/validation.Validate(0x12c6be8, 0x1, 0x1)
	/home/runner/work/gauge/gauge/validation/validate.go:112 +0x7d
github.com/getgauge/gauge/cmd.glob..func18(0x129cb80, 0x12c6be8, 0x0, 0x0)
	/home/runner/work/gauge/gauge/cmd/validate.go:33 +0xa3
github.com/spf13/cobra.(*Command).execute(0x129cb80, 0x12c6be8, 0x0, 0x0, 0x129cb80, 0x12c6be8)
	/home/runner/go/pkg/mod/github.com/spf13/cobra@v1.1.1/command.go:854 +0x2aa
github.com/spf13/cobra.(*Command).ExecuteC(0x129d0c0, 0x42cb3a, 0x1, 0x129ce20)
	/home/runner/go/pkg/mod/github.com/spf13/cobra@v1.1.1/command.go:958 +0x349
github.com/spf13/cobra.(*Command).Execute(...)
	/home/runner/go/pkg/mod/github.com/spf13/cobra@v1.1.1/command.go:895
github.com/getgauge/gauge/cmd.Parse(0xc0001eff18, 0xc000064750)
	/home/runner/work/gauge/gauge/cmd/cmd.go:112 +0x3d
main.main()
	/home/runner/work/gauge/gauge/gauge.go:19 +0x4c

Get Support ----------------------------
	Docs:          https://docs.gauge.org
	Bugs:          https://github.com/getgauge/gauge/issues
	Chat:          https://github.com/getgauge/gauge/discussions

Your Environment Information -----------
	linux, 1.1.7, 5d86b72
	html-report (4.0.12), js (2.3.15), python (0.3.14), rust (0.0.1), screenshot (0.0.1)

I need to investigate further.

To answer your question around debugging:

since gauge and plugins are separate processes, it can be a bit tricky to attach a debugger.
once the basic bootstrap is in place, you'd find it much easier to debug. Some tips:
- gauge -v should list rust as an installed plugin
- cat ~/.gauge/plugins/rust/0.0.1/rust.json should reflect the content of rust.json in the repo
- in rust.json there are commands for run and init. make sure that the run command works.
- the way gauge-rust is currently implemented, it expects rust.json to be relative to the working directory. So you need to cd ~/.gauge/plugins/rust/0.0.1/ and invoke GAUGE_PROJECT_ROOT=<test project path> ./bin/gauge_rs --run. This should invoke the rust plugin standalone and do the bootstrapping. Ideally at this point you should have the grpc server running and listening on a port message.
- note that the plugin is the grpc server, and must broadcast the port it is listening on on stdout. gauge will parse the port from the stdout and make a http2 connection to exchange grpc messages.
- at this point you have gauge and gauge_rs bootstrapped, ready to exchange messages.
- If you need to debug this further, you can set GRPC_TRACE=all or GRPC_VERBOSITY=DEBUG to see the gRPC messages exchanged between gauge and plugin.

Hope this gives you a start. Please feel free to send more questions!

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

How do I debug gauge with debugger #1936

Uh oh!

{{title}}

Uh oh!

Replies: 2 comments

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

How do I debug gauge with debugger #1936

Uh oh!

jtong Mar 16, 2021

Replies: 2 comments

Uh oh!

zabil Mar 16, 2021 Maintainer

Uh oh!

sriv Mar 24, 2021 Maintainer

jtong
Mar 16, 2021

zabil
Mar 16, 2021
Maintainer

sriv
Mar 24, 2021
Maintainer