Forem: Tymoteusz Blazejczyk

Go Error

Tymoteusz Blazejczyk — Tue, 20 Oct 2020 18:48:54 +0000

Tired of using boring #Go errors.New?

Try the latest Go Error package today. It implements replacement fields surrounded by curly braces {} format strings similar to Python string format.

Features:

Implements replacement fields surrounded by curly braces {} format strings
Format string by providing arguments without using placeholders or format verbs %
Format string using automatic placeholder {p}
Format string using positional placeholders {pN}
Format string using named placeholders {name}
Format string using object placeholders {.Field}, {p.Field} and {pN.Field} where Field is an exported struct field or method
Set custom format error message string. Default is {.BaseFile}:{.Line}:{.BaseFunction}(): {.Message}
Error message contains file path, line number, function name from where was called
Compatible with the standard errors package with As, Is and Unwrap functions
It uses the Go Formatter library

Go Formatter

Tymoteusz Blazejczyk — Tue, 20 Oct 2020 10:53:14 +0000

Tired of using boring #Go fmt package?

Try the latest Go Formatter package today. It implements replacement fields surrounded by curly braces {} format strings similar to Python string format.

Features:

Implements replacement fields surrounded by curly braces {} format strings
Format string by providing arguments without using placeholders or format verbs %
Format string using automatic placeholder {p}
Format string using positional placeholders {pN}
Format string using named placeholders {name}
Format string using object placeholders {.Field}, {p.Field} and {pN.Field} where Field is an exported struct field or method
Use custom placeholder string. Default is p
Use custom replacement delimiters. Default are { and }
Use custom replacement functions with transformation using pipeline |
Under the hood it uses the standard text/template package

Feedback about the go-mock script that create mocks for all automatically and recursively detected Go interfaces

Tymoteusz Blazejczyk — Sat, 23 May 2020 11:13:44 +0000

Recently I have working on a project that allow to work on Go projects out-of-box using a Docker image.

It contains preinstalled tools for developing, mocking, formatting, linting, building, testing and documenting Go projects.

For mocking Go interfaces, I'm using the standard and classic mockgen tool in reflect mode. One of annoying thing about that tool is command line invocations.

I have scripted that to automatically and recursively detect all Go interfaces. It excludes _test.go files, mocks directories and the package main.

Go module detection is based on the go env GOMOD command invocation. All mocks are generated under the mocks directory for given Go package.

For me it works well. But I may have miss something. And because of that, I want to ask you for a small feedback. In advance, I appreciate it for any comments :)

The go-mock script that covers this topic: https://gitlab.com/tymonx/docker-go/-/blob/master/scripts/go-mock

Project site: https://gitlab.com/tymonx/docker-go

I also hope, that it may be useful for someone ;)

A Docker image with preinstalled tools for developing, formatting, linting, building, testing and documenting Go projects

Tymoteusz Blazejczyk — Thu, 21 May 2020 09:44:48 +0000

Docker Go

A Docker image with preinstalled tools for developing, formatting, linting,
building, testing and documenting Go projects.

Project site: https://gitlab.com/tymonx/docker-go

For GitLab CI: https://gitlab.com/tymonx/gitlab-ci

Features

Pre-installed required tools for developing, formatting, linting, building, testing and documenting Go projects
Pre-installed the mockgen tool for generating mocks for testing
Formatting and validating Go source files imports with the goimports tool
Formatting and validating Go source files format with the gofmt tool
Validating Go source files errors with the errcheck tool
Linting Go source files with the revive, the golangci-lint and the golint tools
Building Go source files
Testing Go project
Generating Go coverage result, text and HTML reports
Generating JUnit test XML report for GitLab Merge Requests
Generating Cobertura coverage XML report for GitLab Merge Requests
Validating Go coverage value threshold with colorization
Colorizing Go imports and format validation with the colordiff tool
Colorizing Go tests with the richgo tool
Colorizing Go coverage results and format nicely with the column tool
Generating static HTML coverage report with the go tool cover tool

Usage

Download the docker-run.sh helper script:

wget -O docker-run.sh https://gitlab.com/tymonx/docker-go/-/raw/master/docker-run.sh

Make it executable:

chmod a+x ./docker-run.sh

Run the docker-run.sh script without any arguments to work in Docker container:

./docker-run.sh

Or pass arguments to the docker-run.sh script to execute commands inside Docker container:

./docker-run.sh go build ./...

Use the go-format command to automatically reformat Go source files:

./docker-run.sh go-format

Use the go-lint command to run various Go linters on Go source files with enabled colorization:

./docker-run.sh go-lint

Use the go-build command to build Go source files. Equivalent to the go build ./... execution:

./docker-run.sh go-build

Use the go-test command to run tests and validate coverage result with enabled colorization:

./docker-run.sh go-test

All commands accept standard Go paths as additional arguments like ./, ./..., <package-name> and so on.

Handy Gitlab CI YAML job templates for Go projects

Tymoteusz Blazejczyk — Thu, 14 May 2020 08:50:56 +0000

Various useful and handy GitLab CI YAML templates for typical GitLab CI tasks.

Project site: https://gitlab.com/tymonx/gitlab-ci

General Features

Supporting validating, building, testing and auto-documenting projects out-of-box
Automating various and mostly typical GitLab CI tasks
Extending GitLab CI like with parallel download with caching support
Easy to use with the GitLab CI include keyword in your .gitlab-ci.yml files

Go Features

Automatically installing required Go tools for validating, testing and documenting project
Validating Go source files imports with the goimports tool
Validating Go source files errors with the errcheck tool
Validating Go source files format with the gofmt tool
Linting Go source files with the revive, the golangci-lint and the golint tools
Building Go source files
Testing Go project
Generating Go coverage result, text and HTML reports
Generating JUnit test XML report for GitLab Merge Requests
Generating Cobertura coverage XML report for GitLab Merge Requests
Validating Go coverage value with customazible coverage threshold
Colorizing Go imports and format validation with the colordiff tool
Colorizing Go tests with the richgo tool
Colorizing Go coverage results and format nicely with the column tool
Generating static HTML source code documentation with the godoc tool
Generating static HTML coverage report with the go tool cover tool
Uploading static HTML source code documentation and coverage report to GitLab Pages for browsing