Skip to content

Commit

Permalink
README cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
tabgok committed Feb 12, 2024
1 parent 17cb8aa commit 92d604b
Showing 1 changed file with 1 addition and 23 deletions.
24 changes: 1 addition & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <NAME>_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
```

0 comments on commit 92d604b

Please sign in to comment.