integration

package
v0.0.0-...-e56746e Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 23, 2024 License: Apache-2.0 Imports: 22 Imported by: 0

README

sumologic-kubernetes-collection integration tests

This directory contains sumologic-kubernetes-collection integration tests utilizing:

Quickstart

Running tests should be as simple as running:

make test

in this directory.

This will:

  • create kind cluster for each test
  • run the tests (using Go toolchain i.e. go test ....)
  • destroy created kind cluster(s)

NOTE: There is an assumption about mapping tests to helm values files.

In order to keep the model of "one kind cluster per one test" we map the test name (details can be found in strings.ValueFileFromT()) )

Because of that the author of a test is supposed to create a values file in values/ directory which will map to his/hers test name.

Exemplar mapping:

Test name Values file path
Test_Helm_Default_OT_Metadata values/values_helm_default_ot_metadata.yaml

Build tags and CI

Tests are tagged with either allversions or onlylatest. This determines whether the CI will run them on all supported K8s versions, or just the latest one.

The allversions tag is reserved for tests checking basic functionality - the rest should use onlylatest to prevent an explosion of CI test runs.

Note Tests in files without a build tag will not be run by the CI or make targets.

Using pre-existing clusters

You should pay special care when reusing clusters across test runs since left over artifacts in clusters might cause false positives or false negatives in test results.

Creating kind cluster

You can use the create-cluster make target in order to create a cluster and reuse it on subsequent tests runs to save time.

After you're done with the cluster, delete-cluster can be used in order to remove it.

Reusing a preexisting cluster

In order to use a preexisting cluster you can use:

  • USE_KUBECONFIG which when set to anything else than an empty string indicates that tests should not create a cluster but use a pre-existing one
  • KUBECONFIG which indicates the location of kubeconfig to be used for tests

Example:

USE_KUBECONFIG=1 KUBECONFIG=/tmp/xm1r7h7s7 make test

NOTE: The preexisting cluster that's being used for tests does not have to be a kind cluster.

Preloading docker images into the cluster

A significant chunk of the runtime of these tests involves the cluster pulling the necessary docker images. In particular, this can make running the tests on slower internet connections rather painful. Thankfully, kind provides a mechanism to preload both individual docker images and multi-image archives into the cluster at runtime from the host.

We provide a Makefile target for generating a docker image archive from the Helm values used:

make create-image-archive

Running the above will create an images.tar file in this directory, which the tests will automatically make use of.

Using a custom image archive file

It's possible to change the image archive file name:

make create-image-archive IMAGE_ARCHIVE=/my/file.tar
IMAGE_ARCHIVE=/my/file.tar make test

Runtime options

The test framework has the following runtime options that can be utilized:

  • HELM_NO_DEPENDENCY_UPDATE - when set to anything else than an empty string will cause the helm tests to not run helm dependency update. This can be used to speed up tests execution when appropriate (up to date) helm dependencies are already present on the system

    Example:

    HELM_NO_DEPENDENCY_UPDATE=1 make test

Filtering tests

Testing framework that's used in the tests allows filtering tests by feature names, labels and step names.

This might be handy if you'd like to use those abstractions but its consequence is that it will run all the code related to setup and/or teardown so e.g. all kind clusters that were supposed to be created for tests that got filtered out would be created anyway.

Running specific tests

In order to run specific tests you can use go related test filtering like so:

make test TEST_NAME="Test_Helm_Default"

or

go test -v -count 1 -run=Test_Helm_Default .
Running specific features/assessments

In order to run specific features you can use TEST_ARGS makefile argument in which you can specify e2e framework's flags:

make test TEST_NAME="Test_Helm_Default_OT_Metadata" TEST_ARGS="--assess '(metrics)'"

or

make test TEST_NAME="Test_Helm_Default_OT_Metadata" TEST_ARGS="--feature '(installation)'"

K8s node images matrix

Node images (k8s versions) on which tests are being run are defined in kind_images.json and have the following structure:

{
  "supported": [
    ...
    "kindest/node:v1.25.3",
    "kindest/node:v1.23.6"
   ],
  "default": "kindest/node:v1.25.3"
}

Where .default sets what is being used by default and .supported indicates on which images the tests should pass - CI configuration will ensure that tests are being on each of those image versions.

Known limitations/issues

Maximum size of arguments for processes

Maximum size of arguments for processes is limited by:

  • ARG_MAX - maximum length of arguments
  • MAX_ARG_STRLEN - maximum size for one argument

Note: ARG_MAX and MAX_ARG_STRLEN vary on different systems.

Because of limited size of arguments it is not possible to prepare Pod with very long list of arguments which is generated in the code, e.g. Pod with very long list of echo commands that have very long string passed as an argument.

