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.

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

Partial implemented: CLI template build symbols #8168

Merged
merged 3 commits into from
Mar 24, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using JetBrains.Annotations;
using System.Collections.Generic;
using JetBrains.Annotations;
using Volo.Abp.Cli.ProjectBuilding.Files;

namespace Volo.Abp.Cli.ProjectBuilding.Building
Expand All @@ -19,6 +20,8 @@ public class ProjectBuildContext

public ProjectResult Result { get; set; }

public List<string> Symbols { get; } //TODO: Fill the symbols, like "UI-Angular", "CMS-KIT"!

public ProjectBuildContext(
TemplateInfo template,
ModuleInfo module,
Expand All @@ -29,6 +32,7 @@ public class ProjectBuildContext
Module = module;
TemplateFile = Check.NotNull(templateFile, nameof(templateFile));
BuildArgs = Check.NotNull(buildArgs, nameof(buildArgs));
Symbols = new List<string>();

Result = new ProjectResult();
}
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public override void Execute(ProjectBuildContext context)
{
if (file.Name.EndsWith(".cs") || file.Name.EndsWith(".csproj") || file.Name.EndsWith(".cshtml") || file.Name.EndsWith(".json"))
{
file.RemoveTemplateCode();
file.RemoveTemplateCode(context.Symbols);
file.RemoveTemplateCodeMarkers();
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
using System;
using System.Collections.Generic;
using System.Linq;

namespace Volo.Abp.Cli.ProjectBuilding.Files
{
Expand All @@ -11,19 +13,9 @@ public static FileEntry ReplaceText(this FileEntry file, string oldText, string
return file;
}

public static void RemoveTemplateCode(this FileEntry file)
public static void RemoveTemplateCode(this FileEntry file, List<string> symbols)
{
RemoveMarkedTemplateCode(file, "<TEMPLATE-REMOVE>");
}

public static void RemoveTemplateCodeIf(this FileEntry file, string condition)
{
RemoveByCondition(file, "IF", condition);
}

public static void RemoveTemplateCodeIfNot(this FileEntry file, string condition)
{
RemoveByCondition(file, "IF-NOT", condition);
RemoveMarkedTemplateCode(file, symbols);
}

public static void RemoveTemplateCodeMarkers(this FileEntry file)
Expand Down Expand Up @@ -57,12 +49,7 @@ public static void RemoveTemplateCodeMarkers(this FileEntry file)
file.SetLines(newLines);
}

private static void RemoveByCondition(this FileEntry file, string conditionName, string condition)
{
RemoveMarkedTemplateCode(file, $"<TEMPLATE-REMOVE {conditionName}='{condition}'>");
}

private static void RemoveMarkedTemplateCode(this FileEntry file, string beginMark)
private static void RemoveMarkedTemplateCode(this FileEntry file, List<string> symbols)
{
if (!file.Content.Contains("</TEMPLATE-REMOVE>"))
{
Expand All @@ -76,8 +63,40 @@ private static void RemoveMarkedTemplateCode(this FileEntry file, string beginMa

for (int i = 0; i < lines.Length; i++)
{
if (lines[i].Contains(beginMark))
if (lines[i].Contains("<TEMPLATE-REMOVE"))
{
var parsedMarker = ParseTemplateRemoveMarker(lines[i]);

bool sectionShouldBeRemoved = false;

if (!parsedMarker.Symbols.Any())
{
sectionShouldBeRemoved = true;
}
else if(parsedMarker.Symbols.Count == 1)
{
sectionShouldBeRemoved = !parsedMarker.IsNegativeCondition
? symbols.Contains(parsedMarker.Symbols[0], StringComparer.InvariantCultureIgnoreCase)
: !symbols.Contains(parsedMarker.Symbols[0], StringComparer.InvariantCultureIgnoreCase);
}
else if (parsedMarker.Operator == Operator.And)
{
sectionShouldBeRemoved = parsedMarker.Symbols.Any(s => !parsedMarker.IsNegativeCondition
? symbols.Contains(s, StringComparer.InvariantCultureIgnoreCase)
: !symbols.Contains(s, StringComparer.InvariantCultureIgnoreCase));
}
else if (parsedMarker.Operator == Operator.Or)
{
sectionShouldBeRemoved = !parsedMarker.Symbols.All(s => !parsedMarker.IsNegativeCondition
? symbols.Contains(s, StringComparer.InvariantCultureIgnoreCase)
: !symbols.Contains(s, StringComparer.InvariantCultureIgnoreCase) == false);
}

if (!sectionShouldBeRemoved)
{
continue;
}

while (i < lines.Length && !lines[i].Contains("</TEMPLATE-REMOVE>"))
{
++i;
Expand All @@ -94,5 +113,65 @@ private static void RemoveMarkedTemplateCode(this FileEntry file, string beginMa

file.SetLines(newLines);
}

private static TemplateRemoveMarkerParseResult ParseTemplateRemoveMarker(string marker)
{
var result = new TemplateRemoveMarkerParseResult();

var condition = marker.Trim()
.RemovePreFix("//").Trim()
.RemovePreFix("@*").Trim()
.RemovePreFix("<!--").Trim()
.RemovePreFix("<TEMPLATE-REMOVE").Trim()
.RemovePostFix("*@").Trim()
.RemovePostFix("-->").Trim()
.RemovePostFix(">").Trim();

if (string.IsNullOrWhiteSpace(condition))
{
return result;
}

var conditionSplitted = condition.Split("=");

result.IsNegativeCondition = conditionSplitted[0] == "IF-NOT";

var conditionContent = string.Join("=", conditionSplitted.Skip(1))
.RemovePostFix("\"").RemovePreFix("\"")
.RemovePostFix("'").RemovePreFix("'");

if (conditionContent.Contains("&&"))
{
result.Operator = Operator.And;
result.Symbols = conditionContent.Split("&&").ToList();
}
else if(conditionContent.Contains("||"))
{
result.Operator = Operator.Or;
result.Symbols = conditionContent.Split("||").ToList();
}
else
{
result.Symbols.Add(conditionContent);
}

return result;
}

private class TemplateRemoveMarkerParseResult
{
public List<string> Symbols { get; set; } = new List<string>();

public Operator Operator { get; set; } = Operator.None;

public bool IsNegativeCondition { get; set; }
}

private enum Operator
{
None,
And,
Or
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ public override IEnumerable<ProjectBuildPipelineStep> GetCustomSteps(ProjectBuil
SwitchDatabaseProvider(context, steps);
DeleteUnrelatedProjects(context, steps);
RemoveMigrations(context, steps);
ConfigureTieredArchitecture(context, steps);
ConfigurePublicWebSite(context, steps);
RemoveUnnecessaryPorts(context, steps);
RandomizeSslPorts(context, steps);
Expand Down Expand Up @@ -64,7 +65,10 @@ private static void SwitchDatabaseProvider(ProjectBuildContext context, List<Pro
steps.Add(new RemoveProjectFromSolutionStep("MyCompanyName.MyProjectName.EntityFrameworkCore"));
steps.Add(new RemoveProjectFromSolutionStep("MyCompanyName.MyProjectName.EntityFrameworkCore.DbMigrations"));
steps.Add(new RemoveProjectFromSolutionStep("MyCompanyName.MyProjectName.EntityFrameworkCore.Tests", projectFolderPath: "/aspnet-core/test/MyCompanyName.MyProjectName.EntityFrameworkCore.Tests"));
steps.Add(new RemoveEfCoreRelatedCodeStep());
}
else
{
context.Symbols.Add("EFCORE");
}

if (context.BuildArgs.DatabaseProvider != DatabaseProvider.MongoDb)
Expand Down Expand Up @@ -144,14 +148,15 @@ private void ConfigurePublicWebSite(ProjectBuildContext context, List<ProjectBui
{
if (!context.BuildArgs.PublicWebSite)
{
if (!context.BuildArgs.ExtraProperties.ContainsKey(NewCommand.Options.Tiered.Long) &&
!context.BuildArgs.ExtraProperties.ContainsKey("separate-identity-server"))
if (context.BuildArgs.ExtraProperties.ContainsKey(NewCommand.Options.Tiered.Long) ||
context.BuildArgs.ExtraProperties.ContainsKey("separate-identity-server"))
{
steps.Add(new RemovePublicRedisStep());
context.Symbols.Add("PUBLIC-REDIS");
}

steps.Add(new RemoveCmsKitStep());
return;
}
else
{
context.Symbols.Add("public-website");
}

if (context.BuildArgs.ExtraProperties.ContainsKey(NewCommand.Options.Tiered.Long) || context.BuildArgs.ExtraProperties.ContainsKey("separate-identity-server"))
Expand All @@ -164,14 +169,9 @@ private void ConfigurePublicWebSite(ProjectBuildContext context, List<ProjectBui
steps.Add(new ChangePublicAuthPortStep());
}

// We disabled cms-kit for v4.2 release.
if (true || context.BuildArgs.ExtraProperties.ContainsKey("without-cms-kit"))
{
steps.Add(new RemoveCmsKitStep());
}
else
if (!context.BuildArgs.ExtraProperties.ContainsKey("without-cms-kit"))
{
steps.Add(new RemoveGlobalFeaturesPackageStep());
context.Symbols.Add("CMS-KIT");
}
}

Expand All @@ -197,6 +197,8 @@ private static void ConfigureWithoutUi(ProjectBuildContext context, List<Project

private static void ConfigureWithBlazorUi(ProjectBuildContext context, List<ProjectBuildPipelineStep> steps)
{
context.Symbols.Add("ui:blazor");

steps.Add(new RemoveProjectFromSolutionStep("MyCompanyName.MyProjectName.Web"));
steps.Add(new RemoveProjectFromSolutionStep("MyCompanyName.MyProjectName.Web.Host"));
steps.Add(new RemoveProjectFromSolutionStep("MyCompanyName.MyProjectName.Web.Tests", projectFolderPath: "/aspnet-core/test/MyCompanyName.MyProjectName.Web.Tests"));
Expand All @@ -218,6 +220,8 @@ private static void ConfigureWithBlazorUi(ProjectBuildContext context, List<Proj

private static void ConfigureWithBlazorServerUi(ProjectBuildContext context, List<ProjectBuildPipelineStep> steps)
{
context.Symbols.Add("ui:blazor-server");

steps.Add(new RemoveProjectFromSolutionStep("MyCompanyName.MyProjectName.Blazor"));
steps.Add(new RemoveProjectFromSolutionStep("MyCompanyName.MyProjectName.Web"));
steps.Add(new RemoveProjectFromSolutionStep("MyCompanyName.MyProjectName.Web.Host"));
Expand All @@ -242,6 +246,8 @@ private static void ConfigureWithBlazorServerUi(ProjectBuildContext context, Lis

private static void ConfigureWithMvcUi(ProjectBuildContext context, List<ProjectBuildPipelineStep> steps)
{
context.Symbols.Add("ui:mvc");

if (context.BuildArgs.ExtraProperties.ContainsKey("tiered"))
{
steps.Add(new RemoveProjectFromSolutionStep("MyCompanyName.MyProjectName.Web"));
Expand All @@ -262,6 +268,8 @@ private static void ConfigureWithMvcUi(ProjectBuildContext context, List<Project

private static void ConfigureWithAngularUi(ProjectBuildContext context, List<ProjectBuildPipelineStep> steps)
{
context.Symbols.Add("ui:angular");

steps.Add(new RemoveProjectFromSolutionStep("MyCompanyName.MyProjectName.Web"));
steps.Add(new RemoveProjectFromSolutionStep("MyCompanyName.MyProjectName.Web.Host"));
steps.Add(new RemoveProjectFromSolutionStep("MyCompanyName.MyProjectName.Web.Tests", projectFolderPath: "/aspnet-core/test/MyCompanyName.MyProjectName.Web.Tests"));
Expand Down Expand Up @@ -312,6 +320,15 @@ private static void RandomizeSslPorts(ProjectBuildContext context, List<ProjectB
);
}

private void ConfigureTieredArchitecture(ProjectBuildContext context, List<ProjectBuildPipelineStep> steps)
{
if (context.BuildArgs.ExtraProperties.ContainsKey(NewCommand.Options.Tiered.Long) ||
context.BuildArgs.ExtraProperties.ContainsKey("separate-identity-server"))
{
context.Symbols.Add("tiered");
}
}

private static void RandomizeStringEncryption(ProjectBuildContext context, List<ProjectBuildPipelineStep> steps)
{
steps.Add(new RandomizeStringEncryptionStep());
Expand Down