ydeng/gameservicewarden
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ServiceManager completed and ServiceInfo modified to increase encapsulation.

Browse Source 
ServiceManager tested and ServiceInfo tests updated to reflect changes.
This commit is contained in:
Harrison Deng
2020-12-26 13:36:09 -06:00
parent 3a49502970
commit 4996982c89
8 changed files with 341 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
src/GameServiceWarden.Host/Modules/ServiceInfo.cs
View File

@@ -27,7 +27,7 @@ namespace GameServiceWarden.Host.Modules
private readonly IGameService service;
private readonly string assemblyName;
private readonly string moduleName;
private readonly Dictionary<string, IConfigurable> configurables = new Dictionary<string, IConfigurable>();
private readonly IReadOnlyDictionary<string, IConfigurable> configurables;
private bool disposed;
public ServiceInfo(IGameService service, string moduleName, string assemblyName)
@@ -37,10 +37,12 @@ namespace GameServiceWarden.Host.Modules
this.assemblyName = assemblyName ?? throw new ArgumentNullException("assemblyName");
this.service.StateChangeEvent += OnServiceStateChange;
Dictionary<string, IConfigurable> configurables = new Dictionary<string, IConfigurable>();
foreach (IConfigurable configurable in service.Configurables)
{
configurables.Add(configurable.OptionName, configurable);
}
this.configurables = new ReadOnlyDictionary<string, IConfigurable>(configurables);
}
/// <summary>
@@ -91,12 +93,24 @@ namespace GameServiceWarden.Host.Modules
}
/// <summary>
/// Gets the possible <see cref="IConfigurable"/>'s for this service.
/// Gets the possible <see cref="IConfigurable"/>'s names for this service.
/// </summary>
/// <returns>A <see cref="IReadOnlyDictionary{string, IConfigurable}"/> is returned where the string is the option name and the configurable is what handles actually changing the values.</returns>
public IReadOnlyDictionary<string, IConfigurable> GetConfigurables()
/// <returns>A <see cref="ISet{string}"/> returned where the string is the option's name.</returns>
public ISet<string> GetConfigurableOptions()
{
return new ReadOnlyDictionary<string, IConfigurable>(this.configurables);
return new HashSet<string>(this.configurables.Keys);
}
public bool SetConfigurableValue(string configurationName, string value)
{
if (!this.configurables.ContainsKey(configurationName)) throw new KeyNotFoundException($"Unable to find option with name \"{configurationName}\".");
return this.configurables[configurationName].SetValue(value);
}
public string GetConfigurableValue(string configurationName)
{
if (!this.configurables.ContainsKey(configurationName)) throw new KeyNotFoundException($"Unable to find option with name \"{configurationName}\".");
return this.configurables[configurationName].GetValue();
}
/// <returns>The <see cref="ServiceState"/> that this service is currently in.</returns>

42
src/GameServiceWarden.Host/Modules/ServiceManager.cs
View File

