Add Directory.Build.targets file parsing

Author: FrediKats

Sources/Kysect.DotnetProjectSystem.Tests/Projects/DirectoryBuildTargetFileTests.cs

@@ -0,0 +1,27 @@
+using Kysect.DotnetProjectSystem.Projects;
+using Microsoft.Language.Xml;
+
+namespace Kysect.DotnetProjectSystem.Tests.Projects;
+
+public class DirectoryBuildTargetFileTests
+{
+    [Fact]
+    public void Create_FileWithTarget_ReturnFileWithTarget()
+    {
+        var content = """
+                      <Project>
+                        <Target Name="SomeTargetName" BeforeTargets="BeforeBuild">
+                          <PropertyGroup Condition="'$(SomeProperty)' == 'true'">
+                            <SomeProperty>false</SomeProperty>
+                          </PropertyGroup>
+                        </Target>
+                      </Project>
+                      """;
+
+        var dotnetBuildTargetFile = DirectoryBuildTargetFile.Create(content);
+
+        IReadOnlyCollection<IXmlElementSyntax> targets = dotnetBuildTargetFile.GetTargets();
+
+        targets.Should().HaveCount(1);
+    }
+}

Sources/Kysect.DotnetProjectSystem.Tests/SolutionModification/DotnetSolutionModifierFactoryTests.cs

@@ -109,4 +109,29 @@ public void Create_ForSolutionWithoutDirectoryFiles_DirectoryFileMustBeCreatedOn
             .ToXmlString(_syntaxFormatter)
             .Should().Be(directoryPackagesPropsContent);
     }
+
+    [Fact]
+    public void Create_SolutionWithDirectoryBuildTargets_ReturnTargetFileContent()
+    {
+        string directoryBuildTargetContent = """
+                                             <Project>
+                                               <Target Name="SomeTargetName" BeforeTargets="BeforeBuild">
+                                                 <PropertyGroup Condition="'$(SomeProperty)' == 'true'">
+                                                   <SomeProperty>false</SomeProperty>
+                                                 </PropertyGroup>
+                                               </Target>
+                                             </Project>
+                                             """;
+
+        _solutionFileStructureBuilderFactory.Create("Solution")
+            .AddDirectoryBuildTargets(directoryBuildTargetContent)
+            .Save(_currentPath);
+
+        DotnetSolutionModifier solutionModifier = _solutionModifierFactory.Create("Solution.sln");
+
+        solutionModifier
+            .GetOrCreateDirectoryBuildTargetFile()
+            .ToXmlString(_syntaxFormatter)
+            .Should().Be(directoryBuildTargetContent);
+    }
 }

Sources/Kysect.DotnetProjectSystem/FileStructureBuilding/SolutionFileStructureBuilder.cs

@@ -16,6 +16,7 @@ public class SolutionFileStructureBuilder
     private readonly List<SolutionStructureElement> _files;
     private DirectoryBuildPropsFile? _directoryBuildPropsFile;
     private DirectoryPackagesPropsFile? _directoryPackagesPropsFile;