When process receives too long list of arguments following error occurs:

2022-02-22T13:57:55.662403778Z stderr F standard_init_linux.go:228: exec user process caused: argument list too long

To learn more about ARG_MAX and MAX_ARG_STRLEN please read ARG_MAX, maximum length of arguments for a new process

Documentation

Index

Constants

View Source 
const (
	Prometheus MetricsCollector = "prometheus"
	Otelcol    MetricsCollector = "otelcol"
	// number of logs generated by tailing sidecar test (50 * 3), see: tests/inegration/yamls/tailing-sidecar-test.yaml
	TailingSidecarCount uint = 150
	// number of logs generated by pod annotations test (50 * 3), see: tests/inegration/yamls/annotations-test.yaml
	AnnotationsLogsCount uint = 150
	// number of logs generated by containers used in namespace annotations test (50 * 3), see: tests/inegration/yamls/namespace-annotations-test.yaml
	NamespaceAnnotationsLogsCount uint = 150
)

Variables

This section is empty.

Functions

func CheckOtelcolEventsInstall 

func CheckOtelcolEventsInstall(builder *features.FeatureBuilder) *features.FeatureBuilder

func CheckOtelcolLogsCollectorInstall 

func CheckOtelcolLogsCollectorInstall(builder *features.FeatureBuilder) *features.FeatureBuilder

func CheckOtelcolMetadataLogsInstall 

func CheckOtelcolMetadataLogsInstall(builder *features.FeatureBuilder) *features.FeatureBuilder

func CheckOtelcolMetadataMetricsInstall 

func CheckOtelcolMetadataMetricsInstall(builder *features.FeatureBuilder) *features.FeatureBuilder

func CheckOtelcolMetricsCollectorInstall 

func CheckOtelcolMetricsCollectorInstall(builder *features.FeatureBuilder) *features.FeatureBuilder

func CheckPrometheusInstall 

func CheckPrometheusInstall(builder *features.FeatureBuilder) *features.FeatureBuilder

func CheckSumologicSecret 

func CheckSumologicSecret(endpointCount int) featureCheck

func CheckTailingSidecarOperatorInstall 

func CheckTailingSidecarOperatorInstall(builder *features.FeatureBuilder) *features.FeatureBuilder

func CheckTracesInstall 

func CheckTracesInstall(builder *features.FeatureBuilder) *features.FeatureBuilder

func CheckTracesWithoutGatewayInstall 

func CheckTracesWithoutGatewayInstall(builder *features.FeatureBuilder) *features.FeatureBuilder

func DeleteAdditionalSumologicMock 

func DeleteAdditionalSumologicMock() features.Feature

func DeployAdditionalSumologicMock 

func DeployAdditionalSumologicMock() features.Feature

func GetAdditionalPartiallyLogsFeature 

func GetAdditionalPartiallyLogsFeature() features.Feature

func GetAllLogsFeature 

func GetAllLogsFeature(waitFunction stepfuncs.WaitForLogs, generate bool) features.Feature

func GetAnnotationsFeature 

func GetAnnotationsFeature() features.Feature

func GetCurlAppFeature 

func GetCurlAppFeature() features.Feature

func GetDotnetAppFeature 

func GetDotnetAppFeature() features.Feature

func GetEventsFeature 

func GetEventsFeature() features.Feature

func GetInstallFeature 

func GetInstallFeature(installChecks []featureCheck) features.Feature

func GetJavaAppFeature 

func GetJavaAppFeature() features.Feature

func GetMetricsFeature 

func GetMetricsFeature(expectedMetrics []string, metricsCollector MetricsCollector) features.Feature

func GetMultilineLogsFeature 

func GetMultilineLogsFeature() features.Feature

func GetMultipleMultilineLogsFeature 

func GetMultipleMultilineLogsFeature() features.Feature

func GetNamespaceAnnotationsFeature 

func GetNamespaceAnnotationsFeature() features.Feature

func GetNodeJSAppFeature 

func GetNodeJSAppFeature() features.Feature

func GetPartialLogsFeature 

func GetPartialLogsFeature() features.Feature

func GetPythonAppFeature 

func GetPythonAppFeature() features.Feature

func GetTailingSidecarFeature 

func GetTailingSidecarFeature() features.Feature

func GetTelegrafMetricsFeature 

func GetTelegrafMetricsFeature(expectedMetrics []string, metricsCollector MetricsCollector, errOnExtra bool) features.Feature

func GetTracesFeature 

func GetTracesFeature() features.Feature

Types

type MetricsCollector 

type MetricsCollector string

Source Files

View all Source files

Directories

Path Synopsis
ctxopts
curlapp
k8s
logsgenerator
stepfuncs
strings
sumologicmock
tracesgenerator

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.