Skip to content

Change to throw CommandException when throwing on substitution failure #2048

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
APErebus merged 1 commit into from
Jun 29, 2026
Merged

Change to throw CommandException when throwing on substitution failure #2048

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions source/Calamari.Common/Features/Substitutions/FileSubstituter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
using System;
using System.Text;
using Calamari.Common.Commands;
using Calamari.Common.Plumbing.FileSystem;
using Calamari.Common.Plumbing.Logging;
using Calamari.Common.Plumbing.Variables;
Expand All @@ -22,7 +23,7 @@ public FileSubstituter(ILog log, ICalamariFileSystem fileSystem, IVariables vari
public void PerformSubstitution(string sourceFile)
=> PerformSubstitution(sourceFile, sourceFile);

public void PerformSubstitution(string sourceFile, string targetFile)
public void PerformSubstitution(string sourceFile, string targetFile)
=> PerformSubstitutionAndUpdateFile(sourceFile, targetFile, variables.GetFlag(KnownVariables.ShouldFailDeploymentOnSubstitutionFails));

protected virtual void PerformSubstitutionAndUpdateFile(string sourceFile, string targetFile, bool throwOnError, bool throwPlainOctostacheError = false)
Expand All @@ -36,15 +37,14 @@ protected virtual void PerformSubstitutionAndUpdateFile(string sourceFile, strin

if (!string.IsNullOrEmpty(error))
{
var errorMessage = $"Parsing file '{sourceFile}' with Octostache returned the following error: `{error}`";
if (throwOnError)
{
var message = !throwPlainOctostacheError
? $"Parsing file '{sourceFile}' with Octostache returned the following error: `{error}`"
: error;
throw new InvalidOperationException(message);
var message = throwPlainOctostacheError ? error : errorMessage;
throw new CommandException(message);
}

log.VerboseFormat("Parsing file '{0}' with Octostache returned the following error: `{1}`", sourceFile, error);
log.Verbose(errorMessage);
}

fileSystem.OverwriteFile(targetFile, result, encoding);
Expand Down
2 changes: 1 addition & 1 deletion source/Calamari.Common/Features/Substitutions/NonSensitiveFileSubstituter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ protected override void PerformSubstitutionAndUpdateFile(string sourceFile, stri
//We always want to throw when substitution fails
base.PerformSubstitutionAndUpdateFile(sourceFile, targetFile, true, true);
}
catch (InvalidOperationException e)
catch (CommandException e)
{
throw new CommandException($"{e.Message}. This may be due to missing or sensitive variables.");
}
Expand Down