Using Entity Framework 6 with an existing database

DungeonMart’s starter data set is designed for SQL Server, so it’s time to leave DocumentDB behind and start the SQL work. First, I need to create the SQL database and load the seed data. The schema files that I’m using for the initial load can be found here: https://github.com/qanwi1970/dnd-srd-35/tree/master/V1. If you want to follow along, just run them against a new database and you’re good to go.

Since I already have a database, I’m going to use Entity Framework’s database first model to get talking to it quickly. Continue reading

Creating Automated Integration Tests for a DocumentDB Repository

You can unit test all your layers, but when you get to the repository it becomes an exercise in mocking that provides little real benefit. That’s why we have to give up on the unit test idea for repositories and embrace integration tests. There’s nothing wrong with integration tests, as I explained a while back. So let’s review the criteria of effective automated tests and see if this is worth while.

  1. Automated – Yes, my tests will be standard NUnit tests that can be run just about anywhere by just about any automated process. Continue reading

Refactoring My Repository Methods to be Asynchronous

Now I’ve written a DocumentDB based repository for Equipment data in DungeonMart, but I didn’t try to make it perfect, I just tried to make it work. Here it is, if you’re catching up: Part 1 and Part 2.

My next step in getting it closer to perfect is to make all the methods aynchronous. Face it, we’re going out to the cloud to get or write data and we shouldn’t make the whole service wait while that happens. DocumentDB gives you Async methods at least for writing, and we can figure out how to make the read methods async. If we were in Entity Framework, we would already have async methods for both reading and writing.
Continue reading

Creating a DocumentDB Repository Layer (Part 2 – Writing)

“Last time, on Bill DeLude dot com…”

Hmm, it kind of loses its effect without a good narrator voice. Does someone have Morgan Freeman’s number? Because he could say that last time I talked about creating a data repository class using DocumentDB as the data store and covered the setup of the class and the read methods. This time, I’m going to go over the write methods.

But first a disclaimer before we get started. Not everything in this class is complete. As with normal programming, I like to take a highly iterative approach. First, I’ll make it work. Then I’ll improve some part of it. And then I’ll improve some other part, and so on. There’s two things conspicuously missing from today’s code. First, the write methods, as they are offered up, are synchronous. Second, it doesn’t allow for the Equipment type to change. I’ll address both of these in a later post.

First, I’m going to work on adding Equipment to the collection. Here’s the implementation of the AddEquipment method:

public Equipment AddEquipment(Equipment equipment)
{
    dynamic doc = Client.CreateDocumentAsync(CollectionLink, equipment)
        .Result.Resource;
    Equipment result = doc;
    return result;
}

Adding a document to a collection in DocumentDB is pretty straight-forward. All you really have to do is call CreateDocumentAsync with the link to the collection and the document you’re adding.

I made it a little more complicated because I like to return the added document back to the caller, so they can have any changes such as the id or a timestamp. To accomplish that, I need to get the Resource of the CreateDocumentAsync result as a dynamic type. Then I put that into an Equipment type and return the equipment.

Now that we can add documents, let’s make sure we can update them. Updating in DocumentDB is a two step process. You first have to get a document link by reading the collection, and then you replace the document with your changed version. Gone are the days of “UPDATE Equipment SET …” because DocumentDB, as with most NoSQL databases, just doesn’t work that way. Here’s the code for updating:

public Equipment UpdateEquipment(string id, Equipment equipment)
{
    var doc = Client.CreateDocumentQuery(CollectionLink)
        .AsEnumerable().First(d => d.Id == id);
    dynamic updatedDoc = Client.ReplaceDocumentAsync(doc.SelfLink,
        equipment).Result.Resource;
    Equipment result = updatedDoc;
    return result;
}

Notice that when I get the document this time, I’m not specifying a type to return. By omitting the return type, I get it as a Document and not as an Equipment. I want to do that because Equipment doesn’t have the self link I need to do the replace on the next line. Once you have the document, replacing it is pretty simple. Just call ReplaceDocumentAsync with the document’s self link and the new document. Returning the updated equipment requires some extra work, but it’s just like the Create.

Finally, we need to delete documents from the collection. This works a lot like updating: get a self link, then call a delete method. It looks like this:

 public void DeleteEquipment(string id)
{
    var doc = Client.CreateDocumentQuery(CollectionLink)
        .AsEnumerable().First(d => d.Id == id);
    Client.DeleteDocumentAsync(doc.SelfLink);
}

And that’s it. Now you have a full blown Equipment repository using DocumentDB as the data store.

The code that was used at the time of this writing is in my github at this commit.

Welcome to DungeonMart! Can I Interest You in a Longsword?

I need a web app, something with all kinds of webappy features that can serve as my go to project when I’m writing about different technologies. I’ve actually needed this for a while, but have been struggling to come up with the concept.

I tried for a content management system. Then I thought about a customer management system. I thought about building out that online retailer system that I dreamed up back when I was an Amazon/Ebay seller. The main thing lacking in all these was a mature domain model, due to my lack of experience with the subjects.

Then, in a completely unrelated-to-this-topic search, I stumbled upon a complete database of the D20 System Reference Document (SRD). You would probably know it as something else, but I’m not allowed to use that term. Anyway, it’s a database of character types, monsters, and items and equipment that can be used in various table-top gaming systems, like the kind where you poke around in dungeons and fight mighty dragons. This works out great for me, for a couple of reasons.

  1. The data set is very mature, having evolved from a system that was created in the 70’s.
  2. The SRD is open content. The license is full of all kinds of legalese, but I know from other sites that I can do what I need to do with it.
  3. The data is highly relational, but is represented in the database as unrelated tables. This gives me opportunity to model how one would refactor a site or a data model after the site has gone live, the whole changing-the-engines-while-in-flight problem.

Thus DungeonMart was born, a modern day e-commerce site where an adventurer could go to buy all the known adventuring equipment and items. It could be anything from a pound of wheat to a magical suit of chainmail. It’s nothing special yet, just a page that says Welcome. But as I evolve it over time, it should be pretty cool.

Technology wise, I’m first going to play around with getting the data into DocumentDB, while it’s still in preview on Azure and because I’m possibly going to be doing a session on DocumentDB at an upcoming event. Once the data is in place, I’ll probably progress to a Web API 2 RESTful service and then finally the actual web site part.

I’m sure I’ll get distracted many times on the way as I need to talk about one thing or another, but it will slowly come together. The source will be on my github the whole time, and the site will live on Azure probably for a while, here.