README
¶
opentelemetry-operations-e2e-testing
This project contains a test runner and configuration which are used for testing GCP's OpenTelemetry exporters, resource detectors, propagators, etc. These tests are run in pull requests to the other GoogleCloudPlatform/opentelemtry-operations-* repos.
The code in this repository is only for testing purposes! This project is not an official Google project. It is not supported by Google and Google specifically disclaims all warranties as to its quality, merchantability, or fitness for a particular purpose.
Run locally
Build the docker image locally:
docker build . -t opentelemetry-operations-e2e-testing:local
Run the image with a test server, e.g. with the python instrumented test server from a recent build:
PROJECT_ID="opentelemetry-ops-e2e"
GOOGLE_APPLICATION_CREDENTIALS="${HOME}/.config/gcloud/application_default_credentials.json"
# Using a recent python build for example. Alternatively, use a locally built
# test server.
INSTRUMENTED_TEST_SERVER="gcr.io/opentelemetry-ops-e2e/opentelemetry-operations-python-e2e-test-server:45ccd1d"
# Pull the image if it doesn't exist locally
docker pull ${INSTRUMENTED_TEST_SERVER}
docker run \
-e "GOOGLE_APPLICATION_CREDENTIALS=${GOOGLE_APPLICATION_CREDENTIALS}" \
-v "${GOOGLE_APPLICATION_CREDENTIALS}:${GOOGLE_APPLICATION_CREDENTIALS}:ro" \
-v /var/run/docker.sock:/var/run/docker.sock \
-e PROJECT_ID=${PROJECT_ID} \
--rm \
opentelemetry-operations-e2e-testing:local \
local \
--image=${INSTRUMENTED_TEST_SERVER}
Matrix of implemented scenarios
Contributing
See docs/contributing.md for details.
License
Apache 2.0; see LICENSE for details.
Disclaimer
This project is not an official Google project. It is not supported by Google and Google specifically disclaims all warranties as to its quality, merchantability, or fitness for a particular purpose.
Documentation
¶
Index ¶
- Constants
- func NoopCleanup()
- type ApplyPersistent
- type Args
- type Cleanup
- func SetupCloudRun(ctx context.Context, args *Args, logger *log.Logger) (*testclient.Client, Cleanup, error)
- func SetupGce(ctx context.Context, args *Args, logger *log.Logger) (*testclient.Client, Cleanup, error)
- func SetupGke(ctx context.Context, args *Args, logger *log.Logger) (*testclient.Client, Cleanup, error)
- func SetupLocal(ctx context.Context, args *Args, logger *log.Logger) (*testclient.Client, Cleanup, error)
- type CloudRunCmd
- type CmdWithImage
- type CmdWithProjectId
- type GceCmd
- type GkeCmd
- type LocalCmd
- type SetupFunc
Constants ¶
const BeginOutputArt = `` /* 908-byte string literal not displayed */
const EndOutputArt = `` /* 908-byte string literal not displayed */
Variables ¶
This section is empty.
Functions ¶
func NoopCleanup ¶
func NoopCleanup()
Types ¶
type ApplyPersistent ¶
type ApplyPersistent struct {
AutoApprove bool `arg:"--auto-approve" default:"false" help:"Approve without prompting. Default is false."`
}
type Args ¶
type Args struct {
// This subcommand is a special case, it doesn't run any tests. It just
// applies the persistent resources which are used across tests. See
// tf/persistent/README.md for details on what is in there.
ApplyPersistent *ApplyPersistent `arg:"subcommand:apply-persistent" help:"Terraform apply the resources in tf/persistent and exit (does not run tests)."`
Local *LocalCmd `arg:"subcommand:local" help:"Deploy the test server locally with docker and execute tests"`
Gke *GkeCmd `arg:"subcommand:gke" help:"Deploy the test server on GKE and execute tests"`
Gce *GceCmd `arg:"subcommand:gce" help:"Deploy the test server on GCE and execute tests"`
CloudRun *CloudRunCmd `arg:"subcommand:cloud-run" help:"Deploy the test server on Cloud Run and execute tests"`
CmdWithProjectId
GoTestFlags string `help:"go test flags to pass through, e.g. --gotestflags='-test.v'"`
HealthCheckTimeout time.Duration `` /* 126-byte string literal not displayed */
// This is used in a new terraform workspace's name and in the GCP resources
// we create. Pass the GCB build ID in CI to get the build id formatted into
// resources created for debugging. If not provided, we generate a hex
// string.
TestRunID string `arg:"--test-run-id,env:TEST_RUN_ID" help:"Optional test run id to use to partition terraform resources"`
}
type Cleanup ¶
type Cleanup func()
func SetupCloudRun ¶
func SetupCloudRun( ctx context.Context, args *Args, logger *log.Logger, ) (*testclient.Client, Cleanup, error)
SetupCloudRun sets up the instrumented test server to run in Cloud Run. Creates a new service and runs the specified container image as a revision. The returned cleanup function tears down everything.
func SetupGce ¶
func SetupGce( ctx context.Context, args *Args, logger *log.Logger, ) (*testclient.Client, Cleanup, error)
Set up the instrumented test server to run in GCE container. Creates a new GCE VM + pubsub resources, and runs the specified container image. The returned cleanup function tears down the VM.
func SetupGke ¶
func SetupGke( ctx context.Context, args *Args, logger *log.Logger, ) (*testclient.Client, Cleanup, error)
Set up the instrumented test server to run in GKE. Creates a new GKE cluster and runs the specified container image in a pod. The returned cleanup function tears down the whole cluster.
type CloudRunCmd ¶
type CloudRunCmd struct {
CmdWithImage
}
type CmdWithImage ¶
type CmdWithImage struct {
Image string `arg:"required" help:"docker container image to deploy and test"`
}
type CmdWithProjectId ¶
type CmdWithProjectId struct {
ProjectID string `arg:"required,--project-id,env:PROJECT_ID" help:"GCP project id/name"`
}
type GceCmd ¶
type GceCmd struct {
CmdWithImage
}
type GkeCmd ¶
type GkeCmd struct {
CmdWithImage
}
type LocalCmd ¶
type LocalCmd struct {
CmdWithImage
Port string `default:"8000"`
// Needed when running without a metadata server for credentials
GoogleApplicationCredentials string `` /* 152-byte string literal not displayed */
// May be needed when running this binary in a container
Network string `help:"Docker network to use when starting the container, optional"`
ContainerUser string `arg:"--container-user" help:"Optional user to use when running the container"`
}
Source Files
Directories