Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added ProjectContextHelper.GetXmlKeyValue and IProjectContext.CheckNullableVariable #2061

Merged
merged 3 commits into from
Oct 26, 2022
Merged

added ProjectContextHelper.GetXmlKeyValue and IProjectContext.CheckNullableVariable #2061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4a709f7
added ProjectContextHelper.GetXmlKeyValue and IProjectContext.CheckNu…
deepchoudhery Oct 26, 2022
13f482c
minor fix.
deepchoudhery Oct 26, 2022
4d7261f
minor fix 2
deepchoudhery Oct 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/MSIdentityScaffolding/Microsoft.DotNet.MSIdentity/CodeReaderWriter/ProjectModifier.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public async Task AddAuthCodeAsync()
_toolOptions.ProjectFilePath = csProjFiles.First();
}
string csprojText = File.ReadAllText(_toolOptions.ProjectFilePath);
_toolOptions.ShortTfms = ProjectModifierHelper.ProcessCsprojFile(csprojText);
_toolOptions.ShortTfms = ProjectModifierHelper.ProcessCsprojTfms(csprojText);

CodeModifierConfig? codeModifierConfig = GetCodeModifierConfig();
if (codeModifierConfig is null || !codeModifierConfig.Files.Any())
Expand Down
1 change: 1 addition & 0 deletions src/Scaffolding/VS.Web.CG.Design/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ private static void Execute(string[] args, ConsoleLogger logger)
string projectAssetsFile = ProjectModelHelper.GetProjectAssetsFile(projectInformation);
//fix package dependencies sent from VS
projectInformation = projectInformation.AddPackageDependencies(projectAssetsFile);
projectInformation = projectInformation.CheckNullableVariable();
var codeGenArgs = ToolCommandLineHelper.FilterExecutorArguments(args);
var isSimulationMode = ToolCommandLineHelper.IsSimulationMode(args);
CodeGenCommandExecutor executor = new CodeGenCommandExecutor(projectInformation,
Expand Down
2 changes: 1 addition & 1 deletion src/Shared/Microsoft.DotNet.Scaffolding.Shared/Project/ProjectModifierHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ internal static async Task<bool> IsUsingTopLevelStatements(IModelTypesLocator mo
/// </summary>
/// <param name="csprojText">.csproj file as string</param>
/// <returns>string[] containing target frameworks of the project</returns>
internal static string[] ProcessCsprojFile(string csprojText)
internal static string[] ProcessCsprojTfms(string csprojText)
{
List<string> processedTfms = new List<string>();
if (!string.IsNullOrEmpty(csprojText))
Expand Down
26 changes: 26 additions & 0 deletions src/Shared/Microsoft.DotNet.Scaffolding.Shared/ProjectModel/ProjectContextExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ public static IEnumerable<DependencyDescription> GetReferencingPackages(this IPr
.Dependencies
.Any(dep => dep.Name.Equals(name, StringComparison.OrdinalIgnoreCase)));
}

public static IProjectContext AddPackageDependencies(this IProjectContext projectInformation, string projectAssetsFile)
{
//get project assets file
Expand Down Expand Up @@ -64,5 +65,30 @@ public static IProjectContext AddPackageDependencies(this IProjectContext projec
return newProjectContext;
}

/// <summary>
/// Given an IProjectContext, check if IProjectContext.Nullable is set, if it is, no changes necessary.
/// If not already there, set using ProjectContextHelper.GetXmlKeyValue (parsing the csproj xml file).
/// </summary>
/// <param name="context">IProjectContext which has csproj path, and the Nullable variable to set.</param>
/// <returns>modified IProjectContext with the Nullable property set or the same IProjectContext as passed.</returns>
public static IProjectContext CheckNullableVariable(this IProjectContext context)
{
//if nullable is not empty, return current IProjectContext as is.
if (context != null && string.IsNullOrEmpty(context.Nullable))
{
string csprojText = System.IO.File.ReadAllText(context.ProjectFullPath);
string nullableVarValue = ProjectContextHelper.GetXmlKeyValue("nullable", csprojText);
if (!string.IsNullOrEmpty(nullableVarValue))
{
if (context is CommonProjectContext newProjectContext)
{
newProjectContext.Nullable = nullableVarValue;
return newProjectContext;
}
}
}
return context;
}

}
}
28 changes: 28 additions & 0 deletions src/Shared/Microsoft.DotNet.Scaffolding.Shared/ProjectModel/ProjectContextHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
using System.IO;
using System.Linq;
using System.Text.Json;
using System.Xml.Linq;
using Microsoft.DotNet.Scaffolding.Shared.ProjectModel;
using Microsoft.VisualStudio.Web.CodeGeneration.Utils;

Expand Down Expand Up @@ -172,5 +173,32 @@ internal static IList<DependencyDescription> DeserializePackages(JsonElement pac

return packageDependencies;
}

/// <summary>
/// Returns the value given a key (aka a xml tag) from the given xml file
/// </summary>
/// <param name="variableKey">variable key or tags in the csproj file</param>
/// <param name="xmlText">xml file text (mostly used for parsing csproj file)</param>
/// <returns>empty or value from the parsing the elements of the xml file.</returns>
internal static string GetXmlKeyValue(string variableKey, string xmlText)
{
string variableValue = string.Empty;
if (!string.IsNullOrEmpty(xmlText) && !string.IsNullOrEmpty(variableKey))
{
//use XDocument to get all csproj elements.
XDocument document = XDocument.Parse(xmlText);
var docNodes = document.Root?.Elements();
var allElements = docNodes?.SelectMany(x => x.Elements());
if (allElements != null && allElements.Any())
{
var varValueElement = allElements.FirstOrDefault(e => e.Name.LocalName.Equals(variableKey, StringComparison.OrdinalIgnoreCase));
if (varValueElement != null)
{
variableValue = varValueElement.Value;
}
}
}
return variableValue;
}
}
}
33 changes: 32 additions & 1 deletion test/Scaffolding/VS.Web.CG.MSBuild.Test/ProjectContextWriterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,18 @@ public class ProjectContextWriterTests : TestBase
{
static string testAppPath = Path.Combine("..", "TestApps", "ModelTypesLocatorTestClassLibrary");
private ITestOutputHelper _outputHelper;

private const string Net7CsprojVariabledCsproj = @"<Project Sdk=""Microsoft.NET.Sdk.Web"">
<PropertyGroup>
<Var1>$(Var2)$(Var3)</Var1>
<Var2>net</Var2>
<Var3>7.0</Var3>
<TargetFramework>$(Var1)</TargetFramework>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
</PropertyGroup>

</Project>
";
public ProjectContextWriterTests(ITestOutputHelper outputHelper)
{
_outputHelper = outputHelper;
Expand Down Expand Up @@ -139,5 +150,25 @@ public void GetPathTestOSX(string nugetPath, string packageName, string version,
Assert.Equal(expectedPath, ProjectContextHelper.GetPath(nugetPath, nameAndVersion));
}
}

[Fact]
public void GetXmlKeyValueTests()
{
var tfmValue = ProjectContextHelper.GetXmlKeyValue("TargetFramework", Net7CsprojVariabledCsproj);
var var2Value = ProjectContextHelper.GetXmlKeyValue("Var2", Net7CsprojVariabledCsproj);
var nullableValue = ProjectContextHelper.GetXmlKeyValue("Nullable", Net7CsprojVariabledCsproj);
var implicitValue = ProjectContextHelper.GetXmlKeyValue("ImplicitUsings", Net7CsprojVariabledCsproj);
var invalidValue = ProjectContextHelper.GetXmlKeyValue("bleh", Net7CsprojVariabledCsproj);
var emptyValue = ProjectContextHelper.GetXmlKeyValue("", Net7CsprojVariabledCsproj);
var nullValue = ProjectContextHelper.GetXmlKeyValue(null, Net7CsprojVariabledCsproj);

Assert.Equal("$(Var1)", tfmValue, ignoreCase: true);
Assert.Equal("net", var2Value, ignoreCase: true);
Assert.Equal("enable", nullableValue, ignoreCase: true);
Assert.Equal("enable", implicitValue, ignoreCase: true);
Assert.Equal("", invalidValue, ignoreCase: true);
Assert.Equal("", emptyValue, ignoreCase: true);
Assert.Equal("", nullValue, ignoreCase: true);
}
}
}
24 changes: 12 additions & 12 deletions test/Shared/Microsoft.DotNet.Scaffolding.Shared.Tests/ProjectModifierHelperTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -498,26 +498,26 @@ public async Task GlobalStatementExistsTests(string[] existingStatements, string
}

