more tests added

Author: Josh-Tracy

epic/resouce_random_name.go

@@ -48,10 +48,20 @@ func resourceRandomName() *schema.Resource {
 	}
 }
 
+// FOR TESTING ONLY!!
+func getDataDirPath() string {
+	dataDir := os.Getenv("DATA_DIR") // Set to "../data" for go tests
+	if dataDir == "" {
+		dataDir = "data" // Default is "data" because that is what is required for users consuming the provider
+	}
+	return dataDir
+}
+
 func loadNames(mediaType, title string) ([]string, error) {
 	sanitizedTitle := strings.ReplaceAll(title, " ", "_")
 	fileName := fmt.Sprintf("%s.json", sanitizedTitle)
-	filePath := filepath.Join("data", mediaType, fileName)
+	dataDirPath := filepath.FromSlash(getDataDirPath())
+	filePath := filepath.Join(dataDirPath, mediaType, fileName)
 
 	data, err := os.ReadFile(filePath)
 	if err != nil {

epic/resource_random_name_test.go

@@ -1,6 +1,7 @@
 package epic
 
 import (
+	"regexp"
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -9,6 +10,14 @@ import (
 
 // Acceptance tests. Set TF_ACC=1 env variable to enable.
 func TestAccEpicRandomName_basic(t *testing.T) {
+
+	// $env:DATA_DIR = "../data" or export DATA_DIR="../data"
+	dataDir := getDataDirPath()
+
+	if err := LoadAndCacheMediaTypes(dataDir); err != nil {
+		t.Fatalf("Failed to load media types: %v", err)
+	}
+
 	resource.Test(t, resource.TestCase{
 		Providers: map[string]*schema.Provider{
 			"epic": Provider(),
@@ -21,6 +30,14 @@ func TestAccEpicRandomName_basic(t *testing.T) {
 					resource.TestCheckResourceAttr("epic_random_name.test", "title", "lord of the rings"),
 				),
 			},
+			{
+				Config:      testAccCheckEpicRandomNameConfig_invalidMediaType(),
+				ExpectError: regexp.MustCompile(`'not_a_real_media' is not a recognized media type`),
+			},
+			{
+				Config:      testAccCheckEpicRandomNameConfig_invalidTitle(),
+				ExpectError: regexp.MustCompile(`'fake_title' is not a valid title for media type 'movie'`),
+			},
 		},
 	})
 }
@@ -35,3 +52,25 @@ resource "epic_random_name" "test" {
 }
 `
 }
+
+func testAccCheckEpicRandomNameConfig_invalidMediaType() string {
+	return `
+provider "epic" {}
+
+resource "epic_random_name" "test_invalid_media_type" {
+    media_type = "not_a_real_media"
+    title      = "lord of the rings"
+}
+`
+}
+
+func testAccCheckEpicRandomNameConfig_invalidTitle() string {
+	return `
+provider "epic" {}
+
+resource "epic_random_name" "test_invalid_title" {
+    media_type = "movie"
+    title      = "fake_title"
+}
+`
+}

epic/validate_data.go

@@ -11,6 +11,10 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
+// validate_data.go ensures that the map of media_types to titles is cached during the plan.
+// I'm not actually sure if this carries over to the apply?
+// It also validates that the media_types in the /data directory contain a title provided as an input.
+
 var mediaTypeCache map[string]map[string][]string
 var cacheLoaded bool
 
@@ -23,11 +27,13 @@ type MediaTypeData struct {
 // LoadMediaTypes scans the specified dataDir directory, reads each subdirectory as a media type,
 // and loads each JSON file in those subdirectories as titles of that media type.
 func LoadMediaTypes(dataDir string) (map[string]map[string][]string, error) {
+
 	// This map will hold the media type as key and a map of titles with their names as value.
 	mediaTypes := make(map[string]map[string][]string)
 
 	// Read the main data directory.
-	entries, err := os.ReadDir(dataDir)
+	dataDirPath := filepath.FromSlash(dataDir)
+	entries, err := os.ReadDir(dataDirPath)
 	if err != nil {
 		return nil, fmt.Errorf("failed to read data directory: %v", err)
 	}
@@ -36,7 +42,7 @@ func LoadMediaTypes(dataDir string) (map[string]map[string][]string, error) {
 	for _, entry := range entries {
 		if entry.IsDir() {
 			mediaType := entry.Name()
-			mediaPath := filepath.Join(dataDir, mediaType)
+			mediaPath := filepath.Join(dataDirPath, mediaType)
 			mediaTypeMap := make(map[string][]string)
 
 			// Read files within the media type directory.
@@ -59,6 +65,7 @@ func LoadMediaTypes(dataDir string) (map[string]map[string][]string, error) {
 					}
 
 					// Use the title from the JSON or the filename without extension as a fallback.
+					// I actually don't know if this will cause unexpected outcomes for users? We shall see.
 					title := mediaData.Title
 					if title == "" {
 						title = strings.TrimSuffix(file.Name(), ".json")
@@ -79,6 +86,7 @@ func LoadMediaTypes(dataDir string) (map[string]map[string][]string, error) {
 	return mediaTypes, nil
 }
 
+// Function to load media_type to title mapping from cache if the cache is not considered loaded already.
 func LoadAndCacheMediaTypes(dataDir string) error {
 	if !cacheLoaded {
 		var err error
@@ -91,35 +99,39 @@ func LoadAndCacheMediaTypes(dataDir string) error {
 	return nil
 }
 
+// Function called by customizeDiff: during resource creation
 func customValidateMediaTypeAndTitle(ctx context.Context, diff *schema.ResourceDiff, v interface{}) error {
 	mediaType := diff.Get("media_type").(string)
 	title := diff.Get("title").(string)
 
-	if !isValidMediaTypeAndTitle(mediaType, title) {
-		return fmt.Errorf("'%s' is not a valid title for media type '%s'", title, mediaType)
+	isValid, errMsg := isValidMediaTypeAndTitle(mediaType, title)
+	if !isValid {
+		return fmt.Errorf(errMsg)
 	}
 
 	return nil
 }
 
-func isValidMediaTypeAndTitle(mediaType, title string) bool {
+// Function to validate that the user provided media_type and title are valid or not
+func isValidMediaTypeAndTitle(mediaType, title string) (bool, string) {
 	if !cacheLoaded {
 		if err := LoadAndCacheMediaTypes("data"); err != nil {
-			fmt.Printf("Error loading media types: %v\n", err)
-			return false
+			return false, fmt.Sprintf("error loading media types: %v", err)
 		}
 	}
 
+	// Check if the media_type is valid
 	titlesMap, ok := mediaTypeCache[mediaType]
 	if !ok {
-		return false
+		return false, fmt.Sprintf("'%s' is not a recognized media type", mediaType)
 	}
 
+	// Check if the title is valid for the given media_type
 	for t := range titlesMap {
 		if strings.EqualFold(t, title) {
-			return true
+			return true, ""
 		}
 	}
 
-	return false
+	return false, fmt.Sprintf("'%s' is not a valid title for media type '%s'", title, mediaType)
 }