System-IO-Abstractions/System.IO.Abstractions/issues#598 Added benchmarks to project

0ghny · fgreinacher · commit 0a8856c5fbfc · 2020-06-17T12:17:41.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -45,6 +45,9 @@ build/
 *.log
 *.scc
 
+# Benchmarks results
+BenchmarkDotNet.Artifacts
+
 # Visual C++ cache files
 ipch/
 *.aps
diff --git a/System.IO.Abstractions.Benchmarks/FileSystemAbstractionBenchmarks.cs b/System.IO.Abstractions.Benchmarks/FileSystemAbstractionBenchmarks.cs
@@ -0,0 +1,49 @@
+﻿using System;
+using System.IO;
+using System.IO.Abstractions.Benchmarks.Support;
+using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Order;
+
+namespace System.IO.Abstractions.Benchmarks
+{
+    //[SimpleJob(launchCount: 3, warmupCount: 10, targetCount: 30)]
+    [RPlotExporter]
+    [MemoryDiagnoser]
+    [Orderer(summaryOrderPolicy: SummaryOrderPolicy.FastestToSlowest)]
+    [RankColumn]
+    public class FileSystemAbstractionBenchmarks
+    {
+        #region Members
+        /// <summary>
+        /// FileSupport type to avoid counting object initialisation on the benchmark
+        /// </summary>
+        private FileSupport _fileSupport;
+        private DirectorySupport _directorySupport;
+        #endregion
+
+        #region CTOR's
+        public FileSystemAbstractionBenchmarks( )
+        {
+            // Initialize file support
+            _fileSupport = new FileSupport();
+            _directorySupport = new DirectorySupport();
+        }
+        #endregion
+
+        #region File IsFile
+        [Benchmark]
+        public void FileExists_DotNet() => FileSupportStatic.IsFile(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile));
+
+        [Benchmark]
+        public void FileExists_Abstraction() => _fileSupport.IsFile(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile));
+        #endregion
+
+        #region Directory Exists
+        [Benchmark]
+        public void DirectoryExists_DotNet() => DirectorySupportStatic.Exists(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile));
+
+        [Benchmark]
+        public void DirectoryExists_Abstraction() => _directorySupport.Exists(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile));
+        #endregion
+    }
+}
diff --git a/System.IO.Abstractions.Benchmarks/Program.cs b/System.IO.Abstractions.Benchmarks/Program.cs
@@ -0,0 +1,12 @@
+﻿namespace System.IO.Abstractions.Benchmarks
+{
+    using BenchmarkDotNet.Running;
+
+    class Program
+    {
+        public static void Main(string[] args)
+        {
+            BenchmarkRunner.Run<FileSystemAbstractionBenchmarks>();
+        }
+    }
+}
diff --git a/System.IO.Abstractions.Benchmarks/Properties/launchSettings.json b/System.IO.Abstractions.Benchmarks/Properties/launchSettings.json
@@ -0,0 +1,8 @@
+{
+  "profiles": {
+    "yapm": {
+      "commandName": "Project",
+      "commandLineArgs": "apply"
+    }
+  }
+}
diff --git a/System.IO.Abstractions.Benchmarks/Support/DirectorySupport.cs b/System.IO.Abstractions.Benchmarks/Support/DirectorySupport.cs
@@ -0,0 +1,101 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace System.IO.Abstractions.Benchmarks.Support
+{
+    public class DirectorySupport
+    {
+        #region Members
+        private IFileSystem _fileSystem;
+        #endregion
+
+        #region CTOR's
+        public DirectorySupport(IFileSystem fileSystem)
+        {
+            _fileSystem = fileSystem;
+        }
+
+        public DirectorySupport() : this(new FileSystem())
+        {
+            // Default implementation for FileSystem
+        }
+        #endregion
+
+        #region Methods
+        public bool IsDirectory(string path)
+        {
+            return _fileSystem.Directory.Exists(path);
+        }
+
+        private string GetRandomTempDirectory()
+        {
+            return Path.Combine(Path.GetTempPath(), Path.GetRandomFileName());
+        }
+
+        public string CreateRandomDirectory()
+        {
+            var randomPath = this.GetRandomTempDirectory();
+            try
+            {
+                _fileSystem.Directory.CreateDirectory(randomPath);
+                return randomPath;
+            }
+            catch (Exception ex)
+            {
+                throw (ex);
+            }
+        }
+
+        private void DirectoryCopy(string sourceDirName, string destDirName, bool copySubDirs = true, bool overwrite = true)
+        {
+            // Get the subdirectories for the specified directory.
+            var dir = _fileSystem.DirectoryInfo.FromDirectoryName(sourceDirName);
+            if (!dir.Exists)
+            {
+                throw new DirectoryNotFoundException(
+                    "Source directory does not exist or could not be found: "
+                    + sourceDirName);
+            }
+
+            var dirs = dir.GetDirectories();
+            // If the destination directory doesn't exist, create it.
+            if (!_fileSystem.Directory.Exists(destDirName))
+            {
+                _fileSystem.Directory.CreateDirectory(destDirName);
+            }
+
+            // Get the files in the directory and copy them to the new location.
+            var files = dir.GetFiles();
+            foreach (var file in files)
+            {
+                string temppath = Path.Combine(destDirName, file.Name);
+                file.CopyTo(temppath, overwrite);
+            }
+
+            // If copying subdirectories, copy them and their contents to new location.
+            if (copySubDirs)
+            {
+                foreach (var subdir in dirs)
+                {
+                    string temppath = Path.Combine(destDirName, subdir.Name);
+                    DirectoryCopy(subdir.FullName, temppath, copySubDirs);
+                }
+            }
+        }
+
+        public void CreateIfNotExists(string directory)
+        {
+            if (!_fileSystem.Directory.Exists(directory))
+            {
+                _fileSystem.Directory.CreateDirectory(directory);
+            }
+        }
+
+        public bool Exists(string directory)
+        {
+            return _fileSystem.Directory.Exists(directory);
+        }
+        #endregion
+    }
+}
diff --git a/System.IO.Abstractions.Benchmarks/Support/DirectorySupportStatic.cs b/System.IO.Abstractions.Benchmarks/Support/DirectorySupportStatic.cs
@@ -0,0 +1,79 @@
+﻿namespace System.IO.Abstractions.Benchmarks.Support
+{
+    public static class DirectorySupportStatic
+    {
+        #region Methods
+        public static bool IsDirectory(string path)
+        {
+            return Directory.Exists(path);
+        }
+
+        private static string GetRandomTempDirectory()
+        {
+            return Path.Combine(Path.GetTempPath(), Path.GetRandomFileName());
+        }
+
+        public static string CreateDirectory()
+        {
+            var randomPath = GetRandomTempDirectory();
+            try
+            {
+                Directory.CreateDirectory(randomPath);
+                return randomPath;
+            }
+            catch (Exception ex)
+            {
+                throw (ex);
+            }
+        }
+
+        private static void DirectoryCopy(string sourceDirName, string destDirName, bool copySubDirs = true, bool overwrite = true)
+        {
+            // Get the subdirectories for the specified directory.
+            DirectoryInfo dir = new DirectoryInfo(sourceDirName);
+
+            if (!dir.Exists)
+            {
+                throw new DirectoryNotFoundException(
+                    "Source directory does not exist or could not be found: "
+                    + sourceDirName);
+            }
+
+            DirectoryInfo[] dirs = dir.GetDirectories();
+            // If the destination directory doesn't exist, create it.
+            if (!Directory.Exists(destDirName))
+            {
+                Directory.CreateDirectory(destDirName);
+            }
+
+            // Get the files in the directory and copy them to the new location.
+            FileInfo[] files = dir.GetFiles();
+            foreach (FileInfo file in files)
+            {
+                string temppath = Path.Combine(destDirName, file.Name);
+                file.CopyTo(temppath, overwrite);
+            }
+
+            // If copying subdirectories, copy them and their contents to new location.
+            if (copySubDirs)
+            {
+                foreach (DirectoryInfo subdir in dirs)
+                {
+                    string temppath = Path.Combine(destDirName, subdir.Name);
+                    DirectoryCopy(subdir.FullName, temppath, copySubDirs);
+                }
+            }
+        }
+
+        public static void CreateIfNotExists(string directory)
+        {
+            if (!Directory.Exists(directory))
+            {
+                Directory.CreateDirectory(directory);
+            }
+        }
+
+        public static bool Exists(string directory) => Directory.Exists(directory);
+        #endregion
+    }
+}
diff --git a/System.IO.Abstractions.Benchmarks/Support/FileSupport.cs b/System.IO.Abstractions.Benchmarks/Support/FileSupport.cs
@@ -0,0 +1,49 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace System.IO.Abstractions.Benchmarks.Support
+{
+    public class FileSupport
+    {
+        #region Members
+        private IFileSystem _fileSystem;
+        #endregion
+
+        #region CTOR's
+        public FileSupport(IFileSystem fileSystem)
+        {
+            _fileSystem = fileSystem;
+        }
+
+        public FileSupport() : this(new FileSystem())
+        {
+            // Default implementation for FileSystem
+        }
+        #endregion
+
+        #region Methods
+        public string GetRandomTempFile()
+        {
+            return Path.Combine(Path.GetTempPath(), Path.GetRandomFileName());
+        }
+
+        public bool IsFile(string path)
+        {
+            return _fileSystem.File.Exists(path);
+        }
+
+        /// <summary>
+        /// Checks and deletes given file if it does exists.
+        /// </summary>
+        /// <param name="filePath">Path of the file</param>
+        public void DeleteIfExists(string filePath)
+        {
+            if (_fileSystem.File.Exists(filePath))
+            {
+                _fileSystem.File.Delete(filePath);
+            }
+        }
+        #endregion
+    }
+}
diff --git a/System.IO.Abstractions.Benchmarks/Support/FileSupportStatic.cs b/System.IO.Abstractions.Benchmarks/Support/FileSupportStatic.cs
@@ -0,0 +1,29 @@
+﻿using System.IO;
+
+namespace System.IO.Abstractions.Benchmarks.Support
+{
+    public static class FileSupportStatic
+    {
+        public static string GetRandomTempFile()
+        {
+            return Path.Combine(Path.GetTempPath(), Path.GetRandomFileName());
+        }
+
+        public static bool IsFile(string path)
+        {
+            return File.Exists(path);
+        }
+
+        /// <summary>
+        /// Checks and deletes given file if it does exists.
+        /// </summary>
+        /// <param name="filePath">Path of the file</param>
+        public static void DeleteIfExists(string filePath)
+        {
+            if (File.Exists(filePath))
+            {
+                File.Delete(filePath);
+            }
+        }
+    }
+}
diff --git a/System.IO.Abstractions.Benchmarks/System.IO.Abstractions.Benchmarks.csproj b/System.IO.Abstractions.Benchmarks/System.IO.Abstractions.Benchmarks.csproj
@@ -0,0 +1,25 @@
+﻿<Project Sdk="Microsoft.NET.Sdk">
+	<PropertyGroup>
+		<AssemblyName>System.IO.Abstractions.Benchmarks</AssemblyName>
+		<RootNamespace>System.IO.Abstractions.Benchmarks</RootNamespace>
+		<Description>Bencharmks comparisons.</Description>
+		<TargetFrameworks>netcoreapp3.1;net461</TargetFrameworks>
+		<PackageProjectUrl>https://github.com/System-IO-Abstractions/System.IO.Abstractions</PackageProjectUrl>
+		<PackageLicenseExpression>MIT</PackageLicenseExpression>
+		<PackageTags>testing</PackageTags>
+		<IsPackable>false</IsPackable>
+		<IsTestable>false</IsTestable>
+		<OutputType>Exe</OutputType>		
+		<OutputType>Exe</OutputType>		
+	</PropertyGroup>
+	<ItemGroup>
+		<ProjectReference Include="..\System.IO.Abstractions\System.IO.Abstractions.csproj" />
+	</ItemGroup>
+	<ItemGroup>
+		<PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies.net461" Version="1.0.0">
+			<PrivateAssets>all</PrivateAssets>
+			<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+		</PackageReference>
+		<PackageReference Include="BenchmarkDotNet" Version="0.12.1" />
+	</ItemGroup>
+</Project>
diff --git a/System.IO.Abstractions.sln b/System.IO.Abstractions.sln
