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

Jump to bottom

Fix <ApplicationTitle> encoding in maui templates #22084

Merged
merged 9 commits into from
Jun 21, 2024
Merged

Fix <ApplicationTitle> encoding in maui templates #22084

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
40acad8
Makes <ApplicationTitle> use a custom symbol instead of the default n…
MiYanni Apr 26, 2024
5b78c21
Update README.md
Eilon Jun 17, 2024
07f77a2
Fix maui-blazor project and add tests
Eilon Jun 17, 2024
8ac7c1a
Fix multiproject template and more
Eilon Jun 17, 2024
c4af2a6
Fix test
Eilon Jun 18, 2024
07fadb8
Fixes
Eilon Jun 18, 2024
5aaa782
Update TemplateTests.cs
Eilon Jun 18, 2024
aae1fef
Update TemplateTests.cs
Eilon Jun 18, 2024
a1d814f
Fix Tizen
Eilon Jun 19, 2024
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
9 changes: 6 additions & 3 deletions src/Templates/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,13 @@ Add the local artifacts to the NuGet.config:
```

```dotnetcli
# uninstall, build, and install the templates
dotnet new uninstall Microsoft.Maui.Templates.net8
dotnet pack Microsoft.Maui.sln
dotnet new -i artifacts\Microsoft.Maui.Templates.*.nupkg
dotnet new install artifacts\packages\Release\Shipping\Microsoft.Maui.Templates.*.nupkg

