client_golang/prometheus/push/push_test.go

// Copyright 2016 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package push

import (
	"bytes"
	"errors"
	"io"
	"net/http"
	"net/http/httptest"
	"testing"

	"github.com/prometheus/common/expfmt"

	"github.com/prometheus/client_golang/prometheus"
)

func TestPush(t *testing.T) {
	var (
		lastMethod string
		lastBody   []byte
		lastPath   string
		lastHeader http.Header
	)

	// Fake a Pushgateway that responds with 202 to DELETE and with 200 in
	// all other cases.
	pgwOK := httptest.NewServer(
		http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
			lastMethod = r.Method
			lastHeader = r.Header
			var err error
			lastBody, err = io.ReadAll(r.Body)
			if err != nil {
				t.Fatal(err)
			}
			lastPath = r.URL.EscapedPath()
			w.Header().Set("Content-Type", `text/plain; charset=utf-8`)
			if r.Method == http.MethodDelete {
				w.WriteHeader(http.StatusAccepted)
				return
			}
			w.WriteHeader(http.StatusOK)
		}),
	)
	defer pgwOK.Close()

	// Fake a Pushgateway that always responds with 500.
	pgwErr := httptest.NewServer(
		http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
			http.Error(w, "fake error", http.StatusInternalServerError)
		}),
	)
	defer pgwErr.Close()

	metric1 := prometheus.NewCounter(prometheus.CounterOpts{
		Name: "testname1",
		Help: "testhelp1",
	})
	metric2 := prometheus.NewGauge(prometheus.GaugeOpts{
		Name:        "testname2",
		Help:        "testhelp2",
		ConstLabels: prometheus.Labels{"foo": "bar", "dings": "bums"},
	})

	reg := prometheus.NewRegistry()
	reg.MustRegister(metric1)
	reg.MustRegister(metric2)

	mfs, err := reg.Gather()
	if err != nil {
		t.Fatal(err)
	}

	buf := &bytes.Buffer{}
	enc := expfmt.NewEncoder(buf, expfmt.NewFormat(expfmt.TypeProtoDelim))

	for _, mf := range mfs {
		if err := enc.Encode(mf); err != nil {
			t.Fatal(err)
		}
	}
	wantBody := buf.Bytes()

	// Push some Collectors, all good.
	if err := New(pgwOK.URL, "testjob").
		Collector(metric1).
		Collector(metric2).
		Push(); err != nil {
		t.Fatal(err)
	}
	if lastMethod != http.MethodPut {
		t.Errorf("got method %q for Push, want %q", lastMethod, http.MethodPut)
	}
	if !bytes.Equal(lastBody, wantBody) {
		t.Errorf("got body %v, want %v", lastBody, wantBody)
	}
	if lastPath != "/metrics/job/testjob" {
		t.Error("unexpected path:", lastPath)
	}

	// Add some Collectors, with nil grouping, all good.
	if err := New(pgwOK.URL, "testjob").
		Collector(metric1).
		Collector(metric2).
		Add(); err != nil {
		t.Fatal(err)
	}
	if lastMethod != http.MethodPost {
		t.Errorf("got method %q for Add, want %q", lastMethod, http.MethodPost)
	}
	if !bytes.Equal(lastBody, wantBody) {
		t.Errorf("got body %v, want %v", lastBody, wantBody)
	}
	if lastPath != "/metrics/job/testjob" {
		t.Error("unexpected path:", lastPath)
	}

	// Pushes that require base64 encoding.
	if err := New(pgwOK.URL, "test/job").
		Collector(metric1).
		Collector(metric2).
		Push(); err != nil {
		t.Fatal(err)
	}
	if lastMethod != http.MethodPut {
		t.Errorf("got method %q for Push, want %q", lastMethod, http.MethodPut)
	}
	if !bytes.Equal(lastBody, wantBody) {
		t.Errorf("got body %v, want %v", lastBody, wantBody)
	}
	if lastPath != "/metrics/job@base64/dGVzdC9qb2I" {
		t.Error("unexpected path:", lastPath)
	}
	if err := New(pgwOK.URL, "testjob").
		Grouping("foobar", "bu/ms").
		Collector(metric1).
		Collector(metric2).
		Push(); err != nil {
		t.Fatal(err)
	}
	if lastMethod != http.MethodPut {
		t.Errorf("got method %q for Push, want %q", lastMethod, http.MethodPut)
	}
	if !bytes.Equal(lastBody, wantBody) {
		t.Errorf("got body %v, want %v", lastBody, wantBody)
	}
	if lastPath != "/metrics/job/testjob/foobar@base64/YnUvbXM" {
		t.Error("unexpected path:", lastPath)
	}

	// Push that requires URL encoding.
	if err := New(pgwOK.URL, "testjob").
		Grouping("titan", "Προμηθεύς").
		Collector(metric1).
		Collector(metric2).
		Push(); err != nil {
		t.Fatal(err)
	}
	if lastMethod != http.MethodPut {
		t.Errorf("got method %q for Push, want %q", lastMethod, http.MethodPut)
	}
	if !bytes.Equal(lastBody, wantBody) {
		t.Errorf("got body %v, want %v", lastBody, wantBody)
	}
	if lastPath != "/metrics/job/testjob/titan/%CE%A0%CF%81%CE%BF%CE%BC%CE%B7%CE%B8%CE%B5%CF%8D%CF%82" {
		t.Error("unexpected path:", lastPath)
	}

	// Empty label value triggers special base64 encoding.
	if err := New(pgwOK.URL, "testjob").
		Grouping("empty", "").
		Collector(metric1).
		Collector(metric2).
		Push(); err != nil {
		t.Fatal(err)
	}
	if lastMethod != http.MethodPut {
		t.Errorf("got method %q for Push, want %q", lastMethod, http.MethodPut)
	}
	if !bytes.Equal(lastBody, wantBody) {
		t.Errorf("got body %v, want %v", lastBody, wantBody)
	}
	if lastPath != "/metrics/job/testjob/empty@base64/=" {
		t.Error("unexpected path:", lastPath)
	}

	// Empty job name results in error.
	if err := New(pgwErr.URL, "").
		Collector(metric1).
		Collector(metric2).
		Push(); err == nil {
		t.Error("push with empty job succeeded")
	} else {
		if want := errJobEmpty; !errors.Is(err, want) {
			t.Errorf("got error %q, want %q", err, want)
		}
	}

	// Push some Collectors with a broken PGW.
	if err := New(pgwErr.URL, "testjob").
		Collector(metric1).
		Collector(metric2).
		Push(); err == nil {
		t.Error("push to broken Pushgateway succeeded")
	} else {
		if got, want := err.Error(), "unexpected status code 500 while pushing to "+pgwErr.URL+"/metrics/job/testjob: fake error\n"; got != want {
			t.Errorf("got error %q, want %q", got, want)
		}
	}

	// Push some Collectors with invalid grouping or job.
	if err := New(pgwOK.URL, "testjob").
		Grouping("foo", "bums").
		Collector(metric1).
		Collector(metric2).
		Push(); err == nil {
		t.Error("push with grouping contained in metrics succeeded")
	}
	if err := New(pgwOK.URL, "testjob").
		Grouping("foo-bar", "bums").
		Collector(metric1).
		Collector(metric2).
		Push(); err == nil {
		t.Error("push with invalid grouping succeeded")
	}

	// Push registry, all good.
	if err := New(pgwOK.URL, "testjob").
		Gatherer(reg).
		Push(); err != nil {
		t.Fatal(err)
	}
	if lastMethod != http.MethodPut {
		t.Errorf("got method %q for Push, want %q", lastMethod, http.MethodPut)
	}
	if !bytes.Equal(lastBody, wantBody) {
		t.Errorf("got body %v, want %v", lastBody, wantBody)
	}

	// Add registry, all good.
	if err := New(pgwOK.URL, "testjob").
		Grouping("a", "x").
		Grouping("b", "y").
		Gatherer(reg).
		Add(); err != nil {
		t.Fatal(err)
	}
	if lastMethod != http.MethodPost {
		t.Errorf("got method %q for Add, want %q", lastMethod, http.MethodPost)
	}
	if !bytes.Equal(lastBody, wantBody) {
		t.Errorf("got body %v, want %v", lastBody, wantBody)
	}
	if lastPath != "/metrics/job/testjob/a/x/b/y" && lastPath != "/metrics/job/testjob/b/y/a/x" {
		t.Error("unexpected path:", lastPath)
	}

	// Delete, all good.
	if err := New(pgwOK.URL, "testjob").
		Grouping("a", "x").
		Grouping("b", "y").
		Delete(); err != nil {
		t.Fatal(err)
	}
	if lastMethod != http.MethodDelete {
		t.Errorf("got method %q for Delete, want %q", lastMethod, http.MethodDelete)
	}
	if len(lastBody) != 0 {
		t.Errorf("got body of length %d, want empty body", len(lastBody))
	}
	if lastPath != "/metrics/job/testjob/a/x/b/y" && lastPath != "/metrics/job/testjob/b/y/a/x" {
		t.Error("unexpected path:", lastPath)
	}

	// Push some Collectors with custom header, all good.
	header := make(http.Header)
	header.Set("Authorization", "Bearer Token")
	if err := New(pgwOK.URL, "testjob").
		Collector(metric1).
		Collector(metric2).
		Header(header).
		Push(); err != nil {
		t.Fatal(err)
	}
	if lastMethod != http.MethodPut {
		t.Errorf("got method %q for Add, want %q", lastMethod, http.MethodPut)
	}
	if !bytes.Equal(lastBody, wantBody) {
		t.Errorf("got body %v, want %v", lastBody, wantBody)
	}
	if lastPath != "/metrics/job/testjob" {
		t.Error("unexpected path:", lastPath)
	}
	if lastHeader == nil || lastHeader.Get("Authorization") == "" {
		t.Error("empty Authorization header")
	}
}