Toxon.Integresql.Client 1.0.4

Toxon.Integresql.Client

A .NET client for IntegreSQL, a management tool for isolated PostgreSQL databases for integration testing

Usage

• Install the Toxon.Integresql.Client nuget package
• Create a client for communicating with the service

  var client = new IntegresqlClient("http://localhost:5000/api");
  

• Create a hash of the schema & fixtures, this could vary a lot across applications so imagine something like feeding your schema setup files into a SHA256 hash

  var hashBytes = SHA256.HashData(File.ReadAllBytes("schema.sql"));
  var sb = new StringBuilder();
  for (int i = 0; i < hashBytes.Length; i++) { sb.Append(hashBytes[i].ToString("x2")); }
  var hash = sb.ToString();
  

• Setup the template database, you can do this with client.InitializeTemplate and client.FinalizeTemplate, or use the setup helper method. Either way you want to try and only do this once per test session, so consider putting it in a Lazy initialized static field

  await client.SetupTemplate(hash, connectionString => {
      // connect to the database and set it up 
  });
  

• In each test get a connection to a unique isolated database using client.GetDatabase and then return it at the end with client.ReturnDatabase, alternatively use the disposable extension method

  await using var database = client.AcquireDatabase(hash);
  var connectionString = database.GetConnectionString();
  // run your test, the database will be automatically returned and recycled at the end