feat: require environment variables

Author: mtojek

provider/helpers/env.go

@@ -6,7 +6,13 @@ import (
 )
 
 // RequireEnv requires environment variable to be present.
+// The constraint can be verified only during execution of the workspace build
+// (determined with env `CODER_WORKSPACE_BUILD_ID`).
 func RequireEnv(name string) (string, error) {
+	if os.Getenv("CODER_WORKSPACE_BUILD_ID") == "" {
+		return os.Getenv(name), nil
+	}
+
 	val := os.Getenv(name)
 	if val == "" {
 		return "", fmt.Errorf("%s is required", name)

provider/workspace.go

@@ -62,13 +62,22 @@ func workspaceDataSource() *schema.Resource {
 			id := helpers.OptionalEnvOrDefault("CODER_WORKSPACE_ID", uuid.NewString())
 			rd.SetId(id)
 
-			templateID := helpers.OptionalEnv("CODER_WORKSPACE_TEMPLATE_ID") // FIXME switch to `helpers.RequireEnv(...)`
+			templateID, err := helpers.RequireEnv("CODER_WORKSPACE_TEMPLATE_ID")
+			if err != nil {
+				return diag.Errorf("template ID is missing: %w", err)
+			}
 			_ = rd.Set("template_id", templateID)
 
-			templateName := helpers.OptionalEnv("CODER_WORKSPACE_TEMPLATE_NAME") // FIXME switch to `helpers.RequireEnv(...)`
+			templateName, err := helpers.RequireEnv("CODER_WORKSPACE_TEMPLATE_NAME")
+			if err != nil {
+				return diag.Errorf("template name is missing: %w", err)
+			}
 			_ = rd.Set("template_name", templateName)
 
-			templateVersion := helpers.OptionalEnv("CODER_WORKSPACE_TEMPLATE_VERSION") // FIXME switch to `helpers.RequireEnv(...)`
+			templateVersion, err := helpers.RequireEnv("CODER_WORKSPACE_TEMPLATE_VERSION")
+			if err != nil {
+				return diag.Errorf("template version is missing: %w", err)
+			}
 			_ = rd.Set("template_version", templateVersion)
 
 			config, valid := i.(config)