From 07b206db862b93c5405b2ca3c4e7c116a174c95b Mon Sep 17 00:00:00 2001
From: AndrewWinterman <113374170+AndrewWinterman@users.noreply.github.com>
Date: Mon, 14 Oct 2024 10:16:34 -0700
Subject: [PATCH] feat(cfg): env secret/string support (#592)

<!--
  !!!! README !!!! Please fill this out.

  Please follow conventional commit naming conventions:

  https://www.conventionalcommits.org/en/v1.0.0/#summary
-->

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for additional
information on contributing to this repository!

<!-- A short description of what your PR does and what it solves. -->
## What this PR does / why we need it


<!-- <<Stencil::Block(jiraPrefix)>> -->

## Jira ID

[XX-XX]

<!-- <</Stencil::Block>> -->

<!-- Notes that may be helpful for anyone reviewing this PR -->
## Notes for your reviewers

<!-- <<Stencil::Block(custom)>> -->

<!-- <</Stencil::Block>> -->

---------

Co-authored-by: Mark Lee <malept@users.noreply.github.com>
---
 pkg/cfg/env.go      | 33 ++++++++++++++++++++++++++++++
 pkg/cfg/env_test.go | 49 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 82 insertions(+)
 create mode 100644 pkg/cfg/env.go
 create mode 100644 pkg/cfg/env_test.go

diff --git a/pkg/cfg/env.go b/pkg/cfg/env.go
new file mode 100644
index 00000000..af648344
--- /dev/null
+++ b/pkg/cfg/env.go
@@ -0,0 +1,33 @@
+// Copyright 2024 Outreach Corporation. All Rights Reserved.
+
+// Description: Support for env loading env vars as strings or as SecretData
+
+package cfg
+
+import (
+	"os"
+
+	"github.com/pkg/errors"
+)
+
+// EnvSecret looks up a secret from the environment.
+func EnvSecret(name string) (SecretData, error) {
+	val, err := EnvString(name)
+	if err != nil {
+		return "", err
+	}
+	return SecretData(val), nil
+}
+
+// EnvString looks up a string from the environment.
+func EnvString(name string) (string, error) {
+	var (
+		ok  bool
+		val string
+	)
+	val, ok = os.LookupEnv(name)
+	if !ok {
+		return "", errors.Errorf("%q environment variable not set", name)
+	}
+	return val, nil
+}
diff --git a/pkg/cfg/env_test.go b/pkg/cfg/env_test.go
new file mode 100644
index 00000000..44edb8e4
--- /dev/null
+++ b/pkg/cfg/env_test.go
@@ -0,0 +1,49 @@
+package cfg
+
+import (
+	"os"
+	"testing"
+
+	"github.com/google/uuid"
+	"gotest.tools/v3/assert"
+)
+
+func TestEnvString(t *testing.T) {
+	key := uuid.NewString()
+	value := uuid.NewString()
+	notsetKey := uuid.NewString()
+	err := os.Setenv(key, value)
+	assert.NilError(t, err, "failed to set environment variable")
+
+	t.Run("if key not set; error is returned", func(t *testing.T) {
+		_, err := EnvString(notsetKey)
+		assert.ErrorContains(t, err, notsetKey)
+		assert.ErrorContains(t, err, "environment variable not set")
+	})
+
+	t.Run("returns set value", func(t *testing.T) {
+		v, err := EnvString(key)
+		assert.NilError(t, err)
+
+		assert.Equal(t, v, value)
+	})
+}
+
+func TestEnvSecret(t *testing.T) {
+	key := uuid.NewString()
+	value := uuid.NewString()
+	notsetKey := uuid.NewString()
+	err := os.Setenv(key, value)
+	assert.NilError(t, err, "failed to set environment variable")
+
+	t.Run("if key not set; error is returned", func(t *testing.T) {
+		_, err := EnvSecret(notsetKey)
+		assert.ErrorContains(t, err, notsetKey)
+		assert.ErrorContains(t, err, "environment variable not set")
+	})
+
+	v, err := EnvSecret(key)
+	assert.NilError(t, err)
+
+	assert.Equal(t, string(v), value)
+}