Skip to content

Add VSWorkspaceAnalysis functionality #220

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Diagnostics;
using System;
using System.Collections.Generic;

namespace Codelyzer.Analysis.Build.Models
{
public class WorkspaceConfiguration
{
public string workspace { get; set; }
public SolutionConfig solution { get; set; }
}

public class SolutionConfig
{
public List<ProjectConfig> projects { get; set; }
}

public class ProjectConfig
{
public string projectId { get; set; }
public string assemblyName { get; set; }
public string language { get; set; }
public string filePath { get; set; }
public string outputFilePath { get; set; }
public List<DocumentConfig> documents { get; set; }
public List<string> projectReferences { get; set; }
public List<String> metadataReferencesFilePath { get; set; }
public List<AnalyzerReference> analyzerReferences { get; set; }
public ParseOptions parseOptions { get; set; }
public CompilationOptions compilationOptions { get; set; }
}

public class DocumentConfig
{
public string documentId { get; set; }
public string assemblyName { get; set; }
public string filePath { get; set; }
}
}
187 changes: 149 additions & 38 deletions src/Analysis/Codelyzer.Analysis/Analyzer/CodeAnalyzerByLanguage.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,22 @@
using System.Text;
using System.Threading.Tasks;
using Codelyzer.Analysis.Build;
using Codelyzer.Analysis.Build.Models;
using Codelyzer.Analysis.Common;
using Codelyzer.Analysis.Model;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.Text;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json;

