From c434011ee17ee972ddf7692529fae27d370a6770 Mon Sep 17 00:00:00 2001 From: Coen van den Munckhof Date: Mon, 14 Aug 2023 19:20:40 +0200 Subject: [PATCH] Cleanup --- .../Az/AlphabetComparerConfigurationV1.cs | 11 +++- .../Configuration/DocsAppSettingsTests.cs | 34 +++++++---- .../Configuration/DocsModuleSettingsTests.cs | 17 +----- .../DocsRepositoryActionsTests.cs | 59 ++++++------------- ...eSettings_RuntimeAssembly#desc.verified.md | 1 - ...duleSettings_RuntimeAssembly.verified.json | 1 - ...zureDevOpsCreatePullRequestsV1.verified.md | 1 - ...onAzureDevOpsGetPullRequestsV1.verified.md | 1 - ...ctionAzureDevOpsPullRequestsV1.verified.md | 1 - ...epositoryActionClipboardCopyV1.verified.md | 1 - ...yActionSonarCloudSetFavoriteV1.verified.md | 1 - 11 files changed, 53 insertions(+), 75 deletions(-) delete mode 100644 tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs/DocsRepositoryActionsTests.DocsModuleSettings_RuntimeAssembly#desc.verified.md delete mode 100644 tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs/DocsRepositoryActionsTests.DocsModuleSettings_RuntimeAssembly.verified.json delete mode 100644 tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionAzureDevOpsCreatePullRequestsV1.verified.md delete mode 100644 tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionAzureDevOpsGetPullRequestsV1.verified.md delete mode 100644 tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionAzureDevOpsPullRequestsV1.verified.md delete mode 100644 tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionClipboardCopyV1.verified.md delete mode 100644 tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionSonarCloudSetFavoriteV1.verified.md diff --git a/src/RepoM.Api/Ordering/Az/AlphabetComparerConfigurationV1.cs b/src/RepoM.Api/Ordering/Az/AlphabetComparerConfigurationV1.cs index b332a62b..b8ab3375 100644 --- a/src/RepoM.Api/Ordering/Az/AlphabetComparerConfigurationV1.cs +++ b/src/RepoM.Api/Ordering/Az/AlphabetComparerConfigurationV1.cs @@ -2,6 +2,9 @@ namespace RepoM.Api.Ordering.Az; using RepoM.Core.Plugin.RepositoryOrdering.Configuration; +/// +/// Compares two repositories by a given property. +/// public class AlphabetComparerConfigurationV1 : IRepositoriesComparerConfiguration { public const string TYPE_VALUE = "az-comparer@1"; @@ -12,7 +15,13 @@ public string Type set => _ = value; } + /// + /// Repository property. Currently, only `Name`, and `Location` are supported. + /// public string? Property { get; set; } - + + /// + /// The weight of this comparer. The higher the weight, the higher the priority. + /// public int Weight { get; set; } } \ No newline at end of file diff --git a/tests/RepoM.Plugin.Misc.Tests/Configuration/DocsAppSettingsTests.cs b/tests/RepoM.Plugin.Misc.Tests/Configuration/DocsAppSettingsTests.cs index f21ac8b6..b71540b2 100644 --- a/tests/RepoM.Plugin.Misc.Tests/Configuration/DocsAppSettingsTests.cs +++ b/tests/RepoM.Plugin.Misc.Tests/Configuration/DocsAppSettingsTests.cs @@ -1,10 +1,10 @@ namespace RepoM.Plugin.Misc.Tests.Configuration; +using System.Collections.Generic; using System.IO.Abstractions.TestingHelpers; using System.Text; using System.Threading.Tasks; using FakeItEasy; -using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging.Abstractions; using NuDoq; using RepoM.Api.Common; @@ -14,24 +14,34 @@ namespace RepoM.Plugin.Misc.Tests.Configuration; using VerifyXunit; using Xunit; +internal static class MockFileSystemFactory +{ + public static MockFileSystem CreateDefaultFileSystem() + { + return new MockFileSystem(new Dictionary() + { + { "C:\\tmp\\x.tmp", new MockFileData("x") }, // make sure path exists. + }); + } + + public static IAppDataPathProvider CreateDefaultAppDataProvider() + { + IAppDataPathProvider appDataPathProvider = A.Fake(); + A.CallTo(() => appDataPathProvider.AppDataPath).Returns("C:\\tmp\\"); + return appDataPathProvider; + } +} + [UsesVerify] public class DocsAppSettingsTests { - private readonly IAppDataPathProvider _appDataPathProvider; private FileAppSettingsService _fileBasedPackageConfiguration; - private MockFileSystem _fileSystem; - private ILogger _logger; + private readonly MockFileSystem _fileSystem; public DocsAppSettingsTests() { - _appDataPathProvider = A.Fake(); - A.CallTo(() => _appDataPathProvider.AppDataPath).Returns("C:\\tmp\\"); - _fileSystem = new MockFileSystem(new J2N.Collections.Generic.Dictionary() - { - { "C:\\tmp\\x.tmp", new MockFileData("x") }, // make sure path exists. - }); - _logger = NullLogger.Instance; - _fileBasedPackageConfiguration = new FileAppSettingsService(_appDataPathProvider, _fileSystem, _logger); + _fileSystem = MockFileSystemFactory.CreateDefaultFileSystem(); + _fileBasedPackageConfiguration = new FileAppSettingsService(MockFileSystemFactory.CreateDefaultAppDataProvider(), _fileSystem, NullLogger.Instance); } [Fact] diff --git a/tests/RepoM.Plugin.Misc.Tests/Configuration/DocsModuleSettingsTests.cs b/tests/RepoM.Plugin.Misc.Tests/Configuration/DocsModuleSettingsTests.cs index 65019b6d..bbeba59a 100644 --- a/tests/RepoM.Plugin.Misc.Tests/Configuration/DocsModuleSettingsTests.cs +++ b/tests/RepoM.Plugin.Misc.Tests/Configuration/DocsModuleSettingsTests.cs @@ -7,13 +7,10 @@ namespace RepoM.Plugin.Misc.Tests.Configuration; using System.Reflection; using System.Text; using System.Threading.Tasks; -using FakeItEasy; -using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging.Abstractions; using NuDoq; using RepoM.Api.Plugins; using RepoM.Core.Plugin; -using RepoM.Core.Plugin.Common; using RepoM.Plugin.Misc.Tests.TestFramework.NuDoc; using VerifyTests; using VerifyXunit; @@ -22,21 +19,13 @@ namespace RepoM.Plugin.Misc.Tests.Configuration; [UsesVerify] public class DocsModuleSettingsTests { - private readonly IAppDataPathProvider _appDataPathProvider; private FileBasedPackageConfiguration _fileBasedPackageConfiguration; - private MockFileSystem _fileSystem; - private ILogger _logger; + private readonly MockFileSystem _fileSystem; public DocsModuleSettingsTests() { - _appDataPathProvider = A.Fake(); - A.CallTo(() => _appDataPathProvider.AppDataPath).Returns("C:\\tmp\\"); - _fileSystem = new MockFileSystem(new J2N.Collections.Generic.Dictionary() - { - { "C:\\tmp\\x.tmp", new MockFileData("x") }, // make sure path exists. - }); - _logger = NullLogger.Instance; - _fileBasedPackageConfiguration = new FileBasedPackageConfiguration(_appDataPathProvider, _fileSystem, _logger, "dummy"); + _fileSystem = MockFileSystemFactory.CreateDefaultFileSystem(); + _fileBasedPackageConfiguration = new FileBasedPackageConfiguration(MockFileSystemFactory.CreateDefaultAppDataProvider(), _fileSystem, NullLogger.Instance, "dummy"); } public static IEnumerable PackagesTestData => PluginStore.Packages.Select(package => new object[] { package, }).ToArray(); diff --git a/tests/RepoM.Plugin.Misc.Tests/Configuration/DocsRepositoryActionsTests.cs b/tests/RepoM.Plugin.Misc.Tests/Configuration/DocsRepositoryActionsTests.cs index 24bbc3bc..f0b1453c 100644 --- a/tests/RepoM.Plugin.Misc.Tests/Configuration/DocsRepositoryActionsTests.cs +++ b/tests/RepoM.Plugin.Misc.Tests/Configuration/DocsRepositoryActionsTests.cs @@ -2,18 +2,12 @@ namespace RepoM.Plugin.Misc.Tests.Configuration; using System; using System.Collections.Generic; -using System.IO.Abstractions.TestingHelpers; using System.Linq; using System.Reflection; using System.Text; using System.Threading.Tasks; -using FakeItEasy; -using Microsoft.Extensions.Logging; -using Microsoft.Extensions.Logging.Abstractions; using NuDoq; using RepoM.Api.IO.ModuleBasedRepositoryActionProvider.Data; -using RepoM.Api.Plugins; -using RepoM.Core.Plugin.Common; using RepoM.Plugin.Misc.Tests.TestFramework.AssemblyAndTypeHelpers; using RepoM.Plugin.Misc.Tests.TestFramework.NuDoc; using VerifyTests; @@ -23,23 +17,6 @@ namespace RepoM.Plugin.Misc.Tests.Configuration; [UsesVerify] public class DocsRepositoryActionsTests { - private readonly IAppDataPathProvider _appDataPathProvider; - private FileBasedPackageConfiguration _fileBasedPackageConfiguration; - private MockFileSystem _fileSystem; - private ILogger _logger; - - public DocsRepositoryActionsTests() - { - _appDataPathProvider = A.Fake(); - A.CallTo(() => _appDataPathProvider.AppDataPath).Returns("C:\\tmp\\"); - _fileSystem = new MockFileSystem(new J2N.Collections.Generic.Dictionary() - { - { "C:\\tmp\\x.tmp", new MockFileData("x") }, // make sure path exists. - }); - _logger = NullLogger.Instance; - _fileBasedPackageConfiguration = new FileBasedPackageConfiguration(_appDataPathProvider, _fileSystem, _logger, "dummy"); - } - public static IEnumerable AssemblyTestData => PluginStore.Assemblies.Select(assembly => new object[] { assembly, }).ToArray(); public static IEnumerable RepositoryActionsTestData @@ -98,24 +75,6 @@ public async Task VerifyChanges() await Verifier.Verify(results, settings); } - public class RepositoryTestData - { - public RepositoryTestData(Assembly assembly, Type type) - { - Assembly = assembly; - Type = type; - } - - public Assembly Assembly { get; } - - public Type Type { get; } - - public override string ToString() - { - return Assembly.GetName().Name + "-" + Type.Name; - } - } - [Fact] public async Task RepositoryActionBaseDocumentationGeneration() { @@ -213,4 +172,22 @@ public async Task DocsRepositoryActionsSettings(RepositoryTestData repositoryAct Assert.True(true); // this test should only be run in Debug mode. #endif } +} + +public class RepositoryTestData +{ + public RepositoryTestData(Assembly assembly, Type type) + { + Assembly = assembly; + Type = type; + } + + public Assembly Assembly { get; } + + public Type Type { get; } + + public override string ToString() + { + return Assembly.GetName().Name + "-" + Type.Name; + } } \ No newline at end of file diff --git a/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs/DocsRepositoryActionsTests.DocsModuleSettings_RuntimeAssembly#desc.verified.md b/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs/DocsRepositoryActionsTests.DocsModuleSettings_RuntimeAssembly#desc.verified.md deleted file mode 100644 index 5f282702..00000000 --- a/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs/DocsRepositoryActionsTests.DocsModuleSettings_RuntimeAssembly#desc.verified.md +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs/DocsRepositoryActionsTests.DocsModuleSettings_RuntimeAssembly.verified.json b/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs/DocsRepositoryActionsTests.DocsModuleSettings_RuntimeAssembly.verified.json deleted file mode 100644 index 5f282702..00000000 --- a/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs/DocsRepositoryActionsTests.DocsModuleSettings_RuntimeAssembly.verified.json +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionAzureDevOpsCreatePullRequestsV1.verified.md b/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionAzureDevOpsCreatePullRequestsV1.verified.md deleted file mode 100644 index 5f282702..00000000 --- a/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionAzureDevOpsCreatePullRequestsV1.verified.md +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionAzureDevOpsGetPullRequestsV1.verified.md b/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionAzureDevOpsGetPullRequestsV1.verified.md deleted file mode 100644 index 5f282702..00000000 --- a/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionAzureDevOpsGetPullRequestsV1.verified.md +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionAzureDevOpsPullRequestsV1.verified.md b/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionAzureDevOpsPullRequestsV1.verified.md deleted file mode 100644 index 5f282702..00000000 --- a/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionAzureDevOpsPullRequestsV1.verified.md +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionClipboardCopyV1.verified.md b/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionClipboardCopyV1.verified.md deleted file mode 100644 index 5f282702..00000000 --- a/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionClipboardCopyV1.verified.md +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionSonarCloudSetFavoriteV1.verified.md b/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionSonarCloudSetFavoriteV1.verified.md deleted file mode 100644 index 5f282702..00000000 --- a/tests/RepoM.Plugin.Misc.Tests/Configuration/VerifiedDocs1/DocsRepositoryActionsTests.DocsModuleSettings_RepositoryActionSonarCloudSetFavoriteV1.verified.md +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file