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

66.67

/Rdmp.Core/CommandExecution/AtomicCommands/ExecuteCommandExtractMetadata.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.IO;
using System.Linq;
using Rdmp.Core.Curation.Data;
using Rdmp.Core.Reports;

namespace Rdmp.Core.CommandExecution.AtomicCommands;

/// <summary>
/// Extract metadata from one or more Catalogues based on a template file using string replacement e.g. $Name for the catalogue's name
/// </summary>
public class ExecuteCommandExtractMetadata : BasicCommandExecution
{
    private readonly Catalogue[] _catalogues;
    private readonly DirectoryInfo _outputDirectory;
    private readonly FileInfo _template;
    private readonly string _fileNaming;
    private readonly bool _oneFile;
    private readonly string _newlineSub;
    private readonly string _commaSub;

    public ExecuteCommandExtractMetadata(IBasicActivateItems basicActivator,
        Catalogue[] catalogues,
        [DemandsInitialization("Where new files should be generated")]
        DirectoryInfo outputDirectory,
        [DemandsInitialization(
            "Template file in which keys such as $Name will be replaced with the corresponding Catalogue entry")]
        FileInfo template,
        [DemandsInitialization(
            "How output files based on the template should be named.  Uses same replacement strategy as template contents e.g. $Name.xml")]
        string fileNaming,
        [DemandsInitialization(
            "True to append all outputs into a single file.  False to output a new file for every Catalogue")]
        bool oneFile,
        [DemandsInitialization(
            "Optional, specify a replacement for newlines when found in fields e.g. <br/>.  Leave as null to leave newlines intact.")]
        string newlineSub,
        [DemandsInitialization("Optional, specify a replacement for the token $Comma (defaults to ',')",
            DefaultValue = ",")]
        string commaSub = ",") : base(basicActivator)
    {
        _catalogues = catalogues;
        _outputDirectory = outputDirectory;
        _template = template;
        _fileNaming = fileNaming;
        _oneFile = oneFile;
        _newlineSub = newlineSub;
        _commaSub = commaSub;
    }

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

        var catas = _catalogues ?? BasicActivator
            .SelectMany("Which catalogues do you want to extract metadata for", typeof(Catalogue),
                BasicActivator.CoreChildProvider.AllCatalogues);

        if (catas == null || !catas.Any())
            return;

        var outputDir = _outputDirectory ?? BasicActivator.SelectDirectory("Enter output directory");

        if (outputDir == null)
            return;

        var template = _template;

        if (template == null)
        {
            BasicActivator.Show("Pick a template");
            template = BasicActivator.SelectFile(
                "Enter metadata template (should have template values in it e.g. $Name, $Description etc)");
        }

        if (template == null)
            return;

        var fileNaming = _fileNaming;

        if (fileNaming == null)
            if (!BasicActivator.TypeText("File naming", "File Naming", 1000, $"$Name{template.Extension}",
                    out fileNaming, false))
                return;

        if (string.IsNullOrWhiteSpace(fileNaming))
            return;

        var reporter = new CustomMetadataReport(BasicActivator.RepositoryLocator)
        {
            NewlineSubstitution = _newlineSub,
            CommaSubstitution = _commaSub
        };
        reporter.GenerateReport(catas.Cast<Catalogue>().OrderBy(c => c.Name).ToArray(), outputDir, template, fileNaming,
            _oneFile);
    }
}

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.IO;
8	using System.Linq;
9	using Rdmp.Core.Curation.Data;
10	using Rdmp.Core.Reports;
11
12	namespace Rdmp.Core.CommandExecution.AtomicCommands;
13
14	/// <summary>
15	/// Extract metadata from one or more Catalogues based on a template file using string replacement e.g. $Name for the catalogue's name
16	/// </summary>
17	public class ExecuteCommandExtractMetadata : BasicCommandExecution
18	{
19	private readonly Catalogue[] _catalogues;
20	private readonly DirectoryInfo _outputDirectory;
21	private readonly FileInfo _template;
22	private readonly string _fileNaming;
23	private readonly bool _oneFile;
24	private readonly string _newlineSub;
25	private readonly string _commaSub;
26
27	public ExecuteCommandExtractMetadata(IBasicActivateItems basicActivator,
28	Catalogue[] catalogues,
29	[DemandsInitialization("Where new files should be generated")]
30	DirectoryInfo outputDirectory,
31	[DemandsInitialization(
32	"Template file in which keys such as $Name will be replaced with the corresponding Catalogue entry")]
33	FileInfo template,
34	[DemandsInitialization(
35	"How output files based on the template should be named. Uses same replacement strategy as template contents e.g. $Name.xml")]
36	string fileNaming,
37	[DemandsInitialization(
38	"True to append all outputs into a single file. False to output a new file for every Catalogue")]
39	bool oneFile,
40	[DemandsInitialization(
41	"Optional, specify a replacement for newlines when found in fields e.g. <br/>. Leave as null to leave newlines intact.")]
42	string newlineSub,
43	[DemandsInitialization("Optional, specify a replacement for the token $Comma (defaults to ',')",
44	DefaultValue = ",")]
45	string commaSub = ",") : base(basicActivator)	56✔
46	{
47	_catalogues = catalogues;	56✔
48	_outputDirectory = outputDirectory;	56✔
49	_template = template;	56✔
50	_fileNaming = fileNaming;	56✔
51	_oneFile = oneFile;	56✔
52	_newlineSub = newlineSub;	56✔
53	_commaSub = commaSub;	56✔
54	}	56✔
55
56	public override void Execute()
57	{
58	base.Execute();	56✔
59
60	var catas = _catalogues ?? BasicActivator	56!
61	.SelectMany("Which catalogues do you want to extract metadata for", typeof(Catalogue),	56✔
62	BasicActivator.CoreChildProvider.AllCatalogues);	56✔
63
64	if (catas == null \|\| !catas.Any())	56!
65	return;	×
66
67	var outputDir = _outputDirectory ?? BasicActivator.SelectDirectory("Enter output directory");	56!
68
69	if (outputDir == null)	56!
70	return;	×
71
72	var template = _template;	56✔
73
74	if (template == null)	56!
75	{
76	BasicActivator.Show("Pick a template");	×
77	template = BasicActivator.SelectFile(	×
78	"Enter metadata template (should have template values in it e.g. $Name, $Description etc)");	×
79	}
80
81	if (template == null)	56!
82	return;	×
83
84	var fileNaming = _fileNaming;	56✔
85
86	if (fileNaming == null)	56!
87	if (!BasicActivator.TypeText("File naming", "File Naming", 1000, $"$Name{template.Extension}",	×
88	out fileNaming, false))	×
89	return;	×
90
91	if (string.IsNullOrWhiteSpace(fileNaming))	56!
92	return;	×
93
94	var reporter = new CustomMetadataReport(BasicActivator.RepositoryLocator)	56✔
95	{	56✔
96	NewlineSubstitution = _newlineSub,	56✔
97	CommaSubstitution = _commaSub	56✔
98	};	56✔
99	reporter.GenerateReport(catas.Cast<Catalogue>().OrderBy(c => c.Name).ToArray(), outputDir, template, fileNaming,	148✔
100	_oneFile);	56✔
101	}	42✔
102	}

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