mirror of
https://github.com/OrchardCMS/Orchard.git
synced 2025-04-05 17:08:47 +08:00
Validate modules/themes project files during build
We check for a few things: - MVC2/3 tooling guid - "None Include" elements (these often happen for .cshtml files) - Output Path not set to "bin\" - FxCop ruleset not set to Orchard ruleset (disabled for now) Work Items: 16821 --HG-- branch : dev
This commit is contained in:
Renaud Paquay
parent
3681b30e2b
commit
26a0ff06a9
18
Orchard.proj
18
Orchard.proj
@ -120,10 +120,12 @@
|
||||
<UsingTask AssemblyFile="$(MsBuildTasksFolder)\MSBuild.Orchard.Tasks.dll" TaskName="MSBuild.Orchard.Tasks.StageProjectAlteration" />
|
||||
<UsingTask AssemblyFile="$(MsBuildTasksFolder)\MSBuild.Orchard.Tasks.dll" TaskName="MSBuild.Orchard.Tasks.FilterModuleBinaries" />
|
||||
<UsingTask AssemblyFile="$(MsBuildTasksFolder)\MSBuild.Orchard.Tasks.dll" TaskName="MSBuild.Orchard.Tasks.FileUpdateLines" />
|
||||
<UsingTask AssemblyFile="$(MsBuildTasksFolder)\MSBuild.Orchard.Tasks.dll" TaskName="MSBuild.Orchard.Tasks.ValidateExtensionProjectFiles" />
|
||||
|
||||
<Target Name="Package-Stage">
|
||||
<CallTarget Targets="CompileMsBuildTasks"/>
|
||||
|
||||
<CallTarget Targets="ValidateProjectFiles"/>
|
||||
|
||||
<ItemGroup>
|
||||
<SqlCe-Native-Binaries-x86 Include="$(SqlCeFolder)\x86\*"/>
|
||||
<SqlCe-Native-Binaries-amd64 Include="$(SqlCeFolder)\amd64\*"/>
|
||||
@ -322,7 +324,19 @@
|
||||
<Exec Command=""$(GalleryFolder)\bin\Orchard.exe" package create Orchard.Search "$(GalleryArtifactFolder)"" WorkingDirectory="$(GalleryFolder)"/>
|
||||
</Target>
|
||||
|
||||
<!-- Version -->
|
||||
<!-- ValidateProjectFiles-->
|
||||
<Target Name="ValidateProjectFiles">
|
||||
<CallTarget Targets="CompileMsBuildTasks"/>
|
||||
|
||||
<ItemGroup>
|
||||
<Validate-ProjectFiles Include="$(ModulesSrcFolder)\**\*.csproj;$(ThemesSrcFolder)\**\*.csproj"/>
|
||||
</ItemGroup>
|
||||
|
||||
<ValidateExtensionProjectFiles Files="@(Validate-ProjectFiles)"/>
|
||||
|
||||
</Target>
|
||||
|
||||
<!-- SetVersion -->
|
||||
<!-- Update all AssemblyInfo.cs and module.txt files to contain $(Version) -->
|
||||
<Target Name="SetVersion" Condition="$(Version) != ''">
|
||||
<CallTarget Targets="CompileMsBuildTasks"/>
|
||||
|
||||
@ -66,6 +66,7 @@
|
||||
<Reference Include="System.Xml" />
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<Compile Include="ValidateExtensionProjectFiles.cs" />
|
||||
<Compile Include="FileUpdateLines.cs" />
|
||||
<Compile Include="FilterModuleBinaries.cs" />
|
||||
<Compile Include="StageProjectAlteration.cs" />
|
||||
|
||||
179
src/Tools/MSBuild.Orchard.Tasks/ValidateExtensionProjectFiles.cs
Normal file
179
src/Tools/MSBuild.Orchard.Tasks/ValidateExtensionProjectFiles.cs
Normal file
@ -0,0 +1,179 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Xml;
|
||||
using System.Xml.Linq;
|
||||
using Microsoft.Build.Framework;
|
||||
using Microsoft.Build.Utilities;
|
||||
|
||||
namespace MSBuild.Orchard.Tasks {
|
||||
/// <summary>
|
||||
/// Validate various aspect of a set of Module/Theme project files
|
||||
/// </summary>
|
||||
public class ValidateExtensionProjectFiles : Task {
|
||||
public ITaskItem[] Files { get; set; }
|
||||
|
||||
public override bool Execute() {
|
||||
bool result = true;
|
||||
|
||||
foreach (var item in Files) {
|
||||
try {
|
||||
ValidateFile(item);
|
||||
}
|
||||
catch (Exception e) {
|
||||
Log.LogError("Error validating project file \"{0}\"", item);
|
||||
Log.LogErrorFromException(e);
|
||||
result = false;
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
private void ValidateFile(ITaskItem item) {
|
||||
Log.LogMessage("Validating \"{0}\"", item);
|
||||
|
||||
var errors = new Validator(item).Validate();
|
||||
|
||||
if (errors.Any()) {
|
||||
foreach (var error in errors) {
|
||||
Log.LogError("", "", "", error.FileName, error.LineNumber, error.ColumnNumber, 0, 0, "{0}", error.Message);
|
||||
}
|
||||
}
|
||||
else {
|
||||
Log.LogMessage("Project file \"{0}\" is valid", item);
|
||||
}
|
||||
}
|
||||
|
||||
public class Validator {
|
||||
private const string Xmlns = "http://schemas.microsoft.com/developer/msbuild/2003";
|
||||
private static readonly XName Project = XName.Get("Project", Xmlns);
|
||||
private static readonly XName PropertyGroup = XName.Get("PropertyGroup", Xmlns);
|
||||
private static readonly XName ItemGroup = XName.Get("ItemGroup", Xmlns);
|
||||
private static readonly XName ProjectTypeGuids = XName.Get("ProjectTypeGuids", Xmlns);
|
||||
private static readonly XName OutputPath = XName.Get("OutputPath", Xmlns);
|
||||
private static readonly XName None = XName.Get("None", Xmlns);
|
||||
private static readonly XName Content = XName.Get("Content", Xmlns);
|
||||
private static readonly XName Include = XName.Get("Include"); // No XmlNs: this is an attribute
|
||||
private static readonly XName CodeAnalysisRuleSet = XName.Get("CodeAnalysisRuleSet", Xmlns);
|
||||
|
||||
private static readonly Guid[] MvcGuids = new Guid[] {
|
||||
new Guid("{F85E285D-A4E0-4152-9332-AB1D724D3325}") /* MVC2 */,
|
||||
new Guid("{E53F8FEA-EAE0-44A6-8774-FFD645390401}") /* MVC3 */
|
||||
};
|
||||
|
||||
private readonly ITaskItem _item;
|
||||
private readonly List<Error> _validationErrors = new List<Error>();
|
||||
|
||||
public Validator(ITaskItem item) {
|
||||
_item = item;
|
||||
}
|
||||
|
||||
public IEnumerable<Error> Validate() {
|
||||
XDocument document = XDocument.Load(_item.ItemSpec, LoadOptions.SetLineInfo);
|
||||
CheckProjectType(document);
|
||||
CheckOutputPath(document);
|
||||
//CheckCodeAnalysisRuleSet(document);
|
||||
CheckContentFiles(document);
|
||||
return _validationErrors;
|
||||
}
|
||||
|
||||
private void AddValidationError(XElement element, string message) {
|
||||
var error = new Error {
|
||||
Message = message,
|
||||
XElement = element,
|
||||
FileName = _item.ItemSpec,
|
||||
LineNumber = (element as IXmlLineInfo).LineNumber,
|
||||
ColumnNumber = (element as IXmlLineInfo).LinePosition,
|
||||
};
|
||||
_validationErrors.Add(error);
|
||||
}
|
||||
|
||||
private void CheckContentFiles(XDocument document) {
|
||||
var elements = document
|
||||
.Elements(Project)
|
||||
.Elements(ItemGroup)
|
||||
.Elements(None);
|
||||
|
||||
foreach (var element in elements) {
|
||||
var include = (element.Attribute(Include) == null ? null : element.Attribute(Include).Value);
|
||||
bool isValid = string.IsNullOrEmpty(include);
|
||||
if (!isValid) {
|
||||
string message = string.Format(
|
||||
"\"{0}\" element name for include \"{1}\" should be \"{2}\".",
|
||||
element.Name.LocalName, include, Content.LocalName);
|
||||
AddValidationError(element, message);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void CheckCodeAnalysisRuleSet(XDocument document) {
|
||||
const string orchardbasiccorrectnessRuleset = "OrchardBasicCorrectness.ruleset";
|
||||
|
||||
var elements = document
|
||||
.Elements(Project)
|
||||
.Elements(PropertyGroup)
|
||||
.Elements(CodeAnalysisRuleSet);
|
||||
|
||||
foreach (var element in elements) {
|
||||
var filename = Path.GetFileName(element.Value);
|
||||
bool isValid = StringComparer.OrdinalIgnoreCase.Equals(filename, orchardbasiccorrectnessRuleset);
|
||||
if (!isValid) {
|
||||
string message = string.Format(
|
||||
"\"{0}\" element should be \"{1}\" instead of \"{2}\".",
|
||||
element.Name.LocalName, orchardbasiccorrectnessRuleset, element.Value);
|
||||
AddValidationError(element, message);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void CheckOutputPath(XDocument document) {
|
||||
var elements = document
|
||||
.Elements(Project)
|
||||
.Elements(PropertyGroup)
|
||||
.Elements(OutputPath);
|
||||
|
||||
foreach (var element in elements) {
|
||||
bool isValid =
|
||||
StringComparer.OrdinalIgnoreCase.Equals(element.Value, "bin") ||
|
||||
StringComparer.OrdinalIgnoreCase.Equals(element.Value, "bin\\");
|
||||
|
||||
if (!isValid) {
|
||||
string message = string.Format(
|
||||
"\"{0}\" element should be \"bin\\\" instead of \"{1}\".",
|
||||
element.Name.LocalName, element.Value);
|
||||
AddValidationError(element, message);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void CheckProjectType(XDocument document) {
|
||||
var elements = document
|
||||
.Elements(Project)
|
||||
.Elements(PropertyGroup)
|
||||
.Elements(ProjectTypeGuids);
|
||||
foreach (var element in elements) {
|
||||
var guids = element.Value.Split(new char[] { ';' }).Select(g => Guid.Parse(g));
|
||||
|
||||
foreach (var guid in guids) {
|
||||
if (MvcGuids.Contains(guid)) {
|
||||
string message = string.Format(
|
||||
"\"{0}\" element contains an MVC tooling Guid. " +
|
||||
" This prevents the project from loading in Visual Studio if MVC tooling is not installed.",
|
||||
ProjectTypeGuids.LocalName);
|
||||
AddValidationError(element, message);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public class Error {
|
||||
public string Message { get; set; }
|
||||
public XElement XElement { get; set; }
|
||||
public string FileName { get; set; }
|
||||
public int LineNumber { get; set; }
|
||||
public int ColumnNumber { get; set; }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user