Skip to content
This repository has been archived by the owner on Jun 17, 2019. It is now read-only.

Commit

Permalink
Fix for errors in generated PowerShell scripts (#21)
Browse files Browse the repository at this point in the history 
* Fixing issue where calls to powershell scripts aren't being translated properly. Fixes issue #16

* Script generation when the action to run isn't an extracted tool has been changed to only include the command and the arguments.

* Corrected unit test that was passing when it should be failing; added a new minimal repro test case for the scenario. Issue #20

* Variables should be correctly remapped when variable name + value occurs across multiple actions. Fixes issue #20
  • Loading branch information
@DanielBMann9000
DanielBMann9000 committed Apr 28, 2016
1 parent 666d6ce commit 3c9445f
Show file tree
Hide file tree
Showing 6 changed files with 205 additions and 36 deletions.
4 changes: 3 additions & 1 deletion src/RMWorkflowMigrator.Generator.PowerShell/Model/ScriptAction.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ public class ScriptAction

public int Sequence { get; set; }

public Dictionary<string, List<ScriptAction>> RollbackScripts { get; set; } = new Dictionary<string, List<ScriptAction>>();
public Dictionary<string, List<ScriptAction>> RollbackScripts { get; set; } = new Dictionary<string, List<ScriptAction>>();

public bool CommandIsExtractedTool { get; set; }
}
}
8 changes: 7 additions & 1 deletion src/RMWorkflowMigrator.Generator.PowerShell/ScriptGenerator.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ public class ScriptGenerator
private readonly string meaninglessDisplayNameFolderFormat = "{0}_{1}";

private readonly string releaseScriptName = "ReleaseScript.ps1";
private readonly string[] possibleToolExtensions = { ".bat", ".exe", ".com", ".cmd", string.Empty };

private readonly IRMComponentRepository componentRepo;

Expand Down Expand Up @@ -327,7 +328,11 @@ stuff extracted from the RM XAML workflow and stuff we pull out of the RM databa
{
var component = await this.componentRepo.GetComponentByIdAsync(action.WorkflowActivityId, stageId);
await this.deployerToolRepo.WriteToolToDiskAsync(component.DeployerToolId, this.deployerToolsPath);
scriptActionElements.Add(CreateScriptAction(component, action));
var scriptAction = CreateScriptAction(component, action);

scriptAction.CommandIsExtractedTool = possibleToolExtensions.Select(extension => this.fs.Exists(Path.Combine(this.deployerToolsPath, scriptAction.Command + extension))).Any(t=>t==true);

scriptActionElements.Add(scriptAction);
}

this.ScriptGenerationNotification?.Invoke(this, GetActionGenerationArgs(action, ActionEnd));
Expand Down Expand Up @@ -458,6 +463,7 @@ private async Task<Dictionary<string, RollbackActionResolutionResult>> ResolveRo
await this.deployerToolRepo.WriteToolToDiskAsync(component.DeployerToolId, this.deployerToolsPath);
var action = CreateScriptAction(component, rollbackAction);
action.Sequence += rollbackGroup.Item.Sequence;
action.CommandIsExtractedTool = possibleToolExtensions.Select(extension => this.fs.Exists(Path.Combine(this.deployerToolsPath, action.Command + extension))).Any(t => t == true);
rollbackScriptActions.Add(action);
}
else
Expand Down
99 changes: 85 additions & 14 deletions src/RMWorkflowMigrator.Generator.PowerShell/Templates/IndividualActionTemplate.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -265,91 +265,162 @@ public virtual string TransformText()

#line default
#line hidden
this.Write(" &\"$(join-path $DeployerToolsPath \"");

