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

75.56

/Rdmp.Core/ReusableLibraryCode/DatabaseCommandHelper.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.Collections.Generic;
using System.Data.Common;
using System.Linq;
using FAnsi;
using FAnsi.Discovery;
using FAnsi.Implementation;
using FAnsi.Implementations.MicrosoftSQL;
using FAnsi.Implementations.MySql;
using FAnsi.Implementations.Oracle;
using FAnsi.Implementations.PostgreSql;
using Microsoft.Data.SqlClient;
using MySqlConnector;
using Npgsql;
using Oracle.ManagedDataAccess.Client;
using Rdmp.Core.ReusableLibraryCode.Performance;

namespace Rdmp.Core.ReusableLibraryCode;

/// <summary>
/// Provides Cross Database Platform Type translation e.g. GetCommand returns SqlCommand when passed an SqlConnection and a MySqlCommand when passed a
/// MySqlConnection (etc).  Also provides central debugging/performance evaluation of the queries RDMP is using to access Catalogue databases etc via
/// installing a ComprehensiveQueryPerformanceCounter.
/// </summary>
public class DatabaseCommandHelper
{
    private static readonly Dictionary<DatabaseType, IImplementation> _dbConHelpersByType = new()
    {
        { DatabaseType.MySql, new MySqlImplementation() },
        { DatabaseType.Oracle, new OracleImplementation() },
        { DatabaseType.MicrosoftSQLServer, new MicrosoftSQLImplementation() },
        { DatabaseType.PostgreSql, new PostgreSqlImplementation() }
    };

    public static ComprehensiveQueryPerformanceCounter PerformanceCounter = null;

    /// <summary>
    /// Sets the default Global timeout in seconds for new DbCommand objects being created
    /// </summary>
    public static int GlobalTimeout = 30;


    public static IDiscoveredServerHelper For(DbConnection con)
    {
        return _dbConHelpersByType.Values.Single(i => i.IsFor(con)).GetServerHelper();
    }

    public static IDiscoveredServerHelper For(DbConnectionStringBuilder connectionStringBuilder)
    {
        return _dbConHelpersByType.Values.Single(i => i.IsFor(connectionStringBuilder)).GetServerHelper();
    }

    public static IDiscoveredServerHelper For(DatabaseType dbType) => _dbConHelpersByType[dbType].GetServerHelper();

    public static IDiscoveredServerHelper For(DbCommand cmd)
    {
        return cmd switch
        {
            SqlCommand => _dbConHelpersByType[DatabaseType.MicrosoftSQLServer].GetServerHelper(),
            OracleCommand => _dbConHelpersByType[DatabaseType.Oracle].GetServerHelper(),
            MySqlCommand => _dbConHelpersByType[DatabaseType.MySql].GetServerHelper(),
            NpgsqlCommand => _dbConHelpersByType[DatabaseType.PostgreSql].GetServerHelper(),
            _ => throw new NotSupportedException($"Didn't know what helper to use for DbCommand Type {cmd.GetType()}")
        };
        //todo: add this method to implementation in FAnsi
        //return _dbConHelpersByType.Values.Single(i => i.IsFor(cmd)).GetServerHelper();
    }

    public static DbCommand GetCommand(string s, DbConnection con, DbTransaction transaction = null)
    {
        var cmd = For(con).GetCommand(s, con, transaction);

        PerformanceCounter?.AddAudit(cmd, Environment.StackTrace.ToString());

        cmd.CommandTimeout = GlobalTimeout;
        return cmd;
    }

    public static DbCommand GetInsertCommand(DbCommand cmd)
    {
        var toReturn = For(cmd).GetCommandBuilder(cmd).GetInsertCommand(true);
        toReturn.CommandTimeout = cmd.CommandTimeout = GlobalTimeout;

        return toReturn;
    }

    public static DbParameter GetParameter(string parameterName, DbCommand forCommand) =>
        For(forCommand).GetParameter(parameterName);

    public static DbParameter GetParameter(string parameterName, DatabaseType databaseType) =>
        For(databaseType).GetParameter(parameterName);

    // only used in missing fields checker, should be in UsefulStuff?
    public static DbConnection GetConnection(DbConnectionStringBuilder connectionStringBuilder) =>
        For(connectionStringBuilder).GetConnection(connectionStringBuilder);

    public static DbDataAdapter GetDataAdapter(DbCommand cmd) => For(cmd).GetDataAdapter(cmd);