+    private DirectoryBuildTargetFile? _directoryBuildTargetFile;
 
     public SolutionFileStructureBuilder(IFileSystem fileSystem, XmlDocumentSyntaxFormatter syntaxFormatter, string solutionName)
     {
@@ -66,11 +67,22 @@ public SolutionFileStructureBuilder AddDirectoryPackagesProps(DirectoryPackagesP
         return this;
     }
 
+    public SolutionFileStructureBuilder AddDirectoryBuildTargets(string content)
+    {
+        return AddDirectoryBuildTargets(DirectoryBuildTargetFile.Create(content));
+    }
+
+    public SolutionFileStructureBuilder AddDirectoryBuildTargets(DirectoryBuildTargetFile directoryBuildTargetFile)
+    {
+        _directoryBuildTargetFile = directoryBuildTargetFile;
+        return this;
+    }
+
     public void Save(string solutionDirectory)
     {
         string solutionFileContent = CreateSolutionFile(_fileSystem);
 
-        DirectoryExtensions.EnsureDirectoryExists(_fileSystem, solutionDirectory);
+        _fileSystem.EnsureDirectoryExists(solutionDirectory);
         _fileSystem.File.WriteAllText(_fileSystem.Path.Combine(solutionDirectory, $"{_solutionName}.sln"), solutionFileContent);
 
         if (_directoryBuildPropsFile is not null)
@@ -79,6 +91,9 @@ public void Save(string solutionDirectory)
         if (_directoryPackagesPropsFile is not null)
             AddFile([SolutionItemNameConstants.DirectoryPackagesProps], _directoryPackagesPropsFile.File.ToXmlString(_syntaxFormatter));
 
+        if (_directoryBuildTargetFile is not null)
+            AddFile([SolutionItemNameConstants.DirectoryBuildTargets], _directoryBuildTargetFile.ToXmlString(_syntaxFormatter));
+
         foreach (SolutionStructureElement? solutionFileInfo in _files)
         {
             string partialFilePath = _fileSystem.Path.Combine(solutionFileInfo.Path.ToArray());

Sources/Kysect.DotnetProjectSystem/Projects/DirectoryBuildTargetFile.cs

@@ -0,0 +1,58 @@
+using Kysect.CommonLib.BaseTypes.Extensions;
+using Kysect.DotnetProjectSystem.Xml;
+using Microsoft.Language.Xml;
+
+namespace Kysect.DotnetProjectSystem.Projects;
+
+public class DirectoryBuildTargetFile
+{
+    private XmlDocumentSyntax _content;
+
+    public static DirectoryBuildTargetFile CreateEmpty()
+    {
+        string contentTemplate =
+            """
+            <Project>
+            </Project>
+            """;
+
+        return Create(contentTemplate);
+    }
+
+    public static DirectoryBuildTargetFile Create(string content)
+    {
+        XmlDocumentSyntax xmlDocumentSyntax = Parser.ParseText(content);
+        if (xmlDocumentSyntax.RootSyntax is null)
+            return CreateEmpty();
+
+        return new DirectoryBuildTargetFile(xmlDocumentSyntax);
+    }
+
+    public DirectoryBuildTargetFile(XmlDocumentSyntax content)
+    {
+        _content = content;
+    }
+
+    public IReadOnlyCollection<IXmlElementSyntax> GetTargets()
+    {
+        return GetNodesByName("Target");
+    }
+
+    public IReadOnlyCollection<IXmlElementSyntax> GetNodesByName(string name)
+    {
+        return _content.GetNodesByName(name);
+    }
+
+    public void UpdateDocument(Func<XmlDocumentSyntax, XmlDocumentSyntax> morphism)
+    {
+        morphism.ThrowIfNull();
+        _content = morphism(_content);
+    }
+
+    public string ToXmlString(XmlDocumentSyntaxFormatter formatter)
+    {
+        formatter.ThrowIfNull();
+
+        return formatter.Format(_content).ToFullString();
+    }
+}

Sources/Kysect.DotnetProjectSystem/SolutionModification/DotnetSolutionModifier.cs

@@ -13,6 +13,7 @@ public class DotnetSolutionModifier
     private readonly IFileSystem _fileSystem;
     private DirectoryBuildPropsFile? _directoryBuildPropsModifier;
     private DirectoryPackagesPropsFile? _directoryPackagePropsModifier;
+    private DirectoryBuildTargetFile? _directoryBuildTargetFile;
     private readonly Dictionary<string, DotnetCsprojFile> _projects;
 
     public IReadOnlyCollection<KeyValuePair<string, DotnetCsprojFile>> Projects => _projects;
@@ -29,17 +30,25 @@ public DirectoryPackagesPropsFile GetOrCreateDirectoryPackagePropsModifier()
         return _directoryPackagePropsModifier;
     }
 
+    public DirectoryBuildTargetFile GetOrCreateDirectoryBuildTargetFile()
+    {
+        _directoryBuildTargetFile ??= DirectoryBuildTargetFile.CreateEmpty();
+        return _directoryBuildTargetFile;
+    }
+
     public DotnetSolutionModifier(
         Dictionary<string, DotnetCsprojFile> projects,
         DirectoryBuildPropsFile? directoryBuildPropsModifier,
         DirectoryPackagesPropsFile? directoryPackagePropsModifier,
+        DirectoryBuildTargetFile? directoryBuildTargetsFile,
         IFileSystem fileSystem,
         IFileInfo solutionPath,
         XmlDocumentSyntaxFormatter syntaxFormatter)
     {
         _projects = projects;
         _directoryBuildPropsModifier = directoryBuildPropsModifier;
         _directoryPackagePropsModifier = directoryPackagePropsModifier;
+        _directoryBuildTargetFile = directoryBuildTargetsFile;
         _fileSystem = fileSystem;
         _solutionPath = solutionPath;
         _syntaxFormatter = syntaxFormatter;
@@ -61,6 +70,12 @@ public void Save()
             _fileSystem.File.WriteAllText(directoryPackagesPropsPath, _directoryPackagePropsModifier.File.ToXmlString(_syntaxFormatter));
         }
 
+        if (_directoryBuildTargetFile is not null)
+        {
+            string directoryPackagesPropsPath = _fileSystem.Path.Combine(_solutionPath.Directory.FullName, SolutionItemNameConstants.DirectoryBuildTargets);
+            _fileSystem.File.WriteAllText(directoryPackagesPropsPath, _directoryBuildTargetFile.ToXmlString(_syntaxFormatter));
+        }
+
         foreach (KeyValuePair<string, DotnetCsprojFile> projectModifier in _projects)
         {
             _fileSystem.File.WriteAllText(projectModifier.Key, projectModifier.Value.File.ToXmlString(_syntaxFormatter));

Sources/Kysect.DotnetProjectSystem/SolutionModification/DotnetSolutionModifierFactory.cs

@@ -28,12 +28,14 @@ public DotnetSolutionModifier Create(string solutionPath)
 
         DirectoryBuildPropsFile? directoryBuildPropsModifier = TryCreateDirectoryBuildPropsFile(solutionFileInfo);
         DirectoryPackagesPropsFile? directoryPackagesPropsFile = TryCreateDirectoryPackagesPropsFile(solutionFileInfo);
+        DirectoryBuildTargetFile? directoryBuildTargetsFile = TryCreateDirectoryBuildTargetsFile(solutionFileInfo);
         Dictionary<string, DotnetCsprojFile> projects = CreateProjectModifiers(solutionFileInfo);
 
         return new DotnetSolutionModifier(
             projects,
             directoryBuildPropsModifier,
             directoryPackagesPropsFile,
+            directoryBuildTargetsFile,
             _fileSystem,
             solutionFileInfo,
             _syntaxFormatter);
@@ -63,6 +65,22 @@ public DotnetSolutionModifier Create(string solutionPath)
         return new DirectoryPackagesPropsFile(dotnetProjectFile);
     }
 
+    private DirectoryBuildTargetFile? TryCreateDirectoryBuildTargetsFile(IFileInfo solutionFileInfo)
+    {
+        solutionFileInfo.Directory.ThrowIfNull();
+
+        string path = _fileSystem.Path.Combine(solutionFileInfo.Directory.FullName, SolutionItemNameConstants.DirectoryBuildTargets);
+        if (!_fileSystem.File.Exists(path))
+            return null;
+
+        string fileContent =
+            _fileSystem.File.Exists(path)
+                ? _fileSystem.File.ReadAllText(path)
+                : string.Empty;
+
+        return DirectoryBuildTargetFile.Create(fileContent);
+    }
+
     private Dictionary<string, DotnetCsprojFile> CreateProjectModifiers(IFileInfo solutionFileInfo)
     {
         solutionFileInfo.Directory.ThrowIfNull();

Sources/Kysect.DotnetProjectSystem/Tools/SolutionItemNameConstants.cs

@@ -4,4 +4,5 @@ public static class SolutionItemNameConstants
 {
     public const string DirectoryBuildProps = "Directory.Build.props";
     public const string DirectoryPackagesProps = "Directory.Packages.props";
+    public const string DirectoryBuildTargets = "Directory.Build.targets";
 }