Upgrade CI, add reset metrics for prom (#1)

Author: vearutop

.github/workflows/golangci-lint.yml

@@ -5,6 +5,7 @@ on:
       - v*
     branches:
       - master
+      - main
   pull_request:
 jobs:
   golangci:
@@ -13,10 +14,10 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v0.2.0
+        uses: golangci/golangci-lint-action@v2.3.0
         with:
           # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
-          version: v1.27
+          version: v1.32.2
 
           # Optional: golangci-lint command line arguments.
           # args: ./the-only-dir-to-analyze/...
@@ -25,4 +26,4 @@ jobs:
           # The secret `GITHUB_TOKEN` is automatically created by GitHub,
           # no need to create it manually.
           # https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#about-the-github_token-secret
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -5,14 +5,15 @@ on:
       - v*
     branches:
       - master
+      - main
   pull_request:
 env:
   GO111MODULE: "on"
 jobs:
   test:
     strategy:
       matrix:
-        go-version: [1.11.x, 1.12.x, 1.13.x, 1.14.x]
+        go-version: [1.11.x, 1.12.x, 1.13.x, 1.14.x, 1.15.x]
     runs-on: ubuntu-latest
     steps:
       - name: Install Go
@@ -30,7 +31,10 @@ jobs:
       - name: Populate dependencies
         run: '(test -d vendor && echo vendor found) || go mod vendor'
       - name: Test
-        run: go test -mod=vendor -v -cover -race -coverprofile=coverage.txt -covermode=atomic ./...
+        run: make test-unit
       - name: Upload code coverage
-        if: matrix.go-version == '1.14.x'
-        uses: codecov/codecov-action@v1
+        if: matrix.go-version == '1.15.x'
+        uses: codecov/codecov-action@v1
+        with:
+          file: ./unit.coverprofile
+          flags: unittests

.gitignore

@@ -1,2 +1,3 @@
 /.idea
-/bench-*
+/bench-*
+/unit.coverprofile

.golangci.yml

@@ -1,12 +1,39 @@
-GOLANGCI_LINT_VERSION := "v1.30.0"
+GOLANGCI_LINT_VERSION := "v1.32.2"
+
+# The head of Makefile determines location of dev-go to include standard targets.
 GO ?= go
-# detecting GOPATH and removing trailing "/" if any
-GOPATH = $(realpath $(shell go env GOPATH))
 export GO111MODULE = on
 
-lint:
-	@test -s $(GOPATH)/bin/golangci-lint-$(GOLANGCI_LINT_VERSION) || (curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b /tmp $(GOLANGCI_LINT_VERSION) && mv /tmp/golangci-lint $(GOPATH)/bin/golangci-lint-$(GOLANGCI_LINT_VERSION))
-	@$(GOPATH)/bin/golangci-lint-$(GOLANGCI_LINT_VERSION) run ./... --fix
+ifneq "$(GOFLAGS)" ""
+  $(info GOFLAGS: ${GOFLAGS})
+endif
+
+ifneq "$(wildcard ./vendor )" ""
+  $(info Using vendor)
+  modVendor =  -mod=vendor
+  ifeq (,$(findstring -mod,$(GOFLAGS)))
+      export GOFLAGS := ${GOFLAGS} ${modVendor}
+  endif
+  ifneq "$(wildcard ./vendor/github.com/bool64/dev)" ""
+  	DEVGO_PATH := ./vendor/github.com/bool64/dev
+  endif
+endif
+
+ifeq ($(DEVGO_PATH),)
+	DEVGO_PATH := $(shell GO111MODULE=on $(GO) list ${modVendor} -f '{{.Dir}}' -m github.com/bool64/dev)
+	ifeq ($(DEVGO_PATH),)
+    	$(info Module github.com/bool64/dev not found, downloading.)
+    	DEVGO_PATH := $(shell export GO111MODULE=on && $(GO) mod tidy && $(GO) list -f '{{.Dir}}' -m github.com/bool64/dev)
+	endif
+endif
+
+-include $(DEVGO_PATH)/makefiles/main.mk
+-include $(DEVGO_PATH)/makefiles/test-unit.mk
+-include $(DEVGO_PATH)/makefiles/lint.mk
+-include $(DEVGO_PATH)/makefiles/github-actions.mk
+
+## Run tests
+test: test-unit
 
 bench:
 	@$(GO) test -bench=. -count=10 -run=^a  ./... | tee /dev/tty >bench-$(shell git symbolic-ref HEAD --short | tr / - 2>/dev/null).txt

Makefile

@@ -5,6 +5,7 @@ This library provides context-driven stats tracker.
 [![Build Status](https://github.com/bool64/stats/workflows/test/badge.svg)](https://github.com/bool64/stats/actions?query=branch%3Amaster+workflow%3Atest)
 [![Coverage Status](https://codecov.io/gh/bool64/stats/branch/master/graph/badge.svg)](https://codecov.io/gh/bool64/stats)
 [![GoDevDoc](https://img.shields.io/badge/dev-doc-00ADD8?logo=go)](https://pkg.go.dev/github.com/bool64/stats)
+[![time tracker](https://wakatime.com/badge/github/bool64/stats.svg)](https://wakatime.com/badge/github/bool64/stats)
 ![Code lines](https://sloc.xyz/github/bool64/stats/?category=code)
 ![Comments](https://sloc.xyz/github/bool64/stats/?category=comments)
 

README.md

@@ -0,0 +1,3 @@
+package stats_test
+
+import _ "github.com/bool64/dev"

dev_test.go

@@ -3,6 +3,7 @@ module github.com/bool64/stats
 go 1.13
 
 require (
+	github.com/bool64/dev v0.1.7
 	github.com/kr/pretty v0.2.0 // indirect
 	github.com/prometheus/client_golang v1.7.1
 	github.com/stretchr/testify v1.5.1

go.mod

@@ -6,6 +6,8 @@ github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24
 github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8=
 github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
 github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
+github.com/bool64/dev v0.1.7 h1:1xs4ff6lUFIt7euQCmfjU0Xi7IiSmwcQyMokKdq6qAM=
+github.com/bool64/dev v0.1.7/go.mod h1:pn52JC52uSgpazChx9CeXyG+S3sW2V36HHoLNBbscdg=
 github.com/cespare/xxhash/v2 v2.1.1 h1:6MnRN8NT7+YBpUIWxHtefFZOKTAPgGjpQSxqLNn0+qY=
 github.com/cespare/xxhash/v2 v2.1.1/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=

go.sum

@@ -49,6 +49,7 @@ func NewStatsTracker(registry *prometheus.Registry) (*Tracker, error) {
 type Tracker struct {
 	mu         sync.Mutex
 	collectors map[identity]func(map[string]string, float64)
+	registered []prometheus.Collector
 	histograms map[string]prometheus.HistogramOpts
 	summaries  map[string]prometheus.SummaryOpts
 	counters   map[string]prometheus.CounterOpts
@@ -75,6 +76,22 @@ func (t *Tracker) Set(ctx context.Context, name string, absolute float64, labels
 	t.collect(ctx, true, name, absolute, labelsAndValues)
 }
 
+// Reset unregisters and removes all registered collectors.
+func (t *Tracker) Reset() {
+	t.mu.Lock()
+	defer t.mu.Unlock()
+
+	for k := range t.collectors {
+		delete(t.collectors, k)
+	}
+
+	for _, c := range t.registered {
+		t.Registry.Unregister(c)
+	}
+
+	t.registered = t.registered[:0]
+}
+
 // DeclareHistogram registers histogram metric for given name.
 func (t *Tracker) DeclareHistogram(name string, opts prometheus.HistogramOpts) {
 	t.mu.Lock()
@@ -211,6 +228,7 @@ func (t *Tracker) collect(ctx context.Context, isGauge bool, name string, value
 	collect(lb.values, value)
 }
 
+// nolint: dupl // Code uses unique symbols.
 func (t *Tracker) summary(
 	ctx context.Context,
 	canonicalID identity,
@@ -232,13 +250,16 @@ func (t *Tracker) summary(
 		t.ErrLogger(ctx, err, labels)
 	}
 
+	t.registered = append(t.registered, summary)
+
 	*collect = func(labelValues map[string]string, value float64) {
 		summary.With(labelValues).Observe(value)
 	}
 
 	return true
 }
 
+// nolint: dupl // Code uses unique symbols.
 func (t *Tracker) histogram(
 	ctx context.Context,
 	canonicalID identity,
@@ -260,13 +281,16 @@ func (t *Tracker) histogram(
 		t.ErrLogger(ctx, err, labels)
 	}
 
+	t.registered = append(t.registered, histogram)
+
 	*collect = func(labelValues map[string]string, value float64) {
 		histogram.With(labelValues).Observe(value)
 	}
 
 	return true
 }
 
+// nolint: dupl // Code uses unique symbols.
 func (t *Tracker) counter(
 	ctx context.Context,
 	canonicalID identity,
@@ -285,13 +309,16 @@ func (t *Tracker) counter(
 		t.ErrLogger(ctx, err, labels)
 	}
 
+	t.registered = append(t.registered, counter)
+
 	*collect = func(labelValues map[string]string, value float64) {
 		counter.With(labelValues).Add(value)
 	}
 
 	return true
 }
 
+// nolint: dupl // Code uses unique symbols.
 func (t *Tracker) gauge(
 	ctx context.Context,
 	canonicalID identity,
@@ -310,6 +337,8 @@ func (t *Tracker) gauge(
 		t.ErrLogger(ctx, err, labels)
 	}
 
+	t.registered = append(t.registered, gauge)
+
 	*collect = func(labelValues map[string]string, value float64) {
 		gauge.With(labelValues).Set(value)
 	}

prom/tracker.go

@@ -100,4 +100,10 @@ func TestTracker(t *testing.T) {
 
 	err = testutil.GatherAndCompare(registry, bytes.NewBufferString(expected))
 	assert.NoError(t, err)
+
+	// No metrics after reset.
+	tr.Reset()
+
+	err = testutil.GatherAndCompare(registry, bytes.NewBufferString(""))
+	assert.NoError(t, err)
 }