System.IO.Abstractions 22.0.16

System.IO.Abstractions NuGet Build Quality Gate Status Coverage Renovate enabled FOSSA Status

At the core of the library is IFileSystem and FileSystem. Instead of calling methods like File.ReadAllText directly, use IFileSystem.File.ReadAllText. We have exactly the same API, except that ours is injectable and testable.

Usage

dotnet add package TestableIO.System.IO.Abstractions.Wrappers

Note: This NuGet package is also published as System.IO.Abstractions but we suggest to use the prefix to make clear that this is not an official .NET package.

public class MyComponent
{
    readonly IFileSystem fileSystem;

    // <summary>Create MyComponent with the given fileSystem implementation</summary>
    public MyComponent(IFileSystem fileSystem)
    {
        this.fileSystem = fileSystem;
    }
    /// <summary>Create MyComponent</summary>
    public MyComponent() : this(
        fileSystem: new FileSystem() //use default implementation which calls System.IO
    )
    {
    }

    public void Validate()
    {
        foreach (var textFile in fileSystem.Directory.GetFiles(@"c:\", "*.txt", SearchOption.TopDirectoryOnly))
        {
            var text = fileSystem.File.ReadAllText(textFile);
            if (text != "Testing is awesome.")
                throw new NotSupportedException("We can't go on together. It's not me, it's you.");
        }
    }
}

Test helpers

The library also ships with a series of test helpers to save you from having to mock out every call, for basic scenarios. They are not a complete copy of a real-life file system, but they'll get you most of the way there.

dotnet add package TestableIO.System.IO.Abstractions.TestingHelpers

Note: This NuGet package is also published as System.IO.Abstractions.TestingHelpers but we suggest to use the prefix to make clear that this is not an official .NET package.

[Test]
public void MyComponent_Validate_ShouldThrowNotSupportedExceptionIfTestingIsNotAwesome()
{
    // Arrange
    var fileSystem = new MockFileSystem(new Dictionary<string, MockFileData>
    {
        { @"c:\myfile.txt", new MockFileData("Testing is meh.") },
        { @"c:\demo\jQuery.js", new MockFileData("some js") },
        { @"c:\demo\image.gif", new MockFileData(new byte[] { 0x12, 0x34, 0x56, 0xd2 }) }
    });
    var component = new MyComponent(fileSystem);

    try
    {
        // Act
        component.Validate();
    }
    catch (NotSupportedException ex)
    {
        // Assert
        Assert.That(ex.Message, Is.EqualTo("We can't go on together. It's not me, it's you."));
        return;
    }

    Assert.Fail("The expected exception was not thrown.");
}

We even support casting from the .NET Framework's untestable types to our testable wrappers:

FileInfo SomeApiMethodThatReturnsFileInfo()
{
    return new FileInfo("a");
}

void MyFancyMethod()
{
    var testableFileInfo = (FileInfoBase)SomeApiMethodThatReturnsFileInfo();
    ...
}

Mock support

Since version 4.0 the top-level APIs expose interfaces instead of abstract base classes (these still exist, though), allowing you to completely mock the file system. Here's a small example, using Moq:

[Test]
public void Test1()
{
    var watcher = Mock.Of<IFileSystemWatcher>();
    var file = Mock.Of<IFile>();

    Mock.Get(file).Setup(f => f.Exists(It.IsAny<string>())).Returns(true);
    Mock.Get(file).Setup(f => f.ReadAllText(It.IsAny<string>())).Throws<OutOfMemoryException>();

    var unitUnderTest = new SomeClassUsingFileSystemWatcher(watcher, file);

    Assert.Throws<OutOfMemoryException>(() => {
        Mock.Get(watcher).Raise(w => w.Created += null, new System.IO.FileSystemEventArgs(System.IO.WatcherChangeTypes.Created, @"C:\Some\Directory", "Some.File"));
    });

    Mock.Get(file).Verify(f => f.Exists(It.IsAny<string>()), Times.Once);

    Assert.True(unitUnderTest.FileWasCreated);
}

public class SomeClassUsingFileSystemWatcher
{
    private readonly IFileSystemWatcher _watcher;
    private readonly IFile _file;

    public bool FileWasCreated { get; private set; }

    public SomeClassUsingFileSystemWatcher(IFileSystemWatcher watcher, IFile file)
    {
        this._file = file;
        this._watcher = watcher;
        this._watcher.Created += Watcher_Created;
    }

    private void Watcher_Created(object sender, System.IO.FileSystemEventArgs e)
    {
        FileWasCreated = true;

        if(_file.Exists(e.FullPath))
        {
            var text = _file.ReadAllText(e.FullPath);
        }
    }
}

Relationship with Testably.Abstractions

Testably.Abstractions is a complementary project that uses the same interfaces as TestableIO. This means no changes to your production code are necessary when switching between the testing libraries.

Both projects share the same maintainer, but active development and new features are primarily focused on the Testably.Abstractions project. TestableIO.System.IO.Abstractions continues to be maintained for stability and compatibility, but significant new functionality is unlikely to be added.

When to use Testably.Abstractions vs TestableIO

  • Use TestableIO.System.IO.Abstractions if you need:

    • Basic file system mocking capabilities
    • Direct manipulation of stored file entities (MockFileData, MockDirectoryData)
    • Established codebase with existing TestableIO integration
  • Use Testably.Abstractions if you need:

    • Advanced testing scenarios (FileSystemWatcher, SafeFileHandles, multiple drives)
    • Additional abstractions (ITimeSystem, IRandomSystem)
    • Cross-platform file system simulation (Linux, MacOS, Windows)Expand commentComment on line R163ResolvedCode has comments. Press enter to view.
    • More extensive and consistent behavior validation
    • Active development and new features

Migrating from TestableIO

Switching from TestableIO to Testably only requires changes in your test projects:

  1. Replace the NuGet package reference in your test projects:

    <!-- Remove -->
    <PackageReference Include="TestableIO.System.IO.Abstractions.TestingHelpers" />
    <!-- Add -->
    <PackageReference Include="Testably.Abstractions.Testing" />
    
  2. Update your test code to use the new MockFileSystem:

    // Before (TestableIO)
    var fileSystem = new MockFileSystem();
    fileSystem.AddDirectory("some-directory");
    fileSystem.AddFile("some-file.txt", new MockFileData("content"));
    
    // After (Testably)
    var fileSystem = new MockFileSystem();
    fileSystem.Directory.CreateDirectory("some-directory");
    fileSystem.File.WriteAllText("some-file.txt", "content");
    // or using fluent initialization:
    fileSystem.Initialize()
        .WithSubdirectory("some-directory")
        .WithFile("some-file.txt").Which(f => f
            .HasStringContent("content"));
    

Your production code using IFileSystem remains unchanged.

Showing the top 20 packages that depend on System.IO.Abstractions.

Packages Downloads
KubernetesClient
Client library for the Kubernetes open source container orchestrator.
21
KubernetesClient
Client library for the Kubernetes open source container orchestrator.
22
KubernetesClient
Client library for the Kubernetes open source container orchestrator.
23
KubernetesClient
Client library for the Kubernetes open source container orchestrator.
24
KubernetesClient
Client library for the Kubernetes open source container orchestrator.
25
KubernetesClient
Client library for the Kubernetes open source container orchestrator.
26
KubernetesClient
Client library for the Kubernetes open source container orchestrator.
27

Version Downloads Last updated
22.0.16 1 09/16/2025
22.0.16-pre.2 2 09/15/2025
22.0.16-pre.1 2 09/15/2025
22.0.15 5 07/22/2025
22.0.14 8 04/28/2025
22.0.13 13 04/06/2025
22.0.12 10 03/20/2025
22.0.11 10 03/04/2025
22.0.10 12 02/25/2025
22.0.10-beta.1 9 02/25/2025
22.0.9 10 02/23/2025
21.3.1 13 01/31/2025
21.2.12 14 01/31/2025
21.2.8 11 01/25/2025
21.2.1 14 12/29/2024
21.1.7 13 12/24/2024
21.1.3 19 11/12/2024
21.1.2 19 11/20/2024
21.1.1 13 12/09/2024
21.0.29 18 12/07/2024
21.0.26 15 12/15/2024
21.0.22 17 12/03/2024
21.0.2 23 05/18/2024
20.0.34 19 05/15/2024
20.0.28 20 05/23/2024
20.0.15 26 04/10/2024
20.0.4 24 12/20/2023
20.0.1 25 04/09/2024
19.2.91 21 05/25/2024
19.2.87 21 05/23/2024
19.2.69 23 05/15/2024
19.2.67 16 05/19/2024
19.2.66 21 05/11/2024
19.2.64 16 05/25/2024
19.2.63 22 05/03/2024
19.2.61 20 05/24/2024
19.2.51 19 05/25/2024
19.2.50 15 05/25/2024
19.2.29 23 05/08/2024
19.2.26 18 05/25/2024
19.2.25 21 05/07/2024
19.2.22 20 05/09/2024
19.2.18 22 05/13/2024
19.2.17 20 05/25/2024
19.2.16 20 05/10/2024
19.2.15 20 05/22/2024
19.2.13 25 05/25/2024
19.2.12 23 05/11/2024
19.2.11 22 05/15/2024
19.2.9 15 05/21/2024
19.2.8 28 04/30/2024
19.2.4 20 05/17/2024
19.2.1 27 05/09/2024
19.1.18 23 05/06/2024
19.1.14 23 05/04/2024
19.1.13 17 05/25/2024
19.1.5 23 05/19/2024
19.1.1 22 05/02/2024
19.0.1 23 05/19/2024
18.0.1 21 04/22/2024
17.2.26 25 05/11/2024
17.2.3 20 05/25/2024
17.2.1 19 04/09/2024
17.1.1 19 05/25/2024
17.0.28 33 04/09/2024
17.0.24 16 05/25/2024
17.0.23 20 05/02/2024
17.0.21 18 05/25/2024
17.0.18 21 05/24/2024
17.0.15 22 05/06/2024
17.0.14 22 05/25/2024
17.0.13 21 05/24/2024
17.0.12 22 05/25/2024
17.0.11 17 05/25/2024
17.0.10 17 05/02/2024
17.0.9 23 05/23/2024
17.0.8 18 05/16/2024
17.0.7 22 05/24/2024
17.0.6 20 05/09/2024
17.0.5 20 05/25/2024
17.0.4 29 05/15/2024
17.0.3 22 05/05/2024
17.0.2 29 05/25/2024
17.0.1 22 05/25/2024
16.1.26 19 05/25/2024
16.1.22 17 05/25/2024
16.1.18 18 05/14/2024
16.1.16 15 05/01/2024
16.1.13 26 05/03/2024
16.1.12 21 05/07/2024
16.1.9 22 05/22/2024
16.1.4 18 05/23/2024
16.0.8 18 05/06/2024
16.0.7 24 05/13/2024
16.0.6 23 05/13/2024
16.0.5 24 05/19/2024
16.0.4 21 05/02/2024
16.0.3 24 05/15/2024
16.0.2 22 05/10/2024
16.0.1 19 05/21/2024
15.0.1 16 05/20/2024
14.0.13 19 05/06/2024
14.0.12 20 05/06/2024
14.0.11 24 05/10/2024
14.0.10 21 05/14/2024
14.0.9 20 05/11/2024
14.0.7 18 05/25/2024
14.0.6 20 05/10/2024
14.0.5 22 05/24/2024
14.0.4 19 05/25/2024
14.0.3 17 05/21/2024
13.2.32 18 05/25/2024
13.2.31 21 05/19/2024
13.2.9 21 05/09/2024
13.2.7 20 05/05/2024
13.2.5 17 05/08/2024
13.2.4 18 05/06/2024
13.2.3 21 05/16/2024
13.0.1 19 05/14/2024
12.2.26 15 05/25/2024
12.2.25 21 05/25/2024
12.2.7 25 05/25/2024
12.2.4 20 04/30/2024
12.2.1 20 05/25/2024
12.1.11 26 05/08/2024
12.1.2 19 05/07/2024
12.0.7 20 05/16/2024
12.0.2 28 05/25/2024
11.0.18 25 05/25/2024
11.0.17 25 05/25/2024
11.0.16 18 05/18/2024
11.0.13 24 05/31/2024
11.0.11 23 05/03/2024
11.0.9 15 05/10/2024
11.0.7 22 04/26/2022
11.0.5 16 05/25/2024
11.0.4 21 04/26/2022
11.0.2 17 05/19/2024
10.0.9 17 05/22/2024
10.0.8 22 05/01/2024
10.0.6 22 05/13/2024
10.0.5 19 05/01/2024
10.0.4 18 05/25/2024
9.0.6 24 05/18/2024
9.0.4 22 05/14/2024
9.0.3 22 05/25/2024
9.0.2 24 05/09/2024
8.1.1 21 05/23/2024
8.0.3 21 05/22/2024
7.1.4 23 05/23/2024
7.1.1 26 05/11/2024
7.0.15 18 05/21/2024
6.0.36 24 05/13/2024
6.0.34 20 05/07/2024
6.0.27 23 05/09/2024
6.0.25 21 05/25/2024
6.0.23 18 05/01/2024
6.0.21 22 05/02/2024
6.0.17 22 05/21/2024
6.0.14 18 05/25/2024
6.0.13 26 05/04/2024
6.0.7 22 05/25/2024
6.0.6 20 05/13/2024
6.0.5 24 05/19/2024
6.0.3 20 05/15/2024
6.0.1 24 04/26/2022
4.2.15 18 05/25/2024
4.2.12 20 05/08/2024
4.2.9 23 05/22/2024
4.2.8 28 05/14/2024
4.1.6 18 05/10/2024
3.1.1 22 05/25/2024
3.0.2 21 05/25/2024
2.2.10-beta 19 04/23/2024
2.2.9-beta 18 05/02/2024
2.2.4-beta 20 05/17/2024
2.2.2-beta 24 04/24/2024
2.1.0.247 21 05/25/2024
2.1.0.237 22 05/25/2024
2.1.0.236 21 05/25/2024
2.1.0.235 17 05/25/2024
2.1.0.234 19 05/25/2024
2.1.0.231 24 05/25/2024
2.1.0.230 17 05/03/2024
2.1.0.229 20 05/25/2024
2.1.0.227 17 05/25/2024
2.1.0.226 17 05/04/2024
2.1.0.217 17 05/02/2024
2.1.0.216 18 05/11/2024
2.1.0.215 19 05/20/2024
2.1.0.214 18 05/25/2024
2.1.0.213 22 05/25/2024
2.1.0.211 21 05/25/2024
2.1.0.210 19 05/06/2024
2.1.0.209 17 05/11/2024
2.1.0.208 16 05/07/2024
2.1.0.207 19 05/25/2024
2.1.0.206 15 05/25/2024
2.1.0.204 20 05/25/2024
2.1.0.203 16 05/04/2024
2.1.0.202 18 05/25/2024
2.1.0.201 21 05/25/2024
2.1.0.193 19 05/14/2024
2.1.0.189 19 04/26/2022
2.1.0.187 25 05/07/2024
2.1.0.186 19 05/25/2024
2.1.0.184 18 05/25/2024
2.1.0.183 14 05/11/2024
2.1.0.182 21 05/25/2024
2.1.0.181 20 05/25/2024
2.1.0.180 20 05/25/2024
2.1.0.179 20 05/08/2024
2.1.0.178 16 05/06/2024
2.1.0.177 22 05/02/2024
2.1.0.176 20 05/25/2024
2.1.0.175 19 05/16/2024
2.1.0.174 18 05/09/2024
2.1.0.173 18 04/26/2022
2.1.0.171 19 05/25/2024
2.1.0.170 22 05/25/2024
2.1.0.168 17 05/02/2024
2.1.0.164 18 05/02/2024
2.1.0.159 22 05/25/2024
2.0.0.144 25 05/04/2024
2.0.0.143 18 05/25/2024
2.0.0.142 17 05/25/2024
2.0.0.141 19 05/09/2024
2.0.0.140 20 05/19/2024
2.0.0.139 21 05/25/2024
2.0.0.138 18 05/25/2024
2.0.0.136 18 05/25/2024
2.0.0.124 26 04/09/2024
2.0.0.120 16 05/16/2024
2.0.0.119 19 05/21/2024
2.0.0.118 19 05/24/2024
2.0.0.117 24 05/25/2024
2.0.0.115 18 05/25/2024
2.0.0.113 20 05/25/2024
2.0.0.111 21 05/25/2024
2.0.0.110 20 04/26/2022
2.0.0.109 21 04/26/2022
2.0.0.108 21 05/25/2024
2.0.0.107 21 04/10/2024
2.0.0.106 21 05/25/2024
2.0.0.105 16 05/19/2024
2.0.0.104 20 04/26/2022
2.0.0.103 24 05/25/2024
2.0.0.102 21 05/12/2024
2.0.0.101 19 04/26/2022
2.0.0.100 29 04/09/2024
2.0.0.98 18 04/09/2024
1.4.0.93 19 05/20/2024
1.4.0.92 22 05/02/2024
1.4.0.89 17 05/25/2024
1.4.0.88 24 05/07/2024
1.4.0.87 17 05/09/2024
1.4.0.86 17 05/08/2024
1.4.0.85 20 05/01/2024
1.4.0.84 24 05/09/2024
1.4.0.83 21 05/10/2024
1.4.0.82 22 05/21/2024
1.4.0.81 18 05/21/2024
1.4.0.80 17 05/12/2024
1.4.0.79 21 05/01/2024
1.4.0.78 22 05/04/2024
1.4.0.77 23 05/25/2024
1.4.0.76 20 05/10/2024
1.4.0.75 20 05/19/2024
1.4.0.74 19 05/02/2024
1.4.0.73 20 05/25/2024
1.4.0.72 24 05/09/2024
1.4.0.71 19 05/25/2024
1.4.0.70 21 05/10/2024
1.4.0.69 16 05/25/2024
1.4.0.68 25 05/25/2024
1.4.0.67 19 05/23/2024
1.4.0.66 22 05/02/2024
1.4.0.65 21 05/25/2024
1.4.0.64 23 05/08/2024
1.4.0.63 21 05/14/2024
1.4.0.62 19 05/25/2024
1.4.0.61 20 05/07/2024
1.4.0.60 22 05/18/2024
1.4.0.59 16 05/21/2024
1.4.0.58 21 05/13/2024
1.4.0.57 18 05/18/2024
1.4.0.56 24 05/01/2024
1.4.0.55 17 05/16/2024
1.4.0.54 21 05/17/2024
1.4.0.53 21 05/11/2024
1.4.0.52 18 05/25/2024
1.4.0.51 22 05/17/2024
1.4.0.50 19 05/25/2024
1.4.0.49 21 05/25/2024
1.4.0.48 25 05/22/2024
1.4.0.47 24 05/14/2024
1.4.0.46 22 05/15/2024
1.4.0.45 23 05/06/2024
1.4.0.44 20 05/02/2024
1.4.0.43 21 05/09/2024
1.4.0.42 22 05/16/2024
1.4.0.41 20 05/07/2024
1.4.0.40 19 05/23/2024
1.4.0.39 20 05/19/2024
1.4.0.38 23 05/09/2024
1.4.0.37 23 05/25/2024
1.4.0.36 23 05/14/2024
1.4.0.35 19 05/05/2024
1.4.0.34 24 05/02/2024
1.4.0.33 21 05/23/2024
1.4.0.32 22 05/25/2024
1.4.0.31 22 05/07/2024
1.4.0.30 23 05/24/2024
1.4.0.29 24 05/25/2024
1.4.0.28 20 05/25/2024
1.4.0.27 21 05/25/2024
1.4.0.26 20 05/25/2024
1.4.0.25 22 05/15/2024
1.4.0.24 20 05/19/2024
1.4.0.23 23 05/25/2024
1.4.0.22 18 05/17/2024
1.4.0.21 25 05/24/2024
1.4.0.20 32 04/09/2024
1.4.0.19 24 05/23/2024
1.4.0.18 19 05/18/2024
1.4.0.17 22 05/06/2024
1.4.0.14 19 05/25/2024
1.4.0.12 18 05/25/2024
1.4.0.11 19 05/15/2024
1.2.0 19 05/25/2024