Skip to content

Commit

Permalink
Improved DiagnosticReport.
Browse files Browse the repository at this point in the history
  • Loading branch information
@NimaAra
NimaAra committed Jul 25, 2018
1 parent d9f25d1 commit 22d2e84
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 17 deletions.
1 change: 0 additions & 1 deletion Easy.Common.Tests.Unit/DiagnosticReport/DiagnosticReportTests.cs
View file
Expand Up @@ -453,7 +453,6 @@ public void When_generating_system_and_process_and_drives_and_assemblies_and_env
report.EnvironmentVariables.ShouldNotBeEmpty();
report.NetworkingDetails.ShouldNotBeNull();


var formattedReport = report.ToString();
formattedReport.ShouldNotBeNull();
formattedReport.Length.ShouldBeGreaterThan(1000);
Expand Down
91 changes: 77 additions & 14 deletions Easy.Common/DiagnosticReport/DiagnosticReport.cs
View file
Expand Up @@ -30,7 +30,7 @@ public class DiagnosticReport
private const char Space = ' ';
private const char Colon = ':';
private static readonly string NewLine = Environment.NewLine;
private static readonly string LinePrefix = Pipe + "\t";
private static readonly string LinePrefix = Pipe.ToString() + "\t";

private static readonly DiagnosticReportType[] ReportSections =
{
Expand Down Expand Up @@ -58,7 +58,7 @@ public class DiagnosticReport
"OS - Name",
"OS - Type",
"OS - 64Bit",
"CLR Runtime",
".NET Framework",
"Machine Name",
"FQDN",
"Installed RAM",
Expand Down Expand Up @@ -110,8 +110,8 @@ public class DiagnosticReport

private static readonly string[] NetworkHeaders =
{
"Host", "Domain", "DHCP Scope", "Node Type", "Is WINS Proxy",
"Name", "MAC", "Type", "Status", "Is Receive Only", "Supports Multicast", "Speed", "IP Addresses"
"Host", "Domain", "DHCP Scope", "Node Type", "Is WINS Proxy", "Name", "MAC",
"Type", "Status", "Is Receive Only", "Supports Multicast", "Speed", "IP Addresses"
};

/// <summary>
Expand Down Expand Up @@ -208,7 +208,7 @@ private static SystemDetails GetSystemDetails(DiagnosticReportType type)
OSName = RuntimeInformation.OSDescription,
OSType = GetOSPlatform(),
Is64BitOS = Environment.Is64BitOperatingSystem,
CLRRuntime = RuntimeInformation.FrameworkDescription,
DotNetFrameworkVersion = GetDotNetFrameworkVersion(),
MachineName = Environment.MachineName,
FQDN = NetworkHelper.GetFQDN(),
User = Environment.UserDomainName + "\\" + Environment.UserName,
Expand Down Expand Up @@ -393,7 +393,7 @@ private static void AddSystem(StringBuilder builder, DiagnosticReport report)
Format(SystemHeaders[0], report.SystemDetails.OSName);
Format(SystemHeaders[1], report.SystemDetails.OSType);
Format(SystemHeaders[2], report.SystemDetails.Is64BitOS);
Format(SystemHeaders[3], report.SystemDetails.CLRRuntime);
Format(SystemHeaders[3], report.SystemDetails.DotNetFrameworkVersion);
Format(SystemHeaders[4], report.SystemDetails.MachineName);
Format(SystemHeaders[5], report.SystemDetails.FQDN);
Format(SystemHeaders[9], report.SystemDetails.User);
Expand All @@ -404,7 +404,7 @@ private static void AddSystem(StringBuilder builder, DiagnosticReport report)
Format(SystemHeaders[11], report.SystemDetails.CurrentDirectory);
Format(SystemHeaders[12], report.SystemDetails.RuntimeDirectory);

string upTimeStr = "-";
var upTimeStr = "-";
if (report.SystemDetails.Uptime != TimeSpan.MinValue)
{
upTimeStr = report.SystemDetails.Uptime.ToString(@"dd\D\a\y\ hh\H\o\u\r\ mm\M\i\n\ ss\S\e\c");
Expand Down Expand Up @@ -633,7 +633,8 @@ private static void AddNetwork(StringBuilder builder, DiagnosticReport report)

void Format(string key, object value)
{
builder.AppendFormat(format, LinePrefix, Pipe, key, value?.ToString(), NewLine);
// ReSharper disable once RedundantToStringCall
builder.AppendFormat(format, LinePrefix, Pipe.ToString(), key, value?.ToString(), NewLine);
}
}

Expand Down Expand Up @@ -679,8 +680,8 @@ private static void WrapInTable(StringBuilder builder, string[] columnHeaders, L
for (var i = 0; i < columnHeaders.Length; i++)
{
var headerVal = columnHeaders[i];
var formatter = "{0} {1,-" + (cellLengths[i] - 2) + "} ";
headerBuilder.AppendFormat(formatter, Pipe, headerVal);
var formatter = "{0} {1,-" + (cellLengths[i] - 2).ToString() + "} ";
headerBuilder.AppendFormat(formatter, Pipe.ToString(), headerVal);
}
headerBuilder.Append(Pipe).AppendLine();

Expand All @@ -704,8 +705,8 @@ private static void WrapInTable(StringBuilder builder, string[] columnHeaders, L
builder.Append(LinePrefix);
for (var j = 0; j < row.Length; j++)
{
var formatter = "{0} {1,-" + (cellLengths[j] - 2) + "} ";
builder.AppendFormat(formatter, Pipe, row[j]);
var formatter = "{0} {1,-" + (cellLengths[j] - 2).ToString() + "} ";
builder.AppendFormat(formatter, Pipe.ToString(), row[j]);
}
builder.Append(Pipe).AppendLine();
}
Expand Down Expand Up @@ -858,7 +859,7 @@ private static TimeSpan GetUptimeLinux()
}

private static string GetSeperator(string title, int count)
=> $"{Pipe}{NewLine}{Pipe}{title}{Pipe}{new string(Dot, count - title.Length)}{NewLine}{Pipe}{NewLine}";
=> $"{Pipe.ToString()}{NewLine}{Pipe.ToString()}{title}{Pipe.ToString()}{new string(Dot, count - title.Length)}{NewLine}{Pipe.ToString()}{NewLine}";

private static string AsBashCommand(string command)
{
Expand All @@ -883,7 +884,6 @@ private static string AsBashCommand(string command)
return result;
}

// ReSharper disable once InconsistentNaming
private static string GetOSPlatform()
{
if (ApplicationHelper.OSPlatform == OSPlatform.Windows)
Expand All @@ -899,6 +899,69 @@ private static string GetOSPlatform()

private static bool IsWindowsServer() => IsOS(OS_ANYSERVER);

private static string GetDotNetFrameworkVersion()
{
Version version;

try
{
version = GetVersionFull();
return ".NET Framework " + version;
} catch (TypeInitializationException e) when (e.TypeName == "Microsoft.Win32.Registry")
{
try
{
version = GetVersionCore();
return ".NET Core " + version;
} catch (NotSupportedException)
{
return RuntimeInformation.FrameworkDescription + " (Self Contained)";
}
}

Version GetVersionCore()
{
const string REGEX_PATTERN = @"Microsoft\.NETCore\.App[\\,/](?<version>\d+\.\d+.\d+(.\d+)?)$";

var runtimePath = Path.GetDirectoryName(typeof(object).Assembly.Location);

var match = Regex.Match(runtimePath, REGEX_PATTERN);

if (!match.Success)
{
throw new NotSupportedException("Unable to detect a DotNet Core version, runtime path found: " + runtimePath);
}

return new Version(match.Groups["version"].Value);
}

// https://docs.microsoft.com/en-us/dotnet/framework/migration-guide/how-to-determine-which-versions-are-installed
Version GetVersionFull()
{
const string REG_KEY = @"SOFTWARE\Microsoft\NET Framework Setup\NDP\v4\Full";
using (var ndpKey = Registry.LocalMachine.OpenSubKey(REG_KEY))
{
if (ndpKey != null)
{
var value = (int)(ndpKey.GetValue("Release") ?? 0);
if (value >= 461808) { return new Version(4, 7, 2); }
if (value >= 461308) { return new Version(4, 7, 1); }
if (value >= 460798) { return new Version(4, 7, 0); }
if (value >= 394802) { return new Version(4, 6, 2); }
if (value >= 394254) { return new Version(4, 6, 1); }
if (value >= 393295) { return new Version(4, 6, 0); }
if (value >= 379893) { return new Version(4, 5, 2); }
if (value >= 378675) { return new Version(4, 5, 1); }
if (value >= 378389) { return new Version(4, 5, 0); }

throw new NotSupportedException("Unable to detect a DotNet framework version of 4.5 or later, framework key value found: " + value.ToString());
}

throw new NotSupportedException($"Unable to find a registry key under '{REG_KEY}'.");
}
}
}

/// <summary>
/// <see href="https://msdn.microsoft.com/en-us/library/windows/desktop/cc300158(v=vs.85).aspx"/>
/// </summary>
Expand Down
4 changes: 2 additions & 2 deletions Easy.Common/DiagnosticReport/SystemDetails.cs
View file
Expand Up @@ -26,9 +26,9 @@ public sealed class SystemDetails
public bool Is64BitOS { get; internal set; }

/// <summary>
/// Gets the version of the <c>CLR</c>.
/// Gets the version of the <c>.NET</c> framework.
/// </summary>
public string CLRRuntime { get; internal set; }
public string DotNetFrameworkVersion { get; internal set; }

/// <summary>
/// Gets the machine name.
Expand Down

0 comments on commit 22d2e84

Please sign in to comment.