public bool Upgrade(ServiceControlInstance instance, InstanceUpgradeOptions options)
{
ZipInfo.ValidateZip();
var checkLicenseResult = CheckLicenseIsValid();
if (!checkLicenseResult.Valid)
{
logger.Error($"Upgrade aborted - {checkLicenseResult.Message}");
return(false);
}
instance.ReportCard = new ReportCard();
var restartService = instance.Service.Status == ServiceControllerStatus.Running;
if (!instance.TryStopService())
{
logger.Error("Service failed to stop or service stop timed out");
}
try
{
var backupFile = instance.BackupAppConfig();
try
{
instance.UpgradeFiles(ZipInfo.FilePath);
}
finally
{
instance.RestoreAppConfig(backupFile);
}
options.ApplyChangesToInstance(instance);
instance.SetupInstance();
if (instance.ReportCard.HasErrors)
{
foreach (var error in instance.ReportCard.Errors)
{
logger.Error(error);
}
return(false);
}
if (restartService && !instance.TryStartService())
{
logger.Error("Service failed to start after update - please check configuration for {0}", instance.Name);
return(false);
}
}
catch (Exception ex)
{
logger.Error("Upgrade Failed: {0}", ex.Message);
return(false);
}
return(true);
}
protected override void ProcessRecord()
{
var logger = new PSLogger(Host);
var zipFolder = Path.GetDirectoryName(MyInvocation.MyCommand.Module.Path);
var installer = new UnattendInstaller(logger, zipFolder);
foreach (var name in Name)
{
var options = new InstanceUpgradeOptions {
AuditRetentionPeriod = AuditRetentionPeriod, ErrorRetentionPeriod = ErrorRetentionPeriod, OverrideEnableErrorForwarding = ForwardErrorMessages
};
var instance = ServiceControlInstance.FindByName(name);
if (instance == null)
{
WriteWarning($"No action taken. An instance called {name} was not found");
break;
}
options.OverrideEnableErrorForwarding = ForwardErrorMessages;
// Migrate Value
if (!options.AuditRetentionPeriod.HasValue)
{
if (instance.AppSettingExists(SettingsList.HoursToKeepMessagesBeforeExpiring.Name))
{
var i = instance.ReadAppSetting(SettingsList.HoursToKeepMessagesBeforeExpiring.Name, -1);
if (i != -1)
{
options.AuditRetentionPeriod = TimeSpan.FromHours(i);
}
}
}
if (!options.OverrideEnableErrorForwarding.HasValue & !instance.AppSettingExists(SettingsList.ForwardErrorMessages.Name))
{
ThrowTerminatingError(new ErrorRecord(new Exception($"Upgrade of {instance.Name} aborted. ForwardErrorMessages parameter must be set to true or false because the configuration file has no setting for ForwardErrorMessages. This setting is mandatory as of version 1.12"), "UpgradeFailure", ErrorCategory.InvalidArgument, null));
}
if (!options.ErrorRetentionPeriod.HasValue & !instance.AppSettingExists(SettingsList.ErrorRetentionPeriod.Name))
{
ThrowTerminatingError(new ErrorRecord(new Exception($"Upgrade of {instance.Name} aborted. ErrorRetentionPeriod parameter must be set to timespan because the configuration file has no setting for ErrorRetentionPeriod. This setting is mandatory as of version 1.13"), "UpgradeFailure", ErrorCategory.InvalidArgument, null));
}
if (!options.AuditRetentionPeriod.HasValue & !instance.AppSettingExists(SettingsList.AuditRetentionPeriod.Name))
{
ThrowTerminatingError(new ErrorRecord(new Exception($"Upgrade of {instance.Name} aborted. AuditRetentionPeriod parameter must be set to timespan because the configuration file has no setting for AuditRetentionPeriod. This setting is mandatory as of version 1.13"), "UpgradeFailure", ErrorCategory.InvalidArgument, null));
}
if (!installer.Upgrade(instance, options))
{
ThrowTerminatingError(new ErrorRecord(new Exception($"Upgrade of {instance.Name} failed"), "UpgradeFailure", ErrorCategory.InvalidResult, null));
}
}
}
internal ReportCard Upgrade(string instanceName, InstanceUpgradeOptions upgradeOptions, IProgress <ProgressDetails> progress = null)
{
progress = progress ?? new Progress <ProgressDetails>();
var instance = ServiceControlInstance.FindByName(instanceName);
instance.ReportCard = new ReportCard();
ZipInfo.ValidateZip();
progress.Report(0, 5, "Stopping instance...");
if (!instance.TryStopService())
{
return(new ReportCard
{
Errors = { "Service failed to stop" },
Status = Status.Failed
});
}
progress.Report(1, 5, "Backing up app.config...");
var backupFile = instance.BackupAppConfig();
try
{
progress.Report(2, 5, "Upgrading Files...");
instance.UpgradeFiles(ZipInfo.FilePath);
}
finally
{
progress.Report(3, 5, "Restoring app.config...");
instance.RestoreAppConfig(backupFile);
}
upgradeOptions.ApplyChangesToInstance(instance);
progress.Report(4, 5, "Running Queue Creation...");
instance.SetupInstance();
instance.ReportCard.SetStatus();
return(instance.ReportCard);
}
static void UpgradeInstances(Session session, ServiceControlZipInfo zipInfo, MSILogger logger, UnattendInstaller unattendedInstaller)
{
var options = new InstanceUpgradeOptions();
var upgradeInstancesPropertyValue = session["UPGRADEINSTANCES"];
if (string.IsNullOrWhiteSpace(upgradeInstancesPropertyValue))
{
return;
}
upgradeInstancesPropertyValue = upgradeInstancesPropertyValue.Trim();
var forwardErrorMessagesPropertyValue = session["FORWARDERRORMESSAGES"];
try
{
options.OverrideEnableErrorForwarding = bool.Parse(forwardErrorMessagesPropertyValue);
}
catch
{
options.OverrideEnableErrorForwarding = null;
}
var auditRetentionPeriodPropertyValue = session["AUDITRETENTIONPERIOD"];
try
{
options.AuditRetentionPeriod = TimeSpan.Parse(auditRetentionPeriodPropertyValue);
}
catch
{
options.AuditRetentionPeriod = null;
}
var errorRetentionPeriodPropertyValue = session["ERRORRETENTIONPERIOD"];
try
{
options.ErrorRetentionPeriod = TimeSpan.Parse(errorRetentionPeriodPropertyValue);
}
catch
{
options.ErrorRetentionPeriod = null;
}
//determine what to upgrade
var instancesToUpgrade = new List <ServiceControlInstance>();
if (upgradeInstancesPropertyValue.Equals("*", StringComparison.OrdinalIgnoreCase) || upgradeInstancesPropertyValue.Equals("ALL", StringComparison.OrdinalIgnoreCase))
{
instancesToUpgrade.AddRange(ServiceControlInstance.Instances());
}
else
{
var candidates = upgradeInstancesPropertyValue.Replace(" ", String.Empty).Split(",".ToCharArray(), StringSplitOptions.RemoveEmptyEntries);
instancesToUpgrade.AddRange(ServiceControlInstance.Instances().Where(instance => candidates.Contains(instance.Name, StringComparer.OrdinalIgnoreCase)));
}
// do upgrades
foreach (var instance in instancesToUpgrade)
{
if (zipInfo.Version > instance.Version)
{
if (!instance.AppSettingExists(SettingsList.ForwardErrorMessages.Name) & !options.OverrideEnableErrorForwarding.Value)
{
logger.Warn($"Unattend upgrade {instance.Name} to {zipInfo.Version} not attempted. FORWARDERRORMESSAGES MSI parameter was required because appsettings needed a value for '{SettingsList.ForwardErrorMessages.Name}'");
continue;
}
if (!options.AuditRetentionPeriod.HasValue)
{
if (!instance.AppSettingExists(SettingsList.AuditRetentionPeriod.Name))
{
//Try migration first
if (instance.AppSettingExists(SettingsList.HoursToKeepMessagesBeforeExpiring.Name))
{
var i = instance.ReadAppSetting(SettingsList.HoursToKeepMessagesBeforeExpiring.Name, -1);
if (i > 0)
{
options.AuditRetentionPeriod = TimeSpan.FromHours(i);
}
}
else
{
logger.Warn($"Unattend upgrade {instance.Name} to {zipInfo.Version} not attempted. AUDITRETENTIONPERIOD MSI parameter was required because appsettings needed a value for '{SettingsList.AuditRetentionPeriod.Name}'");
continue;
}
}
}
if (!instance.AppSettingExists(SettingsList.ErrorRetentionPeriod.Name) & !options.ErrorRetentionPeriod.HasValue)
{
logger.Warn($"Unattend upgrade {instance.Name} to {zipInfo.Version} not attempted. ERRORRETENTIONPERIOD MSI parameter was required because appsettings needed a value for '{SettingsList.ErrorRetentionPeriod.Name}'");
continue;
}
if (!unattendedInstaller.Upgrade(instance, options))
{
logger.Warn($"Failed to upgrade {instance.Name} to {zipInfo.Version}");
}
}
}
}
public override async Task ExecuteAsync(InstanceDetailsViewModel model)
{
var licenseCheckResult = installer.CheckLicenseIsValid();
if (!licenseCheckResult.Valid)
{
windowManager.ShowMessage("LICENSE ERROR", $"Upgrade could not continue due to an issue with the current license. {licenseCheckResult.Message}. Contact [email protected]", hideCancel: true);
return;
}
var instance = ServiceControlInstance.FindByName(model.Name);
instance.Service.Refresh();
var upgradeOptions = new InstanceUpgradeOptions();
if (!instance.AppSettingExists(SettingsList.ForwardErrorMessages.Name))
{
var result = windowManager.ShowYesNoCancelDialog("UPGRADE QUESTION - DISABLE ERROR FORWARDING", "Error messages can be forwarded to a secondary error queue known as the Error Forwarding Queue. This queue exists to allow external tools to receive error messages. If you do not have a tool processing messages from the Error Forwarding Queue this setting should be disabled.", "So what do you want to do ?", "Do NOT forward", "Yes I want to forward");
if (!result.HasValue)
{
//Dialog was cancelled
eventAggregator.PublishOnUIThread(new RefreshInstances());
return;
}
upgradeOptions.OverrideEnableErrorForwarding = !result.Value;
}
//Grab old setting if it exists
if (!instance.AppSettingExists(SettingsList.AuditRetentionPeriod.Name))
{
if (instance.AppSettingExists(SettingsList.HoursToKeepMessagesBeforeExpiring.Name))
{
var i = instance.ReadAppSetting(SettingsList.HoursToKeepMessagesBeforeExpiring.Name, -1);
if (i != -1)
{
upgradeOptions.AuditRetentionPeriod = TimeSpan.FromHours(i);
}
}
// No setting to migrate so display dialog
if (!upgradeOptions.AuditRetentionPeriod.HasValue)
{
var viewModel = new SliderDialogViewModel("UPGRADE QUESTION - DATABASE RETENTION",
"Service Control periodically purges audit messages from the database.",
"AUDIT RETENTION PERIOD",
"Please specify the age at which these records should be removed",
TimeSpanUnits.Hours,
SettingConstants.AuditRetentionPeriodMinInHours,
SettingConstants.AuditRetentionPeriodMaxInHours,
1,
24,
SettingConstants.AuditRetentionPeriodDefaultInHoursForUI);
if (windowManager.ShowSliderDialog(viewModel))
{
upgradeOptions.AuditRetentionPeriod = viewModel.Period;
}
else
{
//Dialog was cancelled
eventAggregator.PublishOnUIThread(new RefreshInstances());
return;
}
}
}
if (!instance.AppSettingExists(SettingsList.ErrorRetentionPeriod.Name))
{
var viewModel = new SliderDialogViewModel("UPGRADE QUESTION - DATABASE RETENTION",
"Service Control periodically purges resolved and archived error messages from the database.",
"ERROR RETENTION PERIOD",
"Please specify the age at which these records should be removed",
TimeSpanUnits.Days,
SettingConstants.ErrorRetentionPeriodMinInDays,
SettingConstants.ErrorRetentionPeriodMaxInDays,
1,
1,
SettingConstants.ErrorRetentionPeriodDefaultInDaysForUI);
if (windowManager.ShowSliderDialog(viewModel))
{
upgradeOptions.ErrorRetentionPeriod = viewModel.Period;
}
else
{
//Dialog was cancelled
eventAggregator.PublishOnUIThread(new RefreshInstances());
return;
}
}
var confirm = instance.Service.Status == ServiceControllerStatus.Stopped ||
windowManager.ShowYesNoDialog($"STOP INSTANCE AND UPGRADE TO {installer.ZipInfo.Version}", $"{model.Name} needs to be stopped in order to upgrade to version {installer.ZipInfo.Version}.", "Do you want to proceed?", "Yes I want to proceed", "No");
if (confirm)
{
using (var progress = model.GetProgressObject($"UPGRADING {model.Name}"))
{
var reportCard = new ReportCard();
var restartAgain = model.IsRunning;
var stopped = await model.StopService(progress);
if (!stopped)
{
eventAggregator.PublishOnUIThread(new RefreshInstances());
reportCard.Errors.Add("Failed to stop the service");
reportCard.SetStatus();
windowManager.ShowActionReport(reportCard, "ISSUES UPGRADING INSTANCE", "Could not upgrade instance because of the following errors:");
return;
}
reportCard = await Task.Run(() => installer.Upgrade(model.Name, upgradeOptions, progress));
if (reportCard.HasErrors || reportCard.HasWarnings)
{
windowManager.ShowActionReport(reportCard, "ISSUES UPGRADING INSTANCE", "Could not upgrade instance because of the following errors:", "There were some warnings while upgrading the instance:");
}
else
{
if (restartAgain)
{
var serviceStarted = await model.StartService(progress);
if (!serviceStarted)
{
reportCard.Errors.Add("The Service failed to start. Please consult the service control logs for this instance");
windowManager.ShowActionReport(reportCard, "UPGRADE FAILURE", "Instance reported this error after upgrade:");
}
}
}
}
eventAggregator.PublishOnUIThread(new RefreshInstances());
}
}
