Skip to content
This repository has been archived by the owner on Jan 11, 2024. It is now read-only.

Commit

Permalink
Add BuildTools support for SDK-style projects in VS. (#2083)
Browse files Browse the repository at this point in the history 
* Add BuildTools support for SDK-style projects in VS.

1. Turn off FillPartialFacadeUsingTask during design-time builds. These builds don't produced output assemblies, and the task fails if there is no output assembly.
2. The design-time builds run targets in a different order than with the legacy .csproj format. Hook our targets into different locations to make VS design-time builds work correctly.
3. Update UpdateVSConfigurations to write out .sln and .csproj files for SDK-style projects.

* Fix whitespace.

* Add a general AddReferencesDynamically target that allows people to hook to add new References dynamically.
  • Loading branch information
@eerhardt
eerhardt authored Jul 4, 2018
1 parent c290105 commit 94f18eb
Show file tree
Hide file tree
Showing 3 changed files with 100 additions and 67 deletions.
25 changes: 22 additions & 3 deletions src/Microsoft.DotNet.Build.Tasks/PackageFiles/FrameworkTargeting.targets
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,22 @@
<NuGetTargetMoniker Condition="'$(NuGetTargetMoniker)' == ''">.NETCoreApp,Version=v1.0</NuGetTargetMoniker>
</PropertyGroup>

<!--
Between the legacy C# project system and the new managed C# project system, some Targets run in different
orders. A normal "Build" and the legacy C# project system will execute 'Compile', which depends on
'ResolveReferences', which then depends on 'BeforeResolveReferences', so hooking before
'BeforeResolveReferences' allows @(Reference) items to be added before 'ResolveAssemblyReferences'
gets executed.
However, in the new managed C# project system, 'ResolveProjectReferencesDesignTime' gets executed first,
which depends on 'ResolveAssemblyReferences'. This means 'ResolveReferences' doesn't get executed before
'ResolveAssemblyReferences' when doing a design-time build in the managed C# project system.
Work around this by BeforeTargets both 'BeforeResolveReferences' (to preserve any legacy ordering) and
'ResolveAssemblyReferences' (to work in the managed C# project system).
-->
<Target Name="AddReferencesDynamically"
BeforeTargets="BeforeResolveReferences;ResolveAssemblyReferences" />

<PropertyGroup Condition="'$(IncludeDefaultReferences)' == ''">
<IncludeDefaultReferences Condition="'$(MSBuildProjectExtension)' == '.csproj'">true</IncludeDefaultReferences>
<IncludeDefaultReferences Condition="'$(MSBuildProjectExtension)' == '.vbproj'">true</IncludeDefaultReferences>
Expand All @@ -61,11 +77,10 @@
Include="netstandard" />
</ItemGroup>
</Target>

<Target Name="UpdateReferenceItems"
DependsOnTargets="SetupDefaultReferences"
BeforeTargets="BeforeResolveReferences"
>
BeforeTargets="AddReferencesDynamically">
<ItemGroup>
<Reference Include="@(DefaultReference)" />
</ItemGroup>
Expand Down Expand Up @@ -146,6 +161,10 @@
</PropertyGroup>

<PropertyGroup>
<PrepareProjectReferencesDependsOn>
AddProjectReferencesDynamically;
$(PrepareProjectReferencesDependsOn);
</PrepareProjectReferencesDependsOn>
<ResolveReferencesDependsOn>
AddProjectReferencesDynamically;
$(ResolveReferencesDependsOn);
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.DotNet.Build.Tasks/PackageFiles/partialfacades.task.targets
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
of the assembly compilation process.
-->
<PropertyGroup>
<TargetsTriggeredByCompilation Condition="'$(IsPartialFacadeAssembly)' == 'true'">
<TargetsTriggeredByCompilation Condition="'$(IsPartialFacadeAssembly)' == 'true' and '$(DesignTimeBuild)' != 'true'">
$(TargetsTriggeredByCompilation);FillPartialFacadeUsingTask
</TargetsTriggeredByCompilation>
</PropertyGroup>
Expand Down
140 changes: 77 additions & 63 deletions src/Microsoft.DotNet.Build.Tasks/UpdateVSConfigurations.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public class UpdateVSConfigurations : BuildTask

private const string ConfigurationPropsFilename = "Configurations.props";
private static Regex s_configurationConditionRegex = new Regex(@"'\$\(Configuration\)\|\$\(Platform\)' ?== ?'(?<config>.*)'");
private static string[] s_configurationSuffixes = new [] { "Debug|AnyCPU", "Release|AnyCPU" };
private static string[] s_configurationSuffixes = new [] { "Debug", "Release" };

public override bool Execute()
{
Expand All @@ -40,14 +40,14 @@ public override bool Execute()
Log.LogMessage($"Updating {projectFile}");

var project = ProjectRootElement.Open(projectFile);
ICollection<ProjectPropertyGroupElement> propertyGroups;
var actualConfigurations = GetConfigurationFromPropertyGroups(project, out propertyGroups);
ICollection<ProjectPropertyGroupElement> propertyGroups = GetPropertyGroupsToRemove(project);
var actualConfigurations = GetConfigurationsFromProperty(project);

bool addedGuid = EnsureProjectGuid(project);

if (!actualConfigurations.SequenceEqual(expectedConfigurations))
{
ReplaceConfigurationPropertyGroups(project, propertyGroups, expectedConfigurations);
ReplaceConfigurationsProperty(project, propertyGroups, expectedConfigurations);
}

if (addedGuid || !actualConfigurations.SequenceEqual(expectedConfigurations))
Expand Down Expand Up @@ -92,94 +92,66 @@ private static string[] GetConfigurationStrings(string configurationProjectFile,
}

/// <summary>
/// Gets a sorted list of configuration strings from a project file's PropertyGroups
/// Gets a collection of a project file's configuration PropertyGroups in the legacy format.
/// </summary>
/// <param name="project">Project</param>
/// <param name="propertyGroups">collection that accepts the list of property groups representing configuration strings</param>
/// <returns>Sorted list of configuration strings</returns>
private static string[] GetConfigurationFromPropertyGroups(ProjectRootElement project, out ICollection<ProjectPropertyGroupElement> propertyGroups)
/// <returns>Collection of PropertyGroups that should be removed from the project.</returns>
private static ICollection<ProjectPropertyGroupElement> GetPropertyGroupsToRemove(ProjectRootElement project)
{
propertyGroups = new List<ProjectPropertyGroupElement>();
var configurations = new SortedSet<string>(StringComparer.OrdinalIgnoreCase);
List<ProjectPropertyGroupElement> propertyGroups = new List<ProjectPropertyGroupElement>();

foreach (var propertyGroup in project.PropertyGroups)
{
var match = s_configurationConditionRegex.Match(propertyGroup.Condition);

if (match.Success)
{
configurations.Add(match.Groups["config"].Value);
propertyGroups.Add(propertyGroup);
}
}

return configurations.ToArray();
return propertyGroups;
}

private string[] GetConfigurationsFromProperty(ProjectRootElement project)
{
return project.PropertyGroups
.SelectMany(g => g.Properties)
.FirstOrDefault(p => p.Name == "Configurations")?.Value
.Split(';')
?? Array.Empty<string>();
}

/// <summary>
/// Replaces all configuration propertygroups with empty property groups corresponding to the expected configurations.
/// Replaces the configurations property with the expected configurations.
/// Doesn't attempt to preserve any content since it can all be regenerated.
/// Does attempt to preserve the ordering in the project file.
/// </summary>
/// <param name="project">Project</param>
/// <param name="oldPropertyGroups">PropertyGroups to remove</param>
/// <param name="newConfigurations"></param>
private static void ReplaceConfigurationPropertyGroups(ProjectRootElement project, IEnumerable<ProjectPropertyGroupElement> oldPropertyGroups, IEnumerable<string> newConfigurations)
private static void ReplaceConfigurationsProperty(ProjectRootElement project, IEnumerable<ProjectPropertyGroupElement> oldPropertyGroups, IEnumerable<string> newConfigurations)
{
ProjectElement insertAfter = null, insertBefore = null;

foreach (var oldPropertyGroup in oldPropertyGroups)
{
insertBefore = oldPropertyGroup.NextSibling;
project.RemoveChild(oldPropertyGroup);
}

if (insertBefore == null)
string configurationsValue = string.Join(";", newConfigurations);
var configurationsProperty = project.Properties.FirstOrDefault(p => p.Name == "Configurations");
if (configurationsProperty == null)
{
// find first itemgroup after imports
var insertAt = project.Imports.FirstOrDefault()?.NextSibling;

while (insertAt != null)
var firstPropertyGroup = project.PropertyGroups.FirstOrDefault();
if (firstPropertyGroup == null)
{
if (insertAt is ProjectItemGroupElement)
{
insertBefore = insertAt;
break;
}

insertAt = insertAt.NextSibling;
firstPropertyGroup = project.CreatePropertyGroupElement();
}
}

if (insertBefore == null)
{
// find last propertygroup after imports, defaulting to after imports
insertAfter = project.Imports.FirstOrDefault();

while (insertAfter?.NextSibling != null && insertAfter.NextSibling is ProjectPropertyGroupElement)
{
insertAfter = insertAfter.NextSibling;
}
configurationsProperty = firstPropertyGroup.AddProperty("Configurations", configurationsValue);
}

foreach (var newConfiguration in newConfigurations)
else
{
var newPropertyGroup = project.CreatePropertyGroupElement();
newPropertyGroup.Condition = $"'$(Configuration)|$(Platform)' == '{newConfiguration}'";
if (insertBefore != null)
{
project.InsertBeforeChild(newPropertyGroup, insertBefore);
}
else if (insertAfter != null)
{
project.InsertAfterChild(newPropertyGroup, insertAfter);
}
else
{
project.AppendChild(newPropertyGroup);
}
insertBefore = null;
insertAfter = newPropertyGroup;
configurationsProperty.Value = configurationsValue;
}
}

Expand Down Expand Up @@ -280,10 +252,14 @@ private void UpdateSolution(ITaskItem solutionRootItem)

Log.LogMessage($"Generating solution for '{solutionRootPath}'...");

string solutionName = GetNameForSolution(solutionRootPath);
string slnFile = Path.Combine(solutionRootPath, solutionName + ".sln");
Solution solution = new Solution(slnFile);

StringBuilder slnBuilder = new StringBuilder();
slnBuilder.AppendLine("Microsoft Visual Studio Solution File, Format Version 12.00");
slnBuilder.AppendLine("# Visual Studio 14");
slnBuilder.AppendLine("VisualStudioVersion = 14.0.25420.1");
slnBuilder.AppendLine("# Visual Studio 15");
slnBuilder.AppendLine("VisualStudioVersion = 15.0.27213.1");
slnBuilder.AppendLine("MinimumVisualStudioVersion = 10.0.40219.1");


Expand Down Expand Up @@ -376,10 +352,13 @@ private void UpdateSolution(ITaskItem solutionRootItem)
}
slnBuilder.AppendLine("\tEndGlobalSection");

// Output the extensibility globals
slnBuilder.AppendLine("\tGlobalSection(ExtensibilityGlobals) = postSolution");
slnBuilder.AppendLine($"\t\tSolutionGuid = {solution.Guid}");
slnBuilder.AppendLine("\tEndGlobalSection");

slnBuilder.AppendLine("EndGlobal");

string solutionName = GetNameForSolution(solutionRootPath);
string slnFile = Path.Combine(solutionRootPath, solutionName + ".sln");
File.WriteAllText(slnFile, slnBuilder.ToString());
}

Expand Down Expand Up @@ -440,6 +419,41 @@ public ProjectFolder(string basePath, string relPath, string projectId, string p
}
}

