Adds support for pre-processor like directives (#42)

Cisien · web-flow · commit 6c829af637ca · 2020-09-10T22:17:08.000-07:00
* Adds support for pre-processor like directives
Adds a nuget pre-processor like directive
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,4 @@
+﻿[*.cs]
+
+# CA1822: Mark members as static
+dotnet_diagnostic.CA1822.severity = silent
diff --git a/CSDiscord.sln b/CSDiscord.sln
@@ -1,7 +1,7 @@
 ﻿
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 15
-VisualStudioVersion = 15.0.26730.3
+# Visual Studio Version 16
+VisualStudioVersion = 16.0.30404.54
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".nuget", ".nuget", "{443496A8-A004-4C46-8C8F-66FD55AB6402}"
 	ProjectSection(SolutionItems) = preProject
@@ -20,6 +20,11 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Docker", "Docker", "{05C552
 		Dockerfile = Dockerfile
 	EndProjectSection
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{C99A7F61-E624-47AC-9782-1B864E2DBB7A}"
+	ProjectSection(SolutionItems) = preProject
+		.editorconfig = .editorconfig
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
diff --git a/CSDiscordService.Tests/CSDiscordService.Tests.csproj b/CSDiscordService.Tests/CSDiscordService.Tests.csproj
@@ -12,7 +12,7 @@
         <FrameworkReference Include="Microsoft.AspNetCore.App" />
     </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="Microsoft.AspNetCore.TestHost" Version="5.0.0-preview.7.20365.19" />
+    <PackageReference Include="Microsoft.AspNetCore.TestHost" Version="5.0.0-preview.8.20414.8" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.8.0-preview-20200812-03" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.reporters" Version="2.4.1" />
diff --git a/CSDiscordService.Tests/EvalTests.cs b/CSDiscordService.Tests/EvalTests.cs
@@ -14,11 +14,14 @@
 using CSDiscordService.Infrastructure.JsonFormatters;
 using System.Collections.Generic;
 using System.IO;
+using CSDiscordService.Eval;
 
 namespace CSDiscordService.Tests
 {
     public class EvalTests : IDisposable
     {
+        private bool disposedValue;
+
         public EvalTests(ITestOutputHelper outputHelper)
         {
             Environment.SetEnvironmentVariable("ASPNETCORE_ENVIRONMENT", Environments.Development);
@@ -176,6 +179,52 @@ public async Task Eval_ConsoleOutputIsCaptured(string expr, string consoleOut, o
             Assert.Equal(returnValue, result.ReturnValue);
         }
 
+        [Fact]
+        public async Task Eval_SupportsNugetDirective()
+        {
+            var expr = "#nuget Newtonsoft.Json\nConsole.WriteLine(\"foo\");";
+            var (result, statusCode) = await Execute(expr);
+
+            Assert.Equal(HttpStatusCode.OK, statusCode);
+            Assert.StartsWith("Console", result.Code);
+        }
+
+        [Fact]
+        public async Task Eval_FaultyDirectiveFailsGracefully()
+        {
+            var expr = "#nuget asdasd asdasd asda\nConsole.WriteLine(\"foo\");";
+            var (result, statusCode) = await Execute(expr);
+
+            Assert.Equal(HttpStatusCode.BadRequest, statusCode);
+            Assert.StartsWith("#nuget", result.Code);
+            Assert.Equal("Unable to resolve nuget package with id asdasd", result.Exception);
+        }
+
+        [Fact]
+        public void Eval_MissingArgumentsThrowsOnParse()
+        {
+            var expr = "#nuget";
+
+            Assert.Throws<ArgumentException>(() => NugetPreProcessorDirective.Parse(expr));
+        }
+
+        [Fact]
+        public async Task Eval_SupportsNugetDirectiveWithActualUsage()
+        {
+            var expr = @"#nuget ByteSize
+            var input = ""80527998976 B"";
+            if (ByteSize.TryParse(input, out var output))
+            {
+                Console.WriteLine(output);
+            }";
+
+            var (result, statusCode) = await Execute(expr);
+
+            Assert.Equal(HttpStatusCode.OK, statusCode);
+            Assert.StartsWith("            var input", result.Code);
+            Assert.StartsWith("80.53 GB", result.ConsoleOut);
+        }
+
         [Fact]
         public async Task Eval_ConsoleOutputIsCapturedAndValueReturned()
         {
@@ -344,10 +393,24 @@ public async Task Eval_CanUseSystemDrawing()
             return (result, response.StatusCode);
         }
 
+        protected virtual void Dispose(bool disposing)
+        {
+            if (!disposedValue)
+            {
+                if (disposing)
+                {
+                    Client.Dispose();
+                    Server.Dispose();
+                }
+                disposedValue = true;
+            }
+        }
+
+
         public void Dispose()
         {
-            Client.Dispose();
-            Server.Dispose();
+            Dispose(disposing: true);
+            GC.SuppressFinalize(this);
         }
     }
 }
diff --git a/CSDiscordService.Tests/ILTests.cs b/CSDiscordService.Tests/ILTests.cs
@@ -12,7 +12,9 @@
 namespace CSDiscordService.Tests
 {
     public class ILTests : IDisposable
-    {            
+    {
+        private bool disposedValue;
+
         public ILTests(ITestOutputHelper outputHelper)
         {
             var host = WebHost.CreateDefaultBuilder()
@@ -60,11 +62,24 @@ public async Task TestIfWorks(string script)
             return (result, response.StatusCode);
         }
 
+        protected virtual void Dispose(bool disposing)
+        {
+            if (!disposedValue)
+            {
+                if (disposing)
+                {
+                    Client.Dispose();
+                    Server.Dispose();
+                }
+                disposedValue = true;
+            }
+        }
+
 
         public void Dispose()
         {
-            Client.Dispose();
-            Server.Dispose();
+            Dispose(disposing: true);
+            GC.SuppressFinalize(this);
         }
     }
 }
diff --git a/CSDiscordService.Tests/Properties/launchSettings.json b/CSDiscordService.Tests/Properties/launchSettings.json
@@ -1,27 +1,11 @@
 {
-  "iisSettings": {
-    "windowsAuthentication": false,
-    "anonymousAuthentication": true,
-    "iisExpress": {
-      "applicationUrl": "http://localhost:55255/",
-      "sslPort": 0
-    }
-  },
   "profiles": {
-    "IIS Express": {
-      "commandName": "IISExpress",
-      "launchBrowser": true,
-      "environmentVariables": {
-        "ASPNETCORE_ENVIRONMENT": "Development"
-      }
-    },
     "CSDiscordService.Tests": {
       "commandName": "Project",
       "launchBrowser": true,
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
       },
-      "applicationUrl": "http://localhost:55256/"
     }
   }
 }
diff --git a/CSDiscordService/CSDiscordService.csproj b/CSDiscordService/CSDiscordService.csproj
@@ -8,15 +8,22 @@
         <ApplicationInsightsAnnotationResourceId>/subscriptions/a46288ed-15a1-40ee-8fb2-d8867d876013/resourcegroups/CSharpDiscord/providers/microsoft.insights/components/CSDiscordService</ApplicationInsightsAnnotationResourceId>
     </PropertyGroup>
 
+    <ItemGroup>
+      <None Include="..\.editorconfig" Link=".editorconfig" />
+    </ItemGroup>
+
     <ItemGroup>
         <PackageReference Include="ICSharpCode.Decompiler" Version="3.2.0.3856" />
 
         <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
 
-        <PackageReference Include="Microsoft.CodeAnalysis.CSharp.Scripting" Version="3.7.0-6.20418.4" />
-        <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="5.0.0-preview.7.20364.11" />
+        <PackageReference Include="Microsoft.CodeAnalysis.CSharp.Scripting" Version="3.7.0-6.20459.4" />
+        <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="5.0.0-preview.8.20407.11" />
         <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
-        <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="5.0.0-preview.7.20364.11" />
+        <PackageReference Include="NuGet.Packaging" Version="5.8.0-preview.2.6776" />
+        <PackageReference Include="NuGet.Protocol" Version="5.8.0-preview.2.6776" />
+        <PackageReference Include="NuGet.Resolver" Version="5.7.0" />
+        <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="5.0.0-preview.8.20407.11" />
 
         <PackageReference Include="System.ValueTuple" Version="4.5.0" />
         <PackageReference Include="System.Memory" Version="4.5.4" />
diff --git a/CSDiscordService/Eval/CSharpEval.cs b/CSDiscordService/Eval/CSharpEval.cs
@@ -5,80 +5,29 @@
 using Microsoft.CodeAnalysis.Diagnostics;
 using Microsoft.CodeAnalysis.Scripting;
 using System;
-using System.Collections.Generic;
 using System.Collections.Immutable;
 using System.Diagnostics;
 using System.Linq;
-using System.Net.Http;
-using System.Reflection;
-using System.Runtime.CompilerServices;
 using System.Text;
 using System.Threading.Tasks;
 using System.Text.Json;
+using Microsoft.CodeAnalysis.Text;
 
 namespace CSDiscordService.Eval
 {
     public class CSharpEval
     {
-        private static readonly ImmutableArray<string> DefaultImports =
-            ImmutableArray.Create(
-                "Newtonsoft.Json",
-                "Newtonsoft.Json.Linq",
-                "System",
-                "System.Collections",
-                "System.Collections.Concurrent",
-                "System.Collections.Immutable",
-                "System.Collections.Generic",
-                "System.Dynamic",
-                "System.Security.Cryptography",
-                "System.Globalization",
-                "System.IO",
-                "System.Linq",
-                "System.Linq.Expressions",
-                "System.Net",
-                "System.Net.Http",
-                "System.Numerics",
-                "System.Reflection",
-                "System.Reflection.Emit",
-                "System.Runtime.CompilerServices",
-                "System.Runtime.InteropServices",
-                "System.Runtime.Intrinsics",
-                "System.Runtime.Intrinsics.X86",
-                "System.Text",
-                "System.Text.RegularExpressions",
-                "System.Threading",
-                "System.Threading.Tasks",
-                "System.Text.Json",
-                "CSDiscordService.Eval"
-            );
-
-        private static readonly ImmutableArray<Assembly> DefaultReferences =
-            ImmutableArray.Create(
-                typeof(Enumerable).GetTypeInfo().Assembly,
-                typeof(HttpClient).GetTypeInfo().Assembly,
-                typeof(List<>).GetTypeInfo().Assembly,
-                typeof(string).GetTypeInfo().Assembly,
-                typeof(Unsafe).GetTypeInfo().Assembly,
-                typeof(ValueTuple).GetTypeInfo().Assembly,
-                typeof(Globals).GetTypeInfo().Assembly,
-                typeof(Memory<>).GetTypeInfo().Assembly
-            );
-
-        private static readonly ScriptOptions Options =
-            ScriptOptions.Default
-                .WithLanguageVersion(LanguageVersion.Preview)
-                .WithImports(DefaultImports)
-                .WithReferences(DefaultReferences);
-
         private static readonly ImmutableArray<DiagnosticAnalyzer> Analyzers =
             ImmutableArray.Create<DiagnosticAnalyzer>(new BlacklistedTypesAnalyzer());
 
         private static readonly Random random = new Random();
         private readonly JsonSerializerOptions _serializerOptions;
+        private readonly IPreProcessorService _preProcessor;
 
-        public CSharpEval(JsonSerializerOptions serializerOptons)
+        public CSharpEval(JsonSerializerOptions serializerOptons, IPreProcessorService preProcessor)
         {
             _serializerOptions = serializerOptons;
+            _preProcessor = preProcessor;
         }
 
         public async Task<EvalResult> RunEvalAsync(string code)
@@ -88,7 +37,19 @@ public async Task<EvalResult> RunEvalAsync(string code)
             var env = new BasicEnvironment();
 
             var sw = Stopwatch.StartNew();
-            var eval = CSharpScript.Create(code, Options, typeof(Globals));
+
+            var context = new ScriptExecutionContext(code);
+            try
+            {
+                await _preProcessor.PreProcess(context);
+            }
+            catch(Exception ex)
+            {
+                var diagnostics = Diagnostic.Create(new DiagnosticDescriptor("REPL01", ex.Message, ex.Message, "Code", DiagnosticSeverity.Error, true), 
+                    Location.Create("", TextSpan.FromBounds(0,0), new LinePositionSpan(LinePosition.Zero, LinePosition.Zero)));
+                return EvalResult.CreateErrorResult(code, string.Empty, TimeSpan.Zero, new[] { diagnostics }.ToImmutableArray());
+            }
+            var eval = CSharpScript.Create(context.Code, context.Options, typeof(Globals));
 
             var compilation = eval.GetCompilation().WithAnalyzers(Analyzers);
 
@@ -97,7 +58,7 @@ public async Task<EvalResult> RunEvalAsync(string code)
             sw.Stop();
 
             var compileTime = sw.Elapsed;
-            if (compileErrors.Length > 0)
+            if (!compileErrors.IsEmpty)
             {
                 return EvalResult.CreateErrorResult(code, sb.ToString(), sw.Elapsed, compileErrors);
             }
diff --git a/CSDiscordService/Eval/DefaultPreProcessorService.cs b/CSDiscordService/Eval/DefaultPreProcessorService.cs
@@ -0,0 +1,49 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+
+namespace CSDiscordService.Eval
+{
+    public class DefaultPreProcessorService : IPreProcessorService
+    {
+        private readonly IEnumerable<IDirectiveProcessor> _directives;
+
+        public DefaultPreProcessorService(IEnumerable<IDirectiveProcessor> directives)
+        {
+            _directives = directives;
+        }
+        public async Task PreProcess(ScriptExecutionContext context)
+        {
+            var codeLines = context.Code.Split(new[] { "\r\n", "\n" }, StringSplitOptions.None);
+            var remainingLines = new List<string>();
+
+            foreach(var line in codeLines)
+            {
+                var lineHandled = false;
+                foreach(var directive in _directives)
+                {
+                    if (lineHandled)
+                    {
+                        continue;
+                    }
+
+                    var canProcess = directive.CanProcessDirective(line);
+                    if(!canProcess)
+                    {
+                        continue;
+                    }
+
+                    lineHandled = true;
+                    await directive.PreProcess(line, context);
+                }
+
+                if(!lineHandled)
+                {
+                    remainingLines.Add(line);
+                }
+            }
+
+            context.Code = string.Join(Environment.NewLine, remainingLines);
+        }
+    }
+}
diff --git a/CSDiscordService/Eval/IDirectiveProcessor.cs b/CSDiscordService/Eval/IDirectiveProcessor.cs
@@ -0,0 +1,10 @@
+﻿using System.Threading.Tasks;
+
+namespace CSDiscordService.Eval
+{
+    public interface IDirectiveProcessor
+    {
+        bool CanProcessDirective(string directive);
+        Task PreProcess(string directive, ScriptExecutionContext context);
+    }
+}
diff --git a/CSDiscordService/Eval/IPreProcessorService.cs b/CSDiscordService/Eval/IPreProcessorService.cs
diff --git a/CSDiscordService/Eval/NugetPreProcessorDirective.cs b/CSDiscordService/Eval/NugetPreProcessorDirective.cs
diff --git a/CSDiscordService/Eval/NugetdirectiveProcessor.cs b/CSDiscordService/Eval/NugetdirectiveProcessor.cs
diff --git a/CSDiscordService/Eval/ScriptExecutionContext.cs b/CSDiscordService/Eval/ScriptExecutionContext.cs
diff --git a/CSDiscordService/Startup.cs b/CSDiscordService/Startup.cs

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +[*.cs]
++
 +# CA1822: Mark members as static
 +dotnet_diagnostic.CA1822.severity = silent
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,9 @@`
`12`	`12`	`namespace CSDiscordService.Tests`
`13`	`13`	`{`
`14`	`14`	`public class ILTests : IDisposable`
`15`		`- {`
	`15`	`+ {`
	`16`	`+ private bool disposedValue;`
	`17`	`+`
`16`	`18`	`public ILTests(ITestOutputHelper outputHelper)`
`17`	`19`	`{`
`18`	`20`	`var host = WebHost.CreateDefaultBuilder()`
`@@ -60,11 +62,24 @@ public async Task TestIfWorks(string script)`
`60`	`62`	`return (result, response.StatusCode);`
`61`	`63`	`}`
`62`	`64`
	`65`	`+ protected virtual void Dispose(bool disposing)`
	`66`	`+ {`
	`67`	`+ if (!disposedValue)`
	`68`	`+ {`
	`69`	`+ if (disposing)`
	`70`	`+ {`
	`71`	`+ Client.Dispose();`
	`72`	`+ Server.Dispose();`
	`73`	`+ }`
	`74`	`+ disposedValue = true;`
	`75`	`+ }`
	`76`	`+ }`
	`77`	`+`
`63`	`78`
`64`	`79`	`public void Dispose()`
`65`	`80`	`{`
`66`		`- Client.Dispose();`
`67`		`- Server.Dispose();`
	`81`	`+ Dispose(disposing: true);`
	`82`	`+ GC.SuppressFinalize(this);`
`68`	`83`	`}`
`69`	`84`	`}`
`70`	`85`	`}`