namespace Codelyzer.Analysis.Analyzer
{
public class CodeAnalyzerByLanguage
{
protected readonly AnalyzerConfiguration AnalyzerConfiguration;
protected readonly ILogger Logger;
private readonly string projectBuildType = "KnownToBeMSBuildFormat";

public CodeAnalyzerByLanguage(AnalyzerConfiguration configuration, ILogger logger)
{
Expand Down Expand Up @@ -106,35 +112,9 @@ public async Task<List<AnalyzerResult>> Analyze(string path)
{
throw new FileNotFoundException(path);
}

List<ProjectWorkspace> workspaceResults = new List<ProjectWorkspace>();
var analyzerResults = new List<AnalyzerResult>();

WorkspaceBuilder builder = new WorkspaceBuilder(Logger, path, AnalyzerConfiguration);

var projectBuildResults = await builder.Build();

foreach (var projectBuildResult in projectBuildResults)
{
var workspaceResult = await Task.Run(() => AnalyzeProject(projectBuildResult));
workspaceResult.ProjectGuid = projectBuildResult.ProjectGuid;
workspaceResult.ProjectType = projectBuildResult.ProjectType;
workspaceResults.Add(workspaceResult);

//Generate Output result
if (AnalyzerConfiguration.MetaDataSettings.LoadBuildData)
{
analyzerResults.Add(new AnalyzerResult() { ProjectResult = workspaceResult, ProjectBuildResult = projectBuildResult });
}
else
{
analyzerResults.Add(new AnalyzerResult() { ProjectResult = workspaceResult });
}
}

await GenerateOptionalOutput(analyzerResults);

return analyzerResults;
return await AnalyzeBuildResults(projectBuildResults);
}

private async Task GenerateOptionalOutput(List<AnalyzerResult> analyzerResults)
Expand Down Expand Up @@ -275,13 +255,151 @@ private async Task<List<AnalyzerResult>> AnalyzeWithReferences(string path, Dict
throw new FileNotFoundException(path);
}

List<ProjectWorkspace> workspaceResults = new List<ProjectWorkspace>();
var analyzerResults = new List<AnalyzerResult>();

WorkspaceBuilder builder = new WorkspaceBuilder(Logger, path, AnalyzerConfiguration);

var projectBuildResults = builder.GenerateNoBuildAnalysis(oldReferences, references);
return await AnalyzeBuildResults(projectBuildResults);
}

public async Task<AnalyzerResult> AnalyzeProject(string projectPath, List<string> oldReferences, List<string> references)
{
var analyzerResult = await AnalyzeWithReferences(projectPath, oldReferences?.ToDictionary(r => projectPath, r => oldReferences), references?.ToDictionary(r => projectPath, r => references));
return analyzerResult.FirstOrDefault();
}

public async Task<List<AnalyzerResult>> AnalyzeSolutionUsingVSWorkspace(string solutionPath, string workspaceConfig = null)
{
if (workspaceConfig == null)
{
return await Analyze(solutionPath);
}
return await AnalyzeUsingVSWorkspace(workspaceConfig);
}

private async Task<List<AnalyzerResult>> AnalyzeUsingVSWorkspace(string workspaceConfig)
{
var adhocWorkspace = ConstructWorkspaceObject(workspaceConfig);
var projectBuildResults = BuildUsingAdHocWorkspace(adhocWorkspace);
return await AnalyzeBuildResults(projectBuildResults);
}

public Workspace ConstructWorkspaceObject(string workspace)
{
try
{
WorkspaceConfiguration workspaceConfig = JsonConvert.DeserializeObject<WorkspaceConfiguration>(workspace);
AdhocWorkspace adhocWorkspace = new AdhocWorkspace();

foreach (var curProject in workspaceConfig.solution.projects)
{
List<DocumentInfo> docInfoLst = new List<DocumentInfo>();
var projectId = ProjectId.CreateFromSerialized(new Guid(curProject.projectId));
foreach (var doc in curProject.documents)
{
try
{
DocumentInfo docInfo = DocumentInfo.Create(
DocumentId.CreateFromSerialized(projectId, new Guid(doc.documentId)),
curProject.assemblyName,
loader: TextLoader.From(
TextAndVersion.Create(
SourceText.From(File.ReadAllText(doc.filePath), Encoding.Unicode), VersionStamp.Create())),
filePath: doc.filePath);

docInfoLst.Add(docInfo);
}
catch (Exception e)
{
Console.WriteLine(e.ToString());
}
}

List<MetadataReference> metadataReferencesLst = new List<MetadataReference>();
foreach (string filePath in curProject.metadataReferencesFilePath)
{
metadataReferencesLst.Add(MetadataReference.CreateFromFile(filePath));
}


var projectInfo = ProjectInfo.Create(
projectId,
VersionStamp.Create(),
curProject.assemblyName,
curProject.assemblyName,
curProject.language,
filePath: curProject.filePath,
outputFilePath: curProject.outputFilePath,
documents: docInfoLst,
projectReferences: null,//curProject.projectReferences,
metadataReferences: metadataReferencesLst,
analyzerReferences: null,//curProject.analyzerReferences,
parseOptions: curProject.parseOptions,
compilationOptions: curProject.compilationOptions);

var solution = adhocWorkspace.CurrentSolution.AddProject(projectInfo);

if (!adhocWorkspace.TryApplyChanges(solution))
{
return null;
}
}

return adhocWorkspace;
}
catch (Exception ex)
{
return null;
}
}

public List<ProjectBuildResult> BuildUsingAdHocWorkspace(Workspace workspace)
{
List<ProjectBuildResult> projectBuildResults = new List<ProjectBuildResult>();

foreach (Project project in workspace.CurrentSolution.Projects)
{
ProjectBuildResult projectBuildResult = new ProjectBuildResult();
projectBuildResult.Project = project;
projectBuildResult.ProjectPath = project.FilePath;
projectBuildResult.ProjectRootPath = Path.GetDirectoryName(project.FilePath);
projectBuildResult.ProjectGuid = project.Id.Id.ToString();
projectBuildResult.BuildErrors = new List<string>();
projectBuildResult.Compilation = CSharpCompilation.Create(null).AddReferences(project.MetadataReferences);
projectBuildResult.ExternalReferences = GetExternalReferences(projectBuildResult.Compilation, project, project.MetadataReferences);
projectBuildResult.ProjectType = projectBuildType;

foreach (var document in project.Documents)
{
SourceFileBuildResult sourceFileBuildResult = new SourceFileBuildResult();
sourceFileBuildResult.SourceFileFullPath = document.FilePath;
sourceFileBuildResult.SourceFilePath = document.Name;
sourceFileBuildResult.SyntaxTree = document.GetSyntaxTreeAsync().Result;
sourceFileBuildResult.SemanticModel = document.GetSemanticModelAsync().Result;
projectBuildResult.SourceFileBuildResults.Add(sourceFileBuildResult);
}

projectBuildResults.Add(projectBuildResult);
}

return projectBuildResults;
}

private ExternalReferences GetExternalReferences(Compilation compilation, Project project, IEnumerable<MetadataReference> externalReferencesMetaData)
{
IReadOnlyDictionary<string, string> references = new Dictionary<string, string>();
ExternalReferenceLoader externalReferenceLoader = new ExternalReferenceLoader(
Directory.GetParent(project.FilePath).FullName,
compilation,
project,
new Dictionary<string, IReadOnlyDictionary<string, string>>(),
Logger);

return externalReferenceLoader.Load();
}

private async Task<List<AnalyzerResult>> AnalyzeBuildResults(List<ProjectBuildResult> projectBuildResults)
{
var analyzerResults = new List<AnalyzerResult>();
List<ProjectWorkspace> workspaceResults = new List<ProjectWorkspace>();
foreach (var projectBuildResult in projectBuildResults)
{
var workspaceResult = await Task.Run(() => AnalyzeProject(projectBuildResult));
Expand All @@ -304,12 +422,5 @@ private async Task<List<AnalyzerResult>> AnalyzeWithReferences(string path, Dict

return analyzerResults;
}

public async Task<AnalyzerResult> AnalyzeProject(string projectPath, List<string> oldReferences, List<string> references)
{
var analyzerResult = await AnalyzeWithReferences(projectPath, oldReferences?.ToDictionary(r => projectPath, r => oldReferences), references?.ToDictionary(r => projectPath, r => references));
return analyzerResult.FirstOrDefault();
}

}
}