Issue #170 - Also provide a minimal configuration file

pull/170/head
Oleg Nenashev 2016-12-23 22:43:40 +01:00
parent ef0d9f6aca
commit 47716160d9
4 changed files with 62 additions and 1 deletions

View File

@ -22,7 +22,7 @@
This configuration file should be placed near the WinSW executable, the name should be the same. This configuration file should be placed near the WinSW executable, the name should be the same.
E.g. for myapp.exe the configuration file name should be myapp.xml E.g. for myapp.exe the configuration file name should be myapp.xml
You can find more information about the parameters here: https://github.com/kohsuke/winsw/blob/master/doc/xmlConfigFile.md You can find more information about configuration options here: https://github.com/kohsuke/winsw/blob/master/doc/xmlConfigFile.md
--> -->
<configuration> <configuration>

View File

@ -0,0 +1,41 @@
<!--
Copyright (c) 2016 Oleg Nenashev and other contributors
Permission is hereby granted, free of charge, to any person obtaining a copy of this
software and associated documentation files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-->
<!--
This is an example of a minimal Windows Service Wrapper configuration, which includes only mandatiory options.
This configuration file should be placed near the WinSW executable, the name should be the same.
E.g. for myapp.exe the configuration file name should be myapp.xml
You can find more information about the configuration options here: https://github.com/kohsuke/winsw/blob/master/doc/xmlConfigFile.md
Full example: https://github.com/kohsuke/winsw/blob/sample-config-file/examples/allOptions.xml
-->
<configuration>
<!-- ID of the service. It should be unique accross the Windows system-->
<id>myapp</id>
<!-- Display name of the service -->
<name>MyApp Service (powered by WinSW)</name>
<!-- Service description -->
<description>This service is a service cratead from a minimal configuration</description>
<!-- Path to the executable, which should be started -->
<executable>%BASE%\myExecutable.exe</executable>
</configuration>

View File

@ -21,6 +21,25 @@ namespace winswTests.Configuration
public void allOptionsConfigShouldDeclareDefaults() public void allOptionsConfigShouldDeclareDefaults()
{ {
ServiceDescriptor d = doLoad("allOptions"); ServiceDescriptor d = doLoad("allOptions");
Assert.AreEqual("myapp", d.Id);
Assert.AreEqual("MyApp Service (powered by WinSW)", d.Caption);
Assert.AreEqual("This service is a service cratead from a sample configuration", d.Description);
Assert.AreEqual("%BASE%\\myExecutable.exe", d.Executable);
ServiceDescriptorAssert.AssertAllOptionalPropertiesAreDefault(d);
}
[Test]
public void minimalConfigShouldDeclareDefaults()
{
ServiceDescriptor d = doLoad("minimal");
Assert.AreEqual("myapp", d.Id);
Assert.AreEqual("MyApp Service (powered by WinSW)", d.Caption);
Assert.AreEqual("This service is a service cratead from a minimal configuration", d.Description);
Assert.AreEqual("%BASE%\\myExecutable.exe", d.Executable);
ServiceDescriptorAssert.AssertAllOptionalPropertiesAreDefault(d); ServiceDescriptorAssert.AssertAllOptionalPropertiesAreDefault(d);
} }

View File

@ -36,6 +36,7 @@ EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{AA414F46-B863-473A-A0E0-C2971B3396AE}" Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{AA414F46-B863-473A-A0E0-C2971B3396AE}"
ProjectSection(SolutionItems) = preProject ProjectSection(SolutionItems) = preProject
..\examples\config-allOptions.xml = ..\examples\config-allOptions.xml ..\examples\config-allOptions.xml = ..\examples\config-allOptions.xml
..\examples\config-minimal.xml = ..\examples\config-minimal.xml
EndProjectSection EndProjectSection
EndProject EndProject
Global Global