protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
var desc = new RichDescription(
"Stop ",
new Hilite(config[nameof(ContainerName)]),
" container"
);
if (string.Equals(config[nameof(Remove)], "true", StringComparison.OrdinalIgnoreCase))
{
return(new ExtendedRichDescription(desc, new RichDescription("and delete container")));
}
else
{
return(new ExtendedRichDescription(desc));
}
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
return(new ExtendedRichDescription(
new RichDescription(
"Run ",
new Hilite(config[nameof(RepositoryName)] + ":" + config[nameof(Tag)]),
" Docker image"
),
new RichDescription(
"using ",
new Hilite(config[nameof(ConfigInstanceName)]),
" instance of ",
new Hilite(config[nameof(ConfigFileName)]),
" configuration file"
)
));
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
var startInfo = GetFileNameAndArguments(config[nameof(FileName)], config[nameof(Arguments)], config[nameof(Target)]);
var shortDesc = new RichDescription(
"Execute ",
new DirectoryHilite(startInfo?.FileName),
" ",
new Hilite(startInfo?.Arguments)
);
var longDesc = new RichDescription(
"in ",
new DirectoryHilite(config[nameof(WorkingDirectory)])
);
return(new ExtendedRichDescription(shortDesc, longDesc));
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
return(new ExtendedRichDescription(
new RichDescription(
"Replace Text in ",
new MaskHilite(config[nameof(this.Includes)], config[nameof(this.Excludes)])
),
new RichDescription(
"matching ",
new Hilite(config[nameof(this.SearchText)]),
" with ",
new Hilite(config[nameof(this.ReplaceText)]),
" in ",
new DirectoryHilite(config[nameof(this.SourceDirectory)])
)
));
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
var extended = new RichDescription();
var output = config[nameof(Output)];
if (!string.IsNullOrWhiteSpace(output))
{
extended.AppendContent("Output: ", new DirectoryHilite(output));
}
return(new ExtendedRichDescription(
new RichDescription(
"dotnet pack ",
new DirectoryHilite(config[nameof(ProjectPath)])
),
extended
));
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
var desc = new ExtendedRichDescription(
new RichDescription(
"Ensure directory ",
new DirectoryHilite(config[nameof(DirectoryConfiguration.Name)])
),
new RichDescription()
);
if (string.Equals(config[nameof(DirectoryConfiguration.Exists)], "false", StringComparison.OrdinalIgnoreCase))
{
desc.LongDescription.AppendContent("does not exist");
return(desc);
}
return(desc);
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
var extended = new RichDescription();
var framework = config[nameof(Framework)];
if (!string.IsNullOrWhiteSpace(framework))
{
extended.AppendContent("Framework: ", new Hilite(framework));
}
return(new ExtendedRichDescription(
new RichDescription(
$"dotnet test ",
new DirectoryHilite(config[nameof(ProjectPath)])
),
extended
));
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
var shortDesc = new RichDescription(
"Ensure ",
new Hilite(config[nameof(IisApplicationConfiguration.ApplicationPath)]),
" Application");
var longDesc = new RichDescription(
"on site ",
new Hilite(config[nameof(IisApplicationConfiguration.SiteName)]));
if (string.Equals(config[nameof(IisApplicationConfiguration.Exists)], bool.FalseString, StringComparison.OrdinalIgnoreCase))
{
longDesc.AppendContent("does not exist");
return(new ExtendedRichDescription(shortDesc, longDesc));
}
return(new ExtendedRichDescription(shortDesc, longDesc));
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
string buildNumber = config[nameof(this.BuildNumber)];
string branchName = config[nameof(this.BranchName)];
return(new ExtendedRichDescription(
new RichDescription("Import TeamCity ", new Hilite(config[nameof(this.ArtifactName)]), " Artifact "),
new RichDescription("of build ",
AH.ParseInt(buildNumber) != null ? "#" : "",
new Hilite(buildNumber),
!string.IsNullOrEmpty(branchName) ? " on branch " + branchName : "",
" of project ",
new Hilite(config[nameof(this.ProjectName)]),
" using configuration \"",
config[nameof(this.BuildConfigurationName)]
)
));
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
RichDescription desc;
var fileName = config[nameof(PackageFile)];
if (!string.IsNullOrWhiteSpace(fileName))
{
desc = new RichDescription(
"Determine if ",
new DirectoryHilite(fileName),
" exists as a valid universal package"
);
}
else
{
desc = new RichDescription(
"Determine if ",
new Hilite(config[nameof(PackageName)])
);
var version = config[nameof(PackageVersion)];
if (!string.IsNullOrWhiteSpace(version))
{
desc.AppendContent(
" ",
new Hilite(version)
);
}
desc.AppendContent(
" exists on ",
new Hilite(config[nameof(FeedUrl)])
);
}
return(new ExtendedRichDescription(
desc,
new RichDescription(
"and set variables ",
new ListHilite(new[] { config[nameof(Exists)], config[nameof(Metadata)] }.Select(v => v.ToString()).Where(v => !string.IsNullOrEmpty(v)))
)
));
}
protected RichDescription GetLongDescription(IOperationConfiguration config)
{
var description = new RichDescription();
var applicationNames = config[nameof(ApplicationNames)].AsEnumerable();
if (bool.TryParse(AH.CoalesceString(config[nameof(IncludeGlobal)].ToString(), bool.TrueString), out bool includeGlobal) && includeGlobal)
{
description.AppendContent("with ", new Hilite("global"), " items");
if (applicationNames.Any())
{
description.AppendContent(" and items from ", new ListHilite(applicationNames));
}
}
else
{
description.AppendContent("with items from ", new ListHilite(applicationNames));
}
return(description);
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
var hive = (string)config[nameof(RegistryConfiguration.Hive)];
if (Enum.TryParse <RegistryHive>(hive, true, out var h))
{
hive = h.GetAbbreviation();
}
return(new ExtendedRichDescription(
new RichDescription(
"Ensure Registry Key ",
new Hilite(h + "\\" + RegistryConfiguration.GetCanonicalKey(config[nameof(RegistryConfiguration.Key)]))
),
new RichDescription(
string.Equals(config[nameof(RegistryConfiguration.Exists)], "false", StringComparison.OrdinalIgnoreCase) ? "does not exist" : "exists"
)
));
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
return(new ExtendedRichDescription(
new RichDescription(
ParseBool(config[nameof(this.DeleteTarget)]) ? "Mirror " : "Transfer ",
new MaskHilite(config[nameof(this.Includes)], config[nameof(this.Excludes)])
),
new RichDescription(
"from ",
new Hilite(AH.CoalesceString(config[nameof(this.SourceServerName)], "$Server")),
"::",
new DirectoryHilite(config[nameof(this.SourceDirectory)]),
" to ",
new Hilite(AH.CoalesceString(config[nameof(this.TargetServerName)], "$Server")),
"::",
new DirectoryHilite(config[nameof(this.TargetDirectory)])
)
));
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
string jobName = config[nameof(this.JobName)];
string artifactName = config[nameof(this.ArtifactName)];
if (artifactName == "*")
{
artifactName = null;
}
return(new ExtendedRichDescription(
new RichDescription("Download Jenkins Artifact ", new Hilite(artifactName)),
new RichDescription(
config[nameof(this.ExtractFilesToTargetDirectory)] == bool.TrueString ? "" : "as zip file ",
"from job ", new Hilite(jobName),
" to ", new DirectoryHilite(config[nameof(this.TargetDirectory)])
)
));
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
var longActionDescription = new RichDescription();
if (!string.IsNullOrWhiteSpace(config[nameof(this.AdditionalArguments)]))
{
longActionDescription.AppendContent(
"with additional arguments: ",
new Hilite(config[nameof(this.AdditionalArguments)])
);
}
return new ExtendedRichDescription(
new RichDescription(
"Run NUnit on ",
new DirectoryHilite(config[nameof(this.TestFile)])
),
longActionDescription
);
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
var longDesc = new RichDescription();
var attachments = config[nameof(Attachments)].AsEnumerable()?.ToList();
if (attachments != null && attachments.Count > 0)
{
longDesc.AppendContent(
"with attachments ",
new ListHilite(attachments),
" "
);
if (!string.IsNullOrEmpty(config[nameof(SourceDirectory)]))
{
longDesc.AppendContent(
"in ",
new DirectoryHilite(config[nameof(SourceDirectory)])
);
}
}
var text = AH.CoalesceString((string)config[nameof(BodyHtml)], (string)config[nameof(BodyText)]);
if (!string.IsNullOrWhiteSpace(text))
{
longDesc.AppendContent(
"starting with ",
new Hilite(text)
);
}
return(new ExtendedRichDescription(
new RichDescription(
"Send email to ",
new ListHilite(config[nameof(To)]),
" with subject ",
new Hilite(AH.CoalesceString(config[nameof(Subject)], "(no subject)"))
),
longDesc
));
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
var shortDesc = new RichDescription("SHCall ", new Hilite(config[nameof(this.ScriptName)]));
var args = config[nameof(this.Arguments)];
if (string.IsNullOrWhiteSpace(args))
{
return(new ExtendedRichDescription(shortDesc));
}
else
{
return(new ExtendedRichDescription(
shortDesc,
new RichDescription(
"with arguments ",
new Hilite(args)
)
));
}
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
var shortDescription = new RichDescription(new Hilite("Remove"), " Docker Compose project ", new Hilite(config[nameof(ProjectName)]));
var details = new RichDescription();
var timeout = AH.NullIf(AH.ParseInt(config[nameof(Timeout)]), 10);
if (timeout.HasValue)
{
if (timeout == 0)
{
details.AppendContent("with no time limit");
}
else
{
details.AppendContent("with a time limit of ", new Hilite(timeout.ToString()), " seconds");
}
}
return(new ExtendedRichDescription(shortDescription, details));
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
RichDescription uninclusedDesc = null;
if (string.Equals(config[nameof(IExistential.Exists)], "false", StringComparison.OrdinalIgnoreCase))
{
uninclusedDesc = new RichDescription("does not exist");
}
return(new ExtendedRichDescription(
new RichDescription(
"Ensure ",
new Hilite(config[nameof(HostsEntryConfiguration.HostName)]),
" hostsfile entry"
),
uninclusedDesc ?? new RichDescription(
"is ",
new Hilite(config[nameof(HostsEntryConfiguration.IpAddress)])
)
));
}
protected override string PrepareDescription(IOperationConfiguration config, RichDescription details)
{
if (Enum.TryParse <ContainerAction>(config[nameof(Action)], out var action))
{
switch (action)
{
case ContainerAction.Stop:
case ContainerAction.Restart:
details.AppendContent("with a time limit of ", new Hilite(AH.CoalesceString(config[nameof(Timeout)], "10")), " seconds");
break;
case ContainerAction.ForceStop:
details.AppendContent("by sending the ", new Hilite(AH.CoalesceString(config[nameof(Signal)], "SIGKILL")), " signal");
break;
default:
break;
}
}
return(config[nameof(Action)]);
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
var hive = (string)config[nameof(Hive)];
if (Enum.TryParse <RegistryHive>(hive, true, out var h))
{
hive = h.GetAbbreviation();
}
return(new ExtendedRichDescription(
new RichDescription(
"Store Registry Value ",
new Hilite(config[nameof(ValueName)]),
" to ",
new Hilite(config[nameof(Value)])
),
new RichDescription(
"from key ",
new Hilite(h + "\\" + RegistryConfiguration.GetCanonicalKey(config[nameof(Key)]))
)
));
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
var shortDesc = new RichDescription(
"Ensure ",
new Hilite(config[nameof(IisVirtualDirectoryConfiguration.Path)]),
" Virtual Directory");
var longDesc = new RichDescription(
"on site ",
new Hilite(config[nameof(IisVirtualDirectoryConfiguration.SiteName)]));
if (string.Equals(config[nameof(IisVirtualDirectoryConfiguration.Exists)], bool.FalseString, StringComparison.OrdinalIgnoreCase))
{
longDesc.AppendContent("does not exist");
return(new ExtendedRichDescription(shortDesc, longDesc));
}
longDesc.AppendContent(" at ", new DirectoryHilite(config[nameof(IisVirtualDirectoryConfiguration.PhysicalPath)]));
var credential = config[nameof(IisVirtualDirectoryConfiguration.CredentialName)];
var username = config[nameof(IisVirtualDirectoryConfiguration.UserName)];
var logon = config[nameof(IisVirtualDirectoryConfiguration.LogonMethod)];
if (!string.IsNullOrEmpty(credential))
{
longDesc.AppendContent(" impersonate with credentials ", new Hilite(credential));
}
else if (!string.IsNullOrEmpty(username))
{
longDesc.AppendContent(" impersonate with username ", new Hilite(username));
}
if (!string.IsNullOrEmpty(logon))
{
longDesc.AppendContent(" (logon: ", new Hilite(logon), ")");
}
return(new ExtendedRichDescription(shortDesc, longDesc));
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
if (string.IsNullOrEmpty(this.Version))
{
return(new ExtendedRichDescription(
new RichDescription(
"Install latest version of ",
new Hilite(config[nameof(this.PackageName)]),
" from Chocolatey"
)
));
}
return(new ExtendedRichDescription(
new RichDescription(
"Install version ",
new Hilite(config[nameof(this.Version)]),
" of ",
new Hilite(config[nameof(this.PackageName)]),
" from Chocolatey"
)
));
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
if (string.IsNullOrEmpty(config[nameof(ChocolateyPackageConfiguration.Version)]))
{
return(new ExtendedRichDescription(
new RichDescription(
"Ensure latest version of ",
new Hilite(config[nameof(ChocolateyPackageConfiguration.PackageName)]),
" from Chocolatey is installed"
)
));
}
return(new ExtendedRichDescription(
new RichDescription(
"Ensure version ",
new Hilite(config[nameof(ChocolateyPackageConfiguration.Version)]),
" of ",
new Hilite(config[nameof(ChocolateyPackageConfiguration.PackageName)]),
" from Chocolatey is installed"
)
));
}
public HttpHostConfiguration AddOperationConfiguration(IOperationConfiguration configureOperation)
{
this.operationConfiguration.Add(configureOperation);
return(this);
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
return(new ExtendedRichDescription(
new RichDescription("Create TFS Work Item for team project ", config[nameof(this.TeamProject)])
));
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
return(new ExtendedRichDescription(new RichDescription("Install Composer packages")));
}
public HttpHostConfiguration AddOperationConfiguration(IOperationConfiguration configureOperation)
{
this.operationConfiguration.Add(configureOperation);
return this;
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config) => PsRepositoryConfiguration.GetDescription(config);
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
return(new ExtendedRichDescription(
new RichDescription("Set ", new Hilite(config[nameof(this.Name)]), " = ", new Hilite(config[nameof(this.Value)]), " in Otter")
));
}
protected override ExtendedRichDescription GetDescription(IOperationConfiguration config)
{
return(new ExtendedRichDescription(
new RichDescription("Sleep for ", new Hilite(config[nameof(this.Seconds)]), " seconds")
));
}
