ProfileSharp.Store.FileStore 7.0.0.3-prerelease

ProfileSharp was built to allow developers to quickly test on their local machines and automate unit tests without manually generating a large amount of mock data. ProfileSharp provides an easy way to collect mock data and enable its use within your domain.

NOTE: This is an early proof of concept and could change as it matures.

Planned Features

• Automatic Unit Test Generation and Execution at Runtime within your unit tests based on profiled data.

Drawbacks

• Mock data can only be collected at runtime.
• If the signature of a mocked method changes it will no longer be compatible with preivously profiled mocking data.
• Random data is not supported in unit tests. (This may be resolved with an Attribute or alternative means in the future)
• Mocking is currently only supported within an AspNet runtime.
• Only methods and properties can profiled/mocked.

How?

Install the ProfileSharp.AspNetCore package from nuget.

In your Startup.cs call the following methods.

public void ConfigureServices(IServiceCollection services)
{
	services.AddProfileSharp(config =>
	{
		config.AddProfiling(o => o.UseFileStore(@"D:\#temp\ProfilingStore"));
		config.AddMocking(o => o.UseFileStore(@"D:\#temp\ProfilingStore"));

		if(env.IsDevelopment())
		{
			// Enable Mocking Mode, when this mode is set ProfileSharp will mock the
			// specified parts of your domain.
			config.SetMode(ProfileSharpMode.Mocking);
		}
		else if(env.IsStaging())
		{
			// Enable Profiling Mode, when this mode is set ProfileSharp will profile the
			// specified parts of your domain.
			config.SetMode(ProfileSharpMode.Profiling);
		}
	});
}

If your project is using NServiceBus

Install the ProfileSharp.NServiceBus package from nuget.

When configuration your EndpointConfiguration call the following methods

endpointConfiguration.UseProfileSharp();

ProfileSharp Attributes

For ProfileSharp to work, you must specify what parts of your domain will be intercepted. This is done using the EnableProfileSharpAttribute.

[EnableProfileSharp]
public interface IStudentRepository
{
	Task CreateAsync(StudentModel student);

	Task<StudentModel> GetAsync(Guid studentId);

	Task DeleteAsync(Guid studentId);
}

You can also only enable ProfileSharp for specific methods.

public interface IStudentRepository
{
	// This method will not intercepted.
	Task CreateAsync(StudentModel student);

	[EnableProfileSharp]
	Task<StudentModel> GetAsync(Guid studentId);

	// This method will not intercepted.
	Task DeleteAsync(Guid studentId);
}

Or disable ProfileSharp for specific methods.

[EnableProfileSharp]
public interface IStudentRepository
{
	Task CreateAsync(StudentModel student);
	
	Task<StudentModel> GetAsync(Guid studentId);

	// This method will not intercepted.
	[DisableProfileSharp]
	Task DeleteAsync(Guid studentId);
}

Releases

Package	Downloads	NuGet
ProfileSharp
ProfileSharp.AspNetCore
ProfileSharp.NServiceBus
ProfileSharp.Store.FileStore