feat: Added the Go code for the EnvEnsure() function.

Author: skyzyx

corefunc/env_ensure.go

@@ -0,0 +1,23 @@
+package corefunc
+
+import (
+	"errors"
+	"os"
+)
+
+/*
+EnvEnsure ensures that a given environment variable is set to a non-empty value.
+If the environment variable is unset or if it is set to an empty string,
+EnvEnsure will respond with an error.
+
+----
+
+* name (string): The name of the environment variable to check.
+*/
+func EnvEnsure(name string) error {
+	if os.Getenv(name) == "" {
+		return errors.New("environment variable " + name + " is not defined") // lint:allow_errorf
+	}
+
+	return nil
+}

corefunc/env_ensure_test.go

@@ -0,0 +1,84 @@
+package corefunc
+
+import (
+	"fmt"
+	"os"
+	"testing"
+
+	"github.com/northwood-labs/terraform-provider-corefunc/testfixtures"
+	"github.com/stretchr/testify/assert"
+)
+
+func ExampleEnvEnsure() {
+	_ = os.Setenv("MY_ENV_VAR_VALUE", "abcd1234")
+	_ = os.Setenv("MY_ENV_VAR_EMPTY", "")
+
+	err := EnvEnsure("MY_ENV_VAR_VALUE")
+	fmt.Println(err)
+
+	err = EnvEnsure("MY_ENV_VAR_EMPTY")
+	fmt.Println(err)
+
+	err = EnvEnsure("MY_ENV_VAR_NOT_SET")
+	fmt.Println(err)
+	// Output:
+	// <nil>
+	// environment variable MY_ENV_VAR_EMPTY is not defined
+	// environment variable MY_ENV_VAR_NOT_SET is not defined
+}
+
+func TestEnvEnsure(t *testing.T) {
+	for name, tc := range testfixtures.EnvEnsureTestTable {
+		t.Run(name, func(t *testing.T) {
+			_ = os.Setenv(tc.EnvVarName, tc.SetValue)
+			err := EnvEnsure(tc.EnvVarName)
+
+			if tc.ExpectedErr != nil {
+				expectedErrorMsg := tc.ExpectedErr.Error()
+				assert.EqualErrorf(t, err, expectedErrorMsg, "Error should be: %v, got: %v", expectedErrorMsg, err)
+			}
+		})
+	}
+}
+
+func BenchmarkEnvEnsure(b *testing.B) {
+	b.ReportAllocs()
+	for name, tc := range testfixtures.EnvEnsureTestTable {
+		_ = os.Setenv(tc.EnvVarName, tc.SetValue)
+
+		b.Run(name, func(b *testing.B) {
+			b.ResetTimer()
+			for i := 0; i < b.N; i++ {
+				EnvEnsure(tc.EnvVarName)
+			}
+		})
+	}
+}
+
+func BenchmarkEnvEnsureParallel(b *testing.B) {
+	b.ReportAllocs()
+	for name, tc := range testfixtures.EnvEnsureTestTable {
+		_ = os.Setenv(tc.EnvVarName, tc.SetValue)
+
+		b.Run(name, func(b *testing.B) {
+			b.ResetTimer()
+			b.RunParallel(func(pb *testing.PB) {
+				for pb.Next() {
+					EnvEnsure(tc.EnvVarName)
+				}
+			})
+		})
+	}
+}
+
+func FuzzEnvEnsure(f *testing.F) {
+	for _, tc := range testfixtures.EnvEnsureTestTable {
+		f.Add(tc.EnvVarName)
+	}
+
+	f.Fuzz(
+		func(t *testing.T, envVarName string) {
+			_ = EnvEnsure(envVarName)
+		},
+	)
+}

corefunc/truncate_label.go

@@ -32,9 +32,6 @@ shared prefix, but also truncate them appropriately to fit length
 constraints.
 */
 func TruncateLabel(maxLength int64, prefix, label string) string {
-	// origName := fmt.Sprintf("%s: %s", prefix, label)
-	// strLen := int64(len(origName))
-
 	// None.
 	if maxLength == 0 {
 		return ""
@@ -77,12 +74,6 @@ func TruncateLabel(maxLength int64, prefix, label string) string {
 		trimmedLabel := label[:removeFromLabelLength]
 
 		return strings.TrimSpace(trimmedPrefix) + "…: " + strings.TrimSpace(trimmedLabel) + "…"
-
-		// return fmt.Sprintf(
-		// 	"%s…: %s…",
-		// 	strings.TrimSpace(trimmedPrefix),
-		// 	strings.TrimSpace(trimmedLabel),
-		// )
 	}
 
 	return origName

testfixtures/env_ensure.go

@@ -0,0 +1,63 @@
+package testfixtures
+
+import "errors"
+
+// EnvEnsureTestTable is used by both the standard Go tests and also the
+// Terraform acceptance tests.
+// <https://github.com/golang/go/wiki/TableDrivenTests>
+var EnvEnsureTestTable = map[string]struct {
+	EnvVarName  string
+	SetValue    string
+	ExpectedErr error
+}{
+	"AWS_DEFAULT_REGION": {
+		EnvVarName:  "AWS_DEFAULT_REGION",
+		SetValue:    "us-east-1",
+		ExpectedErr: nil,
+	},
+	"AWS_REGION": {
+		EnvVarName:  "AWS_REGION",
+		SetValue:    "us-east-1",
+		ExpectedErr: nil,
+	},
+	"AWS_PAGER": {
+		EnvVarName:  "AWS_PAGER",
+		SetValue:    "",
+		ExpectedErr: errors.New("environment variable AWS_PAGER is not defined"), // lint:allow_errorf
+	},
+	"BREW_PREFIX": {
+		EnvVarName:  "BREW_PREFIX",
+		SetValue:    "/opt/homebrew",
+		ExpectedErr: nil,
+	},
+	"GO111MODULE": {
+		EnvVarName:  "GO111MODULE",
+		SetValue:    "on",
+		ExpectedErr: nil,
+	},
+	"LANG": {
+		EnvVarName:  "LANG",
+		SetValue:    "en_US.UTF-8",
+		ExpectedErr: nil,
+	},
+	"LC_ALL": {
+		EnvVarName:  "LC_ALL",
+		SetValue:    "en_US.UTF-8",
+		ExpectedErr: nil,
+	},
+	"LSCOLORS": {
+		EnvVarName:  "LSCOLORS",
+		SetValue:    "gxBxhxDxfxhxhxhxhxcxcx",
+		ExpectedErr: nil,
+	},
+	"SHELL": {
+		EnvVarName:  "SHELL",
+		SetValue:    "/opt/homebrew/bin/bash",
+		ExpectedErr: nil,
+	},
+	"TERM": {
+		EnvVarName:  "TERM",
+		SetValue:    "xterm-256color",
+		ExpectedErr: nil,
+	},
+}