[Fact]
public void ProcessCsprojFile()
public void ProcessCsprojTfmsTest()
{
var net7Tfms = ProjectModifierHelper.ProcessCsprojFile(Net7Csproj);
var net7Tfms2 = ProjectModifierHelper.ProcessCsprojFile(Net7CsprojVariabledCsproj);
var net7Tfms3 = ProjectModifierHelper.ProcessCsprojFile(Net7CsprojVariabledCsproj2);
var net7Tfms = ProjectModifierHelper.ProcessCsprojTfms(Net7Csproj);
var net7Tfms2 = ProjectModifierHelper.ProcessCsprojTfms(Net7CsprojVariabledCsproj);
var net7Tfms3 = ProjectModifierHelper.ProcessCsprojTfms(Net7CsprojVariabledCsproj2);
Assert.True(net7Tfms.Length == 1 && net7Tfms2.Length == 1 && net7Tfms3.Length == 1);
Assert.True(net7Tfms.First().Equals("net7.0") && net7Tfms2.First().Equals("net7.0") && net7Tfms3.First().Equals("net7.0"));

var emptyTfms = ProjectModifierHelper.ProcessCsprojFile(EmptyCsproj);
var emptyTfms2 = ProjectModifierHelper.ProcessCsprojFile(EmptyCsproj2);
var emptyTfms = ProjectModifierHelper.ProcessCsprojTfms(EmptyCsproj);
var emptyTfms2 = ProjectModifierHelper.ProcessCsprojTfms(EmptyCsproj2);
Assert.True(emptyTfms.Length == 0 && emptyTfms2.Length == 0);

var invalidTfm = ProjectModifierHelper.ProcessCsprojFile(InvalidCsproj);
var invalidTfm2 = ProjectModifierHelper.ProcessCsprojFile(InvalidCsproj2);
var invalidTfm3 = ProjectModifierHelper.ProcessCsprojFile(InvalidCsproj3);
var invalidTfm = ProjectModifierHelper.ProcessCsprojTfms(InvalidCsproj);
var invalidTfm2 = ProjectModifierHelper.ProcessCsprojTfms(InvalidCsproj2);
var invalidTfm3 = ProjectModifierHelper.ProcessCsprojTfms(InvalidCsproj3);
Assert.True(invalidTfm.Length == 0 && invalidTfm2.Length == 0 && invalidTfm3.Length == 0);

var multiTfm = ProjectModifierHelper.ProcessCsprojFile(MultiTfmCsproj);
var multiTfm2 = ProjectModifierHelper.ProcessCsprojFile(MultiTfmVariabledCsproj);
var multiTfm3 = ProjectModifierHelper.ProcessCsprojFile(MultiTfmVariabledCsproj2);
var multiTfm = ProjectModifierHelper.ProcessCsprojTfms(MultiTfmCsproj);
var multiTfm2 = ProjectModifierHelper.ProcessCsprojTfms(MultiTfmVariabledCsproj);
var multiTfm3 = ProjectModifierHelper.ProcessCsprojTfms(MultiTfmVariabledCsproj2);
Assert.True(multiTfm.Length == 2 && net7Tfms2.Length == 1 && multiTfm3.Length == 3);
Assert.True(multiTfm.Contains("net6.0") && multiTfm.Contains("net7.0"));
Assert.True(multiTfm2.Contains("net6.0") && multiTfm2.Contains("net7.0"));
Expand Down