github
/
winsw
mirror of https://github.com/winsw/winsw
1
0
Fork 0
Code Issues Releases Wiki Activity

YAML config test coverage (#647) 

* Update YAML config test coverage

* Increase config readability

* Update src/Core/WinSWCore/Configuration/YamlConfiguration.cs

* Update src/Core/WinSWCore/Configuration/YamlConfiguration.cs

Co-authored-by: Oleg Nenashev <o.v.nenashev@gmail.com>
pull/652/head
Buddhika Chathuranga 2020-08-21 05:35:19 +05:30 committed by GitHub
parent 348d524c79
commit ef7ba3fe32
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 478 additions and 132 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
src/Core/WinSWCore/Configuration/YamlConfiguration.cs
View File

@ -13,7 +13,14 @@ namespace WinSW.Configuration
{
public class YamlConfiguration : IWinSWConfiguration
{
public DefaultWinSWSettings Defaults { get; } = new DefaultWinSWSettings();
public readonly DefaultWinSWSettings Defaults;
public YamlConfiguration()
{
this.Defaults = new DefaultWinSWSettings();
this.BaseName = this.Defaults.BaseName;
this.BasePath = this.Defaults.BasePath;
}
[YamlMember(Alias = "id")]
public string? IdYaml { get; set; }
@ -159,7 +166,7 @@ namespace WinSW.Configuration
public string? AutoRollAtTimeYamlLog { get; set; }
[YamlMember(Alias = "zipOlderThanNumDays")]
public int? ZipOlderThanNumDaysYamlLog { get; set; }
public string? ZipOlderThanNumDaysYamlLog { get; set; }
[YamlMember(Alias = "zipDateFormat")]
public string? ZipDateFormatYamlLog { get; set; }
@ -194,7 +201,7 @@ namespace WinSW.Configuration
{
return this.SizeThresholdYamlLog is null ?
DefaultWinSWSettings.DefaultLogSettings.SizeThreshold :
this.SizeThresholdYamlLog * RollingSizeTimeLogAppender.BytesPerKB;
this.SizeThresholdYamlLog;
}
}
@ -277,12 +284,22 @@ namespace WinSW.Configuration
{
get
{
if (this.ZipOlderThanNumDaysYamlLog != null)
int? zipolderthannumdays = null;
if (!string.IsNullOrEmpty(this.ZipOlderThanNumDaysYamlLog))
{
return this.ZipOlderThanNumDaysYamlLog;
if (!int.TryParse(this.ZipOlderThanNumDaysYamlLog, out int zipolderthannumdaysValue))
{
// FIXME: Remove the build env specific warning suppression from the codebase
#pragma warning disable S2372 // Exceptions should not be thrown from property getters
throw new InvalidDataException("Roll-Size-Time Based rolling policy is specified but zipOlderThanNumDays does not match the int format found in configuration XML.");
#pragma warning restore S2372 // Exceptions should not be thrown from property getters
}
return DefaultWinSWSettings.DefaultLogSettings.ZipOlderThanNumDays;
zipolderthannumdays = zipolderthannumdaysValue;
}
return zipolderthannumdays;
}
}
@ -646,9 +663,9 @@ namespace WinSW.Configuration
public List<string> ExtensionIds => this.YamlExtensionIds ?? this.Defaults.ExtensionIds;
public string BaseName => this.Defaults.BaseName;
public string BaseName { get; set; }
public string BasePath => this.Defaults.BasePath;
public string BasePath { get; set; }
public string? SecurityDescriptor
{

577
src/Test/winswTests/ServiceDescriptorYamlTest.cs
View File

@ -1,25 +1,470 @@
using System;
using System.Diagnostics;
using NUnit.Framework;
using WinSW;
using WinSW.Configuration;
using WinSW.Native;
using WMI;
namespace winswTests
{
class ServiceDescriptorYamlTest
{
private IWinSWConfiguration _extendedServiceDescriptor;
private readonly string MinimalYaml = @"id: myapp
name: This is a test
executable: 'C:\Program Files\Java\jdk1.8.0_241\bin\java.exe'
description: This is test winsw";
private const string ExpectedWorkingDirectory = @"Z:\Path\SubPath";
private const string Username = "User";
private const string Password = "Password";
private const string Domain = "Domain";
private const string AllowServiceAccountLogonRight = "true";
private readonly DefaultWinSWSettings Defaults = new DefaultWinSWSettings();
[SetUp]
public void SetUp()
{
string yaml = $@"
id: service.exe
name: Service
description: The Service.
executable: node.exe
arguments: My Arguments
log:
mode: roll
logpath: c:\logs
serviceaccount:
domain: {Domain}
user: {Username}
password: {Password}
allowservicelogon: {AllowServiceAccountLogonRight}
workingdirectory: {ExpectedWorkingDirectory}";
this._extendedServiceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
}
[Test]
public void Parse_must_implemented_value_test()
public void DefaultStartMode()
{
var yml = @"name: This is a test
Assert.That(this._extendedServiceDescriptor.StartMode, Is.EqualTo(StartMode.Automatic));
}
[Test]
public void IncorrectStartMode()
{
string yaml = $@"
id: service.exe
name: Service
description: The Service.
executable: node.exe
arguments: My Arguments
startMode: roll";
this._extendedServiceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
Assert.That(() => this._extendedServiceDescriptor.StartMode, Throws.ArgumentException);
}
[Test]
public void ChangedStartMode()
{
string yaml = $@"
id: service.exe
name: Service
description: The Service.
executable: node.exe
arguments: My Arguments
startMode: manual";
this._extendedServiceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
Assert.That(this._extendedServiceDescriptor.StartMode, Is.EqualTo(StartMode.Manual));
}
[Test]
public void VerifyWorkingDirectory()
{
Debug.WriteLine("_extendedServiceDescriptor.WorkingDirectory :: " + this._extendedServiceDescriptor.WorkingDirectory);
Assert.That(this._extendedServiceDescriptor.WorkingDirectory, Is.EqualTo(ExpectedWorkingDirectory));
}
[Test]
public void VerifyServiceLogonRight()
{
Assert.That(_extendedServiceDescriptor.ServiceAccount.AllowServiceAcountLogonRight, Is.True);
}
[Test]
public void VerifyUsername()
{
Debug.WriteLine("_extendedServiceDescriptor.WorkingDirectory :: " + _extendedServiceDescriptor.WorkingDirectory);
Assert.That(_extendedServiceDescriptor.ServiceAccount.ServiceAccountUser, Is.EqualTo(Domain + "\\" + Username));
}
[Test]
public void VerifyPassword()
{
Debug.WriteLine("_extendedServiceDescriptor.WorkingDirectory :: " + _extendedServiceDescriptor.WorkingDirectory);
Assert.That(_extendedServiceDescriptor.ServiceAccount.ServiceAccountPassword, Is.EqualTo(Password));
}
[Test]
public void Priority()
{
var sd = ServiceDescriptorYaml.FromYaml(@"
id: service.exe
name: Service
description: The Service.
executable: node.exe
priority: normal").Configurations;
Assert.That(sd.Priority, Is.EqualTo(ProcessPriorityClass.Normal));
sd = ServiceDescriptorYaml.FromYaml(@"
id: service.exe
name: Service
description: The Service.
executable: node.exe
priority: idle").Configurations;
Assert.That(sd.Priority, Is.EqualTo(ProcessPriorityClass.Idle));
sd = ServiceDescriptorYaml.FromYaml(@"
id: service.exe
name: Service
description: The Service.
executable: node.exe").Configurations;
Assert.That(sd.Priority, Is.EqualTo(ProcessPriorityClass.Normal));
}
[Test]
public void StopParentProcessFirstIsTrueByDefault()
{
Assert.That(this._extendedServiceDescriptor.StopParentProcessFirst, Is.True);
}
[Test]
public void CanParseStopParentProcessFirst()
{
const string yaml = @"
id: service.exe
name: Service
description: The Service.
executable: node.exe
stopParentProcessFirst: false";
var serviceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
Assert.That(serviceDescriptor.StopParentProcessFirst, Is.False);
}
[Test]
public void CanParseStopTimeout()
{
const string yaml = @"id: service.exe
name: Service
description: The Service.
executable: node.exe
stopTimeout: 60sec";
var serviceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
Assert.That(serviceDescriptor.StopTimeout, Is.EqualTo(TimeSpan.FromSeconds(60)));
}
[Test]
public void CanParseStopTimeoutFromMinutes()
{
const string yaml = @"
id: service.exe
name: Service
description: The Service.
executable: node.exe
stopTimeout: 10min";
var serviceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
Assert.That(serviceDescriptor.StopTimeout, Is.EqualTo(TimeSpan.FromMinutes(10)));
}
[Test]
public void CanParseLogname()
{
const string yaml = @"
id: service.exe
name: Service
description: The Service.
executable: node.exe
log:
name: MyTestApp";
var serviceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
Assert.That(serviceDescriptor.Log.Name, Is.EqualTo("MyTestApp"));
}
[Test]
public void CanParseOutfileDisabled()
{
const string yaml = @"
id: service.exe
name: Service
description: The Service.
executable: node.exe
log:
outFileDisabled: true";
var serviceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
Assert.That(serviceDescriptor.Log.OutFileDisabled, Is.True);
}
[Test]
public void CanParseErrfileDisabled()
{
const string yaml = @"
id: service.exe
name: Service
description: The Service.
executable: node.exe
log:
errFileDisabled: true";
var serviceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
Assert.That(serviceDescriptor.Log.ErrFileDisabled, Is.True);
}
[Test]
public void CanParseOutfilePattern()
{
const string yaml = @"
id: service.exe
name: Service
description: The Service.
executable: node.exe
log:
outFilePattern: .out.test.log";
var serviceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
Assert.That(serviceDescriptor.Log.OutFilePattern, Is.EqualTo(".out.test.log"));
}
[Test]
public void CanParseErrfilePattern()
{
const string yaml = @"
id: service.exe
name: Service
description: The Service.
executable: node.exe
log:
errFilePattern: .err.test.log";
var serviceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
Assert.That(serviceDescriptor.Log.ErrFilePattern, Is.EqualTo(".err.test.log"));
}
[Test]
public void LogModeRollBySize()
{
const string yaml = @"
id: service.exe
name: Service
description: The Service.
executable: node.exe
log:
logpath: 'c:\\'
mode: roll-by-size
sizeThreshold: 112
keepFiles: 113";
var serviceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
serviceDescriptor.BaseName = "service";
var logHandler = serviceDescriptor.Log.CreateLogHandler() as SizeBasedRollingLogAppender;
Assert.That(logHandler, Is.Not.Null);
Assert.That(logHandler.SizeTheshold, Is.EqualTo(112 * 1024));
Assert.That(logHandler.FilesToKeep, Is.EqualTo(113));
}
[Test]
public void LogModeRollByTime()
{
const string yaml = @"
id: service.exe
name: Service
description: The Service.
executable: node.exe
log:
logpath: c:\\
mode: roll-by-time
period: 7
pattern: log pattern";
var serviceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
serviceDescriptor.BaseName = "service";
var logHandler = serviceDescriptor.Log.CreateLogHandler() as TimeBasedRollingLogAppender;
Assert.That(logHandler, Is.Not.Null);
Assert.That(logHandler.Period, Is.EqualTo(7));
Assert.That(logHandler.Pattern, Is.EqualTo("log pattern"));
}
[Test]
public void LogModeRollBySizeTime()
{
const string yaml = @"
id: service.exe
name: Service
description: The Service.
executable: node.exe
log:
logpath: c:\\
mode: roll-by-size-time
sizeThreshold: 10240
pattern: yyyy-MM-dd
autoRollAtTime: 00:00:00";
var serviceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
serviceDescriptor.BaseName = "service";
var logHandler = serviceDescriptor.Log.CreateLogHandler() as RollingSizeTimeLogAppender;
Assert.That(logHandler, Is.Not.Null);
Assert.That(logHandler.SizeTheshold, Is.EqualTo(10240 * 1024));
Assert.That(logHandler.FilePattern, Is.EqualTo("yyyy-MM-dd"));
Assert.That(logHandler.AutoRollAtTime, Is.EqualTo((TimeSpan?)new TimeSpan(0, 0, 0)));
}
[Test]
public void VerifyServiceLogonRightGraceful()
{
string yaml = $@"
id: service.exe
name: Service
description: The Service.
executable: node.exe
serviceaccount:
domain: {Domain}
user: {Username}
password: {Password}
allowservicelogon: false";
var serviceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
Assert.That(serviceDescriptor.ServiceAccount.AllowServiceAcountLogonRight, Is.False);
}
[Test]
public void VerifyServiceLogonRightOmitted()
{
string yaml = $@"
id: service.exe
name: Service
description: The Service.
executable: node.exe
serviceaccount:
domain: {Domain}
user: {Username}
password: {Password}";
var serviceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
Assert.That(serviceDescriptor.ServiceAccount.AllowServiceAcountLogonRight, Is.False);
}
[Test]
public void VerifyWaitHint()
{
string yaml = $@"
id: service.exe
name: Service
description: The Service.
executable: node.exe
waitHint: 20 min";
var serviceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
Assert.That(serviceDescriptor.WaitHint, Is.EqualTo(TimeSpan.FromMinutes(20)));
}
[Test]
public void VerifySleepTime()
{
string yaml = $@"
id: service.exe
name: Service
description: The Service.
executable: node.exe
sleepTime: 3 hrs";
var serviceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
Assert.That(serviceDescriptor.SleepTime, Is.EqualTo(TimeSpan.FromHours(3)));
}
[Test]
public void VerifyResetFailureAfter()
{
string yaml = $@"
id: service.exe
name: Service
description: The Service.
executable: node.exe
resetFailureAfter: 75 sec";
var serviceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
Assert.That(serviceDescriptor.ResetFailureAfter, Is.EqualTo(TimeSpan.FromSeconds(75)));
}
[Test]
public void VerifyStopTimeout()
{
string yaml = $@"
id: service.exe
name: Service
description: The Service.
executable: node.exe
stopTimeout: 35 sec";
var serviceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
Assert.That(serviceDescriptor.StopTimeout, Is.EqualTo(TimeSpan.FromSeconds(35)));
}
[Test]
public void Arguments_LegacyParam()
{
string yaml = $@"
id: service.exe
name: Service
description: The Service.
executable: node.exe
arguments: arg";
var serviceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
Assert.That(serviceDescriptor.Arguments, Is.EqualTo("arg"));
}
public void DelayedStart_RoundTrip(bool enabled)
{
string yaml = $@"
id: service.exe
name: Service
description: The Service.
executable: node.exe
delayedAutoStart: true";
var serviceDescriptor = ServiceDescriptorYaml.FromYaml(yaml).Configurations;
Assert.That(serviceDescriptor.DelayedAutoStart, Is.EqualTo(true));
}
[Test]
public void Must_Specify_Values_Test()
{
var yml = @"
name: This is a test
executable: 'C:\Program Files\Java\jdk1.8.0_241\bin\java.exe'
description: This is test winsw";
@ -29,121 +474,5 @@ description: This is test winsw";
}, Throws.TypeOf<InvalidOperationException>());
}
[Test]
public void Default_value_map_test()
{
var configs = ServiceDescriptorYaml.FromYaml(MinimalYaml).Configurations;
Assert.IsNotNull(configs.ExecutablePath);
Assert.IsNotNull(configs.BaseName);
Assert.IsNotNull(configs.BasePath);
}
[Test]
public void Parse_downloads()
{
var yml = @"download:
-
from: www.sample.com
to: c://tmp
-
from: www.sample2.com
to: d://tmp
-
from: www.sample3.com
to: d://temp";
var configs = ServiceDescriptorYaml.FromYaml(yml).Configurations;
Assert.AreEqual(3, configs.Downloads.Count);
Assert.AreEqual("www.sample.com", configs.Downloads[0].From);
Assert.AreEqual("c://tmp", configs.Downloads[0].To);
}
[Test]
public void Parse_serviceaccount()
{
var yml = @"id: myapp
name: winsw
description: yaml test
executable: java
serviceaccount:
user: testuser
domain: mydomain
password: pa55w0rd
allowservicelogon: yes";
var serviceAccount = ServiceDescriptorYaml.FromYaml(yml).Configurations.ServiceAccount;
Assert.AreEqual("mydomain\\testuser", serviceAccount.ServiceAccountUser);
Assert.AreEqual(true, serviceAccount.AllowServiceAcountLogonRight);
Assert.AreEqual("pa55w0rd", serviceAccount.ServiceAccountPassword);
Assert.AreEqual(true, serviceAccount.HasServiceAccount());
}
[Test]
public void Parse_environment_variables()
{
var yml = @"id: myapp
name: WinSW
executable: java
description: env test
env:
-
name: MY_TOOL_HOME
value: 'C:\etc\tools\myTool'
-
name: LM_LICENSE_FILE
value: host1;host2";
var envs = ServiceDescriptorYaml.FromYaml(yml).Configurations.EnvironmentVariables;
Assert.That(@"C:\etc\tools\myTool", Is.EqualTo(envs["MY_TOOL_HOME"]));
Assert.That("host1;host2", Is.EqualTo(envs["LM_LICENSE_FILE"]));
}
[Test]
public void Parse_log()
{
var yml = @"id: myapp
name: winsw
description: yaml test
executable: java
log:
mode: roll
logpath: 'D://winsw/logs'";
var config = ServiceDescriptorYaml.FromYaml(yml).Configurations;
Assert.AreEqual("roll", config.LogMode);
Assert.AreEqual("D://winsw/logs", config.LogDirectory);
}
[Test]
public void Parse_onfailure_actions()
{
var yml = @"id: myapp
name: winsw
description: yaml test
executable: java
onFailure:
-
action: restart
delay: 5 sec
-
action: reboot
delay: 10 min";
var onFailure = ServiceDescriptorYaml.FromYaml(yml).Configurations.FailureActions;
Assert.That(onFailure[0].Type, Is.EqualTo(SC_ACTION_TYPE.SC_ACTION_RESTART));
Assert.That(onFailure[1].Type, Is.EqualTo(SC_ACTION_TYPE.SC_ACTION_REBOOT));
Assert.That(TimeSpan.FromMilliseconds(onFailure[0].Delay), Is.EqualTo(TimeSpan.FromSeconds(5)));
Assert.That(TimeSpan.FromMilliseconds(onFailure[1].Delay), Is.EqualTo(TimeSpan.FromMinutes(10)));
}
}
}