Внедрение пакета System.IO.Abstractions (#12)

Stepami · web-flow · commit 1e1f958b4805 · 2022-09-16T18:24:30.000+03:00
* внедрение абстракций I/O для возможности unit-тестирования

* remove unused

* тесты

* coverage

* new version
diff --git a/Interpreter.Tests/MockExtensions.cs b/Interpreter.Tests/MockExtensions.cs
@@ -1,5 +1,6 @@
 using Interpreter.Lib.BackEnd;
 using Interpreter.Lib.BackEnd.Instructions;
+using Microsoft.Extensions.Options;
 using Moq;
 
 namespace Interpreter.Tests
@@ -13,5 +14,9 @@ public static Mock<Halt> Trackable(this Mock<Halt> halt)
             halt.Setup(x => x.End()).Returns(true);
             return halt;
         }
+
+        public static IOptions<CommandLineSettings> ToOptions
+            (this Mock<CommandLineSettings> commandLineSettings) =>
+            Options.Create(commandLineSettings.Object);
     }
 }
diff --git a/Interpreter.Tests/Unit/Infrastructure/ExecutorTests.cs b/Interpreter.Tests/Unit/Infrastructure/ExecutorTests.cs
@@ -8,7 +8,6 @@
 using Interpreter.Services.Executor.Impl;
 using Interpreter.Services.Parsing;
 using Interpreter.Tests.Stubs;
-using Microsoft.Extensions.Options;
 using Moq;
 using Xunit;
 
@@ -38,7 +37,7 @@ public void ExecuteGoesOkTest()
             _parsingService.Setup(x => x.Parse(It.IsAny<string>()))
                 .Returns(ast.Object);
 
-            var executor = new Executor(_parsingService.Object, Options.Create(_settings.Object));
+            var executor = new Executor(_parsingService.Object, _settings.ToOptions());
             Assert.Null(Record.Exception(() => executor.Execute()));
         }
 
@@ -52,7 +51,7 @@ public void SemanticExceptionCaughtTest()
             _parsingService.Setup(x => x.Parse(It.IsAny<string>()))
                 .Returns(ast.Object);
 
-            var executor = new Executor(_parsingService.Object, Options.Create(_settings.Object));
+            var executor = new Executor(_parsingService.Object, _settings.ToOptions());
             Assert.Null(Record.Exception(() => executor.Execute()));
         }
         
@@ -62,7 +61,7 @@ public void LexerExceptionCaughtTest()
             _parsingService.Setup(x => x.Parse(It.IsAny<string>()))
                 .Throws<LexerException>();
 
-            var executor = new Executor(_parsingService.Object, Options.Create(_settings.Object));
+            var executor = new Executor(_parsingService.Object, _settings.ToOptions());
             Assert.Null(Record.Exception(() => executor.Execute()));
         }
         
@@ -72,7 +71,7 @@ public void ParserExceptionCaughtTest()
             _parsingService.Setup(x => x.Parse(It.IsAny<string>()))
                 .Throws<ParserException>();
 
-            var executor = new Executor(_parsingService.Object, Options.Create(_settings.Object));
+            var executor = new Executor(_parsingService.Object, _settings.ToOptions());
             Assert.Null(Record.Exception(() => executor.Execute()));
         }
         
@@ -90,7 +89,7 @@ public void InternalInterpreterErrorCaughtTest()
             _parsingService.Setup(x => x.Parse(It.IsAny<string>()))
                 .Returns(ast.Object);
 
-            var executor = new Executor(_parsingService.Object, Options.Create(_settings.Object));
+            var executor = new Executor(_parsingService.Object, _settings.ToOptions());
             Assert.Null(Record.Exception(() => executor.Execute()));
         }
     }
