LockFile API is now mockable; FileLocker implements IFileLocker and can produce FileLockUses; FileLock wraps FileLockUse and implements IDisposable for being cleaned when disposing ServiceProvider

Author: teneko

src/GitVersionCore/Core/Abstractions/IFileSystem.cs

@@ -14,6 +14,7 @@ public interface IFileSystem
         void WriteAllText(string file, string fileContents);
         void WriteAllText(string file, string fileContents, Encoding encoding);
         IEnumerable<string> DirectoryEnumerateFiles(string directory, string searchPattern, SearchOption searchOption);
+        FileStream Open(string path, FileMode mode, FileAccess access, FileShare share);
         Stream OpenWrite(string path);
         Stream OpenRead(string path);
         void CreateDirectory(string path);

src/GitVersionCore/Core/FileSystem.cs

@@ -51,6 +51,11 @@ public IEnumerable<string> DirectoryEnumerateFiles(string directory, string sear
             return Directory.EnumerateFiles(directory, searchPattern, searchOption);
         }
 
+        public FileStream Open(string path, FileMode mode, FileAccess access, FileShare share)
+        {
+            return File.Open(path, mode, access, share);
+        }
+
         public Stream OpenWrite(string path)
         {
             return File.OpenWrite(path);

src/GitVersionCore/FileLocking/Abstractions/IFileLock.cs

@@ -0,0 +1,7 @@
+using System;
+
+namespace GitVersion.FileLocking.Abstractions
+{
+    public interface IFileLock : IDisposable
+    { }
+}

src/GitVersionCore/FileLocking/Abstractions/IFileLocker.cs

@@ -0,0 +1,29 @@
+/*
+MIT License
+
+Copyright 2020 Teroneko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy 
+of this software and associated documentation files (the "Software"), to deal 
+in the Software without restriction, including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 
+of the Software, and to permit persons to whom the Software is furnished to do 
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all 
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+namespace GitVersion.FileLocking.Abstractions
+{
+    public interface IFileLocker
+    {
+        FileLockUse WaitUntilAcquired();
+    }
+}

src/GitVersionCore/FileLocking/FileLockContext.cs

@@ -0,0 +1,76 @@
+/*
+MIT License
+
+Copyright 2020 Teroneko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy 
+of this software and associated documentation files (the "Software"), to deal 
+in the Software without restriction, including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 
+of the Software, and to permit persons to whom the Software is furnished to do 
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all 
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+using System;
+using System.Diagnostics;
+using System.IO;
+using System.Threading;
+
+namespace GitVersion.FileLocking
+{
+    internal class FileLockContext
+    {
+        public FileStream FileStream { get; set; }
+        public Exception Error { get; set; }
+        public ManualResetEvent ErrorUnlockDone { get; set; }
+
+        private readonly FileLocker fileLocker;
+        private object decreaseLockUseLocker;
+
+        public FileLockContext(FileLocker fileLocker, object decreaseLockUseLocker)
+        {
+            this.fileLocker = fileLocker;
+            this.decreaseLockUseLocker = decreaseLockUseLocker;
+            this.decreaseLockUseLocker = decreaseLockUseLocker;
+        }
+
+        public void DecreaseLockUse(bool decreaseToZero, string lockId)
+        {
+            var decreaseLockUseLocker = this.decreaseLockUseLocker;
+
+            if (decreaseLockUseLocker == null)
+                return;
+
+            // Why surround by lock?
+            // There is a race condition, when number of file lock uses
+            // is decrased to 0. It may not have invalidated the file
+            // stream yet. Now it can happen that the number of file lock
+            // uses is increased to 1 due to file lock, but right after another
+            // file unlock is about to decrease the number again to 0.
+            // There is the possiblity that the actual file lock gets released
+            // two times accidentally.
+            lock (decreaseLockUseLocker)
+            {
+                if (!(FileStream.CanRead || FileStream.CanWrite))
+                {
+                    Trace.WriteLine($"{FileLocker.CurrentThreadWithLockIdPrefix(lockId)} Lock use has been invalidated before. Skip decreasing lock use.", FileLocker.TraceCategory);
+                    return;
+                }
+
+                var locksInUse = fileLocker.DecreaseLockUse(decreaseToZero, lockId);
+
+                if (0 == locksInUse)
+                    this.decreaseLockUseLocker = null;
+            }
+        }
+    }
+}

src/GitVersionCore/FileLocking/FileLockContextExtensions.cs

@@ -0,0 +1,35 @@
+/*
+MIT License
+
+Copyright 2020 Teroneko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy 
+of this software and associated documentation files (the "Software"), to deal 
+in the Software without restriction, including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 
+of the Software, and to permit persons to whom the Software is furnished to do 
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all 
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+namespace GitVersion.FileLocking
+{
+    internal static class FileLockContextExtensions
+    {
+        public static bool IsErroneous(this FileLockContext fileLockContext)
+        {
+            if (fileLockContext?.Error is null)
+                return false;
+
+            return true;
+        }
+    }
+}

src/GitVersionCore/FileLocking/FileLockUse.cs

@@ -0,0 +1,49 @@
+/*
+MIT License
+
+Copyright 2020 Teroneko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy 
+of this software and associated documentation files (the "Software"), to deal 
+in the Software without restriction, including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 
+of the Software, and to permit persons to whom the Software is furnished to do 
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all 
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+using System;
+using System.ComponentModel;
+using System.IO;
+
+namespace GitVersion.FileLocking
+{
+    public struct FileLockUse : IDisposable
+    {
+        public FileStream FileStream => fileLockContext.FileStream;
+
+        private readonly FileLockContext fileLockContext;
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public readonly string LockId;
+
+        internal FileLockUse(FileLockContext fileLockContext, string LockId)
+        {
+            this.fileLockContext = fileLockContext;
+            this.LockId = LockId;
+        }
+
+        public void Dispose()
+        {
+            // When stream not closed, we can decrease lock use.
+            fileLockContext.DecreaseLockUse(false, LockId);
+        }
+    }
+}