Introduce MSBuild tasks programability #12364
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| using System.Security.Cryptography; | ||
| using Microsoft.Build.Framework; | ||
| using MSBuildTask = Microsoft.Build.Utilities.Task; | ||
|
|
||
| namespace OrchardCore.Build.Tasks; | ||
|
|
||
| public class CopyTranslationFilesTask : MSBuildTask | ||
| { | ||
| public string SourceFilePath { get; set; } | ||
|
|
||
| [Required] | ||
| public string DestinationFolderPath { get; set; } | ||
|
|
||
| public override bool Execute() | ||
| { | ||
| if (string.IsNullOrEmpty(SourceFilePath)) | ||
| { | ||
| return true; | ||
| } | ||
|
|
||
| if (!Directory.Exists(DestinationFolderPath)) | ||
| { | ||
| Directory.CreateDirectory(DestinationFolderPath); | ||
| } | ||
|
|
||
| var fileInfo = new FileInfo(SourceFilePath); | ||
| var destinationFilePath = Path.Combine(DestinationFolderPath, fileInfo.Name); | ||
|
|
||
| if (File.Exists(destinationFilePath)) | ||
| { | ||
| // Skip unchanged files | ||
| var sourceFileHash = GetFileHashAsync(fileInfo.FullName); | ||
| var destinationFileHash = GetFileHashAsync(destinationFilePath); | ||
|
|
||
| if (sourceFileHash.Equals(destinationFileHash, StringComparison.OrdinalIgnoreCase)) | ||
| { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| fileInfo.CopyTo(destinationFilePath, overwrite: true); | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| private static string GetFileHashAsync(string fileName) | ||
| { | ||
| using var stream = new FileStream(fileName, FileMode.Open, FileAccess.Read); | ||
| var hash = SHA256.HashData(stream); | ||
|
|
||
| return Convert.ToBase64String(hash); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| using MSBuildTask = Microsoft.Build.Utilities.Task; | ||
|
|
||
| namespace OrchardCore.Build.Tasks; | ||
|
|
||
| public abstract class CreateWebFolderTask : MSBuildTask | ||
| { | ||
| public abstract string FolderName { get; } | ||
|
|
||
| public override bool Execute() | ||
| { | ||
| if (!Directory.Exists(FolderName)) | ||
| { | ||
| Directory.CreateDirectory(FolderName); | ||
|
|
||
| var dummyFilePath = Path.Combine(FolderName, ".placeholder"); | ||
|
|
||
| if (!File.Exists(dummyFilePath)) | ||
| { | ||
| File.WriteAllText(dummyFilePath, string.Empty); | ||
| } | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| namespace OrchardCore.Build.Tasks; | ||
|
|
||
| public class CreateLocalizationFolderTask : CreateWebFolderTask | ||
| { | ||
| public override string FolderName => "Localization"; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| namespace OrchardCore.Build.Tasks; | ||
|
|
||
| public class CreateWebRootFolderTask : CreateWebFolderTask | ||
| { | ||
| public override string FolderName => "wwwroot"; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <Import Project="..\OrchardCore.Build\OrchardCore.Commons.targets" /> | ||
| <Import Project="..\OrchardCore.Build\Dependencies.props" /> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFramework>$(CommonTargetFrameworks)</TargetFramework> | ||
| <ImplicitUsings>enable</ImplicitUsings> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Microsoft.Build.Utilities.Core" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| namespace OrchardCore.Build.Tasks.Tests; | ||
|
|
||
| public class CopyTranslationFilesTaskTests | ||
| { | ||
| private const string LocalizationFolder = "Localization"; | ||
|
|
||
| private readonly Mock<IBuildEngine> _buildEngine; | ||
| private readonly List<BuildErrorEventArgs> _errors = []; | ||
|
|
||
| public CopyTranslationFilesTaskTests() | ||
| { | ||
| _buildEngine = new Mock<IBuildEngine>(); | ||
| _buildEngine.Setup(be => be.LogErrorEvent(It.IsAny<BuildErrorEventArgs>())) | ||
| .Callback<BuildErrorEventArgs>(e => _errors.Add(e)); | ||
| } | ||
|
|
||
| [Theory] | ||
| [InlineData("ar.po")] | ||
| [InlineData("fr.po")] | ||
| public void ShouldCopyTranslationFilesToLocalizationFolder(string file) | ||
| { | ||
| // Arrange | ||
| var filePath = Path.Combine(LocalizationFolder, file); | ||
| var task = new CopyTranslationFilesTask | ||
| { | ||
| BuildEngine = _buildEngine.Object, | ||
| SourceFilePath = file, | ||
| DestinationFolderPath = LocalizationFolder, | ||
| }; | ||
|
|
||
| TryCreateLocalizationFolder(); | ||
|
|
||
| // Act | ||
| var result = task.Execute(); | ||
|
|
||
| // Assert | ||
| Assert.True(result); | ||
| Assert.Empty(_errors); | ||
| Assert.True(File.Exists(filePath)); | ||
| } | ||
|
|
||
| private static void TryCreateLocalizationFolder() | ||
| { | ||
| if (Directory.Exists(LocalizationFolder)) | ||
| { | ||
| Directory.Delete(LocalizationFolder, recursive: true); | ||
| } | ||
|
|
||
| Directory.CreateDirectory(LocalizationFolder); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| namespace OrchardCore.Build.Tasks.Tests; | ||
|
|
||
| public class CreateWebRootFolderTaskTests | ||
| { | ||
| private const string WebRootFolder = "wwwroot"; | ||
|
|
||
| private static readonly string _placeholderFile = $"{WebRootFolder}\\.placeholder"; | ||
|
|
||
| private readonly Mock<IBuildEngine> _buildEngine; | ||
| private readonly List<BuildErrorEventArgs> _errors = []; | ||
|
|
||
| public CreateWebRootFolderTaskTests() | ||
| { | ||
| _buildEngine = new Mock<IBuildEngine>(); | ||
| _buildEngine.Setup(be => be.LogErrorEvent(It.IsAny<BuildErrorEventArgs>())) | ||
| .Callback<BuildErrorEventArgs>(e => _errors.Add(e)); | ||
|
|
||
| TryDeleteLocalizationFolder(); | ||
| } | ||
|
|
||
| [Fact] | ||
| public void ShouldCreateLocalizationFolder() | ||
| { | ||
| // Arrange | ||
| var task = new CreateWebRootFolderTask | ||
| { | ||
| BuildEngine = _buildEngine.Object | ||
| }; | ||
|
|
||
| // Act | ||
| var result = task.Execute(); | ||
|
|
||
| // Assert | ||
| Assert.True(result); | ||
| Assert.Empty(_errors); | ||
| Assert.True(Directory.Exists(WebRootFolder)); | ||
| Assert.True(File.Exists(_placeholderFile)); | ||
| } | ||
|
|
||
| [Fact] | ||
| public void ShouldNotCreateLocalizationFolderIfExists() | ||
| { | ||
| // Arrange | ||
| var task = new CreateWebRootFolderTask | ||
| { | ||
| BuildEngine = _buildEngine.Object | ||
| }; | ||
| Directory.CreateDirectory(WebRootFolder); | ||
|
|
||
| var createdTime1 = new DirectoryInfo(_placeholderFile).CreationTimeUtc; | ||
|
|
||
| // Act & Assert | ||
| task.Execute(); | ||
| Assert.True(Directory.Exists(WebRootFolder)); | ||
|
|
||
| var createdTime2 = new DirectoryInfo(_placeholderFile).CreationTimeUtc; | ||
| Assert.Equal(createdTime1, createdTime2); | ||
| } | ||
|
|
||
| [Fact] | ||
| public void IgnorePlaceholderFileIfExists() | ||
| { | ||
| // Arrange | ||
| var task = new CreateWebRootFolderTask | ||
| { | ||
| BuildEngine = _buildEngine.Object | ||
| }; | ||
|
|
||
| // Act & Assert | ||
| task.Execute(); | ||
|
|
||
| var createdTime1 = new FileInfo(_placeholderFile).CreationTimeUtc; | ||
| task.Execute(); | ||
|
|
||
| var createdTime2 = new FileInfo(_placeholderFile).CreationTimeUtc; | ||
| Assert.Equal(createdTime1, createdTime2); | ||
| } | ||
|
|
||
| private static void TryDeleteLocalizationFolder() | ||
| { | ||
| if (Directory.Exists(WebRootFolder)) | ||
| { | ||
| Directory.Delete(WebRootFolder, true); | ||
| } | ||
| } | ||
| } |
|
There was a problem hiding this comment. Move this under the There was a problem hiding this comment. It was there, but I'd like to separate them into another project to make it clear that's not related to the actual OC tests project There was a problem hiding this comment. All tests and even benchmarks are there, so this is suitable (and it's already in the same file system folder). There was a problem hiding this comment. Benchmarks in a separated project, right? There was a problem hiding this comment. The benchmarks in a separate project There was a problem hiding this comment. I'm talking about moving this project to the There was a problem hiding this comment. I just noticed that while I was preparing a demo |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <Import Project="..\..\src\OrchardCore.Build\Dependencies.props" /> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFrameworks>$(CommonTargetFrameworks)</TargetFrameworks> | ||
| <TreatWarningsAsErrors>true</TreatWarningsAsErrors> | ||
|
There was a problem hiding this comment. This won't be needed if #15764 is merged first. |
||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <FrameworkReference Include="Microsoft.AspNetCore.App" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\..\src\OrchardCore.Build.Tasks\OrchardCore.Build.Tasks.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Microsoft.NET.Test.Sdk" /> | ||
| <PackageReference Include="Moq" /> | ||
| <PackageReference Include="xunit" /> | ||
| <PackageReference Include="xunit.analyzers" /> | ||
| <PackageReference Include="xunit.runner.visualstudio" /> | ||
| <DotNetCliToolReference Include="dotnet-xunit" Version="$(DotNetXunitVersion)" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <EmbeddedResource Include="ar.po"> | ||
| <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory> | ||
| </EmbeddedResource> | ||
| <EmbeddedResource Include="fr.po"> | ||
| <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory> | ||
| </EmbeddedResource> | ||
| </ItemGroup> | ||
|
|
||
| <Import Project="..\..\src\OrchardCore.Build\OrchardCore.Commons.targets" /> | ||
|
|
||
| </Project> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| global using System; | ||
| global using System.Collections.Generic; | ||
| global using System.IO; | ||
| global using Microsoft.Build.Framework; | ||
| global using Moq; | ||
| global using Xunit; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| msgctxt "OrchardCore.Tests.Localization.PortableObjectStringLocalizerFactoryTests.Model" | ||
| msgid "Hello" | ||
| msgstr "مرحبا" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| msgctxt "OrchardCore.Tests.Localization.PortableObjectStringLocalizerFactoryTests.Model" | ||
| msgid "Hello" | ||
| msgstr "Bonjour" |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a folder name, not a path, such as
wwwrootThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How it's used is a path. Passing
wwwroot/some/sub/folderto it would work too.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, it could be