test(STONEO11Y-44): Add initial o11y tests to e2e (konflux-ci#398)

Setting up the framework for the o11y team e2e tests.
Added Pending Labels to test to not to run this test
as part of CI, till the deployment-related
STONEO11Y-86 is completed.

Signed-off-by: Sri Vignesh <sselvan@redhat.com>

Author: srivickynesh

cmd/e2e_test.go

@@ -18,6 +18,7 @@ import (
 	_ "github.com/redhat-appstudio/e2e-tests/tests/has"
 	_ "github.com/redhat-appstudio/e2e-tests/tests/integration-service"
 	_ "github.com/redhat-appstudio/e2e-tests/tests/mvp-demo"
+	_ "github.com/redhat-appstudio/e2e-tests/tests/o11y"
 	_ "github.com/redhat-appstudio/e2e-tests/tests/release"
 
 	"flag"

pkg/framework/describe.go

@@ -46,3 +46,7 @@ func IntegrationServiceSuiteDescribe(text string, args ...interface{}) bool {
 func MvpDemoSuiteDescribe(text string, args ...interface{}) bool {
 	return Describe("[mvp-demo-suite "+text+"]", args, Ordered)
 }
+
+func O11ySuiteDescribe(text string, args ...interface{}) bool {
+	return Describe("[O11y-suite "+text+"]", args, Ordered)
+}

pkg/framework/framework.go

@@ -13,6 +13,7 @@ import (
 	"github.com/redhat-appstudio/e2e-tests/pkg/utils/has"
 	"github.com/redhat-appstudio/e2e-tests/pkg/utils/integration"
 	"github.com/redhat-appstudio/e2e-tests/pkg/utils/jvmbuildservice"
+	"github.com/redhat-appstudio/e2e-tests/pkg/utils/o11y"
 	"github.com/redhat-appstudio/e2e-tests/pkg/utils/release"
 	"github.com/redhat-appstudio/e2e-tests/pkg/utils/spi"
 	"github.com/redhat-appstudio/e2e-tests/pkg/utils/tekton"
@@ -27,6 +28,7 @@ type ControllerHub struct {
 	ReleaseController         *release.SuiteController
 	IntegrationController     *integration.SuiteController
 	JvmbuildserviceController *jvmbuildservice.SuiteController
+	O11yController            *o11y.SuiteController
 }
 
 type Framework struct {
@@ -122,6 +124,11 @@ func InitControllerHub(cc *kubeCl.CustomClient) (*ControllerHub, error) {
 	if err != nil {
 		return nil, err
 	}
+	// Initialize o11y controller
+	o11yController, err := o11y.NewSuiteController(cc)
+	if err != nil {
+		return nil, err
+	}
 
 	return &ControllerHub{
 		HasController:             hasController,
@@ -132,6 +139,7 @@ func InitControllerHub(cc *kubeCl.CustomClient) (*ControllerHub, error) {
 		ReleaseController:         releaseController,
 		IntegrationController:     integrationController,
 		JvmbuildserviceController: jvmbuildserviceController,
+		O11yController:            o11yController,
 	}, nil
 
 }

pkg/utils/common/controller.go

@@ -29,6 +29,7 @@ import (
 	appsv1 "k8s.io/api/apps/v1"
 	rbacv1 "k8s.io/api/rbac/v1"
 	k8sErrors "k8s.io/apimachinery/pkg/api/errors"
+	"sigs.k8s.io/controller-runtime/pkg/client"
 	rclient "sigs.k8s.io/controller-runtime/pkg/client"
 )
 
@@ -634,3 +635,40 @@ func (s *SuiteController) CreateRoleBinding(roleBindingName, namespace, subjectK
 	}
 	return createdRoleBinding, nil
 }
+
+// Delete all the PipelineRuns and Tasks associated to namespace
+func (s *SuiteController) DeleteAllPipelineRunsAndTasks(namespace string) error {
+	// List all PipelineRuns in the namespace
+	pipelineRunList := &v1beta1.PipelineRunList{}
+	err := s.KubeRest().List(context.TODO(), pipelineRunList, &client.ListOptions{
+		Namespace: namespace,
+	})
+	if err != nil {
+		return err
+	}
+
+	// Delete each PipelineRun and its associated tasks
+	for _, pipelineRun := range pipelineRunList.Items {
+		if err := s.KubeRest().Delete(context.TODO(), &pipelineRun, &client.DeleteOptions{}); err != nil {
+			return err
+		}
+		for _, task := range pipelineRun.Spec.PipelineSpec.Tasks {
+			taskObj := &v1beta1.Task{}
+			if err := s.KubeRest().Get(context.TODO(), types.NamespacedName{
+				Namespace: namespace,
+				Name:      task.TaskRef.Name,
+			}, taskObj); err != nil {
+				// Ignore "not found" errors since the task may have already been deleted
+				if k8sErrors.IsNotFound(err) {
+					continue
+				}
+				return err
+			}
+			if err := s.KubeRest().Delete(context.TODO(), taskObj, &client.DeleteOptions{}); err != nil {
+				return err
+			}
+		}
+	}
+
+	return nil
+}

pkg/utils/o11y/controller.go

@@ -0,0 +1,85 @@
+package o11y
+
+import (
+	"encoding/json"
+	"fmt"
+	"math"
+	"os/exec"
+	"regexp"
+	"strconv"
+
+	kubeCl "github.com/redhat-appstudio/e2e-tests/pkg/apis/kubernetes"
+)
+
+type SuiteController struct {
+	*kubeCl.CustomClient
+}
+
+type MetricResult struct {
+	Metric map[string]string `json:"metric"`
+	Value  []interface{}     `json:"value"`
+}
+
+func NewSuiteController(kube *kubeCl.CustomClient) (*SuiteController, error) {
+	return &SuiteController{
+		kube,
+	}, nil
+}
+
+func (h *SuiteController) convertBytesToMB(bytesValue float64) float64 {
+	megabytesValue := bytesValue / (1000 * 1000)
+	return math.Round(megabytesValue*10) / 10
+}
+
+// Fetch metrics for given query
+func (h *SuiteController) GetMetrics(query string) ([]MetricResult, error) {
+
+	var result struct {
+		Data struct {
+			Result []MetricResult `json:"result"`
+		} `json:"data"`
+	}
+
+	// Temporary way to fetch the metrics, will be replaced by golang http client library
+	// curl -X GET -kG "https://$THANOS_QUERIER_HOST/api/v1/query?" --data-urlencode "query="+query -H "Authorization: Bearer $TOKEN"
+	curlCmd := exec.Command("curl", "-X", "GET", "-kG", "http://localhost:8080/api/v1/query", "--data-urlencode", "query="+query)
+	output, err := curlCmd.Output()
+	if err != nil {
+		return nil, err
+	}
+
+	err = json.Unmarshal(output, &result)
+	if err != nil {
+		return nil, err
+	}
+
+	return result.Data.Result, nil
+}
+
+func (h *SuiteController) GetRegexPodNameWithSize(podNameRegex string, results []MetricResult) (map[string]float64, error) {
+	podNameWithSize := make(map[string]float64)
+	regex, err := regexp.Compile(podNameRegex)
+	if err != nil {
+		return podNameWithSize, fmt.Errorf("error compiling regex pattern: %v", err)
+	}
+
+	for _, res := range results {
+		if podName, ok := res.Metric["pod"]; ok {
+			if regex.MatchString(podName) {
+				value := res.Value[1].(string)
+				valueInBytes, err := strconv.ParseFloat(value, 64)
+				if err != nil {
+					return nil, fmt.Errorf("error parsing value for %s: %s", podName, err)
+				}
+				valueInMegabytes := h.convertBytesToMB(valueInBytes)
+				podNameWithSize[podName] = valueInMegabytes
+			}
+		}
+	}
+
+	if len(podNameWithSize) == 0 {
+		return nil, fmt.Errorf("no pods matching the regex pattern were found")
+	}
+
+	return podNameWithSize, nil
+}

tests/o11y/o11y.go

@@ -0,0 +1,62 @@
+package o11y
+
+import (
+	"fmt"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	"github.com/redhat-appstudio/e2e-tests/pkg/framework"
+)
+
+const (
+	O11yUser = "o11y-e2e"
+)
+
+var _ = framework.O11ySuiteDescribe("O11Y E2E tests", Label("o11y", "HACBS"), Pending, func() {
+
+	defer GinkgoRecover()
+	var f *framework.Framework
+	var err error
+
+	Describe("O11y test", Pending, func() {
+		var testNamespace string
+
+		BeforeAll(func() {
+
+			f, err = framework.NewFramework(O11yUser)
+			Expect(err).NotTo(HaveOccurred())
+			testNamespace = f.UserNamespace
+
+		})
+		AfterAll(func() {
+			if !CurrentSpecReport().Failed() {
+				// err := f.AsKubeAdmin.CommonController.DeleteAllPipelineRunsAndTasks(testNamespace)
+				// Expect(err).NotTo(HaveOccurred())
+				Expect(f.SandboxController.DeleteUserSignup(f.UserName)).NotTo(BeFalse())
+			}
+		})
+
+		It("E2E sample test for upload 50MB pod", Pending, func() {
+			podNameRegex := ".*-upload-50mb-pod"
+			query := fmt.Sprintf("last_over_time(container_network_transmit_bytes_total{namespace='%s', pod=~'%s'}[1h])", testNamespace, podNameRegex)
+
+			result, err := f.AsKubeAdmin.O11yController.GetMetrics(query)
+			Expect(err).NotTo(HaveOccurred())
+
+			podNamesWithSize, err := f.AsKubeAdmin.O11yController.GetRegexPodNameWithSize(podNameRegex, result)
+			Expect(err).NotTo(HaveOccurred())
+
+			for podName, podSize := range podNamesWithSize {
+				GinkgoWriter.Printf("Pod: %s, Size: %.2f MB", podName, podSize)
+				// Range limits are measured as part of STONEO11Y-15
+				Expect(podSize).To(And(
+					BeNumerically(">=", 53.00),
+					BeNumerically("<=", 53.59),
+				), fmt.Sprintf("%s: %.2f MB is not within the expected range.", podName, podSize))
+			}
+
+		})
+	})
+
+})