covalyzer-go

covalyzer-go is a tool for aggregating and analyzing code coverage reports in golang

Getting started

Example config.yaml

repositories:
- owner: nokamoto
  repo: covalyzer-go
  ginkgo_packages:
  - cmd/covalyzer-go-test
timestamps:
- "2024-02-01T00:00:00Z"
- "2024-03-01T00:00:00Z"

Aggregate and analyze code coverage report for the nokamoto/covalyer-go repository by running go run ./cmd/covlayzer-go.

It will output the following summaries:

• go tool cover
• ginkgo outline
• ginkgo run --json-report

For more details, see following proto files:

• config
• output

Design

flowchart LR
    subgraph covalyzer-go
        direction BT
        subgraph github
            gh[github.com/foo/bar]
            ghe[ghe.example.com/baz/qux]
        end

        subgraph local
            cmd[cmd/covalyzer-go]
            subgraph tools
                go
                ginkgo
            end

            direction TB
            cmd -- run --> tools
        end

        local -- clone --> github
    end
    config --> covalyzer-go --> output

Go packages layout

flowchart LR
    subgraph packages
        subgraph api
            v1[pkg/api/v1]
        end
        subgraph usecase
            app[internal/usecase]
        end
        subgraph infra
            cmd[internal/infra/command]
            cfg[internal/infra/config]
            writer[internal/infra/writer]
        end
        direction BT
        usecase --> api
        infra --> usecase
    end