prometheus-operator/pkg/prometheus/common_test.go

// Copyright 2023 The prometheus-operator 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 prometheus

import (
	"strings"
	"testing"

	"github.com/stretchr/testify/require"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/utils/ptr"

	monitoringv1 "github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1"
)

func TestStartupProbeTimeoutSeconds(t *testing.T) {
	tests := []struct {
		maximumStartupDurationSeconds   *int32
		expectedStartupPeriodSeconds    int32
		expectedStartupFailureThreshold int32
		expectedMaxStartupDuration      int32
	}{
		{
			maximumStartupDurationSeconds:   nil,
			expectedStartupPeriodSeconds:    15,
			expectedStartupFailureThreshold: 60,
			expectedMaxStartupDuration:      900,
		},
		{
			maximumStartupDurationSeconds:   ptr.To(int32(0)),
			expectedStartupPeriodSeconds:    15,
			expectedStartupFailureThreshold: 60,
			expectedMaxStartupDuration:      900,
		},
		{
			maximumStartupDurationSeconds:   ptr.To(int32(1)),
			expectedStartupPeriodSeconds:    15,
			expectedStartupFailureThreshold: 60,
			expectedMaxStartupDuration:      900,
		},
		{
			maximumStartupDurationSeconds:   ptr.To(int32(60)),
			expectedStartupPeriodSeconds:    60,
			expectedStartupFailureThreshold: 1,
			expectedMaxStartupDuration:      60,
		},
		{
			maximumStartupDurationSeconds:   ptr.To(int32(600)),
			expectedStartupPeriodSeconds:    60,
			expectedStartupFailureThreshold: 10,
			expectedMaxStartupDuration:      600,
		},
		{
			maximumStartupDurationSeconds:   ptr.To(int32(900)),
			expectedStartupPeriodSeconds:    60,
			expectedStartupFailureThreshold: 15,
			expectedMaxStartupDuration:      900,
		},
		{
			maximumStartupDurationSeconds:   ptr.To(int32(1200)),
			expectedStartupPeriodSeconds:    60,
			expectedStartupFailureThreshold: 20,
			expectedMaxStartupDuration:      1200,
		},
		{
			maximumStartupDurationSeconds:   ptr.To(int32(129)),
			expectedStartupPeriodSeconds:    43,
			expectedStartupFailureThreshold: 3,
			expectedMaxStartupDuration:      129,
		},
		{
			maximumStartupDurationSeconds:   ptr.To(int32(322)),
			expectedStartupPeriodSeconds:    54,
			expectedStartupFailureThreshold: 6,
			expectedMaxStartupDuration:      324,
		},
	}

	for _, test := range tests {
		startupPeriodSeconds, startupFailureThreshold := getStatupProbePeriodSecondsAndFailureThreshold(test.maximumStartupDurationSeconds)

		require.Equal(t, test.expectedStartupPeriodSeconds, startupPeriodSeconds)
		require.Equal(t, test.expectedStartupFailureThreshold, startupFailureThreshold)
		require.Equal(t, test.expectedMaxStartupDuration, startupPeriodSeconds*startupFailureThreshold)
	}
}

func TestBuildCommonPrometheusArgsWithRemoteWriteMessageV2(t *testing.T) {
	for _, tc := range []struct {
		version        string
		messageVersion *monitoringv1.RemoteWriteMessageVersion

		expectedPresent bool
	}{
		{
			version: "v2.53.0",
		},
		{
			version:        "v2.53.0",
			messageVersion: ptr.To(monitoringv1.RemoteWriteMessageVersion2_0),
		},
		{
			version: "v2.54.0",
		},
		{
			version:        "v2.54.0",
			messageVersion: ptr.To(monitoringv1.RemoteWriteMessageVersion1_0),
		},
		{
			version:         "v2.54.0",
			messageVersion:  ptr.To(monitoringv1.RemoteWriteMessageVersion2_0),
			expectedPresent: true,
		},
	} {
		t.Run("", func(t *testing.T) {
			p := &monitoringv1.Prometheus{
				ObjectMeta: metav1.ObjectMeta{
					Name:      "test",
					Namespace: "test",
				},
				Spec: monitoringv1.PrometheusSpec{
					CommonPrometheusFields: monitoringv1.CommonPrometheusFields{
						Version: tc.version,
						RemoteWrite: []monitoringv1.RemoteWriteSpec{
							{
								URL:            "http://example.com",
								MessageVersion: tc.messageVersion,
							},
						},
					},
				},
			}

			cg, err := NewConfigGenerator(NewLogger(), p)
			require.NoError(t, err)

			args := cg.BuildCommonPrometheusArgs()

			var found bool
			for _, arg := range args {
				if arg.Name == "enable-feature" && arg.Value == "metadata-wal-records" {
					found = true
					break
				}
			}

			require.Equal(t, tc.expectedPresent, found)
		})
	}
}

