6237307473

Committed 19 Sep 2023 04:02PM UTC coverage: 57.015% (-0.4%) from 57.44%

Build # 6237307473

Build Type

push

github

Committed by

web-flow

Commit Message

Feature/rc4 (#1570)

* Syntax tidying
* Dependency updates
* Event handling singletons (ThrowImmediately and co)

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: James A Sutherland <>
Co-authored-by: James Friel <jfriel001@dundee.ac.uk>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Run Details

10734 of 20259 branches covered (0.0%)

Branch coverage included in aggregate %.

5922 of 5922 new or added lines in 565 files covered. (100.0%)

30687 of 52390 relevant lines covered (58.57%)

7361.8 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

83.64

/Rdmp.Core/DataLoad/Engine/LoadExecution/Components/Arguments/CommandLineHelper.cs

// Copyright (c) The University of Dundee 2018-2019
// This file is part of the Research Data Management Platform (RDMP).
// RDMP is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
// RDMP is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
// You should have received a copy of the GNU General Public License along with RDMP. If not, see <https://www.gnu.org/licenses/>.

using System;
using System.IO;
using System.Text.RegularExpressions;
using FAnsi.Discovery;
using Rdmp.Core.Curation;
using Rdmp.Core.Curation.Data.DataLoad;

namespace Rdmp.Core.DataLoad.Engine.LoadExecution.Components.Arguments;

/// <summary>
/// Helper class for assembling a command line parameters strings for an .exe.  This will wrap with quotes when there is whitespace etc.  Class can
/// be used when you have generic key value pairs you want to send to an exe as startup parameters.
/// </summary>
public class CommandLineHelper
{
    public static string CreateArgString(string name, object value)
    {
        if (string.IsNullOrWhiteSpace(name))
            throw new ArgumentException("The argument 'name' parameter is empty");

        if (!char.IsUpper(name, 0))
            throw new ArgumentException(
                $"The name argument should be in Pascal case, the first character in {name} should be uppercase");

        if (value is LoadDirectory loadDirectory)
            value = loadDirectory.RootPath.FullName;

        return value switch
        {
            null => throw new ArgumentException("The argument value is null"),
            bool => Convert.ToBoolean(value) ? $"-{ConvertArgNameToString(name)}" : "",
            LoadStage => CreateArgString(name, value.ToString()),
            DiscoveredDatabase dbInfo =>
                $"{CreateArgString("DatabaseName", dbInfo.GetRuntimeName())} {CreateArgString("DatabaseServer", dbInfo.Server.Name)}",
            _ => $"-{ConvertArgNameToString(name)}={GetValueString(value)}"
        };
    }

    public static string ConvertArgNameToString(string name) =>
        // Will split on capitals without breaking up capital sequences
        // e.g. 'TestArg' => 'test-arg' and 'TestTLAArg' => 'test-tla-arg'
        Regex.Replace(name, @"((?<=[a-z])[A-Z]|[A-Z](?=[a-z]))", @"-$1").ToLower();

    public static string GetValueString(object value)
    {
        return value switch
        {
            string s => s.Contains(' ')
                ? $@"""{value}"""
                : //<- looks like a snake (or a golf club? GM)
                s,
            DateTime dt =>
                $"\"{(dt.TimeOfDay.TotalSeconds.Equals(0) ? dt.ToString("yyyy-MM-dd") : dt.ToString("yyyy-MM-dd HH:mm:ss"))}\"",
            FileInfo fi => $"\"{fi.FullName}\"",
            _ => throw new ArgumentException(
                $"Cannot create a value string from an object of type {value.GetType().FullName}")
        };
    }
}

1	// Copyright (c) The University of Dundee 2018-2019
2	// This file is part of the Research Data Management Platform (RDMP).
3	// RDMP is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
4	// RDMP is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
5	// You should have received a copy of the GNU General Public License along with RDMP. If not, see <https://www.gnu.org/licenses/>.
6
7	using System;
8	using System.IO;
9	using System.Text.RegularExpressions;
10	using FAnsi.Discovery;
11	using Rdmp.Core.Curation;
12	using Rdmp.Core.Curation.Data.DataLoad;
13
14	namespace Rdmp.Core.DataLoad.Engine.LoadExecution.Components.Arguments;
15
16	/// <summary>
17	/// Helper class for assembling a command line parameters strings for an .exe. This will wrap with quotes when there is whitespace etc. Class can
18	/// be used when you have generic key value pairs you want to send to an exe as startup parameters.
19	/// </summary>
20	public class CommandLineHelper
21	{
22	public static string CreateArgString(string name, object value)
23	{
24	if (string.IsNullOrWhiteSpace(name))	18✔
25	throw new ArgumentException("The argument 'name' parameter is empty");	2✔
26
27	if (!char.IsUpper(name, 0))	16✔
28	throw new ArgumentException(	2✔
29	$"The name argument should be in Pascal case, the first character in {name} should be uppercase");	2✔
30
31	if (value is LoadDirectory loadDirectory)	14!
32	value = loadDirectory.RootPath.FullName;	×
33
34	return value switch	14!
35	{	14✔
36	null => throw new ArgumentException("The argument value is null"),	2✔
37	bool => Convert.ToBoolean(value) ? $"-{ConvertArgNameToString(name)}" : "",	×
38	LoadStage => CreateArgString(name, value.ToString()),	×
39	DiscoveredDatabase dbInfo =>	14✔
40	$"{CreateArgString("DatabaseName", dbInfo.GetRuntimeName())} {CreateArgString("DatabaseServer", dbInfo.Server.Name)}",	2✔
41	_ => $"-{ConvertArgNameToString(name)}={GetValueString(value)}"	10✔
42	};	14✔
43	}
44
45	public static string ConvertArgNameToString(string name) =>
46	// Will split on capitals without breaking up capital sequences
47	// e.g. 'TestArg' => 'test-arg' and 'TestTLAArg' => 'test-tla-arg'
48	Regex.Replace(name, @"((?<=[a-z])[A-Z]\|[A-Z](?=[a-z]))", @"-$1").ToLower();	10✔
49
50	public static string GetValueString(object value)
51	{
52	return value switch	18✔
53	{	18✔
54	string s => s.Contains(' ')	8!
55	? $@"""{value}"""	8✔
56	: //<- looks like a snake (or a golf club? GM)	8✔
57	s,	8✔
58	DateTime dt =>	18✔
59	$"\"{(dt.TimeOfDay.TotalSeconds.Equals(0) ? dt.ToString("yyyy-MM-dd") : dt.ToString("yyyy-MM-dd HH:mm:ss"))}\"",	6✔
60	FileInfo fi => $"\"{fi.FullName}\"",	2✔
61	_ => throw new ArgumentException(	2✔
62	$"Cannot create a value string from an object of type {value.GetType().FullName}")	2✔
63	};	18✔
64	}
65	}

HicServices / RDMP / 6237307473

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous