6245535001

Committed 20 Sep 2023 07:44AM UTC coverage: 57.013%. First build

Build # 6245535001

Build Type

push

github

Committed by

web-flow

Commit Message

8.1.0 Release (#1628)

* Bump Newtonsoft.Json from 13.0.1 to 13.0.2

Bumps [Newtonsoft.Json](https://github.com/JamesNK/Newtonsoft.Json) from 13.0.1 to 13.0.2.
- [Release notes](https://github.com/JamesNK/Newtonsoft.Json/releases)
- [Commits](https://github.com/JamesNK/Newtonsoft.Json/compare/13.0.1...13.0.2)

---
updated-dependencies:
- dependency-name: Newtonsoft.Json
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump NLog from 5.0.5 to 5.1.0

Bumps [NLog](https://github.com/NLog/NLog) from 5.0.5 to 5.1.0.
- [Release notes](https://github.com/NLog/NLog/releases)
- [Changelog](https://github.com/NLog/NLog/blob/dev/CHANGELOG.md)
- [Commits](https://github.com/NLog/NLog/compare/v5.0.5...v5.1.0)

---
updated-dependencies:
- dependency-name: NLog
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump NLog from 5.0.5 to 5.1.0

* Fix -r flag - should have been --results-directory all along

* Bump Newtonsoft.Json from 13.0.1 to 13.0.2

* Bump YamlDotNet from 12.0.2 to 12.1.0

Bumps [YamlDotNet](https://github.com/aaubry/YamlDotNet) from 12.0.2 to 12.1.0.
- [Release notes](https://github.com/aaubry/YamlDotNet/releases)
- [Commits](https://github.com/aaubry/YamlDotNet/compare/v12.0.2...v12.1.0)

---
updated-dependencies:
- dependency-name: YamlDotNet
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump Moq from 4.18.2 to 4.18.3

Bumps [Moq](https://github.com/moq/moq4) from 4.18.2 to 4.18.3.
- [Release notes](https://github.com/moq/moq4/releases)
- [Changelog](https://github.com/moq/moq4/blob/main/CHANGELOG.md)
- [Commits](https://github.com/moq/moq4/compare/v4.18.2...v4.18.3)

---
updated-dependencies:
- dependency-name: Moq
... (continued)

Run Details

10732 of 20257 branches covered (0.0%)

Branch coverage included in aggregate %.

48141 of 48141 new or added lines in 1086 files covered. (100.0%)

30685 of 52388 relevant lines covered (58.57%)

7387.88 hits per line

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

0.0

/Rdmp.Core/CommandExecution/AtomicCommands/ExecuteCommandExportObjectsToFile.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.Linq;
using FAnsi.Discovery;
using Rdmp.Core.Curation.Data.ImportExport;
using Rdmp.Core.Curation.Data.Serialization;
using Rdmp.Core.Icons.IconProvision;
using Rdmp.Core.MapsDirectlyToDatabaseTable;
using Rdmp.Core.Repositories;
using Rdmp.Core.ReusableLibraryCode;
using Rdmp.Core.ReusableLibraryCode.Icons.IconProvision;
using Rdmp.Core.Sharing.Dependency.Gathering;
using SixLabors.ImageSharp;
using SixLabors.ImageSharp.PixelFormats;

namespace Rdmp.Core.CommandExecution.AtomicCommands;

/// <summary>
/// Gathers dependencies of the supplied objects and extracts the share definitions to a directory.  This will have the side effect of creating an ObjectExport declaration
/// if none yet exists which will prevent accidental deletion of the object and enable updating people who receive the definition later on via the sharing Guid.
/// </summary>
public class ExecuteCommandExportObjectsToFile : BasicCommandExecution
{
    private readonly IRDMPPlatformRepositoryServiceLocator _repositoryLocator;
    private readonly IMapsDirectlyToDatabaseTable[] _toExport;

    public DirectoryInfo TargetDirectoryInfo;
    public FileInfo TargetFileInfo;

    private readonly ShareManager _shareManager;
    private readonly Gatherer _gatherer;

    public bool ShowInExplorer { get; set; }

    public bool IsSingleObject => _toExport.Length == 1;

    public ExecuteCommandExportObjectsToFile(IBasicActivateItems activator, IMapsDirectlyToDatabaseTable toExport,
        FileInfo targetFileInfo = null) : this(activator, new[] { toExport })
    {
        TargetFileInfo = targetFileInfo;
    }

    public ExecuteCommandExportObjectsToFile(IBasicActivateItems activator, IMapsDirectlyToDatabaseTable[] toExport,
        DirectoryInfo targetDirectoryInfo = null) : base(activator)
    {
        _toExport = toExport;
        ShowInExplorer = true;

        _repositoryLocator = activator.RepositoryLocator;
        _toExport = toExport;

        TargetDirectoryInfo = targetDirectoryInfo;

        _shareManager = new ShareManager(_repositoryLocator);

        if (toExport == null || !toExport.Any())
        {
            SetImpossible("No objects exist to be exported");
            return;
        }

        _gatherer = new Gatherer(_repositoryLocator);

        var incompatible = toExport.FirstOrDefault(o => !_gatherer.CanGatherDependencies(o));

        if (incompatible != null)
            SetImpossible($"Object {incompatible.GetType()} is not supported by Gatherer");
    }

    public override string GetCommandHelp() =>
        "Creates a share file with definitions for the supplied objects and all children";

    public override Image<Rgba32> GetImage(IIconProvider iconProvider) =>
        Image.Load<Rgba32>(FamFamFamIcons.page_white_put);


    public override string GetCommandName() => "Export Object(s) to File...";


    public override void Execute()
    {
        base.Execute();

        if (IsSingleObject)
        {
            //Extract a single object (to file)
            if (TargetFileInfo == null && BasicActivator.IsInteractive)
            {
                TargetFileInfo =
                    BasicActivator.SelectFile("Path to output share definition to", "Share Definition", "*.sd");

                if (TargetFileInfo == null)
                    return;
            }
        }
        else
        {
            if (TargetDirectoryInfo == null && BasicActivator.IsInteractive)
            {
                TargetDirectoryInfo = BasicActivator.SelectDirectory("Output Directory");

                if (TargetDirectoryInfo == null)
                    return;
            }
        }

        if (TargetFileInfo != null && IsSingleObject)
        {
            var d = _gatherer.GatherDependencies(_toExport[0]);

            var shareDefinitions = d.ToShareDefinitionWithChildren(_shareManager);
            var serial = JsonConvertExtensions.SerializeObject(shareDefinitions, _repositoryLocator);
            File.WriteAllText(TargetFileInfo.FullName, serial);

            return;
        }

        if (TargetDirectoryInfo == null)
            throw new Exception("No output directory set");

        foreach (var o in _toExport)
        {
            var d = _gatherer.GatherDependencies(o);
            var filename = $"{QuerySyntaxHelper.MakeHeaderNameSensible(o.ToString())}.sd";

            var shareDefinitions = d.ToShareDefinitionWithChildren(_shareManager);
            var serial = JsonConvertExtensions.SerializeObject(shareDefinitions, _repositoryLocator);
            var f = Path.Combine(TargetDirectoryInfo.FullName, filename);
            File.WriteAllText(f, serial);
        }


        if (ShowInExplorer && TargetDirectoryInfo != null)
            UsefulStuff.ShowPathInWindowsExplorer(TargetDirectoryInfo);
    }
}

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.Linq;
10	using FAnsi.Discovery;
11	using Rdmp.Core.Curation.Data.ImportExport;
12	using Rdmp.Core.Curation.Data.Serialization;
13	using Rdmp.Core.Icons.IconProvision;
14	using Rdmp.Core.MapsDirectlyToDatabaseTable;
15	using Rdmp.Core.Repositories;
16	using Rdmp.Core.ReusableLibraryCode;
17	using Rdmp.Core.ReusableLibraryCode.Icons.IconProvision;
18	using Rdmp.Core.Sharing.Dependency.Gathering;
19	using SixLabors.ImageSharp;
20	using SixLabors.ImageSharp.PixelFormats;
21
22	namespace Rdmp.Core.CommandExecution.AtomicCommands;
23
24	/// <summary>
25	/// Gathers dependencies of the supplied objects and extracts the share definitions to a directory. This will have the side effect of creating an ObjectExport declaration
26	/// if none yet exists which will prevent accidental deletion of the object and enable updating people who receive the definition later on via the sharing Guid.
27	/// </summary>
28	public class ExecuteCommandExportObjectsToFile : BasicCommandExecution
29	{
30	private readonly IRDMPPlatformRepositoryServiceLocator _repositoryLocator;
31	private readonly IMapsDirectlyToDatabaseTable[] _toExport;
32
33	public DirectoryInfo TargetDirectoryInfo;
34	public FileInfo TargetFileInfo;
35
36	private readonly ShareManager _shareManager;
37	private readonly Gatherer _gatherer;
38
39	public bool ShowInExplorer { get; set; }	×
40
41	public bool IsSingleObject => _toExport.Length == 1;	×
42
43	public ExecuteCommandExportObjectsToFile(IBasicActivateItems activator, IMapsDirectlyToDatabaseTable toExport,
44	FileInfo targetFileInfo = null) : this(activator, new[] { toExport })	×
45	{
46	TargetFileInfo = targetFileInfo;	×
47	}	×
48
49	public ExecuteCommandExportObjectsToFile(IBasicActivateItems activator, IMapsDirectlyToDatabaseTable[] toExport,
50	DirectoryInfo targetDirectoryInfo = null) : base(activator)	×
51	{
52	_toExport = toExport;	×
53	ShowInExplorer = true;	×
54
55	_repositoryLocator = activator.RepositoryLocator;	×
56	_toExport = toExport;	×
57
58	TargetDirectoryInfo = targetDirectoryInfo;	×
59
60	_shareManager = new ShareManager(_repositoryLocator);	×
61
62	if (toExport == null \|\| !toExport.Any())	×
63	{
64	SetImpossible("No objects exist to be exported");	×
65	return;	×
66	}
67
68	_gatherer = new Gatherer(_repositoryLocator);	×
69
70	var incompatible = toExport.FirstOrDefault(o => !_gatherer.CanGatherDependencies(o));	×
71
72	if (incompatible != null)	×
73	SetImpossible($"Object {incompatible.GetType()} is not supported by Gatherer");	×
74	}	×
75
76	public override string GetCommandHelp() =>
77	"Creates a share file with definitions for the supplied objects and all children";	×
78
79	public override Image<Rgba32> GetImage(IIconProvider iconProvider) =>
80	Image.Load<Rgba32>(FamFamFamIcons.page_white_put);	×
81
82
83	public override string GetCommandName() => "Export Object(s) to File...";	×
84
85
86	public override void Execute()
87	{
88	base.Execute();	×
89
90	if (IsSingleObject)	×
91	{
92	//Extract a single object (to file)
93	if (TargetFileInfo == null && BasicActivator.IsInteractive)	×
94	{
95	TargetFileInfo =	×
96	BasicActivator.SelectFile("Path to output share definition to", "Share Definition", "*.sd");	×
97
98	if (TargetFileInfo == null)	×
99	return;	×
100	}
101	}
102	else
103	{
104	if (TargetDirectoryInfo == null && BasicActivator.IsInteractive)	×
105	{
106	TargetDirectoryInfo = BasicActivator.SelectDirectory("Output Directory");	×
107
108	if (TargetDirectoryInfo == null)	×
109	return;	×
110	}
111	}
112
113	if (TargetFileInfo != null && IsSingleObject)	×
114	{
115	var d = _gatherer.GatherDependencies(_toExport[0]);	×
116
117	var shareDefinitions = d.ToShareDefinitionWithChildren(_shareManager);	×
118	var serial = JsonConvertExtensions.SerializeObject(shareDefinitions, _repositoryLocator);	×
119	File.WriteAllText(TargetFileInfo.FullName, serial);	×
120
121	return;	×
122	}
123
124	if (TargetDirectoryInfo == null)	×
125	throw new Exception("No output directory set");	×
126
127	foreach (var o in _toExport)	×
128	{
129	var d = _gatherer.GatherDependencies(o);	×
130	var filename = $"{QuerySyntaxHelper.MakeHeaderNameSensible(o.ToString())}.sd";	×
131
132	var shareDefinitions = d.ToShareDefinitionWithChildren(_shareManager);	×
133	var serial = JsonConvertExtensions.SerializeObject(shareDefinitions, _repositoryLocator);	×
134	var f = Path.Combine(TargetDirectoryInfo.FullName, filename);	×
135	File.WriteAllText(f, serial);	×
136	}
137
138
139	if (ShowInExplorer && TargetDirectoryInfo != null)	×
140	UsefulStuff.ShowPathInWindowsExplorer(TargetDirectoryInfo);	×
141	}	×
142	}

HicServices / RDMP / 6245535001

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