MockFs

FileSystem for simulating IOExceptions

License	The Apache Software License, Version 2.0
GroupId	com.aerse
ArtifactId	mockfs
Last Version	1.4
Release Date	Jun 21, 2020
Type	jar
Description	MockFs FileSystem for simulating IOExceptions
Project URL	https://github.com/dernasherbrezon/mockfs
Source Code Management	https://github.com/dernasherbrezon/mockfs

Download mockfs

Filename	Size
mockfs-1.4.pom
mockfs-1.4.jar	12 KB
mockfs-1.4-sources.jar	6 KB
mockfs-1.4-javadoc.jar	417 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.aerse/mockfs/ -->
<dependency>
    <groupId>com.aerse</groupId>
    <artifactId>mockfs</artifactId>
    <version>1.4</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.aerse/mockfs/
implementation 'com.aerse:mockfs:1.4'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.aerse/mockfs/
implementation ("com.aerse:mockfs:1.4")

Apache Buildr

'com.aerse:mockfs:jar:1.4'

Apache Ivy

<dependency org="com.aerse" name="mockfs" rev="1.4">
  <artifact name="mockfs" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.aerse', module='mockfs', version='1.4')
)

Scala SBT

libraryDependencies += "com.aerse" % "mockfs" % "1.4"

Leiningen

[com.aerse/mockfs "1.4"]

Dependencies

test (1)

Group / Artifact	Type	Version
junit : junit	jar	4.10

Project Modules

There are no modules declared in this project.

About

Java FileSystem for simulating IOExceptions

Usage

1. Add maven dependency:

<dependency>
  <groupId>com.aerse</groupId>
  <artifactId>mockfs</artifactId>
  <version>1.4</version>
</dependency>

2. Ensure code is ready

• Ensure java.nio.file.Path is used instead of java.io.File. FileSystem is available only for Path.
• Ensure Path::resolve(...) is used instead of java.nio.file.Paths.get(...) or Path::of(...). The latter uses FileSystems.getDefault() instead of mocked
• All Path should be created from the FileSystem using FileSystem::getPath(...) method.

3. Setup the test

For example:

	@Test(expected = IOException.class)
	public void testFailingWrite() throws IOException {
		byte[] data = createSampleData();
		Path path = basePath.resolve(UUID.randomUUID().toString());
		mockFs.mock(path, new FailingByteChannelCallback(5));
		try (OutputStream w = Files.newOutputStream(path)) {
			w.write(data);
		}
	}

Features

• MockFileSystem could transparently pass the data to the default FileSystem. Just use com.aerse.mockfs.NoOpByteChannelCallback:

   	FileSystem fs = FileSystems.getDefault();
   	MockFileSystem mockFs = new MockFileSystem(fs);
   	mockFs.mock(path, new NoOpByteChannelCallback());

• Use com.aerse.mockfs.FailingByteChannelCallback for simulating IOExceptions after configurable number of bytes.
• Mock read/write to every file in the directory. Just pass this directory to the com.aerse.mockfs.MockFileSystem::mock(directoryToMock, ...)

Versions

Version
1.4 Jun 21, 2020
1.2 Oct 27, 2019
1.1 Apr 20, 2019