internal class Solution
{
public string Path { get; }
public string Guid { get; }

public Solution(string path)
{
Path = path;
Guid = ReadSolutionGuid(path);
}

private static string ReadSolutionGuid(string path)
{
string solutionGuid = null;
if (File.Exists(path))
{
foreach (string line in File.ReadLines(path))
{
if (line.StartsWith("\t\tSolutionGuid = "))
{
solutionGuid = line.Substring("\t\tSolutionGuid = ".Length);
break;
}
}
}

if (solutionGuid == null)
{
solutionGuid = System.Guid.NewGuid().ToString("B").ToUpper();
}

return solutionGuid;
}
}

internal class SolutionProject
{
public string ProjectPath { get; }
Expand Down Expand Up @@ -507,10 +521,10 @@ public string SolutionGuid
{
//ProjectTypeGuids for different projects, pulled from the Visual Studio regkeys
//TODO: Clean up or map these to actual projects, this is fragile
string slnGuid = "{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}"; // Windows (C#)
string slnGuid = "{9A19103F-16F7-4668-BE54-9A1E7A4F7556}"; // Windows (C#) Managed/CPS
if (ProjectPath.Contains("VisualBasic.vbproj"))
{
slnGuid = "{F184B08F-C81C-45F6-A57F-5ABD9991F28F}"; //Windows (VB.NET)
slnGuid = "{778DAE3C-4631-46EA-AA77-85C1314464D9}"; //Windows (VB.NET) Managed/CPS
}
if (ProjectPath.Contains("TestNativeService")) //Windows (Visual C++)
{
Expand Down

0 comments on commit 94f18eb

Please sign in to comment.