common

Documentation

Overview

Package common contains basic test operation for agent-platform tests

Index

• Constants
• func AgentProcessIsRunning(client *TestClient, processName string) bool
• func AssertPortBoundByService(t assert.TestingT, client *TestClient, port int, service string) (boundport.BoundPort, bool)
• func CheckAgentBehaviour(t *testing.T, client *TestClient)
• func CheckAgentPython(t *testing.T, client *TestClient, expectedVersion string)
• func CheckAgentRestarts(t *testing.T, client *TestClient)
• func CheckAgentStops(t *testing.T, client *TestClient)
• func CheckApmDisabled(t *testing.T, client *TestClient)
• func CheckApmEnabled(t *testing.T, client *TestClient)
• func CheckCWSBehaviour(t *testing.T, client *TestClient)
• func CheckDogstatdAgentBehaviour(t *testing.T, client *TestClient)
• func CheckDogstatsdAgentRestarts(t *testing.T, client *TestClient)
• func CheckDogstatsdAgentStops(t *testing.T, client *TestClient)
• func CheckInstallation(t *testing.T, client *TestClient)
• func CheckInstallationInstallScript(t *testing.T, client *TestClient)
• func CheckInstallationMajorAgentVersion(t *testing.T, client *TestClient, expectedVersion string) bool
• func CheckIntegrationInstall(t *testing.T, client *TestClient)
• func CheckSigningKeys(t *testing.T, client *TestClient)
• func CheckSystemProbeBehavior(t *testing.T, client *TestClient)
• func CheckUninstallation(t *testing.T, client *TestClient)
• func GetBoundPort(host *components.RemoteHost, port int) (boundport.BoundPort, error)
• func ReadJournalCtl(t *testing.T, client *TestClient, grepPattern string) string
• func RunningAgentProcesses(client *TestClient) ([]string, error)
• func SetAgentPythonMajorVersion(t *testing.T, client *TestClient, majorVersion string)
• type TestClient
  • func NewTestClient(host *components.RemoteHost, agentClient agentclient.Agent, ...) *TestClient
  • func NewWindowsTestClient(context e2e.Context, host *components.RemoteHost) *TestClient
  • func (client *TestClient) CheckAgentVersion(t *testing.T, expected string) bool
  • func (c *TestClient) ExecuteWithRetry(cmd string) (string, error)
  • func (c *TestClient) GetAgentVersion() (string, error)
  • func (c *TestClient) GetJSONStatus() (map[string]any, error)
  • func (c *TestClient) GetPythonVersion() (string, error)
  • func (c *TestClient) SetConfig(confPath string, key string, value string) error

Constants

const (
	// ExpectedPythonVersion2 is the expected python 2 version
	// Bump this version when the version in omnibus/config/software/python2.rb changes
	ExpectedPythonVersion2 = "2.7.18"
	// ExpectedPythonVersion3 is the expected python 3 version
	// Bump this version when the version in omnibus/config/software/python3.rb changes
	ExpectedPythonVersion3 = "3.11.8"
)

Functions

func AgentProcessIsRunning

func AgentProcessIsRunning(client *TestClient, processName string) bool

AgentProcessIsRunning returns true if the agent process is running

func AssertPortBoundByService

func AssertPortBoundByService(t assert.TestingT, client *TestClient, port int, service string) (boundport.BoundPort, bool)

AssertPortBoundByService accepts a port and a service name and returns true if the port is bound by the service

func CheckAgentBehaviour

func CheckAgentBehaviour(t *testing.T, client *TestClient)

CheckAgentBehaviour runs test to check the agent is behaving as expected

func CheckAgentPython

func CheckAgentPython(t *testing.T, client *TestClient, expectedVersion string)

CheckAgentPython runs tests to check the agent use the correct python version

func CheckAgentRestarts

func CheckAgentRestarts(t *testing.T, client *TestClient)

CheckAgentRestarts runs tests to check the agent can restart properly

func CheckAgentStops

func CheckAgentStops(t *testing.T, client *TestClient)

CheckAgentStops runs tests to check the agent can stop properly

func CheckApmDisabled

func CheckApmDisabled(t *testing.T, client *TestClient)

CheckApmDisabled runs tests to check the agent behave properly when APM is disabled

func CheckApmEnabled

func CheckApmEnabled(t *testing.T, client *TestClient)

CheckApmEnabled runs tests to check the agent behave properly with APM enabled

func CheckCWSBehaviour

func CheckCWSBehaviour(t *testing.T, client *TestClient)

