fix: create passed output location for generate commands (#1470)

Prior to this commit, if you supplied your own output location it needed
to already exist. This change makes it so the path will be created. We
still validate that the path, if it does exist, is a directory

Author: Matt Cadorette

cli/cmd/generate.go

@@ -179,8 +179,14 @@ func writeHclOutput(hcl string, location string, cloud string) (string, error) {
 		return "", err
 	}
 
+	// check if output location exists and if it's a file
+	outputDirLocation, err := os.Stat(dirname)
+	if !os.IsNotExist(err) && !outputDirLocation.IsDir() {
+		return "", fmt.Errorf("output location %s already exists and is a file", dirname)
+	}
+
 	// Create directory, if needed
-	if location == "" {
+	if os.IsNotExist(err) {
 		directory := filepath.FromSlash(dirname)
 		if _, err := os.Stat(directory); os.IsNotExist(err) {
 			err = os.MkdirAll(directory, 0700)
@@ -210,12 +216,12 @@ func validateOutputLocation(dirname string) error {
 	// If output location was supplied, validate it exists
 	if dirname != "" {
 		outputLocation, err := os.Stat(dirname)
-		if err != nil {
+		if err != nil && !os.IsNotExist(err) {
 			return errors.Wrap(err, "could not access specified output location")
 		}
 
-		if !outputLocation.IsDir() {
-			return errors.New("output location must be a directory")
+		if err == nil && !outputLocation.IsDir() {
+			return errors.New("output location already exists and is a file")
 		}
 	}
 

cli/cmd/generate_test.go

@@ -0,0 +1,96 @@
+package cmd
+
+import (
+	"fmt"
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestWriteHCLOutputLocation(t *testing.T) {
+	t.Run("should write output with existing directory", func(*testing.T) {
+		d, err := os.MkdirTemp("", "locationTest")
+		if err != nil {
+			panic(err)
+		}
+		defer os.RemoveAll(d)
+
+		_, err = writeHclOutput("", d, "")
+		assert.NoError(t, err)
+	})
+	t.Run("should create missing location directory", func(*testing.T) {
+		d, err := os.MkdirTemp("", "locationTest")
+		if err != nil {
+			panic(err)
+		}
+		defer os.RemoveAll(d)
+
+		location := fmt.Sprintf("%s/newplace", d)
+		_, err = writeHclOutput("", location, "")
+		assert.NoError(t, err)
+
+		statOut, err := os.Stat(location)
+		assert.NoError(t, err)
+		assert.True(t, statOut.IsDir())
+	})
+	t.Run("should fail on existing location of type file", func(*testing.T) {
+		d, err := os.MkdirTemp("", "locationTest")
+		if err != nil {
+			panic(err)
+		}
+		defer os.RemoveAll(d)
+
+		fileName := fmt.Sprintf("%s/testfile", d)
+		if err := os.WriteFile(fileName, []byte("test"), os.FileMode(0744)); err != nil {
+			panic(err)
+		}
+		_, err = writeHclOutput("", fileName, "")
+		assert.Error(t, err)
+	})
+	t.Run("should write to homedir location when not supplied", func(*testing.T) {
+		d, err := os.MkdirTemp("", "locationTest")
+		if err != nil {
+			panic(err)
+		}
+		h := os.Getenv("HOME")
+		os.Setenv("HOME", d)
+		defer func() {
+			os.Setenv("HOME", h)
+			os.RemoveAll(d)
+		}()
+
+		_, err = writeHclOutput("", "", "")
+		assert.NoError(t, err)
+		statOut, err := os.Stat(fmt.Sprintf("%s/lacework/main.tf", d))
+		assert.NoError(t, err)
+		assert.True(t, !statOut.IsDir())
+	})
+}
+
+func TestValidateOutputLocation(t *testing.T) {
+	t.Run("should validate existing dir location", func(t *testing.T) {
+		d, err := os.MkdirTemp("", "locationTest")
+		if err != nil {
+			panic(err)
+		}
+		defer os.RemoveAll(d)
+		assert.NoError(t, validateOutputLocation(d))
+	})
+	t.Run("should validate non-existent location", func(t *testing.T) {
+		assert.NoError(t, validateOutputLocation("/i/dont/exist"))
+	})
+	t.Run("should not validate existing file location", func(t *testing.T) {
+		d, err := os.MkdirTemp("", "locationTest")
+		if err != nil {
+			panic(err)
+		}
+		defer os.RemoveAll(d)
+
+		fileName := fmt.Sprintf("%s/testfile", d)
+		if err := os.WriteFile(fileName, []byte("test"), os.FileMode(0744)); err != nil {
+			panic(err)
+		}
+		assert.Error(t, validateOutputLocation(fileName))
+	})
+}