Skip to content

docs: record the symbol moves and behaviour changes from the v2 beta #1882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
james00012 merged 5 commits into from
Aug 10, 2026
Merged

docs: record the symbol moves and behaviour changes from the v2 beta #1882

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0e62b87
docs: record the symbol moves and behaviour changes from the v2 beta
james00012 Aug 5, 2026
50b2d41
chore: trim prose
james00012 Aug 5, 2026
10b9305
Merge branch 'main' into docs/v2-symbol-relocations
james00012 Aug 7, 2026
06962b8
chore: trim prose
james00012 Aug 7, 2026
d9360d8
Merge branch 'main' into docs/v2-symbol-relocations
james00012 Aug 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion docs/v2-import-map.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Terratest v2 Import Map

Status: FROZEN. The one open decision (renames) is resolved: the three hyphenated packages are renamed to idiomatic Go names at the `/v2` boundary.
Status: FROZEN for import paths. The one open decision (renames) is resolved: the three hyphenated packages are renamed to idiomatic Go names at the `/v2` boundary.

Some symbols also moved between modules during the beta. See [Symbols relocated during the v2 beta](#symbols-relocated-during-the-v2-beta).

Built from the actual v1 layout at tag `v1.0.1-test` (27 `modules/` packages, 2 `cmd/` binaries, 1 `internal/lib` tree).

Expand Down Expand Up @@ -66,6 +68,31 @@ So e.g. `modules/logger/parser` -> `modules/core/v2/logger/parser`, `modules/aws
|---|---|
| `internal/lib/formatting` | `internal/formatting` |

## Symbols relocated during the v2 beta

Moved to the module owning the type, so `teststructure` no longer requires `aws`, `k8s`, `packer` and `ssh` (#1877).
Signatures and on-disk filenames are unchanged, and every call site is a compile error.

| beta.1 | beta.2 onwards |
|---|---|
| `teststructure.{Save,Load}Ec2KeyPair` | `aws.{Save,Load}Ec2KeyPair` |
| `teststructure.{Save,Load}KubectlOptions` | `k8s.{Save,Load}KubectlOptions` |
| `teststructure.{Save,Load}PackerOptions` | `packer.{Save,Load}PackerOptions` |
| `teststructure.{Save,Load}SSHKeyPair` | `ssh.{Save,Load}SSHKeyPair` |

Nothing else moved. Watch for files that alias Terratest's `aws` because plain `aws` is the AWS SDK.

## Behaviour changes during the v2 beta

**Node addresses prefer `ExternalIP`** (#1878). `k8s.FindNodeHostnameContextE` and `GetServiceEndpoint` (NodePort)
now return the Node's `ExternalIP` when present, falling back to the internal hostname as before. On EKS that is the
public IP, so no EC2 call and no `ec2:DescribeInstances` permission is needed. Signatures are unchanged; the new
`FindNodeHostnameWithOptionsContext[E]` consults `NodePublicIPLookup` for clusters with no `ExternalIP`.

**`KubectlOptions` carrying a `RestConfig` no longer serializes** (#1879). `MarshalJSON` returns
`k8s.ErrRestConfigNotSerializable` instead of dropping the config. This already failed, with an opaque
`json: unsupported type: transport.WrapperFunc`. Use `NewKubectlOptions` or `NewKubectlOptionsWithInClusterAuth`.

## Accounting

27 `modules/` packages = 6 collapsed into core + 15 standalone submodules + 6 removed. Plus 2 removed `cmd/` binaries and 1 internal flatten. Submodule count: 16.
Expand Down
Loading