DataDog / orchestrion

Automatic compile-time instrumentation of Go code
http://datadoghq.dev/orchestrion/
Apache License 2.0
159 stars 5 forks source link

fix: case-based name conflict with `DataDog` #288

Closed RomainMuller closed 1 month ago

RomainMuller commented 1 month ago

Case-conflicting import paths cause issues when using go mod vendor as the layout on case-sensitive file systems is different from that on case-insensitive file system. This is a long-known issue with the Go toolchain, however fixing this is non-trivial and could have undesirable consequences.

Since the capitalized form of DataDog (sic) is most common today, renaming the orchestrion module is the most pragramtic solution today.

Caused-By golang/go#38342 Fixes #287

eliottness commented 1 month ago

Should we do a v0.9.0 for this ?

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 73.48%. Comparing base (87351e4) to head (715aa9a). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #288 +/- ## ======================================= Coverage 73.48% 73.48% ======================================= Files 144 144 Lines 7861 7861 ======================================= Hits 5777 5777 Misses 1655 1655 Partials 429 429 ``` | [Components](https://app.codecov.io/gh/DataDog/orchestrion/pull/288/components?src=pr&el=components&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog) | Coverage Δ | | |---|---|---| | [Generators](https://app.codecov.io/gh/DataDog/orchestrion/pull/288/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog) | `76.69% <100.00%> (ø)` | | | [Instruments](https://app.codecov.io/gh/DataDog/orchestrion/pull/288/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog) | `88.05% <ø> (ø)` | | | [Go Driver](https://app.codecov.io/gh/DataDog/orchestrion/pull/288/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog) | `72.81% <ø> (ø)` | | | [Toolexec Driver](https://app.codecov.io/gh/DataDog/orchestrion/pull/288/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog) | `70.88% <ø> (ø)` | | | [Aspects](https://app.codecov.io/gh/DataDog/orchestrion/pull/288/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog) | `71.79% <100.00%> (ø)` | | | [Injector](https://app.codecov.io/gh/DataDog/orchestrion/pull/288/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog) | `73.24% <100.00%> (ø)` | | | [Job Server](https://app.codecov.io/gh/DataDog/orchestrion/pull/288/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog) | `63.20% <ø> (ø)` | | | [Integration Test Suite](https://app.codecov.io/gh/DataDog/orchestrion/pull/288/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog) | `87.64% <ø> (ø)` | | | [Other](https://app.codecov.io/gh/DataDog/orchestrion/pull/288/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog) | `73.48% <100.00%> (ø)` | | | [Files with missing lines](https://app.codecov.io/gh/DataDog/orchestrion/pull/288?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog) | Coverage Δ | | |---|---|---| | [instrument/instrument.go](https://app.codecov.io/gh/DataDog/orchestrion/pull/288?src=pr&el=tree&filepath=instrument%2Finstrument.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog#diff-aW5zdHJ1bWVudC9pbnN0cnVtZW50Lmdv) | `77.77% <ø> (ø)` | | | [internal/cmd/go.go](https://app.codecov.io/gh/DataDog/orchestrion/pull/288?src=pr&el=tree&filepath=internal%2Fcmd%2Fgo.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog#diff-aW50ZXJuYWwvY21kL2dvLmdv) | `40.00% <ø> (ø)` | | | [internal/cmd/pin.go](https://app.codecov.io/gh/DataDog/orchestrion/pull/288?src=pr&el=tree&filepath=internal%2Fcmd%2Fpin.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog#diff-aW50ZXJuYWwvY21kL3Bpbi5nbw==) | `0.00% <ø> (ø)` | | | [internal/cmd/server.go](https://app.codecov.io/gh/DataDog/orchestrion/pull/288?src=pr&el=tree&filepath=internal%2Fcmd%2Fserver.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog#diff-aW50ZXJuYWwvY21kL3NlcnZlci5nbw==) | `13.07% <100.00%> (ø)` | | | [internal/cmd/toolexec.go](https://app.codecov.io/gh/DataDog/orchestrion/pull/288?src=pr&el=tree&filepath=internal%2Fcmd%2Ftoolexec.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog#diff-aW50ZXJuYWwvY21kL3Rvb2xleGVjLmdv) | `59.45% <ø> (ø)` | | | [internal/cmd/version.go](https://app.codecov.io/gh/DataDog/orchestrion/pull/288?src=pr&el=tree&filepath=internal%2Fcmd%2Fversion.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog#diff-aW50ZXJuYWwvY21kL3ZlcnNpb24uZ28=) | `35.71% <ø> (ø)` | | | [internal/ensure/integration/main.go](https://app.codecov.io/gh/DataDog/orchestrion/pull/288?src=pr&el=tree&filepath=internal%2Fensure%2Fintegration%2Fmain.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog#diff-aW50ZXJuYWwvZW5zdXJlL2ludGVncmF0aW9uL21haW4uZ28=) | `0.00% <ø> (ø)` | | | [internal/ensure/requiredversion.go](https://app.codecov.io/gh/DataDog/orchestrion/pull/288?src=pr&el=tree&filepath=internal%2Fensure%2Frequiredversion.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog#diff-aW50ZXJuYWwvZW5zdXJlL3JlcXVpcmVkdmVyc2lvbi5nbw==) | `72.28% <ø> (ø)` | | | [internal/goflags/flags.go](https://app.codecov.io/gh/DataDog/orchestrion/pull/288?src=pr&el=tree&filepath=internal%2Fgoflags%2Fflags.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog#diff-aW50ZXJuYWwvZ29mbGFncy9mbGFncy5nbw==) | `76.28% <ø> (ø)` | | | [internal/goproxy/dashc.go](https://app.codecov.io/gh/DataDog/orchestrion/pull/288?src=pr&el=tree&filepath=internal%2Fgoproxy%2Fdashc.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog#diff-aW50ZXJuYWwvZ29wcm94eS9kYXNoYy5nbw==) | `20.00% <ø> (ø)` | | | ... and [50 more](https://app.codecov.io/gh/DataDog/orchestrion/pull/288?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DataDog) | |