codeql/csharp/extractor/Semmle.Extraction.CSharp.Standalone/ProgressMonitor.cs

using Semmle.Util.Logging;

namespace Semmle.BuildAnalyser
{
    /// <summary>
    /// Callback for various events that may happen during the build analysis.
    /// </summary>
    interface IProgressMonitor
    {
        void FindingFiles(string dir);
        void UnresolvedReference(string id, string project);
        void AnalysingProjectFiles(int count);
        void AnalysingSolution(string filename);
        void FailedProjectFile(string filename, string reason);
        void FailedNugetCommand(string exe, string args, string message);
        void NugetInstall(string package);
        void ResolvedReference(string filename);
        void Summary(int existingSources, int usedSources, int missingSources, int references, int unresolvedReferences, int resolvedConflicts, int totalProjects, int failedProjects);
        void Warning(string message);
        void ResolvedConflict(string asm1, string asm2);
        void MissingProject(string projectFile);
        void Restored(string line);
        void MissingPackage(string package, string version, ResolutionFailureReason reason);
        void FoundPackage(string package, string version, string directory);
        void CommandFailed(string exe, string arguments, int exitCode);
        void MissingNuGet();
    }

    class ProgressMonitor : IProgressMonitor
    {
        readonly ILogger logger;

        public ProgressMonitor(ILogger logger)
        {
            this.logger = logger;
        }

        public void FindingFiles(string dir)
        {
            logger.Log(Severity.Info, "Finding files in {0}...", dir);
        }

        public void IndexingReferences(int count)
        {
            logger.Log(Severity.Info, "Indexing...");
            logger.Log(Severity.Debug, "Indexing {0} DLLs...", count);
        }

        public void UnresolvedReference(string id, string project)
        {
            logger.Log(Severity.Info, "Unresolved reference {0}", id);
            logger.Log(Severity.Debug, "Unresolved {0} referenced by {1}", id, project);
        }

        public void AnalysingProjectFiles(int count)
        {
            logger.Log(Severity.Info, "Analyzing project files...");
        }

        public void AnalysingSolution(string filename)
        {
            logger.Log(Severity.Info, $"Analysing {filename}...");
        }

        public void FailedProjectFile(string filename, string reason)
        {
            logger.Log(Severity.Info, "Couldn't read project file {0}: {1}", filename, reason);
        }

        public void FailedNugetCommand(string exe, string args, string message)
        {
            logger.Log(Severity.Info, "Command failed: {0} {1}", exe, args);
            logger.Log(Severity.Info, "  {0}", message);
        }

        public void NugetInstall(string package)
        {
            logger.Log(Severity.Info, "Restoring {0}...", package);
        }

        public void ResolvedReference(string filename)
        {
            logger.Log(Severity.Info, "Resolved {0}", filename);
        }

        public void Summary(int existingSources, int usedSources, int missingSources,
            int references, int unresolvedReferences,
            int resolvedConflicts, int totalProjects, int failedProjects)
        {
            logger.Log(Severity.Info, "");
            logger.Log(Severity.Info, "Build analysis summary:");
            logger.Log(Severity.Info, "{0, 6} source files in the filesystem", existingSources);
            logger.Log(Severity.Info, "{0, 6} source files in project files", usedSources);
            logger.Log(Severity.Info, "{0, 6} sources missing from project files", missingSources);
            logger.Log(Severity.Info, "{0, 6} resolved references", references);
            logger.Log(Severity.Info, "{0, 6} unresolved references", unresolvedReferences);
            logger.Log(Severity.Info, "{0, 6} resolved assembly conflicts", resolvedConflicts);
            logger.Log(Severity.Info, "{0, 6} projects", totalProjects);
            logger.Log(Severity.Info, "{0, 6} missing/failed projects", failedProjects);
        }

        public void Restored(string line)
        {
            logger.Log(Severity.Debug, $"  {line}");
        }

        private static string[] reasonText = { "success", "package was not found", "the version was not found", "the package does not appear to contain any libraries" };

        public void MissingPackage(string package, string version, ResolutionFailureReason reason)
        {
            logger.Log(Severity.Info, $"  Couldn't find package {package} {version} because {reasonText[(int)reason]}");
        }

        public void FoundPackage(string package, string version, string directory)
        {
            logger.Log(Severity.Debug, $"  Found package {package} {version} in {directory}");
        }

        public void Warning(string message)
        {
            logger.Log(Severity.Warning, message);
        }

        public void ResolvedConflict(string asm1, string asm2)
        {
            logger.Log(Severity.Debug, "Resolved {0} as {1}", asm1, asm2);
        }

        public void MissingProject(string projectFile)
        {
            logger.Log(Severity.Info, "Solution is missing {0}", projectFile);
        }

        public void CommandFailed(string exe, string arguments, int exitCode)
        {
            logger.Log(Severity.Error, $"Command {exe} {arguments} failed with exit code {exitCode}");
        }

        public void MissingNuGet()
        {
            logger.Log(Severity.Error, "Missing nuget.exe");
        }
    }
}