refac: generate Go code to render themes

Question

refac: generate Go code to render themes

matm opened this issue 2 years ago · 23 comments

Generating the code for methods Beautifier.Template() and Beautifier.Data() will ease theme management. This way Beautifer.Assets() can be used to simply define the required assets to build a theme.

Remove implementions of Beautifier.Template() and Beautifier.Data() for the golang (default) theme
Write a Go generator in pkg/themes/generator.go that will generate a default_gen.go file implementing those two methods with proper content taken from Assets()
Update the build system to go generate before building

Answer 1 · 2023-03-08T08:59:16.000Z

Generating the code for methods Beautifier.Template() and Beautifier.Data() will ease theme management. This way Beautifer.Assets() can be used to simply define the required assets to build a theme.

Remove implementions of Beautifier.Template() and Beautifier.Data() for the golang (default) theme

Write a Go generator in pkg/themes/generator.go that will generate a default_gen.go file implementing those two methods with proper content taken from Assets()

Update the build system to go generate before building

Hi @matm I don't see generator.go file in pkg/themes/ and we are getting this error
/../github.com/matm/gocov-html/pkg/themes/theme.go:9:14: cannot use defaultTheme{} (type defaultTheme) as type types.Beautifier in slice literal:
defaultTheme does not implement types.Beautifier (missing Data method)

github.com/matm/gocov-html/pkg/themes/theme.go:13:5: cannot use defaultTheme{} (type defaultTheme) as type types.Beautifier in assignment:
defaultTheme does not implement types.Beautifier (missing Data method)

Answer 2 · 2023-03-08T09:30:45.000Z

Hi @MdSahilGrab, the generator code has been moved to cmd/generator on master. How do you get this error? How do you build it?

Answer 3 · 2023-03-08T09:32:58.000Z

Actually we have this command in Dockerfile RUN go get github.com/matm/gocov-html/cmd/gocov-html which we are running when building the code.

Answer 4 · 2023-03-08T09:34:49.000Z

@matm so you want to us to use RUN go get github.com/matm/gocov-html/cmd/generator

Answer 5 · 2023-03-08T09:35:25.000Z

Okay, can you try with the latest stable release instead? Something like

RUN go install github.com/matm/gocov-html/cmd/gocov-html@latest

Answer 6 · 2023-03-08T09:36:32.000Z

Yes we tried but this is also not working

Answer 7 · 2023-03-08T09:37:12.000Z

@matm so you want to us to use RUN go get github.com/matm/gocov-html/cmd/generator

Maybe this can help: https://github.com/matm/gocov-html/blob/master/build.mk#L73

Answer 8 · 2023-03-08T09:39:17.000Z

Yes we tried but this is also not working

What if you do

RUN go install github.com/matm/gocov-html/cmd/gocov-html@v1.2.0

Answer 9 · 2023-03-08T09:40:11.000Z

Let me check

Answer 10 · 2023-03-08T09:41:47.000Z

@matm so you want to us to use RUN go get github.com/matm/gocov-html/cmd/generator

Maybe this can help: https://github.com/matm/gocov-html/blob/master/build.mk#L73

Yes we tried but this is also not working

What if you do
RUN go install github.com/matm/gocov-html/cmd/gocov-html@v1.2.0

When we tried this command RUN go install github.com/matm/gocov-html/cmd/gocov-html@latest, we actually got this error.
go: modules disabled by GO111MODULE=off; see 'go help modules'
The command '/bin/sh -c go install github.com/matm/gocov-html/cmd/gocov-html@latest' returned a non-zero code: 1

Answer 11 · 2023-03-08T09:43:03.000Z

Maybe this can help: https://github.com/matm/gocov-html/blob/master/build.mk#L73,
How exactly can i use this in dokerfile

Answer 12 · 2023-03-08T09:51:52.000Z

Can you paste a working sample of your Dockerfile here? I need more context, thank you.

Answer 13 · 2023-03-08T10:06:33.000Z

@matm yeah this is the Dockerfile we have now which was running successfully till yesterday
RUN ./coverage.sh
RUN go get github.com/jstemmer/go-junit-report
RUN go get github.com/axw/gocov/gocov
RUN go get github.com/AlekSi/gocov-xml
RUN go get github.com/matm/gocov-html/cmd/gocov-html
RUN go test -v -coverprofile=coverage.txt -covermode count ./... 2>&1 | go-junit-report > report.xml
RUN mkdir $GOPATH/coverage
RUN mkdir $GOPATH/lint
RUN gocov convert coverage.txt > coverage.json
RUN gocov-xml < coverage.json > $GOPATH/coverage/coverage.xml
RUN gocov-html < coverage.json > $GOPATH/coverage/index.html
RUN cp report.xml $GOPATH/coverage/report.xml
RUN cp lint_report.xml $GOPATH/lint/lint_report.xml

Answer 14 · 2023-03-08T11:16:55.000Z

Which Go compiler version is used by this image?

Answer 15 · 2023-03-08T11:18:02.000Z

its golang:1.16-alpine3.14

Answer 16 · 2023-03-08T11:24:22.000Z

This works:

FROM golang:1.16-alpine3.14
RUN go get github.com/axw/gocov/gocov
RUN go get github.com/matm/gocov-html/cmd/gocov-html

Then

$ docker build -t tool .
$ docker run --rm -ti tool gocov-html -h
Usage of gocov-html:
  -d    output CSS of default theme
  -lt
        list available themes
  -s string
        path to custom CSS file
  -t string
        theme to use for rendering (default "golang")
  -v    show program version

Answer 17 · 2023-03-08T12:11:34.000Z

@matm This is what we have in dockerfile but still its failing from yesterday
FROM golang:1.16-alpine3.14 RUN go get github.com/axw/gocov/gocov RUN go get github.com/matm/gocov-html/cmd/gocov-html

Answer 18 · 2023-03-08T12:29:18.000Z

Can you try my Dockerfile above and assert if it works? If it does work, the problem is elsewhere.

Answer 19 · 2023-03-08T12:34:29.000Z

Fetching the latest stable release v1.2.0 works too:

FROM golang:1.16-alpine3.14
RUN go get github.com/axw/gocov/gocov
RUN go install github.com/matm/gocov-html/cmd/gocov-html@v1.2.0

No error, gocov-html works.

Answer 20 · 2023-03-08T12:42:00.000Z

Not sure why its failing, will check internally

Answer 21 · 2023-03-09T17:43:21.000Z

@matm What is the reason not to store generated code in git?

Answer 22 · 2023-03-09T18:53:45.000Z

@obalunenko Actually, I was thinking about it today. Also this would prevent increasing the major version number and keeping the go install working.

Answer 23 · 2023-03-09T21:19:50.000Z

v1.3.1 just released and fixes this annoying issue. go install works as usual now.
Thanks for your feedback guys.