C#: Rename DotNetCliWrapper to DotNet.

2025-12-16 16:53:25 +01:00 · 2023-09-19 11:12:36 +02:00
parent 6c0afab0aa
commit a3da11a962
3 changed files with 18 additions and 18 deletions
--- a/csharp/extractor/Semmle.Extraction.CSharp.DependencyFetching/DotNet.cs
+++ b/csharp/extractor/Semmle.Extraction.CSharp.DependencyFetching/DotNet.cs
@@ -0,0 +1,108 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text.RegularExpressions;
+
+namespace Semmle.Extraction.CSharp.DependencyFetching
+{
+    /// <summary>
+    /// Utilities to run the "dotnet" command.
+    /// </summary>
+    internal partial class DotNet : IDotNet
+    {
+        private readonly IDotNetCliInvoker dotnetCliInvoker;
+        private readonly ProgressMonitor progressMonitor;
+
+        private DotNet(IDotNetCliInvoker dotnetCliInvoker, ProgressMonitor progressMonitor)
+        {
+            this.progressMonitor = progressMonitor;
+            this.dotnetCliInvoker = dotnetCliInvoker;
+            Info();
+        }
+
+        private DotNet(IDependencyOptions options, ProgressMonitor progressMonitor) : this(new DotNetCliInvoker(progressMonitor, Path.Combine(options.DotNetPath ?? string.Empty, "dotnet")), progressMonitor) { }
+
+        internal static IDotNet Make(IDotNetCliInvoker dotnetCliInvoker, ProgressMonitor progressMonitor) => new DotNet(dotnetCliInvoker, progressMonitor);
+
+        public static IDotNet Make(IDependencyOptions options, ProgressMonitor progressMonitor) => new DotNet(options, progressMonitor);
+
+        private void Info()
+        {
+            // TODO: make sure the below `dotnet` version is matching the one specified in global.json
+            var res = dotnetCliInvoker.RunCommand("--info");
+            if (!res)
+            {
+                throw new Exception($"{dotnetCliInvoker.Exec} --info failed.");
+            }
+        }
+
+        private static string GetRestoreArgs(string projectOrSolutionFile, string packageDirectory) =>
+            $"restore --no-dependencies \"{projectOrSolutionFile}\" --packages \"{packageDirectory}\" /p:DisableImplicitNuGetFallbackFolder=true";
+
+        public bool RestoreProjectToDirectory(string projectFile, string packageDirectory, out string stdout, string? pathToNugetConfig = null)
+        {
+            var args = GetRestoreArgs(projectFile, packageDirectory);
+            if (pathToNugetConfig != null)
+            {
+                args += $" --configfile \"{pathToNugetConfig}\"";
+            }
+            var success = dotnetCliInvoker.RunCommand(args, out var output);
+            stdout = string.Join("\n", output);
+            return success;
+        }
+
+        public bool RestoreSolutionToDirectory(string solutionFile, string packageDirectory, out IEnumerable<string> projects)
+        {
+            var args = GetRestoreArgs(solutionFile, packageDirectory);
+            args += " --verbosity normal";
+            if (dotnetCliInvoker.RunCommand(args, out var output))
+            {
+                var regex = RestoreProjectRegex();
+                projects = output
+                    .Select(line => regex.Match(line))
+                    .Where(match => match.Success)
+                    .Select(match => match.Groups[1].Value);
+                return true;
+            }
+
+            projects = Array.Empty<string>();
+            return false;
+        }
+
+        public bool New(string folder)
+        {
+            var args = $"new console --no-restore --output \"{folder}\"";
+            return dotnetCliInvoker.RunCommand(args);
+        }
+
+        public bool AddPackage(string folder, string package)
+        {
+            var args = $"add \"{folder}\" package \"{package}\" --no-restore";
+            return dotnetCliInvoker.RunCommand(args);
+        }
+
+        public IList<string> GetListedRuntimes() => GetListed("--list-runtimes", "runtime");
+
+        public IList<string> GetListedSdks() => GetListed("--list-sdks", "SDK");
+
+        private IList<string> GetListed(string args, string artifact)
+        {
+            if (dotnetCliInvoker.RunCommand(args, out var artifacts))
+            {
+                progressMonitor.LogInfo($"Found {artifact}s: {string.Join("\n", artifacts)}");
+                return artifacts;
+            }
+            return new List<string>();
+        }
+
+        public bool Exec(string execArgs)
+        {
+            var args = $"exec {execArgs}";
+            return dotnetCliInvoker.RunCommand(args);
+        }
+
+        [GeneratedRegex("Restored\\s+(.+\\.csproj)", RegexOptions.Compiled)]
+        private static partial Regex RestoreProjectRegex();
+    }
+}