deprecate git, version-checker, and slack packages (#1838)

* deprecate git, version-checker, and slack packages

Per the Terratest V2 proposal, these packages are scheduled for removal in v2:
git (each helper wraps a single git command), version-checker (marginal value
over shelling out), and slack (out of scope for an IaC testing library).

- Add // Deprecated: notices to every exported symbol in all three packages.
- git has in-repo callers, so migrate them off it in the same change to avoid
  staticcheck SA1019 in CI: test-structure and the docker/opa tests now shell
  out to git directly with os/exec.

version-checker and slack have no in-repo callers, so those are
annotation-only. No behavior change; the packages keep working for v1.

* Show stdlib replacements in deprecation comments

Address review: each // Deprecated: comment on git/version-checker/slack now demos the concrete replacement (the exact git command via os/exec, the version regexp + go-version check, the slack-go client call) so users can pattern-match from the IDE hover. Also drop the dead 'migration notes' links in favor of stating there's no public replacement.

* git: correct the detached-HEAD note on the rev-parse demo

git rev-parse --abbrev-ref HEAD prints "HEAD" (not empty) when detached; the real code maps it to "". Fix the demo so a user copying it doesn't get the wrong result. (Two-agent review.)

* Fix wsl lint failures in the git caller migrations

Add the blank lines golangci-lint's wsl_v5 rule requires before the if and the assignments in the inlined git replacements (docker, opa, test-structure). Verified with golangci-lint 2.11.3: 0 issues.

Author: james00012

modules/docker/build_test.go

@@ -1,11 +1,11 @@
 package docker_test
 
 import (
+	"os/exec"
 	"strings"
 	"testing"
 
 	"github.com/gruntwork-io/terratest/modules/docker"
-	"github.com/gruntwork-io/terratest/modules/git"
 	"github.com/gruntwork-io/terratest/modules/logger"
 	"github.com/gruntwork-io/terratest/modules/random"
 	"github.com/stretchr/testify/require"
@@ -102,9 +102,15 @@ func TestGitCloneAndBuild(t *testing.T) {
 
 	ctx := t.Context()
 
-	gitBranchName := git.GetCurrentBranchNameContext(t, ctx, "")
-	if gitBranchName == "" {
-		logger.Default.Logf(t, "WARNING: git.GetCurrentBranchNameContext returned an empty string; falling back to main")
+	branchOut, err := exec.CommandContext(ctx, "git", "branch", "--show-current").Output()
+	gitBranchName := ""
+
+	if err == nil {
+		gitBranchName = strings.TrimSpace(string(branchOut))
+	}
+
+	if gitBranchName == "" || gitBranchName == "HEAD" {
+		logger.Default.Logf(t, "WARNING: could not determine the current git branch; falling back to main")
 
 		gitBranchName = "main"
 	}

modules/git/git.go

@@ -1,4 +1,9 @@
 // Package git allows to interact with Git.
+//
+// Deprecated: The git package is scheduled for removal in Terratest v2. Each
+// helper here wraps a single git command (for example, git rev-parse or
+// git describe); call git directly with os/exec instead. There is no public
+// replacement; the package is being dropped.
 package git
 
 import (
@@ -14,9 +19,8 @@ import (
 // GetCurrentBranchName retrieves the current branch name or an empty string
 // in case of detached state. Fails the test if an error occurs.
 //
-// Deprecated: Use [GetCurrentBranchNameContext] instead, which supports context
-// cancellation and accepts an explicit working directory rather than relying on
-// the process working directory.
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly, e.g.
+// exec.Command("git", "branch", "--show-current").Output() (empty when detached).
 func GetCurrentBranchName(t testing.TestingT) string {
 	return GetCurrentBranchNameContext(t, context.Background(), "")
 }
@@ -25,6 +29,9 @@ func GetCurrentBranchName(t testing.TestingT) string {
 // string in case of detached state. The dir parameter specifies the working
 // directory for the git command; if empty, the process working directory is
 // used. Fails the test if an error occurs.
+//
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly, e.g.
+// exec.CommandContext(ctx, "git", "branch", "--show-current") with cmd.Dir = dir, then .Output().
 func GetCurrentBranchNameContext(t testing.TestingT, ctx context.Context, dir string) string {
 	out, err := GetCurrentBranchNameContextE(t, ctx, dir)
 	if err != nil {
@@ -38,9 +45,8 @@ func GetCurrentBranchNameContext(t testing.TestingT, ctx context.Context, dir st
 // in case of detached state. Uses git branch --show-current, which was
 // introduced in git v2.22. Falls back to git rev-parse for older versions.
 //
-// Deprecated: Use [GetCurrentBranchNameContextE] instead, which supports
-// context cancellation and accepts an explicit working directory rather than
-// relying on the process working directory.
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly, e.g.
+// exec.Command("git", "branch", "--show-current").Output() (empty when detached).
 func GetCurrentBranchNameE(t testing.TestingT) (string, error) {
 	return GetCurrentBranchNameContextE(t, context.Background(), "")
 }
@@ -50,6 +56,9 @@ func GetCurrentBranchNameE(t testing.TestingT) (string, error) {
 // introduced in git v2.22. Falls back to git rev-parse for older versions.
 // The dir parameter specifies the working directory for the git command; if
 // empty, the process working directory is used.
+//
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly, e.g.
+// exec.CommandContext(ctx, "git", "branch", "--show-current") with cmd.Dir = dir, then .Output().
 func GetCurrentBranchNameContextE(t testing.TestingT, ctx context.Context, dir string) (string, error) {
 	cmd := exec.CommandContext(ctx, "git", "branch", "--show-current")
 	cmd.Dir = dir
@@ -70,9 +79,8 @@ func GetCurrentBranchNameContextE(t testing.TestingT, ctx context.Context, dir s
 // GetCurrentBranchNameOldE retrieves the current branch name or an empty
 // string in case of detached state using git rev-parse --abbrev-ref HEAD.
 //
-// Deprecated: Use [GetCurrentBranchNameOldContextE] instead, which supports
-// context cancellation and accepts an explicit working directory rather than
-// relying on the process working directory.
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly, e.g.
+// exec.Command("git", "rev-parse", "--abbrev-ref", "HEAD").Output() (prints "HEAD" when detached; map it to "").
 func GetCurrentBranchNameOldE(t testing.TestingT) (string, error) {
 	return GetCurrentBranchNameOldContextE(t, context.Background(), "")
 }
@@ -82,6 +90,9 @@ func GetCurrentBranchNameOldE(t testing.TestingT) (string, error) {
 // This is a fallback for git versions older than v2.22 that lack
 // git branch --show-current. The dir parameter specifies the working directory
 // for the git command; if empty, the process working directory is used.
+//
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly, e.g.
+// exec.CommandContext(ctx, "git", "rev-parse", "--abbrev-ref", "HEAD") with cmd.Dir = dir, then .Output().
 func GetCurrentBranchNameOldContextE(t testing.TestingT, ctx context.Context, dir string) (string, error) {
 	cmd := exec.CommandContext(ctx, "git", "rev-parse", "--abbrev-ref", "HEAD")
 	cmd.Dir = dir
@@ -103,9 +114,8 @@ func GetCurrentBranchNameOldContextE(t testing.TestingT, ctx context.Context, di
 // (non-annotated) tag, or exact tag value if the tag points to the current
 // commit. Fails the test if an error occurs.
 //
-// Deprecated: Use [GetCurrentGitRefContext] instead, which supports context
-// cancellation and accepts an explicit working directory rather than relying on
-// the process working directory.
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly: try
+// git branch --show-current, then git describe --tags when detached.
 func GetCurrentGitRef(t testing.TestingT) string {
 	return GetCurrentGitRefContext(t, context.Background(), "")
 }
@@ -115,6 +125,9 @@ func GetCurrentGitRef(t testing.TestingT) string {
 // commit. The dir parameter specifies the working directory for the git
 // command; if empty, the process working directory is used. Fails the test if
 // an error occurs.
+//
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly: try
+// git branch --show-current, then git describe --tags when detached (set cmd.Dir = dir).
 func GetCurrentGitRefContext(t testing.TestingT, ctx context.Context, dir string) string {
 	out, err := GetCurrentGitRefContextE(t, ctx, dir)
 	if err != nil {
@@ -128,9 +141,8 @@ func GetCurrentGitRefContext(t testing.TestingT, ctx context.Context, dir string
 // (non-annotated) tag, or exact tag value if the tag points to the current
 // commit.
 //
-// Deprecated: Use [GetCurrentGitRefContextE] instead, which supports context
-// cancellation and accepts an explicit working directory rather than relying on
-// the process working directory.
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly: try
+// git branch --show-current, then git describe --tags when detached.
 func GetCurrentGitRefE(t testing.TestingT) (string, error) {
 	return GetCurrentGitRefContextE(t, context.Background(), "")
 }
@@ -139,6 +151,9 @@ func GetCurrentGitRefE(t testing.TestingT) (string, error) {
 // (non-annotated) tag, or exact tag value if the tag points to the current
 // commit. The dir parameter specifies the working directory for the git
 // command; if empty, the process working directory is used.
+//
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly: try
+// git branch --show-current, then git describe --tags when detached (set cmd.Dir = dir).
 func GetCurrentGitRefContextE(t testing.TestingT, ctx context.Context, dir string) (string, error) {
 	out, err := GetCurrentBranchNameContextE(t, ctx, dir)
 	if err != nil {
@@ -160,9 +175,8 @@ func GetCurrentGitRefContextE(t testing.TestingT, ctx context.Context, dir strin
 // GetTagE retrieves the lightweight (non-annotated) tag or exact tag value if
 // the tag points to the current commit.
 //
-// Deprecated: Use [GetTagContextE] instead, which supports context
-// cancellation and accepts an explicit working directory rather than relying on
-// the process working directory.
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly, e.g.
+// exec.Command("git", "describe", "--tags").Output().
 func GetTagE(t testing.TestingT) (string, error) {
 	return GetTagContextE(t, context.Background(), "")
 }
@@ -171,6 +185,9 @@ func GetTagE(t testing.TestingT) (string, error) {
 // value if the tag points to the current commit. The dir parameter specifies
 // the working directory for the git command; if empty, the process working
 // directory is used.
+//
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly, e.g.
+// exec.CommandContext(ctx, "git", "describe", "--tags") with cmd.Dir = dir, then .Output().
 func GetTagContextE(t testing.TestingT, ctx context.Context, dir string) (string, error) {
 	cmd := exec.CommandContext(ctx, "git", "describe", "--tags")
 	cmd.Dir = dir
@@ -186,16 +203,18 @@ func GetTagContextE(t testing.TestingT, ctx context.Context, dir string) (string
 // GetRepoRoot retrieves the path to the root directory of the repo. Fails the
 // test if there is an error.
 //
-// Deprecated: Use [GetRepoRootContext] instead, which supports context
-// cancellation and accepts an explicit working directory rather than relying on
-// the process working directory.
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly, e.g.
+// exec.Command("git", "rev-parse", "--show-toplevel").Output().
 func GetRepoRoot(t testing.TestingT) string {
 	return GetRepoRootContext(t, context.Background(), "")
 }
 
 // GetRepoRootContext retrieves the path to the root directory of the repo. The
 // dir parameter specifies the working directory for the git command; if empty,
 // the process working directory is used. Fails the test if there is an error.
+//
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly, e.g.
+// exec.CommandContext(ctx, "git", "rev-parse", "--show-toplevel") with cmd.Dir = dir, then .Output().
 func GetRepoRootContext(t testing.TestingT, ctx context.Context, dir string) string {
 	out, err := GetRepoRootContextE(t, ctx, dir)
 	require.NoError(t, err)
@@ -205,16 +224,18 @@ func GetRepoRootContext(t testing.TestingT, ctx context.Context, dir string) str
 
 // GetRepoRootE retrieves the path to the root directory of the repo.
 //
-// Deprecated: Use [GetRepoRootContextE] instead, which supports context
-// cancellation and accepts an explicit working directory rather than relying on
-// the process working directory.
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly, e.g.
+// exec.Command("git", "rev-parse", "--show-toplevel").Output().
 func GetRepoRootE(t testing.TestingT) (string, error) {
 	return GetRepoRootContextE(t, context.Background(), "")
 }
 
 // GetRepoRootContextE retrieves the path to the root directory of the repo.
 // The dir parameter specifies the working directory for the git command; if
 // empty, the process working directory is used.
+//
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly, e.g.
+// exec.CommandContext(ctx, "git", "rev-parse", "--show-toplevel") with cmd.Dir = dir, then .Output().
 func GetRepoRootContextE(t testing.TestingT, ctx context.Context, dir string) (string, error) {
 	if dir == "" {
 		cwd, err := os.Getwd()
@@ -231,14 +252,17 @@ func GetRepoRootContextE(t testing.TestingT, ctx context.Context, dir string) (s
 // GetRepoRootForDir retrieves the path to the root directory of the repo in
 // which dir resides. Fails the test if there is an error.
 //
-// Deprecated: Use [GetRepoRootForDirContext] instead, which supports context
-// cancellation.
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly, e.g.
+// exec.Command("git", "rev-parse", "--show-toplevel") with cmd.Dir = dir, then .Output().
 func GetRepoRootForDir(t testing.TestingT, dir string) string {
 	return GetRepoRootForDirContext(t, context.Background(), dir)
 }
 
 // GetRepoRootForDirContext retrieves the path to the root directory of the
 // repo in which dir resides. Fails the test if there is an error.
+//
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly, e.g.
+// exec.CommandContext(ctx, "git", "rev-parse", "--show-toplevel") with cmd.Dir = dir, then .Output().
 func GetRepoRootForDirContext(t testing.TestingT, ctx context.Context, dir string) string {
 	out, err := GetRepoRootForDirContextE(t, ctx, dir)
 	require.NoError(t, err)
@@ -249,14 +273,17 @@ func GetRepoRootForDirContext(t testing.TestingT, ctx context.Context, dir strin
 // GetRepoRootForDirE retrieves the path to the root directory of the repo in
 // which dir resides.
 //
-// Deprecated: Use [GetRepoRootForDirContextE] instead, which supports context
-// cancellation.
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly, e.g.
+// exec.Command("git", "rev-parse", "--show-toplevel") with cmd.Dir = dir, then .Output().
 func GetRepoRootForDirE(t testing.TestingT, dir string) (string, error) {
 	return GetRepoRootForDirContextE(t, context.Background(), dir)
 }
 
 // GetRepoRootForDirContextE retrieves the path to the root directory of the
 // repo in which dir resides.
+//
+// Deprecated: scheduled for removal in Terratest v2. Shell out to git directly, e.g.
+// exec.CommandContext(ctx, "git", "rev-parse", "--show-toplevel") with cmd.Dir = dir, then .Output().
 func GetRepoRootForDirContextE(t testing.TestingT, ctx context.Context, dir string) (string, error) {
 	cmd := exec.CommandContext(ctx, "git", "rev-parse", "--show-toplevel")
 	cmd.Dir = dir

modules/opa/download_policy_test.go

@@ -2,6 +2,7 @@ package opa_test
 
 import (
 	"os"
+	"os/exec"
 	"path/filepath"
 	"strings"
 	"sync"
@@ -11,7 +12,6 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"github.com/gruntwork-io/terratest/modules/files"
-	"github.com/gruntwork-io/terratest/modules/git"
 	"github.com/gruntwork-io/terratest/modules/opa"
 )
 
@@ -30,7 +30,19 @@ func TestDownloadPolicyReturnsLocalPath(t *testing.T) {
 func TestDownloadPolicyDownloadsRemote(t *testing.T) {
 	t.Parallel()
 
-	curRef := git.GetCurrentGitRefContext(t, t.Context(), "")
+	ctx := t.Context()
+
+	branchOut, err := exec.CommandContext(ctx, "git", "branch", "--show-current").Output()
+	require.NoError(t, err)
+
+	curRef := strings.TrimSpace(string(branchOut))
+	if curRef == "" || curRef == "HEAD" {
+		tagOut, err := exec.CommandContext(ctx, "git", "describe", "--tags").Output()
+		require.NoError(t, err)
+
+		curRef = strings.TrimSpace(string(tagOut))
+	}
+
 	baseDir := "git::https://github.com/gruntwork-io/terratest.git?ref=" + curRef
 	localPath := "../../examples/terraform-opa-example/policy/enforce_source.rego"
 	remotePath := "git::https://github.com/gruntwork-io/terratest.git//examples/terraform-opa-example/policy/enforce_source.rego?ref=" + curRef

modules/slack/doc.go

@@ -1,2 +1,7 @@
 // Package slack contains routines useful for testing slack integrations.
+//
+// Deprecated: The slack package is scheduled for removal in Terratest v2. Slack
+// validation is out of scope for an infrastructure testing library; use the
+// github.com/slack-go/slack client directly if you need it. There is no public
+// replacement; the package is being dropped.
 package slack

modules/slack/validate.go

@@ -18,6 +18,15 @@ import (
 // - Header block text
 // All other blocks are ignored in the validation.
 // NOTE: This only looks for bot posted messages.
+//
+// Deprecated: scheduled for removal in Terratest v2. Use the slack-go client directly, e.g.:
+//
+//	client := slack.New(token)
+//	resp, err := client.GetConversationHistory(&slack.GetConversationHistoryParameters{
+//		ChannelID: channelID,
+//		Limit:     historyLimit,
+//	})
+//	// then scan resp.Messages for the expected text.
 func ValidateExpectedSlackMessageE(
 	t testing.TestingT,
 	token,
@@ -96,6 +105,8 @@ func checkMessageContainsText(msg *slack.Msg, expectedText string) bool {
 }
 
 // MessageNotFoundErr is returned when the expected text cannot be found in any of the messages posted in a Slack channel.
+//
+// Deprecated: scheduled for removal in Terratest v2 along with the slack package.
 type MessageNotFoundErr struct{}
 
 func (err MessageNotFoundErr) Error() string {

modules/test-structure/test_structure.go

@@ -14,11 +14,10 @@ import (
 	"context"
 	"fmt"
 	"os"
+	"os/exec"
 	"path/filepath"
 	"strings"
 
-	"github.com/gruntwork-io/terratest/modules/git"
-
 	go_test "testing"
 
 	"github.com/gruntwork-io/terratest/modules/files"
@@ -253,10 +252,14 @@ func runValidateOnAllTerraformModulesContext(
 ) {
 	t.Helper()
 
-	// Find the Git root
-	gitRoot, err := git.GetRepoRootForDirContextE(t, ctx, opts.RootDir)
+	// Find the Git root by shelling out to git rev-parse from the target directory.
+	gitRootCmd := exec.CommandContext(ctx, "git", "rev-parse", "--show-toplevel")
+	gitRootCmd.Dir = opts.RootDir
+	gitRootOut, err := gitRootCmd.Output()
 	require.NoError(t, err)
 
+	gitRoot := strings.TrimSpace(string(gitRootOut))
+
 	// Find the relative path between the root dir and the git root
 	relPath, err := filepath.Rel(gitRoot, opts.RootDir)
 	require.NoError(t, err)