func TestBuildCommonPrometheusArgsWithOTLPReceiver(t *testing.T) {
	for _, tc := range []struct {
		version                    string
		enableOTLPReceiver         *bool
		expectedOTLPReceiverFlag   bool
		OTLPConfig                 *monitoringv1.OTLPConfig
		expectedOTLPFeatureEnabled bool
	}{
		// OTLP receiver not supported.
		{
			version:                    "2.46.0",
			enableOTLPReceiver:         ptr.To(true),
			expectedOTLPFeatureEnabled: false,
			expectedOTLPReceiverFlag:   false,
		},
		// OTLP receiver supported starting with v2.47.0.
		{
			version:                    "2.47.0",
			enableOTLPReceiver:         ptr.To(true),
			expectedOTLPFeatureEnabled: true,
			expectedOTLPReceiverFlag:   false,
		},
		// OTLP receiver supported but not enabled.
		{
			version:                    "2.47.0",
			enableOTLPReceiver:         ptr.To(false),
			expectedOTLPFeatureEnabled: false,
			expectedOTLPReceiverFlag:   false,
		},
		// OTLP receiver config supported but verison not support
		{
			version:            "2.46.0",
			enableOTLPReceiver: ptr.To(false),
			OTLPConfig: &monitoringv1.OTLPConfig{
				PromoteResourceAttributes: []string{"aa", "bb"},
			},
			expectedOTLPFeatureEnabled: false,
			expectedOTLPReceiverFlag:   false,
		},
		// OTLP receiver config supported
		{
			version:            "2.55.0",
			enableOTLPReceiver: nil,
			OTLPConfig: &monitoringv1.OTLPConfig{
				PromoteResourceAttributes: []string{"aa", "bb"},
			},
			expectedOTLPFeatureEnabled: true,
			expectedOTLPReceiverFlag:   false,
		},
		// OTLP receiver config supported with verison 3.x
		{
			version:            "3.0.0",
			enableOTLPReceiver: nil,
			OTLPConfig: &monitoringv1.OTLPConfig{
				PromoteResourceAttributes: []string{"aa", "bb"},
			},
			expectedOTLPFeatureEnabled: false,
			expectedOTLPReceiverFlag:   true,
		},
		// Test higher version from which enable-feature available.
		{
			version:                    "2.54.0",
			enableOTLPReceiver:         ptr.To(true),
			expectedOTLPFeatureEnabled: true,
			expectedOTLPReceiverFlag:   false,
		},
		// Test higher version from which web.enable-otlp-receiver arg available.
		{
			version:                    "3.0.0",
			enableOTLPReceiver:         ptr.To(true),
			expectedOTLPFeatureEnabled: false,
			expectedOTLPReceiverFlag:   true,
		},
		// Test higher version but not enabled.
		{
			version:                    "3.0.0",
			enableOTLPReceiver:         ptr.To(false),
			expectedOTLPFeatureEnabled: false,
			expectedOTLPReceiverFlag:   false,
		},
	} {
		t.Run("", func(t *testing.T) {
			p := &monitoringv1.Prometheus{
				Spec: monitoringv1.PrometheusSpec{
					CommonPrometheusFields: monitoringv1.CommonPrometheusFields{
						Version:            tc.version,
						EnableOTLPReceiver: tc.enableOTLPReceiver,
						OTLP:               tc.OTLPConfig,
					},
				},
			}

			cg, err := NewConfigGenerator(NewLogger(), p)
			require.NoError(t, err)

			args := cg.BuildCommonPrometheusArgs()

			var (
				argsEnabled    bool
				featureEnabled bool
			)
			for _, arg := range args {
				switch arg.Name {
				case "web.enable-otlp-receiver":
					argsEnabled = true
				case "enable-feature":
					feats := strings.Split(arg.Value, ",")
					for _, feat := range feats {
						if feat == "otlp-write-receiver" {
							featureEnabled = true
							break
						}
					}
				}
			}

			require.Equal(t, tc.expectedOTLPReceiverFlag, argsEnabled)
			require.Equal(t, tc.expectedOTLPFeatureEnabled, featureEnabled)
		})
	}
}