patterns & practices: Repository Factory

Updated Wiki: TestingResults

lerocha — Tue, 07 Oct 2008 00:26:42 GMT

Testing Results - Change Set 23234

Area	SQL Server	Oracle
Recipe - Specify project responsibility	Passed	Passed
Recipe - Add database connection	Passed	Failed (WI#11418)
Recipe - Create CRUD stored procedures	Passed	Blocked (WI#11418)
Recipe - Create business entities from database (C#)	Passed	Blocked (WI#11418)
Recipe - Create data repository classes (C#)	Passed	Blocked (WI#11418)
Recipe - Create data repository classes from business Recipe entities (C#)	Passed	Blocked (WI#11418)
Executing Insert (C#)	Passed	Blocked (WI#11418)
Executing GetAll (C#)	Passed	Blocked (WI#11418)
Executing GetOne (C#)	Failed (WI#11414)	Blocked (WI#11418)
Executing Update (C#)	Passed	Blocked (WI#11418)
Executing Delete (C#)	Passed	Blocked (WI#11418)
Recipe - Specify project responsibility	Failed (WI#11415)	Failed (WI#11415)
Recipe - Create business entities from database (VB)	Passed	Blocked (WI#11415, WI#11418)
Recipe - Create data repository classes (VB)	Blocked (WI11415)	Blocked (WI#11415, WI#11418)
Recipe - Create data repository classes from business entities (VB)	Blocked (WI11415)	Blocked (WI#11415, WI#11418)
Executing Insert (VB)	Blocked (WI11415)	Blocked (WI#11415, WI#11418)
Executing GetAll (VB)	Blocked (WI11415)	Blocked (WI#11415, WI#11418)
Executing GetOne (VB)	Blocked (WI11415)	Blocked (WI#11415, WI#11418)
Executing Update (VB)	Blocked (WI11415)	Blocked (WI#11415, WI#11418)
Executing Delete (VB)	Blocked (WI11415)	Blocked (WI#11415, WI#11418)

Updated Wiki: TestingResults

lerocha — Tue, 07 Oct 2008 00:17:38 GMT

Testing Results - Change Set 23234

Area	SQL Server	Oracle
Recipe - Specify project responsibility	Passed	Passed
Recipe - Add database connection	Passed	Failed: Work Item #11418
Recipe - Create CRUD stored procedures	Passed	Blocked by Work Item #11418
Recipe - Create business entities from database (C#)	Passed	Blocked by Work Item #11418
Recipe - Create data repository classes (C#)	Passed	Blocked by Work Item #11418
Recipe - Create data repository classes from business Recipe entities (C#)	Passed	Blocked by Work Item #11418
Executing Insert (C#)	Passed	Blocked by Work Item #11418
Executing GetAll (C#)	Passed	Blocked by Work Item #11418
Executing GetOne (C#)	Failed: Work Item #11414	Blocked by Work Item #11418
Executing Update (C#)	Passed	Blocked by Work Item #11418
Executing Delete (C#)	Passed	Blocked by Work Item #11418
Recipe - Specify project responsibility	Failed: Work Item #11415	Failed: Work Item #11415
Recipe - Create business entities from database (VB)	Passed	Blocked by Work Item #11418
Recipe - Create data repository classes (VB)	Blocked by Work Item #11415	Blocked by Work Item #11418
Recipe - Create data repository classes from business entities (VB)	Blocked by Work Item #11415	Blocked by Work Item #11418
Executing Insert (VB)	Blocked by Work Item #11415	Blocked by Work Item #11418
Executing GetAll (VB)	Blocked by Work Item #11415	Blocked by Work Item #11418
Executing GetOne (VB)	Blocked by Work Item #11415	Blocked by Work Item #11418
Executing Update (VB)	Blocked by Work Item #11415	Blocked by Work Item #11418
Executing Delete (VB)	Blocked by Work Item #11415	Blocked by Work Item #11418

Updated Wiki: Home

lerocha — Mon, 06 Oct 2008 23:58:59 GMT

Welcome to the Repository Factory

The Repository Factory is a guidance package that automates creation of entity classes that map to database tables and repository classes to read and write those entity classes. The generated code removes the tedium of writing a persistence-ignorant domain model.

This package was originally published as the "Data Access Guidance Package" as part of the Web Service Software Factory. Data access is a much larger problem space than just services, so we've decided to split this package out into its own project.

News

p&p has completed development. The source code is available here

Goals

The Repository Factory is not intended to be a be-all-does-everything ORM solution. Instead, it's a lightweight code generator that automates most of the hand-coding needed to build domain model object and persist them to a database.

Information for Developers

Contribute

The Repository Factory is currently looking for project members! Please join the discussion on the message boards and volunteer!

Created Issue: Adding database connection

lerocha — Mon, 06 Oct 2008 23:23:59 GMT

When using Oracle database, the connection created by the "Adding database connection" recipe is invalid.

STEPS
1. Install the Oracle test database from: http://www.codeplex.com/ChinookDatabase/Release/ProjectReleases.aspx?ReleaseId=16370

2. Open the VS solution from the attached file.

3. Right-click on the DataAccessCS project and select "Repository Factory", and then "Add database connection".

4. Enter a connection name and click on the connection string button.

5. Select Oracle Database as data source and click on OK.

6. Enter the Server name (xe), user name (chinook), and password (p4ssw0rd), and click on OK.

RESULTS

The recipe generates the following connection string:

<add name="MyConnection" connectionString="Data Source=xe;User ID=chinook;Password=p4ssw0rd;Unicode=True" providerName="System.Data.SqlClient" />

The provider name is incorrect and other recipes will fail when trying to use this connection.

Created Issue: Missing Recipes to Create Data Repository Classes in VB.NET

lerocha — Mon, 06 Oct 2008 22:03:46 GMT

After setting the a VB.NET project as a Data Access Project, the recipes to create Data Repository classes are not available.

This issue was identified using the Test Plan: http://www.codeplex.com/RepositoryFactory/Wiki/View.aspx?title=TestPlan

STEPS

1. Extract and open the VS 2005 solution from the attached file.

2. Right click on the DataAccessVB project, and select "Specify Project Responsibility".

3. Select all responsibilities.

4. Right click on the DataAccessVB project, and verify the list of available recipes.

RESULTS

The following recipes are missing:
1. Create data repository classes (VB)
2. Create data repository classes from business entities (VB)

EXPECTED

The recipes to create data repository classes to be available in the context-menu.

Created Issue: Get One generated code throws SqlException

lerocha — Mon, 06 Oct 2008 21:36:50 GMT

After running the Get One recipe the generated code compiles fine but there is an error when executing Get One operations.

This issue is related to the Get One changes to use the new ISimpleDomainObjectFactory interface. It seems that the Get One stored procedures need to be changed to specify OUT or IN/OUT parameters for each parameter that would otherwise have been columns in the cursor. See ThreadId=32194.

STEPS

1. Download and install the test database (SQL Server version) from: http://www.codeplex.com/ChinookDatabase/Release/ProjectReleases.aspx

2. Create the CRUD stored procedures by running the from the attached file. At the Command Prompt window, run:
osql -E -S .\sqlexpress -d Chinook -i StoredProcedures.sql

3. Open the VS2005 solution from the attached file, build it and run the unit tests.

If you want to create this solution manually, you can follow the test plan:
http://www.codeplex.com/RepositoryFactory/Wiki/View.aspx?title=TestPlan

RESULTS

Running unit test of test plan results in:

System.Data.SqlClient.SqlException: Procedure or Function 'GetAlbumByAlbumId' expects parameter '@albumId', which was not supplied.
at System.Data.SqlClient.SqlConnection.OnError(SqlException exception, Boolean breakConnection)
at System.Data.SqlClient.SqlInternalConnection.OnError(SqlException exception, Boolean breakConnection)
at System.Data.SqlClient.TdsParser.ThrowExceptionAndWarning(TdsParserStateObject stateObj)
at System.Data.SqlClient.TdsParser.Run(RunBehavior runBehavior, SqlCommand cmdHandler, SqlDataReader dataStream, BulkCopySimpleResultSet bulkCopyHandler, TdsParserStateObject stateObj)
at System.Data.SqlClient.SqlCommand.FinishExecuteReader(SqlDataReader ds, RunBehavior runBehavior, String resetOptionsString)
at System.Data.SqlClient.SqlCommand.RunExecuteReaderTds(CommandBehavior cmdBehavior, RunBehavior runBehavior, Boolean returnStream, Boolean async)
at System.Data.SqlClient.SqlCommand.RunExecuteReader(CommandBehavior cmdBehavior, RunBehavior runBehavior, Boolean returnStream, String method, DbAsyncResult result)
at System.Data.SqlClient.SqlCommand.InternalExecuteNonQuery(DbAsyncResult result, String methodName, Boolean sendToPipe)
at System.Data.SqlClient.SqlCommand.ExecuteNonQuery()
at Microsoft.Practices.EnterpriseLibrary.Data.Database.DoExecuteNonQuery(DbCommand command)
at Microsoft.Practices.EnterpriseLibrary.Data.Database.ExecuteNonQuery(DbCommand command)
at Microsoft.Practices.Repository.Repository`1.FindOne<TIdentity>(ISelectionFactory`1 selectionFactory, ISimpleDomainObjectFactory`1 domainObjectFactory, TIdentity identity)
at DataAccess.AlbumRepositoryArtifacts.AlbumRepository.GetAlbumByAlbumId(Int32 albumId) in AlbumRepository.cs: line 56
Microsoft.Practices.Repository.RepositoryFailureException: Unexpected error occurred in the database server
at DataAccess.AlbumRepositoryArtifacts.AlbumRepository.HandleSqlException(SqlException ex, IDbToBusinessEntityNameMapper mapper) in AlbumRepository.cs: line 124
at DataAccess.AlbumRepositoryArtifacts.AlbumRepository.GetAlbumByAlbumId(Int32 albumId) in AlbumRepository.cs: line 60
at RepositoryFactoryTestApp.Tests.RepositoryTests.Album_CRUD() in RepositoryTests.cs: line 68

Updated Wiki: TestPlan

lerocha — Wed, 01 Oct 2008 21:00:32 GMT

Test Plan

The Repository Factory is tested by automated and manual tests.

Automated tests were developed using NUnit and they cover unit tests and compilation of T4 templates.
Manual tests consist of running the Repository Factory Guidance Package using the provided test project and sample databases, and running the NUnit tests of the test project.

Automated Testing

The Repository Factory is currently using NUnit as the unit testing framework. The original source code drop from Microsoft was using Microsoft Tests (only supported in Visual Studio Team System edition). The reason to change to NUnit is to allow developers using other editions of Visual Studio to write and run their unit tests. Also, NUnit is a widely adopted testing framework and it is supported by other tools such as Resharper.

Developers and Unit Tests

Developers should write unit tests. This is the only way to make sure the code you write is tested and working as you intended. A good set of units tests will allow you and other developers to change and refactor existing code without breaking existing functionality.
Before checking in your code changes, make sure to run all unit tests and verify that they are passing.

Unit Testing Areas

The Repository Factory can be basically divided into three areas of unit testing:

Class Libraries: class libraries are used internally to generate the code (text template transformation) and externally by the client applications (Repository base classes). These libraries can and should be unit tested.
T4 Templates: T4 templates were originally manually tested. However, new unit tests were created to test that T4 files are syntax error free, e.g. they compile. When changing existing T4 files, run their unit tests to verify they have no compilation errors.
UI: the user interface uses the GAT recipes and are currently manually tested.

Manual Testing

Test Projects

The testing solutions are located under the Repository Factory source code at:

$/RespositoryFactory/Trunk/Source/RepositoryFactoryTestingSolutions/RepositoryFactoryTestCS.sln
$/RespositoryFactory/Trunk/Source/RepositoryFactoryTestingSolutions/RepositoryFactoryTestVB.sln

These solutions are available as of change set # 23234.

Testing Database

The following database servers are required for this test plan:

SQL Server Express (already installed with Visual Studio).
Oracle Database 10g Express Edition (XE).

We are using the Chinook Sample Database which provide scripts for SQL Server and Oracle:

Download and install the latest Chinook Database.

Test Plan

The following test plan should be performed in 4 runs:

C# Project using SQL Server Database
C# Project using Oracle Database
VB Project using SQL Server Database
VB Project using Oracle Database

Test Plan Steps

Restore the Test project.
Run the Specify project responsibility Recipe.

Right click on the DataAccessCS/DataAccessVB and select Specify project responsibility.
Select all three responsibility options and press OK.
Verify that all recipes are available on the context menu.

Run the Add database connection Recipe.

Name the connection as MyConnection (needed in order to run the unit tests below).
Use the Chinook database created on the Testing Database section above.
Verify that app.config was created with the connection string was added.

Run the Create CRUD stored procedures Recipe.

Select MyConnection as connection name and click on Next.
Select all database tables and accept all default settings.
Execute the generated SQL script in order to create the stored procedures. In SQL Server, you can execute it by opening a command prompt window and running: osql -E -S .\sqlexpress -i StoredProcedures.sql -d "Chinook".

Run the Create business entities from database Recipe.

Select MyConnection as connection name and click on Next.
Leave the default namespace and click on Next.
Select all tables available and click on Next, and then on Finish.
Compile the solution to verify that there are no errors.

Run the Create data repository classes from business entities Recipe.

Select MyConnection as connection name and click on Next twice.
Select all business entities created on the previous step and click on Next.
Select the Album entity and click on Add... / Get One.
Select the GetAlbumByAlbumId stored procedure, and click on Next and Finish.
Click on Finish to end the recipe.
Compile the solution to verify that there are no errors.

Run the solution Unit Tests

On the DataAccess.Test project, click on the RepositoryTests.cs file and change its property Build Action to Compile.
Make sure your connection name is MyConnection, if not rename it on your app.config or change it on RepositoryTests class.
Rebuild the solution and run all unit tests.

Source code checked in, #23234

lerocha — Wed, 01 Oct 2008 20:55:34 GMT

Adding solution for testing the Repository Factory.

Updated Wiki: TestPlan

lerocha — Wed, 01 Oct 2008 18:23:59 GMT

Test Plan

The Repository Factory is tested by automated and manual tests.

Automated tests were developed using NUnit and they cover unit tests and compilation of T4 templates.
Manual tests consist of running the Repository Factory Guidance Package using the provided test project and sample databases, and running the NUnit tests of the test project.

Automated Testing

Developers and Unit Tests

Developers should write unit tests. This is the only way to make sure the code you write is tested and working as you intended. A good set of units tests will allow you and other developers to change and refactor existing code without breaking existing functionality.
Before checking in your code changes, make sure to run all unit tests and verify that they are passing.

Unit Testing Areas

The Repository Factory can be basically divided into three areas of unit testing:

Class Libraries: class libraries are used internally to generate the code (text template transformation) and externally by the client applications (Repository base classes). These libraries can and should be unit tested.
T4 Templates: T4 templates were originally manually tested. However, new unit tests were created to test that T4 files are syntax error free, e.g. they compile. When changing existing T4 files, run their unit tests to verify they have no compilation errors.
UI: the user interface uses the GAT recipes and are currently manually tested.

Manual Testing

Test Projects

The following projects are used for manual testing of the Repository Factory:

TODO: Add link to test project here

Testing Database

The following database servers are required for this test plan:

SQL Server Express (already installed with Visual Studio).
Oracle Database 10g Express Edition (XE).

We are using the Chinook Sample Database which provide scripts for SQL Server and Oracle:

Download and install the latest Chinook Database.

Test Plan

The following test plan should be performed in 4 runs:

C# Project using SQL Server Database
C# Project using Oracle Database
VB Project using SQL Server Database
VB Project using Oracle Database

Test Plan Steps

Restore the Test project.
Run the Specify project responsibility Recipe.

Right click on the RepositoryFactoryTestApp and select Specify project responsibility.
Select all three responsibility options and press OK.
Verify that all recipes are available on the context menu.

Run the Add database connection Recipe.

Name the connection as MyConnection (needed in order to run the unit tests below).
Verify that app.config was created with the connection string was added.

Run the Create CRUD stored procedures Recipe.

Execute the generated SQL script in order to create the stored procedures. You can execute it by opening a command prompt window and run: osql -E -S .\sqlexpress -i StoredProcedures.sql -n "RepositoryFactoryDB".

Run the Create business entities from database Recipe.

Select all tables available.
Compile the solution to verify that there are no errors.

Run the Create data repository classes from business entities Recipe.

Select all business entities created on the previous step.
Compile the solution to verify that there are no errors.

Run the solution Unit Tests

Click on the RepositoryTests.cs file and change its property Build Action to Compile.
Make sure your connection name is MyConnection, if not rename it on your app.config or change it on RepositoryTests class.
Rebuild the solution and run all unit tests.

Updated Wiki: TestPlan

lerocha — Wed, 01 Oct 2008 17:33:19 GMT

Test Plan

This document describes a simple test plan to be executed for testing the Repository Factory functionality.

This test plan consists of running the Repository Factory Guidance Package on our test projects with the sample databases.

Test Projects

The following projects are used for manual testing of the Repository Factory:

TODO: Add link to test project here

Testing Database

TODO: Add instructions to how to create the testing database

Test Plan

The following test plan should be performed in 4 runs:

C# Project using SQL Server Database
C# Project using Oracle Database
VB Project using SQL Server Database
VB Project using Oracle Database

Test Plan Steps

Restore the Test project.
Run the Specify project responsibility Recipe.

Right click on the RepositoryFactoryTestApp and select Specify project responsibility.
Select all three responsibility options and press OK.
Verify that all recipes are available on the context menu.

Run the Add database connection Recipe.

Name the connection as MyConnection (needed in order to run the unit tests below).
Verify that app.config was created with the connection string was added.

Run the Create CRUD stored procedures Recipe.

Execute the generated SQL script in order to create the stored procedures. You can execute it by opening a command prompt window and run: osql -E -S .\sqlexpress -i StoredProcedures.sql -n "RepositoryFactoryDB".

Run the Create business entities from database Recipe.

Select all tables available.
Compile the solution to verify that there are no errors.

Run the Create data repository classes from business entities Recipe.

Select all business entities created on the previous step.
Compile the solution to verify that there are no errors.

Run the solution Unit Tests

Click on the RepositoryTests.cs file and change its property Build Action to Compile.
Make sure your connection name is MyConnection, if not rename it on your app.config or change it on RepositoryTests class.
Rebuild the solution and run all unit tests.

Updated Wiki: TestPlan

lerocha — Wed, 01 Oct 2008 17:32:20 GMT

Test Projects

The following projects are used for manual testing of the Repository Factory:

TODO: Add link to test project here

Testing Database

TODO: Add instructions to how to create the testing database

Test Plan

The following test plan should be performed in 4 runs:

C# Project using SQL Server Database
C# Project using Oracle Database
VB Project using SQL Server Database
VB Project using Oracle Database

Test Plan Steps

Restore the Test project.
Run the Specify project responsibility Recipe.

Right click on the RepositoryFactoryTestApp and select Specify project responsibility.
Select all three responsibility options and press OK.
Verify that all recipes are available on the context menu.

Run the Add database connection Recipe.

Name the connection as MyConnection (needed in order to run the unit tests below).
Verify that app.config was created with the connection string was added.

Run the Create CRUD stored procedures Recipe.

Execute the generated SQL script in order to create the stored procedures. You can execute it by opening a command prompt window and run: osql -E -S .\sqlexpress -i StoredProcedures.sql -n "RepositoryFactoryDB".

Run the Create business entities from database Recipe.

Select all tables available.
Compile the solution to verify that there are no errors.

Run the Create data repository classes from business entities Recipe.

Select all business entities created on the previous step.
Compile the solution to verify that there are no errors.

Run the solution Unit Tests

Click on the RepositoryTests.cs file and change its property Build Action to Compile.
Make sure your connection name is MyConnection, if not rename it on your app.config or change it on RepositoryTests class.
Rebuild the solution and run all unit tests.

Updated Wiki: Home

lerocha — Wed, 01 Oct 2008 17:24:59 GMT

Welcome to the Repository Factory

News

p&p has completed development. The source code is available here

Goals

Information for Developers

Contribute

The Repository Factory is currently looking for project members! Please join the discussion on the message boards and volunteer!

Source code checked in, #23221

lerocha — Tue, 30 Sep 2008 20:34:25 GMT

Adding DebuggerDisplay and DebuggerBrowsable attributes to the business entity classes. This will provide a better information of the business entity object while debugging it.

Closed Issue: uniqueidentifier System.Guid CastDBNull

lerocha — Tue, 30 Sep 2008 18:59:02 GMT

It appears that the creation of the respository classes have a difficult time with Sql Server columns of type uniqueidentifier. It understands that this converts to System.Guid but attempts to add CastDBNull as in the following...

customer.CustomerID= CastDBNull.To<Guid>(db.GetParameterValue(command, "CustomerID") , // TODO: GetCastDBNullDefault(string clsType) could not determine default value for clsType = Guid);

This line fails to compile and for now needed to be hand converted to...

customer.CustomerID= (Guid)(db.GetParameterValue(command, "CustomerID"));

Tadd

Source code checked in, #23220

lerocha — Tue, 30 Sep 2008 18:59:01 GMT

Work Item #11113: Adding missing reference to CastDBNull.cs in the project file. This was causing compilation errors of the generated code which could not find the definition of the CastDBNull class.

Closed Issue: Generation of Repository.cs contains errors

lerocha — Tue, 30 Sep 2008 02:37:11 GMT

I used the release for VS2008 and found that in <entity>Repository.cs generated file there are two errors in 'Remove' method:
1. signature of Remove method is 'public void Remove(System.Int32 clientIDSystem.String phone)' instead of 'public void Remove(System.Int32 clientID, System.String phone)' - a comma is missing
2. DeleteIdentity() method is invoked with wrong parameters: 'DeleteIdentity deleteIdentity = new DeleteIdentity(clientIDField, telefonField)' instead of 'DeleteIdentity deleteIdentity = new DeleteIdentity(clientID, phone)' - suffix "Field" is appended although the Remove() method has parameters defined whithout this suffix.

Please let us know how to fix this until a new release that fixes the above issues is out...

Source code checked in, #23206

lerocha — Tue, 30 Sep 2008 02:37:09 GMT

1. Adding unit tests for the IdentityHelper class. 2. Fixing work item #11365: The Remove method of repository class has compilation errors when using composite primary key.

Created Issue: GetAllFactory class generated code assigns values to read-only properties

valeriuz — Thu, 25 Sep 2008 13:02:15 GMT

It happened to me to declare read-only properties during "creation of repository classes from business entities" and I ended with compilation errors because the code generation template/snippet was designed for R/W properties:

internal class GetAllFactory : IDomainObjectsFactory<BNRxchng> {
public List<BNRxchng> Construct(IDataReader reader) {
List<BNRxchng> bNRxchngList = new List<BNRxchng>();

// Process first cursor
while (reader.Read()) {
BNRxchng bNRxchng = new BNRxchng();
int dateIndex = reader.GetOrdinal("Date");
if (!reader.IsDBNull(dateIndex)) {
bNRxchng.Date = reader.GetDateTime(dateIndex);
}
int iDIndex = reader.GetOrdinal("ID");
if (!reader.IsDBNull(iDIndex)) {
bNRxchng.ID = reader.GetInt32(iDIndex);
}
bNRxchngList.Add(bNRxchng);
}
return bNRxchngList;
}
}

In the above example properties Date and ID are getters only which leads to errors during compilation phase.

Could anyone from the development team fix this fast?

TIA

Created Issue: Generation of Repository.cs contains errors

valeriuz — Tue, 23 Sep 2008 14:23:35 GMT

Reviewed: Build 18936 (Sep 14, 2008)

amfakheruddin — Sun, 14 Sep 2008 09:13:31 GMT

Rated 2 Stars (out of 5) - i am interested to see Oracle support but i discover that it still not supported also for vs2008 :S