File: Construction\ProjectItemGroupElement_tests.cs
Web Access
Project: ..\..\..\src\Build.OM.UnitTests\Microsoft.Build.Engine.OM.UnitTests.csproj (Microsoft.Build.Engine.OM.UnitTests)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System.Linq;
using Microsoft.Build.Construction;
using Microsoft.Build.Evaluation;
using Xunit;
 
#nullable disable
 
namespace Microsoft.Build.UnitTests.OM.Construction
{
    /// <summary>
    /// Test the ProjectItemGroupElement class
    /// </summary>
    public class ProjectItemGroupElement_tests
    {
        /// <summary>
        /// Read item groups in an empty project
        /// </summary>
        [Fact]
        public void ReadNoItemGroup()
        {
            ProjectRootElement project = ProjectRootElement.Create();
            Assert.Equal(0, Helpers.Count(project.Children));
            Assert.Empty(project.ItemGroups);
        }
 
        /// <summary>
        /// Read an empty item group
        /// </summary>
        [Fact]
        public void ReadEmptyItemGroup()
        {
            string content = @"
                    <Project>
                        <ItemGroup/>
                    </Project>
                ";
 
            using ProjectRootElementFromString projectRootElementFromString = new(content);
            ProjectRootElement project = projectRootElementFromString.Project;
            ProjectItemGroupElement group = (ProjectItemGroupElement)Helpers.GetFirst(project.Children);
 
            Assert.Equal(0, Helpers.Count(group.Items));
        }
 
        /// <summary>
        /// Read an item group with two item children
        /// </summary>
        [Fact]
        public void ReadItemGroupTwoItems()
        {
            string content = @"
                    <Project>
                        <ItemGroup>
                            <i Include='i1'/>
                            <i Include='i2'/>
                        </ItemGroup>
                    </Project>
                ";
 
            using ProjectRootElementFromString projectRootElementFromString = new(content);
            ProjectRootElement project = projectRootElementFromString.Project;
            ProjectItemGroupElement group = (ProjectItemGroupElement)Helpers.GetFirst(project.Children);
 
            var items = Helpers.MakeList(group.Items);
 
            Assert.Equal(2, items.Count);
            Assert.Equal("i1", items[0].Include);
            Assert.Equal("i2", items[1].Include);
        }
 
        /// <summary>
        /// Set the condition value
        /// </summary>
        [Fact]
        public void SetCondition()
        {
            ProjectRootElement project = ProjectRootElement.Create();
            project.AddItemGroup();
            Helpers.ClearDirtyFlag(project);
 
            ProjectItemGroupElement itemGroup = Helpers.GetFirst(project.ItemGroups);
            itemGroup.Condition = "c";
 
            Assert.Equal("c", itemGroup.Condition);
            Assert.True(project.HasUnsavedChanges);
        }
 
        /// <summary>
        /// Set the Label value
        /// </summary>
        [Fact]
        public void SetLabel()
        {
            ProjectRootElement project = ProjectRootElement.Create();
            project.AddItemGroup();
            Helpers.ClearDirtyFlag(project);
 
            ProjectItemGroupElement itemGroup = Helpers.GetFirst(project.ItemGroups);
            itemGroup.Label = "c";
 
            Assert.Equal("c", itemGroup.Label);
            Assert.True(project.HasUnsavedChanges);
        }
 
        [Theory]
        [InlineData("""
            <Project>
                <ItemGroup>
                    <PackageReference Include="A" Version="1.0.0" /><!-- some comment -->
                </ItemGroup>
            </Project>
            """,
            """
            <Project>
                <ItemGroup>
                    <PackageReference Include="A" Version="1.0.0" /><!-- some comment -->
                    <PackageReference Include="Inserted" Version="1.5.0" />
                </ItemGroup>
            </Project>
            """,
            true)] // use trailing single comment scenario
        [InlineData("""
            <Project>
              <ItemGroup>
                <PackageReference Include="A" Version="1.0.0" /><!--
                    This is a multi-line
                    comment across lines
                    -->
              </ItemGroup>
            </Project>
            """,
            """
            <Project>
              <ItemGroup>
                <PackageReference Include="A" Version="1.0.0" /><!--
                    This is a multi-line
                    comment across lines
                    -->
                <PackageReference Include="Inserted" Version="1.5.0" />
              </ItemGroup>
            </Project>
            """,// use multi-line trailing comment scenario
            true)]
        [InlineData("""
            <Project>
               <ItemGroup>
                    <PackageReference Include="A" Version="1.0.0" />
                    <!--
                    This is a multi-line
                    comment before the next item
                    -->
                    <PackageReference Include="B" Version="2.0.0" />
                </ItemGroup>
            </Project>
            """,
            """
            <Project>
               <ItemGroup>
                    <PackageReference Include="A" Version="1.0.0" />
                    <PackageReference Include="Inserted" Version="1.5.0" />
                    <!--
                    This is a multi-line
                    comment before the next item
                    -->
                    <PackageReference Include="B" Version="2.0.0" />
                </ItemGroup>
            </Project>
            """,
            false)] // use multi-line comment scenario
        [InlineData(
            """
            <Project>
              <ItemGroup>
                <PackageReference Include="A" Version="1.0.0" />    <!-- comment A -->
                <!-- comment before B -->
                <PackageReference Include="B" Version="2.0.0" />
              </ItemGroup>
            </Project>
            """,
            """
            <Project>
              <ItemGroup>
                <PackageReference Include="A" Version="1.0.0" />    <!-- comment A -->
                <PackageReference Include="Inserted" Version="1.5.0" />
                <!-- comment before B -->
                <PackageReference Include="B" Version="2.0.0" />
              </ItemGroup>
            </Project>
            """,
            false)] // use comment before next item scenario
        public void AddItem_PreservesComments(string content, string expectedContent, bool trailingComment)
        {
            using ProjectRootElementFromString projectRootElementFromString = new(content, ProjectCollection.GlobalProjectCollection, true);
            ProjectRootElement project = projectRootElementFromString.Project;
            ProjectItemGroupElement group = project.ItemGroups.First();
            if (trailingComment)
            {
 
                group.AddItem("PackageReference", "Inserted").AddMetadata("Version", "1.5.0", expressAsAttribute: true);
            }
            else
            {
                // Insert a new item between the two existing items
                var items = group.Items.ToList();
                var newItem = project.CreateItemElement("PackageReference");
                newItem.Include = "Inserted";
                group.InsertAfterChild(newItem, items[0]);
                newItem.AddMetadata("Version", "1.5.0", true);
            }
            Helpers.VerifyAssertLineByLine(expectedContent, project.RawXml);
        }
    }
}