#line 53 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
if (action.Command.StartsWith("powershell")) {
if (action.Arguments.StartsWith(@"""&") || action.Arguments.StartsWith(@"-command ""&") || action.Arguments.StartsWith(@"-Command ""&")) {

#line default
#line hidden
this.Write("\tpowershell ");

#line 55 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
this.Write(this.ToStringHelper.ToStringWithCulture(action.Arguments));

#line default
#line hidden
this.Write("\r\n");

#line 56 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
}
else {
var ps1Index = action.Arguments.IndexOf(".ps1")+4;
var actualCommand = action.Arguments.Substring(0,ps1Index);
var strippedArguments = action.Arguments.Replace(actualCommand, string.Empty);
actualCommand = actualCommand.Replace("-command", string.Empty).Replace("-Command", string.Empty).Trim();

#line default
#line hidden
this.Write("\tInvoke-Expression \"& `\"$(join-path $DeployerToolsPath \'");

#line 62 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
this.Write(this.ToStringHelper.ToStringWithCulture(actualCommand));

#line default
#line hidden
this.Write("\')`\" ");

#line 62 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
this.Write(this.ToStringHelper.ToStringWithCulture(strippedArguments));

#line default
#line hidden
this.Write("\"\r\n");

#line 63 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
}
}
else if (!action.CommandIsExtractedTool) {

#line default
#line hidden
this.Write(" ");

#line 66 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
this.Write(this.ToStringHelper.ToStringWithCulture(action.Command));

#line default
#line hidden
this.Write("\")\" ");
this.Write(" ");

#line 53 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
#line 66 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
this.Write(this.ToStringHelper.ToStringWithCulture(action.Arguments));

#line default
#line hidden
this.Write("\r\n");

#line 54 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
#line 67 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
}
else {

#line default
#line hidden
this.Write(" &\"$(join-path $DeployerToolsPath \"");

#line 69 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
this.Write(this.ToStringHelper.ToStringWithCulture(action.Command));

#line default
#line hidden
this.Write("\")\" ");

#line 69 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
this.Write(this.ToStringHelper.ToStringWithCulture(action.Arguments));

#line default
#line hidden
this.Write("\r\n");

#line 70 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
}}

#line default
#line hidden
this.Write("}\r\ncatch {\r\n Write-output \"");

#line 57 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
#line 73 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
this.Write(this.ToStringHelper.ToStringWithCulture(action.DisplayName));

#line default
#line hidden
this.Write(" failed. Error:\"\r\n Write-output $_\r\n");

#line 59 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
#line 75 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
if (action.RollbackScripts.Any()) {

#line default
#line hidden
this.Write(" Write-output \"Executing rollback script(s)\"\r\n");

#line 61 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
#line 77 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
if (action.IsComponent) {

#line default
#line hidden
this.Write(" cd $basePath\r\n");

#line 63 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
#line 79 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
}

#line default
#line hidden

#line 64 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
#line 80 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
foreach (var script in action.RollbackScripts) {

#line default
#line hidden
this.Write(" .\\");

#line 65 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
#line 81 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
this.Write(this.ToStringHelper.ToStringWithCulture(script.Key));

#line default
#line hidden
this.Write(".ps1 ");

#line 65 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
#line 81 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
this.Write(this.ToStringHelper.ToStringWithCulture(string.Join(" ", script.Value.OrderBy(rsa => rsa.Sequence).SelectMany(rsa => rsa.ConfigurationVariables).Where(s => !string.IsNullOrWhiteSpace(s.Value) && s.IsParameter).Distinct(new ConfigurationVariableEqualityComparer()).Select(s => "-" + s.RemappedName + " \"$" + s.RemappedName + "\""))));

#line default
#line hidden
this.Write(" ");

#line 65 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
#line 81 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
this.Write(this.ToStringHelper.ToStringWithCulture(string.Join(" ", script.Value.Where(s => s.IsComponent).Select(c => $"-ComponentPath{c.Sequence} $ComponentPath{c.Sequence}"))));

#line default
#line hidden
this.Write(" -DeployerToolsPath $DeployerToolsPath\r\n");

#line 66 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
#line 82 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
}

#line default
#line hidden

#line 67 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
#line 83 "C:\Users\Administrator\Documents\GitHubVisualStudio\Migrate-assets-from-RM-server-to-VSTS\src\RMWorkflowMigrator.Generator.PowerShell\Templates\IndividualActionTemplate.tt"
}

#line default
Expand Down
18 changes: 17 additions & 1 deletion src/RMWorkflowMigrator.Generator.PowerShell/Templates/IndividualActionTemplate.tt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,24 @@ var targetPath = action.ConfigurationVariables.First(cv => cv.OriginalName == "I
&"$(join-path $DeployerToolsPath "TokenizationScript.ps1")" -FilePath $<#=targetPath#> -FileSpec "<#=action.FileExtensionFilter#>" -Values $configVariables
<#}#>
<#} else {#>
<#if (action.Command.StartsWith("powershell")) {
if (action.Arguments.StartsWith(@"""&") || action.Arguments.StartsWith(@"-command ""&") || action.Arguments.StartsWith(@"-Command ""&")) {#>
powershell <#=action.Arguments#>
<#}
else {
var ps1Index = action.Arguments.IndexOf(".ps1")+4;
var actualCommand = action.Arguments.Substring(0,ps1Index);
var strippedArguments = action.Arguments.Replace(actualCommand, string.Empty);
actualCommand = actualCommand.Replace("-command", string.Empty).Replace("-Command", string.Empty).Trim();#>
Invoke-Expression "& `"$(join-path $DeployerToolsPath '<#=actualCommand#>')`" <#=strippedArguments#>"
<#}
}
else if (!action.CommandIsExtractedTool) {#>
<#=action.Command#> <#=action.Arguments#>
<#}
else {#>
&"$(join-path $DeployerToolsPath "<#=action.Command#>")" <#=action.Arguments#>
<#}#>
<#}}#>
}
catch {
Write-output "<#=action.DisplayName#> failed. Error:"
Expand Down
52 changes: 34 additions & 18 deletions src/RMWorkflowMigrator.Generator.PowerShell/UniquePropertyResolver.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public static class UniquePropertyResolver
public static IEnumerable<ScriptAction> ResolveProperties(IEnumerable<ScriptAction> actions)
{
var sequence = 2;
var properties = new HashSet<Tuple<string, string>>();
var properties = new HashSet<Tuple<string, string, string>>();
foreach (var action in actions)
{
action.Arguments = CleanActionParameters(action.Arguments);
Expand All @@ -31,7 +31,7 @@ public static IEnumerable<ScriptAction> ResolveProperties(IEnumerable<ScriptActi
return actions;
}

private static int MakeParametersUnique(ScriptAction action, ISet<Tuple<string, string>> properties, int sequence)
private static int MakeParametersUnique(ScriptAction action, ISet<Tuple<string, string, string>> properties, int sequence)
{
if (action.ConfigurationVariables == null)
{
Expand All @@ -40,29 +40,45 @@ private static int MakeParametersUnique(ScriptAction action, ISet<Tuple<string,

foreach (var configVar in action.ConfigurationVariables)
{
var tuple = Tuple.Create(CleanInvalidCharacters(configVar.OriginalName), configVar.Value);
if (!properties.Contains(tuple))
var tuple = Tuple.Create(CleanInvalidCharacters(configVar.OriginalName), configVar.Value, configVar.RemappedName);

// If we already have a matching variable name + value, we can reuse the remapped name of what's there
var match = properties.FirstOrDefault(p => p.Item1 == tuple.Item1 && p.Item2 == tuple.Item2);
if (match != null)
{
if (properties.Any(p => p.Item1 == tuple.Item1 && p.Item2 != tuple.Item2))
{
var newVariableName = configVar.RemappedName + sequence;
sequence++;
action.Arguments = action.Arguments?.Replace($"${configVar.RemappedName}", $"${newVariableName}");
var commandHasParameter = action.Command?.Contains(configVar.RemappedName);
if (commandHasParameter.HasValue && commandHasParameter.Value)
{
action.Command = action.Command?.Replace($"${configVar.RemappedName}", $"${newVariableName}");
}
configVar.RemappedName = newVariableName;
}
UpdateRemappedVariable(action, configVar, match.Item3);
}

properties.Add(tuple);
// If we have a matching variable name with a different value, remap it with a sequence number
else if (properties.Any(p => p.Item1 == tuple.Item1 && p.Item2 != tuple.Item2))
{
var newVariableName = configVar.RemappedName + sequence;
sequence++;
UpdateRemappedVariable(action, configVar, newVariableName);
tuple = Tuple.Create(CleanInvalidCharacters(configVar.OriginalName), configVar.Value, newVariableName);
properties.Add(tuple);
}
// Otherwise, we've never seen this variable + value combo before so we can just track that we've seen it
else
{
properties.Add(tuple);
}

}

return sequence;
}

private static void UpdateRemappedVariable(ScriptAction action, ConfigurationVariable configVar, string newVariableName)
{
action.Arguments = action.Arguments?.Replace($"${configVar.RemappedName}", $"${newVariableName}");
var commandHasParameter = action.Command?.Contains(configVar.RemappedName);
if (commandHasParameter.HasValue && commandHasParameter.Value)
{
action.Command = action.Command?.Replace($"${configVar.RemappedName}", $"${newVariableName}");
}
configVar.RemappedName = newVariableName;
}

private static void CleanConfigurationValues(IEnumerable<ConfigurationVariable> configurationVariables)
{
if (configurationVariables == null)
Expand Down
Loading

0 comments on commit 3c9445f

Please sign in to comment.