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

Move ProjectNameValidator enhancements to 4.4 #10093

Merged
merged 1 commit into from
Sep 21, 2021
Merged

Move ProjectNameValidator enhancements to 4.4 #10093

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 2 additions & 5 deletions framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/Commands/NewCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,7 @@ public async Task ExecuteAsync(CommandLineArgs commandLineArgs)
);
}

if (!ProjectNameValidator.IsValid(projectName))
{
throw new CliUsageException("The project name is invalid! Please specify a different name.");
}
ProjectNameValidator.Validate(projectName);

Logger.LogInformation("Creating your project...");
Logger.LogInformation("Project name: " + projectName);
Expand Down Expand Up @@ -559,4 +556,4 @@ public static class Preview
}
}
}
}
}
60 changes: 20 additions & 40 deletions framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/Utils/ProjectNameValidator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,70 +22,50 @@ public static class ProjectNameValidator
"Blazor"
};

private static bool HasParentDirectoryString(string projectName)
private static void ValidateParentDirectoryString(string projectName)
{
return projectName.Contains("..");
if (projectName.Contains(".."))
{
throw new CliUsageException("Project name cannot contain \"..\"! Specify a different name.");
}
}

private static bool HasSurrogateOrControlChar(string projectName)
private static void ValidateSurrogateOrControlChar(string projectName)
{
return projectName.Any(chr => char.IsControl(chr) || char.IsSurrogate(chr));
if (projectName.Any(chr => char.IsControl(chr) || char.IsSurrogate(chr)))
{
throw new CliUsageException("Project name cannot contain surrogate or control characters! Specify a different name.");
}
}

private static bool IsIllegalProjectName(string projectName)
private static void ValidateIllegalProjectName(string projectName)
{
foreach (var illegalProjectName in IllegalProjectNames)
{
if (projectName.Equals(illegalProjectName, StringComparison.OrdinalIgnoreCase))
{
return true;
throw new CliUsageException("Project name cannot be \"" + illegalProjectName + "\"! Specify a different name.");
}
}

return false;
}

private static bool HasIllegalKeywords(string projectName)
private static void ValidateIllegalKeywords(string projectName)
{
foreach (var illegalKeyword in IllegalKeywords)
{
if (projectName.Contains(illegalKeyword))
if (projectName.Split(".").Contains(illegalKeyword))
{
return true;
throw new CliUsageException("Project name cannot contain the word \"" + illegalKeyword + "\". Specify a different name.");
}
}

return false;
}

public static bool IsValid(string projectName)
public static void Validate(string projectName)
{
if (projectName == null)
{
throw new CliUsageException("Project name cannot be empty!");
}

if (HasSurrogateOrControlChar(projectName))
{
return false;
}

if (HasParentDirectoryString(projectName))
{
return false;
}

if (IsIllegalProjectName(projectName))
{
return false;
}

if (HasIllegalKeywords(projectName))
{
return false;
}

return true;
ValidateSurrogateOrControlChar(projectName);
ValidateParentDirectoryString(projectName);
ValidateIllegalProjectName(projectName);
ValidateIllegalKeywords(projectName);
}
}
}
13 changes: 7 additions & 6 deletions framework/test/Volo.Abp.Cli.Core.Tests/Volo/Abp/Cli/ProjectNameValidation_Tests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public ProjectNameValidation_Tests()
}

[Fact]
public async Task IllegalProjectName_Test()
public async Task Illegal_ProjectName_Test()
{
var illegalProjectNames = new[]
{
Expand All @@ -39,27 +39,28 @@ public async Task IllegalProjectName_Test()
}

[Fact]
public async Task ParentDirectoryContain_Test()
public async Task Parent_Directory_Char_Contains_Test()
{

var args = new CommandLineArgs("new", "Test..Test");
await _newCommand.ExecuteAsync(args).ShouldThrowAsync<CliUsageException>();
}


[Fact]
public async Task Has_Illegel_Keyword_Test()
public async Task Contains_Illegal_Keyword_Test()
{
var illegalKeywords = new[]
{
"Acme.Blazor",
"MyBlazor",
"Blazor"
};

foreach (var illegalKeyword in illegalKeywords)
{
var args = new CommandLineArgs("new", illegalKeyword);
await _newCommand.ExecuteAsync(args).ShouldThrowAsync<CliUsageException>();

args = new CommandLineArgs("new", "Acme." + illegalKeyword);
await _newCommand.ExecuteAsync(args).ShouldThrowAsync<CliUsageException>();
}
}

Expand Down