Provider should properly failed when ansible-playbook executable is n…

…ot installed (#106) * Provider should properly failed when ansible-playbook executable is missing * adding changelog fragment (cherry picked from commit 34b158a)
ansible · Apr 24, 2024 · 9687665 · 9687665
1 parent 2a47805
commit 9687665
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 5 deletions.
diff --git a/changelogs/fragments/20240410-proper-failure-message-when-ansible-is-not-installed.yml b/changelogs/fragments/20240410-proper-failure-message-when-ansible-is-not-installed.yml
@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - resource/ansible_playbook - Provider should failed with proper message when ansible is not installed (https://github.com/ansible/terraform-provider-ansible/issues/35).
diff --git a/provider/resource_playbook.go b/provider/resource_playbook.go
@@ -9,6 +9,7 @@ import (
 	"time"
 
 	"github.com/ansible/terraform-provider-ansible/providerutils"
+	"github.com/hashicorp/terraform-plugin-log/tflog"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
@@ -512,7 +513,7 @@ func resourcePlaybookRead(ctx context.Context, data *schema.ResourceData, meta i
 	return diags
 }
 
-func resourcePlaybookUpdate(_ context.Context, data *schema.ResourceData, _ interface{}) diag.Diagnostics {
+func resourcePlaybookUpdate(ctx context.Context, data *schema.ResourceData, _ interface{}) diag.Diagnostics {
 	var diags diag.Diagnostics
 
 	name, okay := data.Get("name").(string)
@@ -552,7 +553,7 @@ func resourcePlaybookUpdate(_ context.Context, data *schema.ResourceData, _ inte
 		})
 	}
 
-	log.Printf("LOG [ansible-playbook]: playbook = %s", playbook)
+	tflog.Info(ctx, fmt.Sprintf("LOG [ansible-playbook]: playbook = %s", playbook))
 
 	ignorePlaybookFailure, okay := data.Get("ignore_playbook_failure").(bool)
 	if !okay {
@@ -604,10 +605,22 @@ func resourcePlaybookUpdate(_ context.Context, data *schema.ResourceData, _ inte
 		}
 	}
 
-	log.Printf("Temp Inventory File: %s", tempInventoryFile)
+	tflog.Debug(ctx, fmt.Sprintf("Temp Inventory File: %s", tempInventoryFile))
 
 	// ********************************* RUN PLAYBOOK ********************************
 
+	// Validate ansible-playbook binary
+	if _, validateBinPath := exec.LookPath(ansiblePlaybookBinary); validateBinPath != nil {
+		diags = append(diags, diag.Diagnostic{
+			Severity: diag.Error,
+			Summary:  fmt.Sprintf("ERROR [ansible-playbook]: couldn't find executable %s", ansiblePlaybookBinary),
+		})
+	}
+
+	if diags.HasError() {
+		return diags
+	}
+
 	args := []string{}
 
 	args = append(args, "-i", tempInventoryFile)
@@ -625,6 +638,7 @@ func resourcePlaybookUpdate(_ context.Context, data *schema.ResourceData, _ inte
 		args = append(args, tmpArg)
 	}
 
+	tflog.Info(ctx, fmt.Sprintf("Running Command <%s %s>", ansiblePlaybookBinary, strings.Join(args, " ")))
 	runAnsiblePlay := exec.Command(ansiblePlaybookBinary, args...)
 
 	runAnsiblePlayOut, runAnsiblePlayErr := runAnsiblePlay.CombinedOutput()
@@ -667,12 +681,12 @@ func resourcePlaybookUpdate(_ context.Context, data *schema.ResourceData, _ inte
 		})
 	}
 
-	log.Printf("LOG [ansible-playbook]: %s", runAnsiblePlayOut)
+	tflog.Debug(ctx, fmt.Sprintf("LOG [ansible-playbook]: %s", runAnsiblePlayOut))
 
 	// Wait for playbook execution to finish, then remove the temporary file
 	err := runAnsiblePlay.Wait()
 	if err != nil {
-		log.Printf("LOG [ansible-playbook]: didn't wait for playbook to execute: %v", err)
+		tflog.Error(ctx, fmt.Sprintf("LOG [ansible-playbook]: didn't wait for playbook to execute: %v", err))
 	}
 
 	diagsFromUtils := providerutils.RemoveFile(tempInventoryFile)