# then just in the maui folder, so you get a NuGet.config
mkdir foo
cd foo
mkdir myproject
cd myproject
dotnet new maui
```
11 changes: 11 additions & 0 deletions src/Templates/src/templates/maui-blazor/.template.config/template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,12 @@
]
}
},
"XmlEncodedAppNameParam": {
"type": "derived",
"valueSource": "name",
"valueTransform": "encode",
"replaces": "XmlEncodedAppName"
},
"defaultAppId":{
"type": "generated",
"generator": "join",
Expand All @@ -128,5 +134,10 @@
"replaces": "com.companyname.mauiapp"
}
},
"forms": {
"encode": {
"identifier": "xmlEncode"
}
},
"defaultName": "MauiApp1"
}
2 changes: 1 addition & 1 deletion src/Templates/src/templates/maui-blazor/MauiApp.1.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<Nullable>enable</Nullable>

<!-- Display name -->
<ApplicationTitle>MauiApp.1</ApplicationTitle>
<ApplicationTitle>XmlEncodedAppName</ApplicationTitle>

<!-- App Identifier -->
<ApplicationId>com.companyname.mauiapp</ApplicationId>
Expand Down
2 changes: 1 addition & 1 deletion src/Templates/src/templates/maui-blazor/Platforms/Tizen/tizen-manifest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<manifest package="maui-application-id-placeholder" version="0.0.0" api-version="8" xmlns="http://tizen.org/ns/packages">
<profile name="common" />
<ui-application appid="maui-application-id-placeholder" exec="MauiApp.1.dll" multiple="false" nodisplay="false" taskmanage="true" type="dotnet" launch_mode="single">
<ui-application appid="maui-application-id-placeholder" exec="XmlEncodedAppName.dll" multiple="false" nodisplay="false" taskmanage="true" type="dotnet" launch_mode="single">
<label>maui-application-title-placeholder</label>
<icon>maui-appicon-placeholder</icon>
<metadata key="http://tizen.org/metadata/prefer_dotnet_aot" value="true" />
Expand Down
11 changes: 11 additions & 0 deletions src/Templates/src/templates/maui-mobile/.template.config/template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,12 @@
]
}
},
"XmlEncodedAppNameParam": {
"type": "derived",
"valueSource": "name",
"valueTransform": "encode",
"replaces": "XmlEncodedAppName"
},
"defaultAppId":{
"type": "generated",
"generator": "join",
Expand All @@ -132,5 +138,10 @@
"replaces": "com.companyname.mauiapp"
}
},
"forms": {
"encode": {
"identifier": "xmlEncode"
}
},
"defaultName": "MauiApp1"
}
2 changes: 1 addition & 1 deletion src/Templates/src/templates/maui-mobile/MauiApp.1.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<Nullable>enable</Nullable>

<!-- Display name -->
<ApplicationTitle>MauiApp.1</ApplicationTitle>
<ApplicationTitle>XmlEncodedAppName</ApplicationTitle>

<!-- App Identifier -->
<ApplicationId>com.companyname.mauiapp</ApplicationId>
Expand Down
2 changes: 1 addition & 1 deletion src/Templates/src/templates/maui-mobile/Platforms/Tizen/tizen-manifest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<manifest package="maui-application-id-placeholder" version="0.0.0" api-version="8" xmlns="http://tizen.org/ns/packages">
<profile name="common" />
<ui-application appid="maui-application-id-placeholder" exec="MauiApp.1.dll" multiple="false" nodisplay="false" taskmanage="true" type="dotnet" launch_mode="single">
<ui-application appid="maui-application-id-placeholder" exec="XmlEncodedAppName.dll" multiple="false" nodisplay="false" taskmanage="true" type="dotnet" launch_mode="single">
<label>maui-application-title-placeholder</label>
<icon>maui-appicon-placeholder</icon>
<metadata key="http://tizen.org/metadata/prefer_dotnet_aot" value="true" />
Expand Down
11 changes: 11 additions & 0 deletions src/Templates/src/templates/maui-multiproject/.template.config/template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,12 @@
]
}
},
"XmlEncodedAppNameParam": {
"type": "derived",
"valueSource": "name",
"valueTransform": "encode",
"replaces": "XmlEncodedAppName"
},
"defaultAppId":{
"type": "generated",
"generator": "join",
Expand All @@ -217,5 +223,10 @@
"replaces": "com.companyname.mauiapp"
}
},
"forms": {
"encode": {
"identifier": "xmlEncode"
}
},
"defaultName": "MauiApp1"
}
3 changes: 2 additions & 1 deletion src/Templates/src/templates/maui-multiproject/MauiApp.1.Droid/MauiApp.1.Droid.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<TargetFramework>DOTNET_TFM-android</TargetFramework>
<SupportedOSPlatformVersion>21.0</SupportedOSPlatformVersion>
<OutputType>Exe</OutputType>
<RootNamespace>MauiApp._1</RootNamespace>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<UseMaui>true</UseMaui>
Expand All @@ -16,7 +17,7 @@
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\MauiApp.1\MauiApp.1.csproj" />
<ProjectReference Include="..\XmlEncodedAppName\XmlEncodedAppName.csproj" />
</ItemGroup>

</Project>
2 changes: 1 addition & 1 deletion src/Templates/src/templates/maui-multiproject/MauiApp.1.Droid/Resources/values/strings.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<resources>
<string name="app_name">MauiApp.1</string>
<string name="app_name">XmlEncodedAppName</string>
</resources>
3 changes: 2 additions & 1 deletion src/Templates/src/templates/maui-multiproject/MauiApp.1.Mac/MauiApp.1.Mac.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<TargetFramework>DOTNET_TFM-maccatalyst</TargetFramework>
<SupportedOSPlatformVersion>13.1</SupportedOSPlatformVersion>
<OutputType>Exe</OutputType>
<RootNamespace>MauiApp._1</RootNamespace>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<UseMaui>true</UseMaui>
Expand All @@ -16,7 +17,7 @@
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\MauiApp.1\MauiApp.1.csproj" />
<ProjectReference Include="..\XmlEncodedAppName\XmlEncodedAppName.csproj" />
</ItemGroup>

</Project>
4 changes: 2 additions & 2 deletions src/Templates/src/templates/maui-multiproject/MauiApp.1.WinUI/MauiApp.1.WinUI.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<OutputType>WinExe</OutputType>
<TargetFramework>DOTNET_TFM-windows10.0.19041.0</TargetFramework>
<TargetPlatformMinVersion>10.0.17763.0</TargetPlatformMinVersion>
<RootNamespace>MauiApp.1.WinUI</RootNamespace>
<RootNamespace>MauiApp._1.WinUI</RootNamespace>
<ApplicationManifest>app.manifest</ApplicationManifest>
<Platforms>x86;x64;ARM64</Platforms>
<RuntimeIdentifiers>win10-x86;win10-x64;win10-arm64</RuntimeIdentifiers>
Expand All @@ -25,7 +25,7 @@
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\MauiApp.1\MauiApp.1.csproj" />
<ProjectReference Include="..\XmlEncodedAppName\XmlEncodedAppName.csproj" />
</ItemGroup>

<ItemGroup>
Expand Down
3 changes: 2 additions & 1 deletion src/Templates/src/templates/maui-multiproject/MauiApp.1.iOS/MauiApp.1.iOS.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<TargetFramework>DOTNET_TFM-ios</TargetFramework>
<SupportedOSPlatformVersion>11.0</SupportedOSPlatformVersion>
<OutputType>Exe</OutputType>
<RootNamespace>MauiApp._1</RootNamespace>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<UseMaui>true</UseMaui>
Expand All @@ -16,7 +17,7 @@
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\MauiApp.1\MauiApp.1.csproj" />
<ProjectReference Include="..\XmlEncodedAppName\XmlEncodedAppName.csproj" />
</ItemGroup>

</Project>
1 change: 1 addition & 0 deletions src/Templates/src/templates/maui-multiproject/MauiApp.1/MauiApp.1.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<TargetFramework>DOTNET_TFM</TargetFramework>
<SingleProject>true</SingleProject>
<ImplicitUsings>enable</ImplicitUsings>
<RootNamespace>MauiApp._1</RootNamespace>
<UseMaui>true</UseMaui>
<Nullable>enable</Nullable>
</PropertyGroup>
Expand Down
30 changes: 21 additions & 9 deletions src/TestUtils/src/Microsoft.Maui.IntegrationTests/TemplateTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,13 @@ public void Build(string id, string framework, string config, bool shouldPack)
}

[Test]
[TestCase("Debug")]
[TestCase("Release")]
public void BuildMultiProject(string config)
[TestCase("Debug", "simplemulti")]
[TestCase("Release", "simplemulti")]
[TestCase("Debug", "MultiProject@Symbol & More")]
[TestCase("Release", "MultiProject@Symbol & More")]
public void BuildMultiProject(string config, string projectName)
{
var projectDir = TestDirectory;
var projectDir = Path.Combine(TestDirectory, projectName);
var name = Path.GetFileName(projectDir);
var solutionFile = Path.Combine(projectDir, $"{name}.sln");

Expand All @@ -62,7 +64,7 @@ public void BuildMultiProject(string config)

if (!TestEnvironment.IsWindows)
{
Assert.IsTrue(DotnetInternal.Run("sln", $"{solutionFile} remove {projectDir}/{name}.WinUI/{name}.WinUI.csproj"),
Assert.IsTrue(DotnetInternal.Run("sln", $"\"{solutionFile}\" remove \"{projectDir}/{name}.WinUI/{name}.WinUI.csproj\""),
$"Unable to remove WinUI project from solution. Check test output for errors.");
}

Expand Down Expand Up @@ -99,10 +101,10 @@ public void BuildMultiProjectSinglePlatform(string config, string platformArg)
[TestCase("maui", "Project Space", "projectspace")]
[TestCase("maui-blazor", "Project Space", "projectspace")]
[TestCase("mauilib", "Project Space", "projectspace")]
// with invalid characters
[TestCase("maui", "Project@Symbol", "projectsymbol")]
[TestCase("maui-blazor", "Project@Symbol", "projectsymbol")]
[TestCase("mauilib", "Project@Symbol", "projectsymbol")]
// with lots tricky characters (the '&' requires XML escaping too)
[TestCase("maui", "Project@Symbol & More", "projectsymbolmore")]
[TestCase("maui-blazor", "Project@Symbol & More", "projectsymbolmore")]
[TestCase("mauilib", "Project@Symbol & More", "projectsymbolmore")]
public void BuildsWithSpecialCharacters(string id, string projectName, string expectedId)
{
var projectDir = Path.Combine(TestDirectory, projectName);
Expand All @@ -117,12 +119,22 @@ public void BuildsWithSpecialCharacters(string id, string projectName, string ex
if (id != "mauilib")
{
var doc = XDocument.Load(projectFile);

// Check the app ID got invalid characters removed
var appId = doc.Root!
.Elements("PropertyGroup")
.Elements("ApplicationId")
.Single()
.Value;
Assert.AreEqual($"com.companyname.{expectedId}", appId);

// Check the app title matches the project name exactly (it might have been XML-encoded, but loading the document decodes that)
var appTitle = doc.Root!
.Elements("PropertyGroup")
.Elements("ApplicationTitle")
.Single()
.Value;
Assert.AreEqual(projectName, appTitle);
}

Assert.IsTrue(DotnetInternal.Build(projectFile, "Debug", properties: BuildProps, msbuildWarningsAsErrors: true),
Expand Down
Loading