diff --git a/Interpreter.Tests/Unit/Infrastructure/LoggingEntitiesTests.cs b/Interpreter.Tests/Unit/Infrastructure/LoggingEntitiesTests.cs
@@ -0,0 +1,96 @@
+using System.Collections.Generic;
+using System.IO.Abstractions;
+using System.Linq;
+using Interpreter.Lib.BackEnd.Instructions;
+using Interpreter.Lib.FrontEnd.GetTokens;
+using Interpreter.Lib.FrontEnd.GetTokens.Data;
+using Interpreter.Lib.FrontEnd.TopDownParse;
+using Interpreter.Lib.IR.Ast;
+using Interpreter.Services.Providers.Impl.LexerProvider;
+using Interpreter.Services.Providers.Impl.ParserProvider;
+using Moq;
+using Xunit;
+
+namespace Interpreter.Tests.Unit.Infrastructure
+{
+    public class LoggingEntitiesTests
+    {
+        private readonly Mock<IFile> _file;
+        private readonly Mock<IFileSystem> _fileSystem;
+
+        public LoggingEntitiesTests()
+        {
+            _file = new Mock<IFile>();
+
+            _fileSystem = new Mock<IFileSystem>();
+            _fileSystem.Setup(x => x.File)
+                .Returns(_file.Object);
+        }
+
+        [Fact]
+        public void CorrectFileNameProducedByLexerTest()
+        {
+            var lexer = new Mock<ILexer>();
+            lexer.Setup(x => x.GetTokens(It.IsAny<string>()))
+                .Returns(new List<Token>());
+            lexer.Setup(x => x.ToString())
+                .Returns("lexer");
+
+            _file.Setup(x => x.WriteAllText(
+                It.IsAny<string>(), It.IsAny<string>()
+            )).Verifiable();
+
+            var loggingLexer = new LoggingLexer(lexer.Object, "file", _fileSystem.Object);
+            loggingLexer.GetTokens("");
+
+            _file.Verify(x => x.WriteAllText(
+                It.Is<string>(p => p == "file.tokens"), It.Is<string>(c => c == "lexer")
+            ), Times.Once());
+        }
+        
+        [Fact]
+        public void CorrectTreeWrittenAndLoggingTreeProducedTest()
+        {
+            var ast = new Mock<IAbstractSyntaxTree>();
+            ast.Setup(x => x.ToString())
+                .Returns("digraph ast { }");
+            
+            var parser = new Mock<IParser>();
+            parser.Setup(x => x.TopDownParse(It.IsAny<string>()))
+                .Returns(ast.Object);
+
+            _file.Setup(x => x.WriteAllText(
+                It.IsAny<string>(), It.IsAny<string>()
+            )).Verifiable();
+
+            var loggingParser = new LoggingParser(parser.Object, "file", _fileSystem.Object);
+            var parsed = loggingParser.TopDownParse("");
+
+            _file.Verify(x => x.WriteAllText(
+                It.Is<string>(p => p == "ast.dot"),
+                It.Is<string>(c => c == "digraph ast { }")
+            ), Times.Once());
+            Assert.IsType<LoggingAbstractSyntaxTree>(parsed);
+        }
+
+        [Fact]
+        public void CorrectFileNameProducedByTreeTest()
+        {
+            var ast = new Mock<IAbstractSyntaxTree>();
+            ast.Setup(x => x.GetInstructions())
+                .Returns(new List<Instruction> { new Halt(0) });
+
+            _file.Setup(x => x.WriteAllLines(
+                It.IsAny<string>(), It.IsAny<IEnumerable<string>>()
+            )).Verifiable();
+
+            var loggingTree = new LoggingAbstractSyntaxTree(ast.Object, "file", _fileSystem.Object);
+            loggingTree.GetInstructions();
+
+            _file.Verify(x => x.WriteAllLines(
+                It.Is<string>(p => p == "file.tac"),
+                It.Is<IEnumerable<string>>(c => c.SequenceEqual(new[] { "0: End" }))
+            ), Times.Once());
+        }
+    }
+}
diff --git a/Interpreter/Interpreter.csproj b/Interpreter/Interpreter.csproj
@@ -3,7 +3,7 @@
     <PropertyGroup>
         <OutputType>Exe</OutputType>
         <TargetFramework>net6.0</TargetFramework>
-        <Version>1.1.2</Version>
+        <Version>1.1.3</Version>
     </PropertyGroup>
 
     <ItemGroup>
@@ -15,6 +15,7 @@
       <PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" Version="11.0.0" />
       <PackageReference Include="CommandLineParser" Version="2.9.1" />
       <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="6.0.0" />
+      <PackageReference Include="System.IO.Abstractions" Version="17.2.1" />
     </ItemGroup>
 
 </Project>
diff --git a/Interpreter/Services/Providers/Impl/LexerProvider/LexerProvider.cs b/Interpreter/Services/Providers/Impl/LexerProvider/LexerProvider.cs
@@ -1,3 +1,4 @@
+using System.IO.Abstractions;
 using AutoMapper;
 using Interpreter.Lib.FrontEnd.GetTokens;
 using Interpreter.Lib.FrontEnd.GetTokens.Data;