    public static void AddParameterWithValueToCommand(string parameterName, DbCommand command, object valueForParameter)
    {
        var dbParameter = GetParameter(parameterName, command);
        dbParameter.Value = valueForParameter;
        command.Parameters.Add(dbParameter);
    }
}

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.Collections.Generic;
9	using System.Data.Common;
10	using System.Linq;
11	using FAnsi;
12	using FAnsi.Discovery;
13	using FAnsi.Implementation;
14	using FAnsi.Implementations.MicrosoftSQL;
15	using FAnsi.Implementations.MySql;
16	using FAnsi.Implementations.Oracle;
17	using FAnsi.Implementations.PostgreSql;
18	using Microsoft.Data.SqlClient;
19	using MySqlConnector;
20	using Npgsql;
21	using Oracle.ManagedDataAccess.Client;
22	using Rdmp.Core.ReusableLibraryCode.Performance;
23
24	namespace Rdmp.Core.ReusableLibraryCode;
25
26	/// <summary>
27	/// Provides Cross Database Platform Type translation e.g. GetCommand returns SqlCommand when passed an SqlConnection and a MySqlCommand when passed a
28	/// MySqlConnection (etc). Also provides central debugging/performance evaluation of the queries RDMP is using to access Catalogue databases etc via
29	/// installing a ComprehensiveQueryPerformanceCounter.
30	/// </summary>
31	public class DatabaseCommandHelper
32	{
33	private static readonly Dictionary<DatabaseType, IImplementation> _dbConHelpersByType = new()	4✔
34	{	4✔
35	{ DatabaseType.MySql, new MySqlImplementation() },	4✔
36	{ DatabaseType.Oracle, new OracleImplementation() },	4✔
37	{ DatabaseType.MicrosoftSQLServer, new MicrosoftSQLImplementation() },	4✔
38	{ DatabaseType.PostgreSql, new PostgreSqlImplementation() }	4✔
39	};	4✔
40
41	public static ComprehensiveQueryPerformanceCounter PerformanceCounter = null;	4✔
42
43	/// <summary>
44	/// Sets the default Global timeout in seconds for new DbCommand objects being created
45	/// </summary>
46	public static int GlobalTimeout = 30;	4✔
47
48
49	public static IDiscoveredServerHelper For(DbConnection con)
50	{
51	return _dbConHelpersByType.Values.Single(i => i.IsFor(con)).GetServerHelper();	2,499,225✔
52	}
53
54	public static IDiscoveredServerHelper For(DbConnectionStringBuilder connectionStringBuilder)
55	{
56	return _dbConHelpersByType.Values.Single(i => i.IsFor(connectionStringBuilder)).GetServerHelper();	650✔
57	}
58
59	public static IDiscoveredServerHelper For(DatabaseType dbType) => _dbConHelpersByType[dbType].GetServerHelper();	1,098✔
60
61	public static IDiscoveredServerHelper For(DbCommand cmd)
62	{
63	return cmd switch	437,397!
64	{	437,397✔
65	SqlCommand => _dbConHelpersByType[DatabaseType.MicrosoftSQLServer].GetServerHelper(),	416,735✔
66	OracleCommand => _dbConHelpersByType[DatabaseType.Oracle].GetServerHelper(),	×
67	MySqlCommand => _dbConHelpersByType[DatabaseType.MySql].GetServerHelper(),	20,662✔
68	NpgsqlCommand => _dbConHelpersByType[DatabaseType.PostgreSql].GetServerHelper(),	×
69	_ => throw new NotSupportedException($"Didn't know what helper to use for DbCommand Type {cmd.GetType()}")	×
70	};	437,397✔
71	//todo: add this method to implementation in FAnsi
72	//return _dbConHelpersByType.Values.Single(i => i.IsFor(cmd)).GetServerHelper();
73	}
74
75	public static DbCommand GetCommand(string s, DbConnection con, DbTransaction transaction = null)
76	{
77	var cmd = For(con).GetCommand(s, con, transaction);	499,845✔
78
79	PerformanceCounter?.AddAudit(cmd, Environment.StackTrace.ToString());	499,845✔
80
81	cmd.CommandTimeout = GlobalTimeout;	499,845✔
82	return cmd;	499,845✔
83	}
84
85	public static DbCommand GetInsertCommand(DbCommand cmd)
86	{
87	var toReturn = For(cmd).GetCommandBuilder(cmd).GetInsertCommand(true);	×
88	toReturn.CommandTimeout = cmd.CommandTimeout = GlobalTimeout;	×
89
90	return toReturn;	×
91	}
92
93	public static DbParameter GetParameter(string parameterName, DbCommand forCommand) =>
94	For(forCommand).GetParameter(parameterName);	437,387✔
95
96	public static DbParameter GetParameter(string parameterName, DatabaseType databaseType) =>
97	For(databaseType).GetParameter(parameterName);	×
98
99	// only used in missing fields checker, should be in UsefulStuff?
100	public static DbConnection GetConnection(DbConnectionStringBuilder connectionStringBuilder) =>
101	For(connectionStringBuilder).GetConnection(connectionStringBuilder);	130✔
102
103	public static DbDataAdapter GetDataAdapter(DbCommand cmd) => For(cmd).GetDataAdapter(cmd);	10✔
104
105	public static void AddParameterWithValueToCommand(string parameterName, DbCommand command, object valueForParameter)
106	{
107	var dbParameter = GetParameter(parameterName, command);	45,338✔
108	dbParameter.Value = valueForParameter;	45,338✔
109	command.Parameters.Add(dbParameter);	45,338✔
110	}	45,338✔
111	}

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