mirror of
https://github.com/opentffoundation/opentf.git
synced 2025-12-19 17:59:05 -05:00
d2bef1fd47
Previously we were using a third-party library, but that doesn't have any
support for passing context.Context through its API and so isn't suitable
for our goals of adding OpenTelemetry tracing for all outgoing network
requests.
We now have our own fork that is updated to use context.Context. It also
has a slightly reduced scope no longer including various details that
are tightly-coupled to our cliconfig mechanism and so better placed in the
main OpenTofu codebase so we can evolve it in future without making
lockstep library releases.
The "registry-address" library also uses svchost and uses some of its types
in its public API, so this also incorporates v2 of that library that is
updated to use our own svchost module.
Unfortunately this commit is a mix of mechanical updates to the new
libraries and some new code dealing with the functionality that is removed
in our fork of svchost. The new code is primarily in the "svcauthconfig"
package, which is similar in purpose "ociauthconfig" but for OpenTofu's
own auth mechanism instead of the OCI Distribution protocol's auth
mechanism.
This includes some additional plumbing of context.Context where it was
possible to do so without broad changes to files that would not otherwise
have been included in this commit, but there are a few leftover spots that
are context.TODO() which we'll address separately in later commits.
This removes the temporary workaround from d079da6e9e, since we are now
able to plumb the OpenTelemetry span tree all the way to the service
discovery requests.
Signed-off-by: Martin Atkins <mart@degeneration.co.uk>
52 lines
2.4 KiB
Go
52 lines
2.4 KiB
Go
// Copyright (c) The OpenTofu Authors
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
// Copyright (c) 2023 HashiCorp, Inc.
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
|
|
package addrs
|
|
|
|
import (
|
|
regaddr "github.com/opentofu/registry-address/v2"
|
|
)
|
|
|
|
// A ModulePackage represents a physical location where OpenTofu can retrieve
|
|
// a module package, which is an archive, repository, or other similar
|
|
// container which delivers the source code for one or more OpenTofu modules.
|
|
//
|
|
// A ModulePackage is a string in go-getter's address syntax. By convention,
|
|
// we use ModulePackage-typed values only for the result of successfully
|
|
// running the go-getter "detectors", which produces an address string which
|
|
// includes an explicit installation method prefix along with an address
|
|
// string in the format expected by that installation method.
|
|
//
|
|
// Note that although the "detector" phase of go-getter does do some simple
|
|
// normalization in certain cases, it isn't generally possible to compare
|
|
// two ModulePackage values to decide if they refer to the same package. Two
|
|
// equal ModulePackage values represent the same package, but there might be
|
|
// other non-equal ModulePackage values that also refer to that package, and
|
|
// there is no reliable way to determine that.
|
|
//
|
|
// Don't convert a user-provided string directly to ModulePackage. Instead,
|
|
// use ParseModuleSource with a remote module address and then access the
|
|
// ModulePackage value from the result, making sure to also handle the
|
|
// selected subdirectory if any. You should convert directly to ModulePackage
|
|
// only for a string that is hard-coded into the program (e.g. in a unit test)
|
|
// where you've ensured that it's already in the expected syntax.
|
|
type ModulePackage string
|
|
|
|
func (p ModulePackage) String() string {
|
|
return string(p)
|
|
}
|
|
|
|
// A ModuleRegistryPackage is an extra indirection over a ModulePackage where
|
|
// we use a module registry to translate a more symbolic address (and
|
|
// associated version constraint given out of band) into a physical source
|
|
// location.
|
|
//
|
|
// ModuleRegistryPackage is distinct from ModulePackage because they have
|
|
// disjoint use-cases: registry package addresses are only used to query a
|
|
// registry in order to find a real module package address. These being
|
|
// distinct is intended to help future maintainers more easily follow the
|
|
// series of steps in the module installer, with the help of the type checker.
|
|
type ModuleRegistryPackage = regaddr.ModulePackage
|