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

Output window for visualization of OpenCppCoverage results is significantly improved. #37

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
19 changes: 19 additions & 0 deletions VSPackage/CoverageRateBuilder/CoverageRateBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ public CoverageRate Build(CoverageResult result)
foreach (var protoFile in protoModule.FilesList)
module.AddChild(BuildFileCoverage(protoFile));
coverageRate.AddChild(module);
Update(module);
}

return coverageRate;
Expand All @@ -52,5 +53,23 @@ FileCoverage BuildFileCoverage(ProtoBuff.FileCoverage protoFile)
lines.Select(l => new LineCoverage(
(int)l.LineNumber, l.HasBeenExecuted)).ToList());
}

private static void Update(ModuleCoverage module)
{
OutputWindowWriter.WriteLine("PROJECT: \"" + module.Name + "\"\u0004 // <Lines: " + module.CoverLineCount.ToString() + " / " + module.TotalLineCount.ToString() + "> " + GetProgress(module.CoverLineCount, module.TotalLineCount));
foreach (FileCoverage current in module.Children)
{
OutputWindowWriter.WriteLine(" FILE: \"" + current.Path + "\" // <Lines: " + current.CoverLineCount.ToString() + " / " + current.TotalLineCount.ToString() + "> " + GetProgress(current.CoverLineCount, current.TotalLineCount));
}
}

private static string GetProgress(int current, int total)
{
if (total > 0)
{
return ((current * 100) / total).ToString() + "%";
}
return "100%";
}
}
}
12 changes: 6 additions & 6 deletions VSPackage/CoverageRunner.cs
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,6 @@ public void RunCoverageOnStartupProject(MainSettings settings)
void RunCoverage(MainSettings settings)
{
outputWindowWriter.ActivatePane();
outputWindowWriter.WriteLine("Start computing code coverage...");

if (!File.Exists(settings.BasicSettings.ProgramToRun))
{
Expand All @@ -109,9 +108,10 @@ void RunCoverage(MainSettings settings)
AddBinaryOutput(settings.ImportExportSettings, coveragePath);
onCoverageFinished = openCppCoverageRunner.RunCodeCoverageAsync(settings);
}
catch (Exception)
catch (Exception e)
{
coveragePath.Dispose();
OutputWindowWriter.WriteLine("ERROR: " + e.Message);
throw;
}

Expand Down Expand Up @@ -148,12 +148,12 @@ void OnCoverageRateBuilt(CoverageRate coverageRate, string coveragePath)
{
if (coverageRate == null)
{
outputWindowWriter.WriteLine("The execution of the previous line failed." +
" Please execute the previous line in a promt" +
" command to have more information about the issue.");
OutputWindowWriter.WriteLine("ERROR: The execution of the previous line failed.");
OutputWindowWriter.WriteLine(" Please execute the previous line in a promt command to have more information about the issue.");
throw new VSPackageException("Cannot generate coverage. See output pane for more information");
}
outputWindowWriter.WriteLine("Coverage written in " + coveragePath);
OutputWindowWriter.WriteLine("COVERAGE: Computing finished\u0006");
OutputWindowWriter.WriteLine(" Result written in \"" + coveragePath + "\"");

coverageTreeManager.ShowTreeCoverage(this.dte, this.coverageViewManager, coverageRate);
this.coverageViewManager.CoverageRate = coverageRate;
Expand Down
3 changes: 3 additions & 0 deletions VSPackage/CoverageTree/CoverageTreeController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,10 @@ public SharpTreeNode Current
if (fileCoverage != null)
{
if (this.dte == null)
{
//outputWindowWriter.WriteLine("ERROR: UpdateCoverageRate should be call first.");
throw new InvalidOperationException("UpdateCoverageRate should be call first.");
}
this.dte.ItemOperations.OpenFile(fileCoverage.Path, Constants.vsViewKindCode);
}
}
Expand Down
8 changes: 4 additions & 4 deletions VSPackage/CoverageTree/CoverageTreeManager.cs
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ public void ShowTreeCoverage()
//---------------------------------------------------------------------
void ShowTreeCoverage(Action<CoverageTreeToolWindow> action)
{
var window = this.windowFinder.FindToolWindow<CoverageTreeToolWindow>();
//var window = this.windowFinder.FindToolWindow<CoverageTreeToolWindow>();

action(window);
var frame = (IVsWindowFrame)window.Frame;
Microsoft.VisualStudio.ErrorHandler.ThrowOnFailure(frame.Show());
//action(window);
//var frame = (IVsWindowFrame)window.Frame;
//Microsoft.VisualStudio.ErrorHandler.ThrowOnFailure(frame.Show());
}
}
}
13 changes: 7 additions & 6 deletions VSPackage/ErrorHandler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -38,18 +38,19 @@ public async Task ExecuteAsync(Func<Task> action)
{
await action();
}
catch (VSPackageException exception)
catch (VSPackageException e)
{
if (OutputWriter != null)
OutputWriter.WriteLine(exception.Message);
ShowMessage(exception.Message);
OutputWindowWriter.WriteLine("ERROR: " + e.Message);
ShowMessage(e.Message);
}
catch (Exception exception)
catch (Exception e)
{
if (OutputWriter != null && OutputWriter.WriteLine(exception.ToString()))
if (OutputWriter != null && OutputWindowWriter.WriteLine("ERROR: " + e.ToString()))
ShowMessage("Unknow error. Please see the output console for more information.");
else
ShowMessage(exception.ToString());
ShowMessage(e.ToString());
OutputWindowWriter.WriteLine("ERROR: " + e.Message);
}
}

