Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@ngbrown
ngbrown committed Aug 20, 2017
1 parent 8ef9ebf commit 3ab4538
Showing 1 changed file with 80 additions and 60 deletions.
140 changes: 80 additions & 60 deletions readme.md
View file
Original file line number Diff line number Diff line change
@@ -1,42 +1,54 @@
NHibernate.PersistenceTesting
=============================

Code based on the [testing framework in Fluent NHibernate](https://github.com/jagregory/fluent-nhibernate/tree/master/src/FluentNHibernate/Testing) and adopted to work with vanilla [NHibernate](https://github.com/nhibernate/nhibernate-core).
[![Build status](https://ci.appveyor.com/api/projects/status/keuc9vrs70gyg5wt/branch/master?svg=true)](https://ci.appveyor.com/project/ngbrown/nhibernate-persistancetesting/branch/master) [![NuGet](https://img.shields.io/nuget/v/NHibernate.PersistenceTesting.svg)](https://www.nuget.org/packages/NHibernate.PersistenceTesting/)

Documentation adapted from [Fluent NHibernate wiki](https://github.com/jagregory/fluent-nhibernate/wiki/Persistence-specification-testing).
Code based on the [testing framework in Fluent NHibernate](https://github.com/jagregory/fluent-nhibernate/tree/master/src/FluentNHibernate/Testing) and adopted to work with vanilla [NHibernate](https://github.com/nhibernate/nhibernate-core). Documentation adapted from [Fluent NHibernate wiki](https://github.com/jagregory/fluent-nhibernate/wiki/Persistence-specification-testing).

You can quickly test your mappings using the `PersistenceSpecification<T>` class. Let's start with a simple `Employee` mapping:

public class Employee
{
public virtual int Id { get; private set; }
public virtual string FirstName { get; set; }
public virtual string LastName { get; set; }
}
# Downloads

The latest release of NHibernate.PersistenceTesting is [available on NuGet](https://www.nuget.org/packages/NHibernate.PersistenceTesting/).

public class EmployeeMap : ClassMap<Employee>

# Usage

You can quickly test your mappings using the `PersistenceSpecification<T>` class. Let's start with a simple `Employee` mapping:

```cs
public class Employee
{
public virtual int Id { get; private set; }
public virtual string FirstName { get; set; }
public virtual string LastName { get; set; }
}

public class EmployeeMap : ClassMapping<Employee>
{
public EmployeeMap()
{
public EmployeeMap()
{
Id(x => x.Id);
Map(x => x.FirstName);
Map(x => x.LastName);
}
Id(x => x.Id);
Property(x => x.FirstName);
Property(x => x.LastName);
}
}
```

To test this mapping:

using FluentNHibernate.Testing;
```cs
using NHibernate.PersistenceTesting;

[Test]
public void CanCorrectlyMapEmployee()
{
new PersistenceSpecification<Employee>(session)
.CheckProperty(c => c.Id, 1)
.CheckProperty(c => c.FirstName, "John")
.CheckProperty(c => c.LastName, "Doe")
.VerifyTheMappings();
}
[Test]
public void CanCorrectlyMapEmployee()
{
new PersistenceSpecification<Employee>(session)
.CheckProperty(c => c.Id, 1)
.CheckProperty(c => c.FirstName, "John")
.CheckProperty(c => c.LastName, "Doe")
.VerifyTheMappings();
}
```

This test will:

Expand All @@ -45,66 +57,74 @@ This test will:
* retrieve the record into a new `Employee` instance
* verify the retrieved `Employee` matches the original

# Testing references

## Testing references

Let's consider an `Employee` mapping that includes a reference to a `Store`:

public class EmployeeMap : ClassMap<Employee>
```cs
public class EmployeeMap : ClassMapping<Employee>
{
public EmployeeMap()
{
public EmployeeMap()
{
Id(x => x.Id);
Map(x => x.FirstName);
Map(x => x.LastName);
References(x => x.Store);
}
Id(x => x.Id);
Property(x => x.FirstName);
Property(x => x.LastName);
ManyToOne(x => x.Store);
}
}
```

When verifying mappings, the `Object.Equals()` method is used to compare the retrieved values to the inserted values. This works as expected for primitive types and types that override `Object.Equals()`. For all other types, such as our `Store` class, the default implementation of `Object.Equals()` checks that both values point to the same instance of the object. We will always have different instances because the test flushes and clears the session cache after inserting the record. Instead, we want to verify the correct `Store` was loaded by comparing the Store's `Id` (and possibly other properties).

The `PersistenceSpecification` constructor allows us to pass in an `IEqualityComparer` to customize how each value is compared.

[Test]
public void CanCorrectlyMapEmployee()
{
new PersistenceSpecification<Employee>(session, new CustomEqualityComparer())
.CheckProperty(c => c.Id, 1)
.CheckProperty(c => c.FirstName, "John")
.CheckProperty(c => c.LastName, "Doe")
.CheckReference(c => c.Store, new Store() {Name = "MyStore"})
.VerifyTheMappings();
}

public class CustomEqualityComparer: IEqualityComparer
```cs
[Test]
public void CanCorrectlyMapEmployee()
{
new PersistenceSpecification<Employee>(session, new CustomEqualityComparer())
.CheckProperty(c => c.Id, 1)
.CheckProperty(c => c.FirstName, "John")
.CheckProperty(c => c.LastName, "Doe")
.CheckReference(c => c.Store, new Store() {Name = "MyStore"})
.VerifyTheMappings();
}

public class CustomEqualityComparer: IEqualityComparer
{
public bool Equals(object x, object y)
{
public bool Equals(object x, object y)
if (x == null || y == null)
{
if (x == null || y == null)
{
return false;
}
if (x is Store && y is Store)
{
return ((Store) x).Id == ((Store) y).Id;
}
return x.Equals(y);
return false;
}

public int GetHashCode(object obj)
if (x is Store && y is Store)
{
throw new NotImplementedException();
return ((Store) x).Id == ((Store) y).Id;
}
return x.Equals(y);
}

public int GetHashCode(object obj)
{
throw new NotImplementedException();
}
}
```

Note that, in order for `CheckReferences` to work, you either need to pass an already persistence entity, or have cascading on the entities you're testing. Otherwise, the test will fail complaining "object references an unsaved transient instance".

Obviously, the sample provided here won't work because the `Store` object is transient so here you'll need `Cascading` to make the test pass (which is omitted for brevity).


# Testing lists

`CheckList` saves each element individually while `CheckComponentList` relies on cascading or the user saving.


# Contributors

For list of contributors, see [Fluent NHibernate](https://github.com/jagregory/fluent-nhibernate).

NHibernate.PersistenceTesting is &copy; 2017 [Nathan Brown](https://github.com/ngbrown) and contributors and &copy; 2008-2015 [James Gregory](http://jagregory.com) and contributors under the [BSD license](https://github.com/ngbrown/NHibernate.PersistanceTesting/blob/master/LICENSE.txt)
Expand Down

0 comments on commit 3ab4538

Please sign in to comment.