From 92d604b2f7339a4df6699dd2ffa3b0e7f41cc872 Mon Sep 17 00:00:00 2001 From: Teague Bick Date: Mon, 12 Feb 2024 18:10:11 -0500 Subject: [PATCH] README cleanup --- README.md | 24 +----------------------- 1 file changed, 1 insertion(+), 23 deletions(-) diff --git a/README.md b/README.md index 577dd8d1fd..6e6f275865 100644 --- a/README.md +++ b/README.md @@ -105,26 +105,4 @@ If you're only interested in the tests for a specific integration it can be usef For example if you're running tests that need the `mysql` database container to be up: ```shell docker compose -f docker-compose.yaml -p dd-trace-go up -d mysql -``` - - -NOTES: -- `go build ./...` -> doesn't do much in this package, since its a library (grpc errors are expected) -- `go test ./...` -> will run all of the tests (compile + run tests) (`go help test`) (containers have to be launched separately) -- `go install` => for packages with binaries, does a build and puts built binaries into PATH -- `INTEGRATION=1 go test ./contrib/aws/aws-sdk-go-v2/...` to run aws-sdk-go-v2 items (`-v` for verbose) (`-run` to select specific tests) -- `nice -n20 gotestsum --junitfile ./gotestsum-report.xml -- -race -v -coverprofile=contrib_coverage.txt -covermode=atomic gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer -run TestSQLCommentCarrier` => provides coverage and stuff on top of ^, also launches containers. mostly used by CI -- `go mod tidy` => downloads dependencies, fixes go.mod, etc (run during setup and after updating any dependencies) -- `package main` means binary/executable -- `DOCKER_DEFAULT_PLATFORM=linux/amd64 docker compose -f docker-compose.yaml -p dd-trace-go up -d mysql` to launch a container -- `docker-compose up -d` to launch all containers -- `test.sh --all` is not loading all the containers -_- so it breaks until you've got them built -- Go will do pattern matching on the test names for benchmarking (from the go test framework) - - Test files must be _test.go (does not need to match filename) - - Tests must be called Test* for test Benchmark* for benchmarks -- Go other things: - - functions (and everything) starting with a lowercase are private to the package - - functions (and everything) starting with an uppercase are public (exportable) - - -Right now: The span we're setting the informaiton on appears to be a connect span, while the one we're checking is a "call" span. I'm not sure if we can transfer the information between the two spans \ No newline at end of file +``` \ No newline at end of file