CheckCWSBehaviour runs tests to check the agent behave correctly when CWS is enabled

func CheckDogstatdAgentBehaviour

func CheckDogstatdAgentBehaviour(t *testing.T, client *TestClient)

CheckDogstatdAgentBehaviour runs tests to check the agent behave properly with dogstatsd

func CheckDogstatsdAgentRestarts

func CheckDogstatsdAgentRestarts(t *testing.T, client *TestClient)

CheckDogstatsdAgentRestarts runs tests to check the agent can restart properly

func CheckDogstatsdAgentStops

func CheckDogstatsdAgentStops(t *testing.T, client *TestClient)

CheckDogstatsdAgentStops runs tests to check the agent can stop properly

func CheckInstallation

func CheckInstallation(t *testing.T, client *TestClient)

CheckInstallation run tests to check the installation of the agent

func CheckInstallationInstallScript

func CheckInstallationInstallScript(t *testing.T, client *TestClient)

CheckInstallationInstallScript run tests to check the installation of the agent with the install script

func CheckInstallationMajorAgentVersion

func CheckInstallationMajorAgentVersion(t *testing.T, client *TestClient, expectedVersion string) bool

CheckInstallationMajorAgentVersion run tests to check the installation of an agent has the correct major version

func CheckIntegrationInstall

func CheckIntegrationInstall(t *testing.T, client *TestClient)

CheckIntegrationInstall run test to test installation of integrations

func CheckSigningKeys

func CheckSigningKeys(t *testing.T, client *TestClient)

CheckSigningKeys ensures datadog-signing-keys package is installed

func CheckSystemProbeBehavior

func CheckSystemProbeBehavior(t *testing.T, client *TestClient)

CheckSystemProbeBehavior runs tests to check the agent behave correctly when system-probe is enabled

func CheckUninstallation

func CheckUninstallation(t *testing.T, client *TestClient)

CheckUninstallation runs check to see if the agent uninstall properly

func GetBoundPort

func GetBoundPort(host *components.RemoteHost, port int) (boundport.BoundPort, error)

GetBoundPort returns a port that is bound on the host, or nil if the port is not bound

func ReadJournalCtl

func ReadJournalCtl(t *testing.T, client *TestClient, grepPattern string) string

ReadJournalCtl returns the output of journalctl with an optional grep pattern

func RunningAgentProcesses

func RunningAgentProcesses(client *TestClient) ([]string, error)

RunningAgentProcesses returns the list of running agent processes

func SetAgentPythonMajorVersion

func SetAgentPythonMajorVersion(t *testing.T, client *TestClient, majorVersion string)

SetAgentPythonMajorVersion set the python major version in the agent config and restarts the agent

Types

type TestClient

type TestClient struct {
	Host        *components.RemoteHost
	AgentClient agentclient.Agent
	Helper      helpers.Helper
	FileManager filemanager.FileManager
	SvcManager  svcmanager.ServiceManager
	PkgManager  pkgmanager.PackageManager
}

TestClient contain the Agent Env and SvcManager and PkgManager for tests

func NewTestClient

func NewTestClient(host *components.RemoteHost, agentClient agentclient.Agent, fileManager filemanager.FileManager, helper helpers.Helper) *TestClient

NewTestClient create a an ExtendedClient from VMClient and AgentCommandRunner, includes svcManager and pkgManager to write agent-platform tests

func NewWindowsTestClient

func NewWindowsTestClient(context e2e.Context, host *components.RemoteHost) *TestClient

NewWindowsTestClient create a TestClient for Windows VM

func (*TestClient) CheckAgentVersion

func (client *TestClient) CheckAgentVersion(t *testing.T, expected string) bool

CheckAgentVersion run tests to check that the agent has the correct version

func (*TestClient) ExecuteWithRetry

func (c *TestClient) ExecuteWithRetry(cmd string) (string, error)

ExecuteWithRetry execute the command with retry

func (*TestClient) GetAgentVersion

func (c *TestClient) GetAgentVersion() (string, error)

GetAgentVersion returns agent version from the Agent status

func (*TestClient) GetJSONStatus

func (c *TestClient) GetJSONStatus() (map[string]any, error)

GetJSONStatus returns the status of the Agent in JSON format

func (*TestClient) GetPythonVersion

func (c *TestClient) GetPythonVersion() (string, error)

GetPythonVersion returns python version from the Agent status

func (*TestClient) SetConfig

func (c *TestClient) SetConfig(confPath string, key string, value string) error

SetConfig set config given a key and a path to a yaml config file, support key nested twice at most