6658089448

Committed 26 Oct 2023 06:10PM UTC coverage: 56.911% (-0.07%) from 56.985%

Build # 6658089448

Build Type

push

github

Committed by

web-flow

Commit Message

RDMP-15 Use .bak files as Data Loads (#1656)

* basic ui triggers
* working dl

---------

Co-authored-by: James A Sutherland <j@sutherland.pw>

Run Details

10695 of 20239 branches covered (0.0%)

Branch coverage included in aggregate %.

89 of 89 new or added lines in 6 files covered. (100.0%)

30536 of 52209 relevant lines covered (58.49%)

7341.8 hits per line

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

0.0

/Rdmp.Core/DataLoad/Engine/LoadExecution/Components/Runtime/ExecuteSqlBakFileRuntimeTask.cs

﻿// Copyright (c) The University of Dundee 2018-2023
// 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.Data;
using System.IO;
using System.Linq;
using Microsoft.Data.SqlClient;
using MongoDB.Driver.Core.Servers;
using Rdmp.Core.Curation.Data.DataLoad;
using Rdmp.Core.DataFlowPipeline;
using Rdmp.Core.DataLoad.Engine.Job;
using Rdmp.Core.DataLoad.Engine.LoadExecution.Components.Arguments;
using Rdmp.Core.DataLoad.Modules.Mutilators;
using Rdmp.Core.ReusableLibraryCode.Checks;
using Rdmp.Core.ReusableLibraryCode.Progress;

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

/// <summary>
/// RuntimeTask that executes a single .bak file specified by the user in a ProcessTask with ProcessTaskType SQLBakFile.
/// </summary>
public class ExecuteSqlBakFileRuntimeTask : RuntimeTask
{
    public string Filepath;
    private readonly IProcessTask _task;

    private LoadStage _loadStage;

    public ExecuteSqlBakFileRuntimeTask(IProcessTask task, RuntimeArgumentCollection args) : base(task, args)
    {
        _task = task;
        Filepath = task.Path;
    }

    public override ExitCodeType Run(IDataLoadJob job, GracefulCancellationToken cancellationToken)
    {
        var db = RuntimeArguments.StageSpecificArguments.DbInfo;
        _loadStage = RuntimeArguments.StageSpecificArguments.LoadStage;

        if (!Exists())
            throw new Exception($"The sql bak file {Filepath} does not exist");

        string fileOnlyCommand = $"RESTORE FILELISTONLY FROM DISK = '{Filepath}'";
        using var fileInfo = new DataTable();
        using var con = (SqlConnection)db.Server.GetConnection();
        using (var cmd = new SqlCommand(fileOnlyCommand, con))
          using (var da = new SqlDataAdapter(cmd))
            da.Fill(fileInfo);
        DataRow[] primaryFiles = fileInfo.Select("Type = 'D'");
        DataRow[] logFiles = fileInfo.Select("Type = 'L'");
        if (primaryFiles.Length != 1 || logFiles.Length != 1)
        {
            //Something has gone wrong
            return ExitCodeType.Error;
        }


        DataRow primaryFile = primaryFiles[0];
        DataRow logFile = logFiles[0];
        string primaryFilePhysicalName = primaryFile["PhysicalName"].ToString();
        string logFilePhysicalName = logFile["PhysicalName"].ToString();

        if (File.Exists(primaryFilePhysicalName) || File.Exists(logFilePhysicalName))
        {
            string timestamp = DateTime.Now.Millisecond.ToString();
            string primaryFileName = primaryFilePhysicalName.Substring(0, primaryFilePhysicalName.Length - 4);
            string primaryFileExtention = primaryFilePhysicalName.Substring(primaryFilePhysicalName.Length - 4);
            primaryFilePhysicalName = $"{primaryFileName}_{timestamp}{primaryFileExtention}";
            string logFileName = logFilePhysicalName.Substring(0, logFilePhysicalName.Length - 4);
            string logFileExtention = logFilePhysicalName.Substring(logFilePhysicalName.Length - 4);
            logFilePhysicalName = $"{logFileName}_{timestamp}{logFileExtention}";
        }

        string name = db.ToString();

        string restoreCommand = @$"
        use master;
        ALTER DATABASE {name} SET SINGLE_USER WITH ROLLBACK IMMEDIATE;
        RESTORE DATABASE {name}
        FROM DISK = '{Filepath}'
        WITH MOVE '{primaryFile["LogicalName"]}' TO '{primaryFilePhysicalName}',
        MOVE '{logFile["LogicalName"]}' TO '{logFilePhysicalName}' ,  NOUNLOAD,  REPLACE,  STATS = 5;
        ALTER DATABASE {name} SET MULTI_USER;
        ";

        job.OnNotify(this, new NotifyEventArgs(ProgressEventType.Information,
            $"Executing script {Filepath} ( against {db})"));

        var executer = new ExecuteSqlInDleStage(job, _loadStage);
        return executer.Execute(restoreCommand, db);
    }


    public override bool Exists() => File.Exists(Filepath);

    public override void Abort(IDataLoadEventListener postLoadEventListener)
    {
    }

    public override void LoadCompletedSoDispose(ExitCodeType exitCode, IDataLoadEventListener postLoadEventListener)
    {
    }

    public override void Check(ICheckNotifier notifier)
    {
        if (string.IsNullOrWhiteSpace(Filepath))
        {
            notifier.OnCheckPerformed(
                new CheckEventArgs($"ExecuteSqlFileTask {_task} does not have a path specified",
                    CheckResult.Fail));
            return;
        }

        if (!File.Exists(Filepath))
            notifier.OnCheckPerformed(
                new CheckEventArgs(
                    $"File '{Filepath}' does not exist! (the only time this would be legal is if you have an exe or a freaky plugin that creates this file)",
                    CheckResult.Warning));
        else
            notifier.OnCheckPerformed(new CheckEventArgs($"Found File '{Filepath}'",
                CheckResult.Success));
    }
}

1	// Copyright (c) The University of Dundee 2018-2023
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.Data;
9	using System.IO;
10	using System.Linq;
11	using Microsoft.Data.SqlClient;
12	using MongoDB.Driver.Core.Servers;
13	using Rdmp.Core.Curation.Data.DataLoad;
14	using Rdmp.Core.DataFlowPipeline;
15	using Rdmp.Core.DataLoad.Engine.Job;
16	using Rdmp.Core.DataLoad.Engine.LoadExecution.Components.Arguments;
17	using Rdmp.Core.DataLoad.Modules.Mutilators;
18	using Rdmp.Core.ReusableLibraryCode.Checks;
19	using Rdmp.Core.ReusableLibraryCode.Progress;
20
21	namespace Rdmp.Core.DataLoad.Engine.LoadExecution.Components.Runtime;
22
23	/// <summary>
24	/// RuntimeTask that executes a single .bak file specified by the user in a ProcessTask with ProcessTaskType SQLBakFile.
25	/// </summary>
26	public class ExecuteSqlBakFileRuntimeTask : RuntimeTask
27	{
28	public string Filepath;
29	private readonly IProcessTask _task;
30
31	private LoadStage _loadStage;
32
33	public ExecuteSqlBakFileRuntimeTask(IProcessTask task, RuntimeArgumentCollection args) : base(task, args)	×
34	{
35	_task = task;	×
36	Filepath = task.Path;	×
37	}	×
38
39	public override ExitCodeType Run(IDataLoadJob job, GracefulCancellationToken cancellationToken)
40	{
41	var db = RuntimeArguments.StageSpecificArguments.DbInfo;	×
42	_loadStage = RuntimeArguments.StageSpecificArguments.LoadStage;	×
43
44	if (!Exists())	×
45	throw new Exception($"The sql bak file {Filepath} does not exist");	×
46
47	string fileOnlyCommand = $"RESTORE FILELISTONLY FROM DISK = '{Filepath}'";	×
48	using var fileInfo = new DataTable();	×
49	using var con = (SqlConnection)db.Server.GetConnection();	×
50	using (var cmd = new SqlCommand(fileOnlyCommand, con))	×
51	using (var da = new SqlDataAdapter(cmd))	×
52	da.Fill(fileInfo);	×
53	DataRow[] primaryFiles = fileInfo.Select("Type = 'D'");	×
54	DataRow[] logFiles = fileInfo.Select("Type = 'L'");	×
55	if (primaryFiles.Length != 1 \|\| logFiles.Length != 1)	×
56	{
57	//Something has gone wrong
58	return ExitCodeType.Error;	×
59	}
60
61
62	DataRow primaryFile = primaryFiles[0];	×
63	DataRow logFile = logFiles[0];	×
64	string primaryFilePhysicalName = primaryFile["PhysicalName"].ToString();	×
65	string logFilePhysicalName = logFile["PhysicalName"].ToString();	×
66
67	if (File.Exists(primaryFilePhysicalName) \|\| File.Exists(logFilePhysicalName))	×
68	{
69	string timestamp = DateTime.Now.Millisecond.ToString();	×
70	string primaryFileName = primaryFilePhysicalName.Substring(0, primaryFilePhysicalName.Length - 4);	×
71	string primaryFileExtention = primaryFilePhysicalName.Substring(primaryFilePhysicalName.Length - 4);	×
72	primaryFilePhysicalName = $"{primaryFileName}_{timestamp}{primaryFileExtention}";	×
73	string logFileName = logFilePhysicalName.Substring(0, logFilePhysicalName.Length - 4);	×
74	string logFileExtention = logFilePhysicalName.Substring(logFilePhysicalName.Length - 4);	×
75	logFilePhysicalName = $"{logFileName}_{timestamp}{logFileExtention}";	×
76	}
77
78	string name = db.ToString();	×
79
80	string restoreCommand = @$"	×
81	use master;	×
82	ALTER DATABASE {name} SET SINGLE_USER WITH ROLLBACK IMMEDIATE;	×
83	RESTORE DATABASE {name}	×
84	FROM DISK = '{Filepath}'	×
85	WITH MOVE '{primaryFile["LogicalName"]}' TO '{primaryFilePhysicalName}',	×
86	MOVE '{logFile["LogicalName"]}' TO '{logFilePhysicalName}' , NOUNLOAD, REPLACE, STATS = 5;	×
87	ALTER DATABASE {name} SET MULTI_USER;	×
88	";	×
89
90	job.OnNotify(this, new NotifyEventArgs(ProgressEventType.Information,	×
91	$"Executing script {Filepath} ( against {db})"));	×
92
93	var executer = new ExecuteSqlInDleStage(job, _loadStage);	×
94	return executer.Execute(restoreCommand, db);	×
95	}	×
96
97
98	public override bool Exists() => File.Exists(Filepath);	×
99
100	public override void Abort(IDataLoadEventListener postLoadEventListener)
101	{
102	}	×
103
104	public override void LoadCompletedSoDispose(ExitCodeType exitCode, IDataLoadEventListener postLoadEventListener)
105	{
106	}	×
107
108	public override void Check(ICheckNotifier notifier)
109	{
110	if (string.IsNullOrWhiteSpace(Filepath))	×
111	{
112	notifier.OnCheckPerformed(	×
113	new CheckEventArgs($"ExecuteSqlFileTask {_task} does not have a path specified",	×
114	CheckResult.Fail));	×
115	return;	×
116	}
117
118	if (!File.Exists(Filepath))	×
119	notifier.OnCheckPerformed(	×
120	new CheckEventArgs(	×
121	$"File '{Filepath}' does not exist! (the only time this would be legal is if you have an exe or a freaky plugin that creates this file)",	×
122	CheckResult.Warning));	×
123	else
124	notifier.OnCheckPerformed(new CheckEventArgs($"Found File '{Filepath}'",	×
125	CheckResult.Success));	×
126	}	×
127	}

HicServices / RDMP / 6658089448

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