@@ -7,8 +7,8 @@ namespace GameServiceWarden.Host.Modules
{
public class ServiceManager
{
private Dictionary<string, ServiceInfo> services = new Dictionary<string, ServiceInfo>();
private Dictionary<string, Dictionary<string, IGameServiceModule>> modules = new Dictionary<string, Dictionary<string, IGameServiceModule>>();
private readonly Dictionary<string, ServiceInfo> services = new Dictionary<string, ServiceInfo>();
private readonly Dictionary<string, Dictionary<string, IGameServiceModule>> modules = new Dictionary<string, Dictionary<string, IGameServiceModule>>();
public void AddModule(string assemblyName, IGameServiceModule module)
{
@@ -23,9 +23,25 @@ namespace GameServiceWarden.Host.Modules
if (modules[assemblyName].Count == 0) modules.Remove(assemblyName);
}
public IReadOnlyCollection<string> GetAssemblyNames()
{
string[] names = new string[modules.Count];
modules.Keys.CopyTo(names, 0);
return names;
}
public IReadOnlyCollection<string> GetModuleNames(string assembly)
{
if (!modules.ContainsKey(assembly)) throw new KeyNotFoundException($"No loaded assembly named \"{assembly}\".");
string[] names = new string[modules.Count];
modules[assembly].Keys.CopyTo(names, 0);
return names;
}
public void CreateService(string serviceName, string assemblyName, string moduleName)
{
if (!modules.ContainsKey(assemblyName) || modules[assemblyName].ContainsKey(moduleName)) throw new KeyNotFoundException($"No module registered from \"{assemblyName}\" named \"{moduleName}\".");
if (!modules.ContainsKey(assemblyName) || !modules[assemblyName].ContainsKey(moduleName)) throw new KeyNotFoundException($"No module registered from \"{assemblyName}\" named \"{moduleName}\".");
if (services.ContainsKey(serviceName)) throw new ArgumentException($"Service of Name \"{serviceName}\" already exists.");
services.Add(serviceName, new ServiceInfo(modules[assemblyName][moduleName].CreateGameService(), moduleName, assemblyName));
@@ -42,15 +58,27 @@ namespace GameServiceWarden.Host.Modules
{
if (!services.ContainsKey(serviceName)) throw new KeyNotFoundException($"Service under name \"{serviceName}\" not found.");
ServiceInfo serviceInfo = services[serviceName];
return serviceInfo.GetConfigurables().Keys;
return serviceInfo.GetConfigurableOptions();
}
public bool SetServiceOptionValue(string serviceName, string optionName, string value)
{
if (!services.ContainsKey(serviceName)) throw new KeyNotFoundException($"Service under name \"{serviceName}\" not found.");
if (!services[serviceName].GetConfigurables().ContainsKey(optionName)) throw new KeyNotFoundException($"Option \"{optionName}\" for service \"{serviceName}\" not found.");
IConfigurable configurable = services[serviceName].GetConfigurables()[optionName];
return configurable.SetValue(value);
if (!services[serviceName].GetConfigurableOptions().Contains(optionName)) throw new KeyNotFoundException($"Option \"{optionName}\" for service \"{serviceName}\" not found.");
return services[serviceName].SetConfigurableValue(optionName, value);
}
public string GetServiceOptionValue(string serviceName, string optionName)
{
if (!services.ContainsKey(serviceName)) throw new KeyNotFoundException($"Service under name \"{serviceName}\" not found.");
if (!services[serviceName].GetConfigurableOptions().Contains(optionName)) throw new KeyNotFoundException($"Option \"{optionName}\" for service \"{serviceName}\" not found.");
return services[serviceName].GetConfigurableValue(optionName);
}
public ServiceState GetServiceState(string serviceName)
{
if (!services.ContainsKey(serviceName)) throw new KeyNotFoundException($"Service under name \"{serviceName}\" not found.");
return services[serviceName].GetServiceState();
}
public void StartService(string serviceName)

14
src/GameServiceWarden.Host/UMLSketch.drawio
View File

@@ -1,26 +1,26 @@
<mxfile host="65bd71144e" modified="2020-12-24T22:37:11.750Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Code/1.52.1 Chrome/83.0.4103.122 Electron/9.3.5 Safari/537.36" etag="I0usdzu5wRPewA4HBn-M" version="13.10.0" type="embed">
<mxfile host="65bd71144e" modified="2020-12-26T07:51:18.537Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Code/1.52.1 Chrome/83.0.4103.122 Electron/9.3.5 Safari/537.36" etag="Iqq-QtiSg1pcXFCyEV9I" version="13.10.0" type="embed">
<diagram id="LHR7ubqCPd17_LyHkaH9" name="Structure">
<mxGraphModel dx="895" dy="510" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
<mxGraphModel dx="850" dy="740" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
<root>
<mxCell id="0"/>
<mxCell id="1" parent="0"/>
<mxCell id="v9q6W0nyI9kZyF3peKlB-5" style="edgeStyle=orthogonalEdgeStyle;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=1;entryDx=0;entryDy=0;jumpStyle=none;dashed=1;endArrow=block;endFill=0;exitX=1;exitY=0;exitDx=0;exitDy=0;sketch=1;curved=1;" parent="1" source="v9q6W0nyI9kZyF3peKlB-1" target="v9q6W0nyI9kZyF3peKlB-4" edge="1">
<mxGeometry relative="1" as="geometry"/>
</mxCell>
<mxCell id="v9q6W0nyI9kZyF3peKlB-1" value="&lt;table border=&quot;1&quot; width=&quot;100%&quot; cellpadding=&quot;4&quot; style=&quot;width: 100% ; height: 100% ; border-collapse: collapse&quot;&gt;&lt;tbody&gt;&lt;tr&gt;&lt;th align=&quot;center&quot;&gt;ServiceInfo (entity)&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td align=&quot;center&quot;&gt;- serviceName: string&lt;br&gt;- controlLock: object&lt;br&gt;- state: ServiceState&lt;br&gt;- service: IGameService&lt;br&gt;- serviceConsoleStream: Stream&lt;br&gt;- moduleName: string&lt;br&gt;- assemblyName: string&lt;br&gt;- Dictionary&amp;lt;string, IConfigurable&amp;gt;&lt;br&gt;- disposed: bool&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td align=&quot;center&quot;&gt;+ Start(): void&lt;br&gt;+ Stop(): void&lt;br&gt;+ GetConfigurables(): IReadOnlyDictionary&amp;lt;string, IConfigurable&amp;gt;&lt;br&gt;+ GetServiceState(): ServiceState&lt;br&gt;+ getModuleName(): string&lt;br&gt;+ GetassemblyName(): string&lt;br&gt;+ SetServiceName(name: string): void // Implemented as property&lt;br&gt;+ GetServiceName(): string // Implemented as property&lt;br&gt;+ GetServiceConsoleStream(): Stream // Implemented as property&lt;br&gt;- OnServiceStateChange(curr: ServiceState,&amp;nbsp;prev: ServiceState): void&lt;br&gt;# Dispose(disposing: bool): void&lt;br&gt;+ Dispose(): void&lt;br&gt;&lt;/td&gt;&lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;" style="text;html=1;fillColor=none;overflow=fill;strokeColor=#f0f0f0;sketch=1;" parent="1" vertex="1">
<mxCell id="v9q6W0nyI9kZyF3peKlB-1" value="&lt;table border=&quot;1&quot; width=&quot;100%&quot; cellpadding=&quot;4&quot; style=&quot;width: 100% ; height: 100% ; border-collapse: collapse&quot;&gt;&lt;tbody&gt;&lt;tr&gt;&lt;th align=&quot;center&quot;&gt;ServiceInfo (entity)&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td align=&quot;center&quot;&gt;- serviceName: string&lt;br&gt;- controlLock: object&lt;br&gt;- state: ServiceState&lt;br&gt;- service: IGameService&lt;br&gt;- serviceConsoleStream: Stream&lt;br&gt;- moduleName: string&lt;br&gt;- assemblyName: string&lt;br&gt;- Dictionary&amp;lt;string, IConfigurable&amp;gt;&lt;br&gt;- disposed: bool&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td align=&quot;center&quot;&gt;+ Start(): void&lt;br&gt;+ Stop(): void&lt;br&gt;+ GetConfigurableOptions(): ISet&amp;lt;string&amp;gt;&lt;br&gt;+ SetConfigurableValue(configurationName: string, value: string): bool&lt;br&gt;+ GetConfigurableValue(configurationName: string): string&lt;br&gt;+ GetServiceState(): ServiceState&lt;br&gt;+ getModuleName(): string&lt;br&gt;+ GetassemblyName(): string&lt;br&gt;+ SetServiceName(name: string): void // Implemented as property&lt;br&gt;+ GetServiceName(): string // Implemented as property&lt;br&gt;+ GetServiceConsoleStream(): Stream // Implemented as property&lt;br&gt;- OnServiceStateChange(curr: ServiceState,&amp;nbsp;prev: ServiceState): void&lt;br&gt;# Dispose(disposing: bool): void&lt;br&gt;+ Dispose(): void&lt;br&gt;&lt;/td&gt;&lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;" style="text;html=1;fillColor=none;overflow=fill;strokeColor=#f0f0f0;sketch=1;" parent="1" vertex="1">
<mxGeometry x="950" y="950" width="400" height="410" as="geometry"/>
</mxCell>
<mxCell id="6" style="edgeStyle=orthogonalEdgeStyle;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;fontStyle=1;sketch=1;curved=1;" parent="1" source="v9q6W0nyI9kZyF3peKlB-2" target="v9q6W0nyI9kZyF3peKlB-1" edge="1">
<mxGeometry relative="1" as="geometry"/>
</mxCell>
<mxCell id="v9q6W0nyI9kZyF3peKlB-2" value="&lt;table border=&quot;1&quot; width=&quot;100%&quot; cellpadding=&quot;4&quot; style=&quot;width: 100% ; height: 100% ; border-collapse: collapse&quot;&gt;&lt;tbody&gt;&lt;tr&gt;&lt;th align=&quot;center&quot;&gt;ServiceManager (Use-case)&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td align=&quot;center&quot;&gt;- services: Dictionary&amp;lt;string, Service&amp;gt;&lt;br&gt;- modules: Dictionary&amp;lt;string, Dictionary&amp;lt;string, IGameServiceModule&amp;gt;&amp;gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td align=&quot;center&quot;&gt;+ AddModule(assemblyName: string, module: IGameServiceModule): void&lt;br&gt;+ RemoveModule(assemblyName: string, moduleName string): void&lt;br&gt;+ CreateService(serviceName: string, assemblyName: string, moduleName: string): void&lt;br&gt;+ GetServiceNames(): IReadOnlyCollection&amp;lt;string&amp;gt;&lt;br&gt;+ GetServiceOptions(serviceName: string): IEnumerable&amp;lt;string&amp;gt;&lt;br&gt;+ SetServiceOptionValue(serviceName: string, optionName: string, string: value): bool&lt;br&gt;+ StartService(serviceName: string): void&lt;br&gt;+ StopService(serviceName: string): void&lt;br&gt;+ ExecuteCommand(serviceName: string, command: string): void&lt;br&gt;+ GetServiceConsoleStream(): Stream&lt;/td&gt;&lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;" style="text;html=1;fillColor=none;overflow=fill;strokeColor=#f0f0f0;sketch=1;" parent="1" vertex="1">
<mxGeometry x="640" y="610" width="490" height="280" as="geometry"/>
<mxCell id="v9q6W0nyI9kZyF3peKlB-2" value="&lt;table border=&quot;1&quot; width=&quot;100%&quot; cellpadding=&quot;4&quot; style=&quot;width: 100% ; height: 100% ; border-collapse: collapse&quot;&gt;&lt;tbody&gt;&lt;tr&gt;&lt;th align=&quot;center&quot;&gt;ServiceManager (Use-case)&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td align=&quot;center&quot;&gt;- services: Dictionary&amp;lt;string, Service&amp;gt;&lt;br&gt;- modules: Dictionary&amp;lt;string, Dictionary&amp;lt;string, IGameServiceModule&amp;gt;&amp;gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td align=&quot;center&quot;&gt;+ AddModule(assemblyName: string, module: IGameServiceModule): void&lt;br&gt;+ RemoveModule(assemblyName: string, moduleName string): void&lt;br&gt;+ CreateService(serviceName: string, assemblyName: string, moduleName: string): void&lt;br&gt;+ GetServiceNames(): IReadOnlyCollection&amp;lt;string&amp;gt;&lt;br&gt;+ GetServiceOptionsValue(serviceName: string): IEnumerable&amp;lt;string&amp;gt;&lt;br&gt;+ SetServiceOptionValue(serviceName: string, optionName: string, string: value): bool&lt;br&gt;+ GetServiceState(serviceName: string): ServiceState&lt;br&gt;+ StartService(serviceName: string): void&lt;br&gt;+ StopService(serviceName: string): void&lt;br&gt;+ ExecuteCommand(serviceName: string, command: string): void&lt;br&gt;+ GetServiceConsoleStream(): Stream&lt;/td&gt;&lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;" style="text;html=1;fillColor=none;overflow=fill;strokeColor=#f0f0f0;sketch=1;" parent="1" vertex="1">
<mxGeometry x="640" y="570" width="490" height="290" as="geometry"/>
</mxCell>
<mxCell id="v9q6W0nyI9kZyF3peKlB-4" value="IDisposable" style="shape=ext;double=1;whiteSpace=wrap;html=1;sketch=1;" parent="1" vertex="1">
<mxGeometry x="1410" y="820" width="120" height="80" as="geometry"/>
</mxCell>
<mxCell id="v9q6W0nyI9kZyF3peKlB-13" value="&lt;table border=&quot;1&quot; width=&quot;100%&quot; cellpadding=&quot;4&quot; style=&quot;width: 100% ; height: 100% ; border-collapse: collapse&quot;&gt;&lt;tbody&gt;&lt;tr&gt;&lt;th align=&quot;center&quot;&gt;ModuleLoader (Gateway)&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td align=&quot;center&quot;&gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td align=&quot;center&quot;&gt;- InstantiateServiceables(assembly: Assembly): void&lt;br&gt;- LoadAssembly(path: string): void&lt;br&gt;+ LoadModules(path: string): IEnumerable&amp;lt;IGameServiceModule&amp;gt;&lt;br&gt;+ LoadAllModules(path: string[]): IEnumerable&amp;lt;IGameServiceModule&amp;gt;&lt;br&gt;+ LoadAllModules(path: IEnumerable&amp;lt;string&amp;gt;): IEnumerable&amp;lt;IGameServiceModule&amp;gt;&lt;br&gt;&lt;/td&gt;&lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;" style="text;html=1;fillColor=none;overflow=fill;strokeColor=#f0f0f0;sketch=1;" parent="1" vertex="1">
<mxGeometry x="110" y="280" width="490" height="250" as="geometry"/>
<mxGeometry x="90" y="280" width="490" height="250" as="geometry"/>
</mxCell>
<mxCell id="titdvn9p0HDrujjw1N2D-4" style="edgeStyle=orthogonalEdgeStyle;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.75;exitY=0;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;dashed=1;endArrow=block;endFill=0;sketch=1;curved=1;" parent="1" source="v9q6W0nyI9kZyF3peKlB-16" target="v9q6W0nyI9kZyF3peKlB-27" edge="1">
<mxGeometry relative="1" as="geometry"/>
@@ -38,7 +38,7 @@
<mxGeometry x="640" y="280" width="432.5" height="250" as="geometry"/>
</mxCell>
<mxCell id="v9q6W0nyI9kZyF3peKlB-23" value="&lt;table border=&quot;1&quot; width=&quot;100%&quot; cellpadding=&quot;4&quot; style=&quot;width: 100% ; height: 100% ; border-collapse: collapse&quot;&gt;&lt;tbody&gt;&lt;tr&gt;&lt;th align=&quot;center&quot;&gt;ServiceGateway (Gateway)&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td align=&quot;center&quot;&gt;- dataDirectory: string&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td align=&quot;center&quot;&gt;+ SaveService(name: string, assemblyName: string, moduleName: string): void&lt;br&gt;+ GetServiceName(path: string): string&lt;br&gt;+ GetServiceModuleName(path: string): string&lt;br&gt;+ GetAllServiceInfoPaths() IEnumerable&amp;lt;string&amp;gt;&lt;/td&gt;&lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;" style="text;html=1;fillColor=none;overflow=fill;strokeColor=#f0f0f0;sketch=1;" parent="1" vertex="1">
<mxGeometry x="110" y="545" width="490" height="230" as="geometry"/>
<mxGeometry x="90" y="545" width="490" height="230" as="geometry"/>
</mxCell>
<mxCell id="v9q6W0nyI9kZyF3peKlB-27" value="&lt;table border=&quot;1&quot; width=&quot;100%&quot; cellpadding=&quot;4&quot; style=&quot;width: 100% ; height: 100% ; border-collapse: collapse&quot;&gt;&lt;tbody&gt;&lt;tr&gt;&lt;th align=&quot;center&quot;&gt;ICommandable &amp;lt;I&amp;gt;&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td align=&quot;center&quot;&gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td align=&quot;center&quot;&gt;+ GetPrefix(): string&lt;br&gt;+ Validate(string input): bool&lt;br&gt;+ Execute(string input): void&lt;br&gt;+ Help(): string&lt;/td&gt;&lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;" style="text;html=1;fillColor=none;overflow=fill;strokeColor=#f0f0f0;sketch=1;" parent="1" vertex="1">
<mxGeometry x="900" y="50" width="250" height="170" as="geometry"/>