Simulatable Api

Implements several simulators for common dependencies. These abstractions make it easier to write highly-testable code.

View the Project on GitHub arlobelshee/SimulatableApi

Download binaries on NuGet

License: MIT.

Why Simulate?

Your program needs to run on several platforms or it depends on slow components (databases, files, networks, or users).

The first part of the solution is to use a Hexagonal Architecture. In this architecture, your program has 4 parts:

Your business model is the core of everything. This should contain all the domain logic for your domain. Use Domain Driven Design techniques.
Your application manipulates the business model. The manipulation code wraps your model and connects to various ports. It responds to port events by manipulating the model. It notifies ports when the model changes is ways they care about.
Ports are abstractions for external actors that your application interacts with. Examples include file systems, users, the internet, and queryable persistant storage. Some ports trigger events to which your application reacts. Some just do whatever your application tells them to do. Some do both.
Adaptors adapt a particular port to a particular external system. For example, an adaptor may adapt the user port to a GUI, while another adapts it to a batch processing system and a third adapts it to a test double.

The next step is to define a set of test cases that operate on the ports. These ensure that each adaptor for a given port behaves exactly the same—to whatever degree your application wants uniformity.

All of your system other than the adaptors and ports is now platform independent. It can be fully unit tested. The few parts of your system that depend on a port can use the simplest adaptor that will possibly work. Likely, this is an in-memory simulator or a memory-based caching adaptor. So even your integration tests will run quickly.

Platform testing is simple. You run your port test suite against on each target platform, using the adaptor for that platform. Because you run the same tests everywhere, you know that your adaptors are ensuring consistency between your platforms.

The remaining work is to continually ensure that your port tests include all behavior that your application depends on. When you need more out of a port you update the suite for that port to include the new behavior. You then extend all the adaptors to pass the new tests.

Why use this library?

As I've used this architecture and testing pattern on several projects, I've found certain ports come up over and over. I finally got around to extracting them so that I could share them between projects. If you find similar patterns, I invite you to use my simulators.

Note: different applications require different types of uniformity in their ports. So some of these implementations may not work for your project. I think they're a good starting point. These ports have proven to be good abstractions in numerous projects. However, I do expect that you'll modify them some to fit each particular project.

Simulatable API binaries are available on NuGet for those who can use the port abstractions as-is. I've released the source for those who need to modify the abstractions to fit their domains.

What ports can I expect in this library?

My first release contains only one port, and only two adaptors. I will add more ports and adpators over time. Here is the list of planned ports, with a description of each. I'll add full documentation for each as I add it to the library.

File System
This port is a transactional view on an arbitrary storage medium. There are two adaptors. One is backed by a file system. The other is backed by memory. I may eventually add an adaptor for an async read- & write-through cache.
Structured Data Store (not implemented yet)
This port is a view of a structured data store. It supports both Queryable Repository and Loader/Saver patterns for interaction with the store. There will be adaptors for an in-memory non-persitent caching store and for Sql Server. I may add adaptors for other data stores over time.
Time (not implemented yet)
This port manages time. Adaptors will include wall-clock time, simuation frame time, and event sequence time. There are numerous other definitions of time; I may add adaptors for them eventually.
User Interaction (not implemented yet)
This port represents interaction with the user. The first three adaptors will be for WPF, a DSL for batch files or other automation, and a test adaptor. The test adaptor makes it easy to force the system to an initial state and provides low-level control. The automation adaptor allows the aplication to present abstractions that make it easier to write automation scripts.
Internet (not implemented yet)
This is a generic port that represents the internet as a whole. Initial adaptors will be for async HTTP and for an in-memory internet cache.
Remote Service (not implemented yet)
This port represents a single remote service. Usage examples include a credit-card processing service or a read-write REST API. Initial adaptors will include an adaptor that connects to the live service, one that connects to a testing or pre-production service, and one that provides canned responses to canned operations. This port differs from the others in that it is designed to be tested in an approval style and be incorporated into your site monitoring. It protects you against unexpected changes in a third-party service that will affect your product.
Parallel Computation (not implemented yet)
This port represents parallelism. its purpose is to allow you to code with high-level APIs (Task, PLinq, etc), but still break that abstraction in test code so that you can force a particular execution order. This helps when trying to pin down race conditions or deadlocks. This port depends heavily on the Time port.
.Net Platform (not implemented yet)
This port abstracts over the .Net runtime in use. Adaptors will exist for Azure, Windows Client, Windows Server, Phone, Silverlight, and WindowsRT. This port will eventually get very large. This is not at attempt to create a full common subset for these platforms. You will still need to compile your code differently for each one. However, it should abstract away platform differences such as Reflection semmantics.

File System

This port represents a transactional view on an arbitrary storage medium.

The port's core class is FileSystem.

There are three ways to get a FileSystem. The first two, FileSystem.Real() and FileSystem.Simulated(), return a new view wrapped around some storage.

The last, FileSystem.Clone(), creates a view from another view. The two views share the same underlying storage but each has its own change tracking and undo facilities.

This is not your typical files and directories API.

There is a single instance that represents the entire file system; file and directory objects are bound to a file system.

All the instances related to a single file system share consistent state. If you create two file objects pointing to the same path in a particular file system and then write to one, you will immediately see the changes in the second.

Clones are guaranteed to share consistent state. They only difference is where their last savepoint is.

No promise is made about consistency between multiple FileSystems unless they are clones of each other. For example, the in-memory adaptor has disjoint state between FileSystem instances. The on disk adaptor shares state between separate FileSystem instances.

For this reason, I recommend that you only create one adaptor instance. If you need multiple views then clone your instance. Do not create a new, unrelated instance.