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

72.55

/Rdmp.Core/ReusableLibraryCode/Checks/CheckEventArgs.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 Rdmp.Core.ReusableLibraryCode.Progress;
using Rdmp.Core.ReusableLibraryCode.Settings;

namespace Rdmp.Core.ReusableLibraryCode.Checks;

/// <summary>
/// Created when an ICheckable performs a check to indicate whether the check passed or not and whether there is an Exception or ProposedFix.  ProposedFix
/// is a string that suggests how a problem can be resolved but where the resolution might be undesireable under certain circumstances (hence the choice).
/// 
/// <para>The workflow is:
/// 1. ICheckable has its Check method called with an ICheckNotifier
/// 2. Check logic performed
/// 3. CheckEventArgs created and ICheckNotifier.OnCheckPerformed called
/// 4. ICheckNotifier decides how to respond to the message (which can include throwing an Exception - which you should not catch/suppress).
/// 5. If OnCheckPerformed compeltes without Exception evaluate the bool return if there was a ProposedFix and apply the fix if it is true</para>
/// 
/// </summary>
public partial class CheckEventArgs : IHasSummary
{
    public string Message { get; set; }
    public CheckResult Result { get; set; }
    public Exception Ex { get; set; }
    public string ProposedFix { get; set; }
    public string StackTrace { get; set; }

    public DateTime EventDate { get; private set; }

    public CheckEventArgs(string message, CheckResult result, Exception ex = null, string proposedFix = null)
    {
        Message = message;
        Result = result;
        Ex = ex;
        ProposedFix = proposedFix;

        EventDate = DateTime.Now;

        try
        {
            StackTrace = Environment.StackTrace;
        }
        catch (Exception)
        {
            //Stack trace not available ah well
        }
    }

    public CheckEventArgs(ErrorCode code, params object[] formatStringArgs) : this(code, null, null, formatStringArgs)
    {
    }

    public CheckEventArgs(ErrorCode code, Exception ex, params object[] formatStringArgs) : this(code, ex, null,
        formatStringArgs)
    {
    }

    /// <summary>
    /// Reports an event from the standard list in <see cref="ErrorCodes"/> at the <see cref="ErrorCode.DefaultTreatment"/> check
    /// level (or the customised reporting level in <see cref="UserSettings"/>).
    /// </summary>
    /// <param name="code"></param>
    /// <param name="ex"></param>
    /// <param name="proposedFix"></param>
    /// <param name="formatStringArgs"></param>
    public CheckEventArgs(ErrorCode code, Exception ex, string proposedFix, params object[] formatStringArgs)
    {
        Message = $"{code.Code} {string.Format(code.Message, formatStringArgs)}";
        Result = UserSettings.GetErrorReportingLevelFor(code);
        Ex = ex;
        ProposedFix = proposedFix;

        EventDate = DateTime.Now;

        try
        {
            StackTrace = Environment.StackTrace;
        }
        catch (Exception)
        {
            //Stack trace not available ah well
        }
    }

    public override string ToString() => Message;

    public NotifyEventArgs ToNotifyEventArgs()
    {
        var status = Result switch
        {
            CheckResult.Success => ProgressEventType.Information,
            CheckResult.Warning => ProgressEventType.Warning,
            CheckResult.Fail => ProgressEventType.Error,
            _ => throw new ArgumentOutOfRangeException()
        };

        return new NotifyEventArgs(status, Message, Ex);
    }

