Skip to content

Latest commit

 

History

History
51 lines (39 loc) · 2.23 KB

README.md

File metadata and controls

51 lines (39 loc) · 2.23 KB
Raw

Integration Tests

Goal

Integration tests are meant to test some custom configurations we are adding to Prometheus with the Configurator. For instance the k8s target_discovery. As an example we want to test if the relabel configs we are adding to drop some targets based on the label names in combination with annotations are behaving as expected. But we don't want to test if basic_auth feature is working.

Run

Make sure you have these tools or install them:

To start your local minikube cluster (if you have not started it yet), run:

make start-local-cluster

Once you have minikube started run the integration tests with:

make integration-test

Components

Integrations are based on the local execution of a Prometheus server, remote-write receiver(RWR) and local exporters. Prometheus binary is fetched/checked from the official repo by the TestMain function before executing tests. K8s tests use a real cluster (local minikube by default) to create objects to be discovered. A .kubeconfig-dev is required at project root for the tests/Prometheus to connect to the cluster(created by the make target).

All tests are meant to be run in parallel because:

  • Each test executes a RWR on a random free port.
  • We use a random port for Prometheus API
  • We use kubernetes_sd_configs namespace filtering, to isolate test objects.

New assertions can be implemented in the asserter which has access to the local remote write receiver and also can make use of the Prometheus API to check for other things like status, targets, etc.

flowchart LR
    subgraph host
        Asserter-->|Asserts on Stored metrics|RemoteWriteReceiver
        Asserter-->|Asserts on Prom API|Prometheus
        Prometheus-->|send metrics|RemoteWriteReceiver
        Prometheus-->|scrape metrics\n intercepted by proxy|TestObjectEndpoint
    end

    subgraph k8sCluster
        subgraph testNamespace
            TestObject
        end

    end

    Prometheus-->|Discovery \n filtered by 'testNamespace'|k8sCluster

    TestObjectEndpoint-. metrics of TestObject are\n exposed by TestObjectEndpoint  .-TestObject
Loading