Expand Down
3 changes: 2 additions & 1 deletion VSPackage/OpenCppCoverageCmdLine.cs
Original file line number Diff line number Diff line change
Expand Up @@ -155,9 +155,10 @@ void AppendMiscellaneousSettings(
foreach (var line in lines)
writer.WriteLine(line);
}
catch (FileNotFoundException)
catch (FileNotFoundException e)
{
string message = $"Cannot find the config file defined in Miscellanous tab: {settings.OptionalConfigFile}";
OutputWindowWriter.WriteLine("ERROR: " + e.Message);
throw new VSPackageException(message);
}
}
Expand Down
10 changes: 5 additions & 5 deletions VSPackage/OpenCppCoveragePackage.cs
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@ namespace OpenCppCoverage.VSPackage
[InstalledProductRegistration("#110", "#112", "1.0", IconResourceID = 400)]
// This attribute is needed to let the shell know that this package exposes some menus.
[ProvideMenuResource("Menus.ctmenu", 1)]
[ProvideToolWindow(typeof(CoverageTreeToolWindow),
Style = Microsoft.VisualStudio.Shell.VsDockStyle.Tabbed,
MultiInstances = false,
Transient = true,
Window = Microsoft.VisualStudio.Shell.Interop.ToolWindowGuids.Outputwindow)]
//[ProvideToolWindow(typeof(CoverageTreeToolWindow),
// Style = Microsoft.VisualStudio.Shell.VsDockStyle.Tabbed,
// MultiInstances = false,
// Transient = true,
// Window = Microsoft.VisualStudio.Shell.Interop.ToolWindowGuids.Outputwindow)]
[ProvideToolWindow(typeof(SettingToolWindow),
Style = Microsoft.VisualStudio.Shell.VsDockStyle.Float,
MultiInstances = false,
Expand Down
7 changes: 3 additions & 4 deletions VSPackage/OpenCppCoverageRunner.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
using System;
using System.Diagnostics;
using System.IO;
using System.Runtime.InteropServices;
using System.Threading.Tasks;

namespace OpenCppCoverage.VSPackage
Expand All @@ -44,9 +43,9 @@ public Task RunCodeCoverageAsync(MainSettings settings)
var fileName = GetOpenCppCoveragePath(basicSettings.ProgramToRun);
var arguments = this.openCppCoverageCmdLine.Build(settings);

this.outputWindowWriter.WriteLine("Run:");
this.outputWindowWriter.WriteLine(string.Format(@"""{0}"" {1}",
fileName, arguments));
OutputWindowWriter.WriteLine("COVERAGE: Computing started\u0006");
OutputWindowWriter.WriteLine(" File name = " + fileName);
OutputWindowWriter.WriteLine(" Arguments = " + arguments);

// Run in a new thread to not block UI thread.
return Task.Run(() =>
Expand Down
8 changes: 4 additions & 4 deletions VSPackage/OutputWindowWriter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -46,16 +46,16 @@ public OutputWindowWriter(DTE2 dte, IVsOutputWindow outputWindow)
//---------------------------------------------------------------------
public void ActivatePane()
{
outputWindowPane_.Activate();
//outputWindowPane_.Activate();
}

//---------------------------------------------------------------------
public bool WriteLine(string message)
public static bool WriteLine(string message)
{
return Microsoft.VisualStudio.ErrorHandler.Succeeded(outputWindowPane_.OutputString(message + "\n"));
}
readonly IVsOutputWindowPane outputWindowPane_;

private static IVsOutputWindowPane outputWindowPane_ = null;
public readonly static Guid OpenCppCoverageOutputPaneGuid = new Guid("CB47C727-5E45-467B-A4CD-4A025986A8A0");
}
}
11 changes: 4 additions & 7 deletions VSPackage/ProjectBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,6 @@ public void Build(

// buildEvents need to be a member to avoid a garbage collector issue.
this.buildEvents.OnBuildProjConfigDone += buildHandler;

this.outputWindowWriter.WriteLine(
"Start building " + projectName
+ " " + solutionConfigurationName);

var output = dte.Windows.Item(EnvDTE.Constants.vsWindowKindOutput);
if (output != null)
Expand All @@ -67,9 +63,10 @@ public void Build(
}
catch (COMException e)
{
throw new VSPackageException(
string.Format("Error when building {0} with configuration {1}: {2}",
projectName, solutionConfigurationName, e.Message));
OutputWindowWriter.WriteLine("ERROR: " + e.Message);
OutputWindowWriter.WriteLine(" Project = " + projectName);
OutputWindowWriter.WriteLine(" Configuration = " + solutionConfigurationName);
throw;
}
}

Expand Down
7 changes: 5 additions & 2 deletions VSPackage/Settings/SettingsStorage.cs
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,14 @@ public UserInterfaceSettings TryLoad(string optionalProjectPath, string optional
{
json = File.ReadAllText(configPath);
}
catch (FileNotFoundException)
catch (FileNotFoundException e)
{
OutputWindowWriter.WriteLine("ERROR: " + e.Message);
return null;
}
catch (DirectoryNotFoundException)
catch (DirectoryNotFoundException e)
{
OutputWindowWriter.WriteLine("ERROR: " + e.Message);
return null;
}

Expand All @@ -70,6 +72,7 @@ public UserInterfaceSettings TryLoad(string optionalProjectPath, string optional
{
var error = string.Format(
$"Error when deserializing {configPath} : {e.Message}\nRemoving {configPath} should fix this issue.");
OutputWindowWriter.WriteLine("ERROR: " + e.Message);
throw new VSPackageException(error);
}
}
Expand Down
3 changes: 2 additions & 1 deletion VSPackage/Settings/StartUpProjectSettingsBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -166,9 +166,10 @@ List<ExtendedProject> CreateExtendedProjectsFor(Project project)
if (projectObject != null && projectObject.Kind == "VCProject")
projects.Add(new ExtendedProject(project, new DynamicVCProject(projectObject)));
}
catch (RuntimeBinderException)
catch (RuntimeBinderException e)
{
// Nothing because not a VCProject
OutputWindowWriter.WriteLine("ERROR: " + e.Message);
}
}

Expand Down
1 change: 1 addition & 0 deletions VSPackage/Settings/UI/MainSettingController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ public TabItem SelectedTab
catch (Exception e)
{
this.CommandLineText = e.Message;
OutputWindowWriter.WriteLine("ERROR: " + e.Message);
}
}
}
Expand Down
3 changes: 2 additions & 1 deletion VSPackage/TemporaryFile.cs
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,9 @@ public void Dispose()
{
File.Delete(this.Path);
}
catch (FileNotFoundException)
catch (FileNotFoundException e)
{
OutputWindowWriter.WriteLine("ERROR: " + e.Message);
}
}
}
Expand Down
3 changes: 0 additions & 3 deletions VSPackage/VSPackage.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -277,9 +277,6 @@
<IncludeInVSIX>true</IncludeInVSIX>
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</Content>
<Content Include="Newtonsoft.Json.dll">
<IncludeInVSIX>true</IncludeInVSIX>
</Content>
<Content Include="OpenCppCoverage-x64\boost_date_time-vc141-mt-x64-1_69.dll">
<IncludeInVSIX>true</IncludeInVSIX>
</Content>
Expand Down
2 changes: 1 addition & 1 deletion VSPackage/source.extension.vsixmanifest
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
<Metadata>
<Identity Id="c6a77aca-f53c-4cd1-97d7-0ed595751347" Version="0.9.7.1" Language="en-US" Publisher="OpenCppCoverage" />
<Identity Id="c6a77aca-f53c-4cd1-97d7-0ed595751347" Version="0.9.7.2" Language="en-US" Publisher="OpenCppCoverage" />
<DisplayName>OpenCppCoverage Plugin</DisplayName>
<Description xml:space="preserve">Visual Studio plugin for OpenCppCoverage to compute code coverage for C++ application.</Description>
<MoreInfo>https://github.com/OpenCppCoverage/OpenCppCoveragePlugin</MoreInfo>
Expand Down