    public void GetSummary(out string title, out string body, out string stackTrace, out CheckResult level)
    {
        title = "Check Result";
        body = Message;
        stackTrace = StackTrace;
        level = Result;
    }
}

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 Rdmp.Core.ReusableLibraryCode.Progress;
9	using Rdmp.Core.ReusableLibraryCode.Settings;
10
11	namespace Rdmp.Core.ReusableLibraryCode.Checks;
12
13	/// <summary>
14	/// Created when an ICheckable performs a check to indicate whether the check passed or not and whether there is an Exception or ProposedFix. ProposedFix
15	/// is a string that suggests how a problem can be resolved but where the resolution might be undesireable under certain circumstances (hence the choice).
16	///
17	/// <para>The workflow is:
18	/// 1. ICheckable has its Check method called with an ICheckNotifier
19	/// 2. Check logic performed
20	/// 3. CheckEventArgs created and ICheckNotifier.OnCheckPerformed called
21	/// 4. ICheckNotifier decides how to respond to the message (which can include throwing an Exception - which you should not catch/suppress).
22	/// 5. If OnCheckPerformed compeltes without Exception evaluate the bool return if there was a ProposedFix and apply the fix if it is true</para>
23	///
24	/// </summary>
25	public partial class CheckEventArgs : IHasSummary
26	{
27	public string Message { get; set; }	4,792✔
28	public CheckResult Result { get; set; }	8,623✔
29	public Exception Ex { get; set; }	4,802✔
30	public string ProposedFix { get; set; }	6,172✔
31	public string StackTrace { get; set; }	4,428✔
32
33	public DateTime EventDate { get; private set; }	4,428✔
34
35	public CheckEventArgs(string message, CheckResult result, Exception ex = null, string proposedFix = null)	4,406✔
36	{
37	Message = message;	4,406✔
38	Result = result;	4,406✔
39	Ex = ex;	4,406✔
40	ProposedFix = proposedFix;	4,406✔
41
42	EventDate = DateTime.Now;	4,406✔
43
44	try
45	{
46	StackTrace = Environment.StackTrace;	4,406✔
47	}	4,406✔
48	catch (Exception)	×
49	{
50	//Stack trace not available ah well
51	}	×
52	}	4,406✔
53
54	public CheckEventArgs(ErrorCode code, params object[] formatStringArgs) : this(code, null, null, formatStringArgs)	14✔
55	{
56	}	14✔
57
58	public CheckEventArgs(ErrorCode code, Exception ex, params object[] formatStringArgs) : this(code, ex, null,	8✔
59	formatStringArgs)	8✔
60	{
61	}	8✔
62
63	/// <summary>
64	/// Reports an event from the standard list in <see cref="ErrorCodes"/> at the <see cref="ErrorCode.DefaultTreatment"/> check
65	/// level (or the customised reporting level in <see cref="UserSettings"/>).
66	/// </summary>
67	/// <param name="code"></param>
68	/// <param name="ex"></param>
69	/// <param name="proposedFix"></param>
70	/// <param name="formatStringArgs"></param>
71	public CheckEventArgs(ErrorCode code, Exception ex, string proposedFix, params object[] formatStringArgs)	22✔
72	{
73	Message = $"{code.Code} {string.Format(code.Message, formatStringArgs)}";	22✔
74	Result = UserSettings.GetErrorReportingLevelFor(code);	22✔
75	Ex = ex;	22✔
76	ProposedFix = proposedFix;	22✔
77
78	EventDate = DateTime.Now;	22✔
79
80	try
81	{
82	StackTrace = Environment.StackTrace;	22✔
83	}	22✔
84	catch (Exception)	×
85	{
86	//Stack trace not available ah well
87	}	×
88	}	22✔
89
90	public override string ToString() => Message;	×
91
92	public NotifyEventArgs ToNotifyEventArgs()
93	{
94	var status = Result switch	124!
95	{	124✔
96	CheckResult.Success => ProgressEventType.Information,	110✔
97	CheckResult.Warning => ProgressEventType.Warning,	14✔
98	CheckResult.Fail => ProgressEventType.Error,	×
99	_ => throw new ArgumentOutOfRangeException()	×
100	};	124✔
101
102	return new NotifyEventArgs(status, Message, Ex);	124✔
103	}
104
105	public void GetSummary(out string title, out string body, out string stackTrace, out CheckResult level)
106	{
107	title = "Check Result";	×
108	body = Message;	×
109	stackTrace = StackTrace;	×
110	level = Result;	×
111	}	×
112	}

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