@@ -23,7 +24,7 @@ public ILexer CreateLexer()
             var domain = _mapper.Map<StructureModel, Structure>(_settings.StructureModel);
             var lexer = new Lexer(domain);
             return _settings.Dump
-                ? new LoggingLexer(lexer, _settings.GetInputFileName())
+                ? new LoggingLexer(lexer, _settings.GetInputFileName(), new FileSystem())
                 : lexer;
         }
     }
diff --git a/Interpreter/Services/Providers/Impl/LexerProvider/LoggingLexer.cs b/Interpreter/Services/Providers/Impl/LexerProvider/LoggingLexer.cs
@@ -1,5 +1,6 @@
 using System.Collections.Generic;
-using System.IO;
+using System.Diagnostics.CodeAnalysis;
+using System.IO.Abstractions;
 using Interpreter.Lib.FrontEnd.GetTokens;
 using Interpreter.Lib.FrontEnd.GetTokens.Data;
 
@@ -9,19 +10,22 @@ public class LoggingLexer : ILexer
     {
         private readonly ILexer _lexer;
         private readonly string _fileName;
+        private readonly IFileSystem _fileSystem;
 
-        public LoggingLexer(ILexer lexer, string fileName)
+        public LoggingLexer(ILexer lexer, string fileName, IFileSystem fileSystem)
         {
             _lexer = lexer;
             _fileName = fileName;
+            _fileSystem = fileSystem;
         }
 
+        [ExcludeFromCodeCoverage]
         public Structure Structure => _lexer.Structure;
     
         public List<Token> GetTokens(string text)
         {
             var tokens = _lexer.GetTokens(text);
-            File.WriteAllText(
+            _fileSystem.File.WriteAllText(
                 $"{_fileName}.tokens",
                 _lexer.ToString()
             );
diff --git a/Interpreter/Services/Providers/Impl/ParserProvider/LoggingAbstractSyntaxTree.cs b/Interpreter/Services/Providers/Impl/ParserProvider/LoggingAbstractSyntaxTree.cs
@@ -1,5 +1,5 @@
 using System.Collections.Generic;
-using System.IO;
+using System.IO.Abstractions;
 using System.Linq;
 using Interpreter.Lib.BackEnd.Instructions;
 using Interpreter.Lib.IR.Ast;
@@ -10,17 +10,19 @@ public class LoggingAbstractSyntaxTree : IAbstractSyntaxTree
     {
         private readonly IAbstractSyntaxTree _ast;
         private readonly string _fileName;
+        private readonly IFileSystem _fileSystem;
 
-        public LoggingAbstractSyntaxTree(IAbstractSyntaxTree ast, string fileName)
+        public LoggingAbstractSyntaxTree(IAbstractSyntaxTree ast, string fileName, IFileSystem fileSystem)
         {
             _ast = ast;
             _fileName = fileName;
+            _fileSystem = fileSystem;
         }
     
         public List<Instruction> GetInstructions()
         {
             var instructions = _ast.GetInstructions();
-            File.WriteAllLines(
+            _fileSystem.File.WriteAllLines(
                 $"{_fileName}.tac",
                 instructions.OrderBy(i => i).Select(i => i.ToString())
             );
diff --git a/Interpreter/Services/Providers/Impl/ParserProvider/LoggingParser.cs b/Interpreter/Services/Providers/Impl/ParserProvider/LoggingParser.cs
@@ -1,4 +1,4 @@
-using System.IO;
+using System.IO.Abstractions;
 using Interpreter.Lib.FrontEnd.TopDownParse;
 using Interpreter.Lib.IR.Ast;
 
@@ -8,19 +8,21 @@ public class LoggingParser : IParser
     {
         private readonly IParser _parser;
         private readonly string _fileName;
+        private readonly IFileSystem _fileSystem;
 
-        public LoggingParser(IParser parser, string fileName)
+        public LoggingParser(IParser parser, string fileName, IFileSystem fileSystem)
         {
             _parser = parser;
             _fileName = fileName;
+            _fileSystem = fileSystem;
         }
     
         public IAbstractSyntaxTree TopDownParse(string text)
         {
             var ast = _parser.TopDownParse(text);
             var astDot = ast.ToString();
-            File.WriteAllText("ast.dot", astDot);
-            return new LoggingAbstractSyntaxTree(ast, _fileName);
+            _fileSystem.File.WriteAllText("ast.dot", astDot);
+            return new LoggingAbstractSyntaxTree(ast, _fileName, _fileSystem);
         }
     }
 }
diff --git a/Interpreter/Services/Providers/Impl/ParserProvider/ParserProvider.cs b/Interpreter/Services/Providers/Impl/ParserProvider/ParserProvider.cs
@@ -1,3 +1,4 @@
+using System.IO.Abstractions;
 using Interpreter.Lib.FrontEnd.TopDownParse;
 using Parser = Interpreter.Lib.FrontEnd.TopDownParse.Impl.Parser;
 using Microsoft.Extensions.Options;
@@ -20,7 +21,7 @@ public IParser CreateParser()
             var lexer = _lexerProvider.CreateLexer();
             var parser = new Parser(lexer);
             return _settings.Dump
-                ? new LoggingParser(parser, _settings.GetInputFileName())
+                ? new LoggingParser(parser, _settings.GetInputFileName(), new FileSystem())
                 : parser;
         }
     }
diff --git a/Readme.md b/Readme.md
@@ -174,7 +174,7 @@ let s = v2d as string
 ### Запуск
 
 ```
-Interpreter 1.1.2
+Interpreter 1.1.3
 Copyright (C) 2022 Interpreter
 USAGE:
 Simple interpretation call:

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using Interpreter.Lib.BackEnd;`
`2`	`2`	`using Interpreter.Lib.BackEnd.Instructions;`
	`3`	`+using Microsoft.Extensions.Options;`
`3`	`4`	`using Moq;`
`4`	`5`
`5`	`6`	`namespace Interpreter.Tests`
`@@ -13,5 +14,9 @@ public static Mock<Halt> Trackable(this Mock<Halt> halt)`
`13`	`14`	`halt.Setup(x => x.End()).Returns(true);`
`14`	`15`	`return halt;`
`15`	`16`	`}`
	`17`	`+`
	`18`	`+ public static IOptions<CommandLineSettings> ToOptions`
	`19`	`+ (this Mock<CommandLineSettings> commandLineSettings) =>`
	`20`	`+ Options.Create(commandLineSettings.Object);`
`16`	`21`	`}`
`17`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+using System.IO.Abstractions;`
`1`	`2`	`using AutoMapper;`
`2`	`3`	`using Interpreter.Lib.FrontEnd.GetTokens;`
`3`	`4`	`using Interpreter.Lib.FrontEnd.GetTokens.Data;`
`@@ -23,7 +24,7 @@ public ILexer CreateLexer()`
`23`	`24`	`var domain = _mapper.Map<StructureModel, Structure>(_settings.StructureModel);`
`24`	`25`	`var lexer = new Lexer(domain);`
`25`	`26`	`return _settings.Dump`
`26`		`- ? new LoggingLexer(lexer, _settings.GetInputFileName())`
	`27`	`+ ? new LoggingLexer(lexer, _settings.GetInputFileName(), new FileSystem())`
`27`	`28`	`: lexer;`
`28`	`29`	`}`
`29`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-using System.IO;`
	`1`	`+using System.IO.Abstractions;`
`2`	`2`	`using Interpreter.Lib.FrontEnd.TopDownParse;`
`3`	`3`	`using Interpreter.Lib.IR.Ast;`
`4`	`4`
`@@ -8,19 +8,21 @@ public class LoggingParser : IParser`
`8`	`8`	`{`
`9`	`9`	`private readonly IParser _parser;`
`10`	`10`	`private readonly string _fileName;`
	`11`	`+ private readonly IFileSystem _fileSystem;`
`11`	`12`
`12`		`- public LoggingParser(IParser parser, string fileName)`
	`13`	`+ public LoggingParser(IParser parser, string fileName, IFileSystem fileSystem)`
`13`	`14`	`{`
`14`	`15`	`_parser = parser;`
`15`	`16`	`_fileName = fileName;`
	`17`	`+ _fileSystem = fileSystem;`
`16`	`18`	`}`
`17`	`19`
`18`	`20`	`public IAbstractSyntaxTree TopDownParse(string text)`
`19`	`21`	`{`
`20`	`22`	`var ast = _parser.TopDownParse(text);`
`21`	`23`	`var astDot = ast.ToString();`
`22`		`- File.WriteAllText("ast.dot", astDot);`
`23`		`- return new LoggingAbstractSyntaxTree(ast, _fileName);`
	`24`	`+ _fileSystem.File.WriteAllText("ast.dot", astDot);`
	`25`	`+ return new LoggingAbstractSyntaxTree(ast, _fileName, _fileSystem);`
`24`	`26`	`}`
`25`	`27`	`}`
`26`	`28`	`}`