From b7a57e2704cd3d740d6c4c7c0dbf4dce6f44cf20 Mon Sep 17 00:00:00 2001 From: Mario Toffia Date: Fri, 1 Oct 2021 14:45:45 +0200 Subject: [PATCH] added readme for nuspec mstest and xunit --- .../Ductus.FluentDocker.MsTest.csproj | 5 ++ Ductus.FluentDocker.MsTest/README.md | 65 +++++++++++++++++++ .../Ductus.FluentDocker.XUnit.csproj | 5 ++ Ductus.FluentDocker.XUnit/README.md | 62 ++++++++++++++++++ 4 files changed, 137 insertions(+) create mode 100644 Ductus.FluentDocker.MsTest/README.md create mode 100644 Ductus.FluentDocker.XUnit/README.md diff --git a/Ductus.FluentDocker.MsTest/Ductus.FluentDocker.MsTest.csproj b/Ductus.FluentDocker.MsTest/Ductus.FluentDocker.MsTest.csproj index 187a838..a090a41 100644 --- a/Ductus.FluentDocker.MsTest/Ductus.FluentDocker.MsTest.csproj +++ b/Ductus.FluentDocker.MsTest/Ductus.FluentDocker.MsTest.csproj @@ -13,6 +13,7 @@ https://github.com/mariotoffia/FluentDocker https://pbs.twimg.com/profile_images/378800000124779041/fbbb494a7eef5f9278c6967b6072ca3e.png Ductus.FluentDocker.MsTest + README.md false Docker;Docker-Compose;Docker Compose;Docker-Machine;Docker Machine;Linux;Windows;Mac;Test;NET Core git @@ -30,6 +31,10 @@ Documentation: https://github.com/mariotoffia/FluentDocker + + + + diff --git a/Ductus.FluentDocker.MsTest/README.md b/Ductus.FluentDocker.MsTest/README.md new file mode 100644 index 0000000..926cf5e --- /dev/null +++ b/Ductus.FluentDocker.MsTest/README.md @@ -0,0 +1,65 @@ +# FluentDocker for MsTest + +In addition to the standard _FluentDocker_ usage, it adds the ability to use easy testing with containers via MsTest. + +For example, fire up a Postgres container inside the test could look like this + +```cs +[TestClass] +public class PostgresMsTests : PostgresTestBase +{ + [TestMethod] + public void Test() + { + // We now have a running Postgres + // and a valid connection string to use. + } +} +``` + +This library enables `docker` and `docker-compose` interactions using a _Fluent API_. It is supported on Linux, Windows and Mac. It also has support for the legacy `docker-machine` interactions. + +**Have a look at the [project site](https://github.com/mariotoffia/FluentDocker) for more information.** + +**Sample Fluent API usage** +```cs + using ( + var container = + new Builder().UseContainer() + .UseImage("kiasaki/alpine-postgres") + .ExposePort(5432) + .WithEnvironment("POSTGRES_PASSWORD=mysecretpassword") + .WaitForPort("5432/tcp", 30000 /*30s*/) + .Build() + .Start()) + { + var config = container.GetConfiguration(true); + Assert.AreEqual(ServiceRunningState.Running, config.State.ToServiceState()); + } +``` +The following snippet fires up Postgres and waits for it to be ready. It uses docker-compose file to perform the task. +```cs + var file = Path.Combine(Directory.GetCurrentDirectory(), + (TemplateString) "Resources/ComposeTests/WordPress/docker-compose.yml"); + + // @formatter:off + using (var svc = new Builder() + .UseContainer() + .UseCompose() + .FromFile(file) + .RemoveOrphans() + .WaitForHttp("wordpress", "http://localhost:8000/wp-admin/install.php") + .Build().Start()) + // @formatter:on + { + // We now have a running WordPress with a MySql database + var installPage = await "http://localhost:8000/wp-admin/install.php".Wget(); + + Assert.IsTrue(installPage.IndexOf("https://wordpress.org/", StringComparison.Ordinal) != -1); + Assert.AreEqual(1, svc.Hosts.Count); // The host used by compose + Assert.AreEqual(2, svc.Containers.Count); // We can access each individual container + Assert.AreEqual(2, svc.Images.Count); // And the images used. + } +``` + +👀 It has tons of features, including a low-level command style, services and finally, the Fluent API on top of it. \ No newline at end of file diff --git a/Ductus.FluentDocker.XUnit/Ductus.FluentDocker.XUnit.csproj b/Ductus.FluentDocker.XUnit/Ductus.FluentDocker.XUnit.csproj index 727738e..95d61dd 100644 --- a/Ductus.FluentDocker.XUnit/Ductus.FluentDocker.XUnit.csproj +++ b/Ductus.FluentDocker.XUnit/Ductus.FluentDocker.XUnit.csproj @@ -12,6 +12,7 @@ https://github.com/mariotoffia/FluentDocker https://pbs.twimg.com/profile_images/378800000124779041/fbbb494a7eef5f9278c6967b6072ca3e.png Ductus.FluentDocker.XUnit + README.md false Docker;Docker-Compose;Docker Compose;Docker-Machine;Docker Machine;Linux;Windows;Mac;Test;NET Core git @@ -29,6 +30,10 @@ + + + + diff --git a/Ductus.FluentDocker.XUnit/README.md b/Ductus.FluentDocker.XUnit/README.md new file mode 100644 index 0000000..fd2ab69 --- /dev/null +++ b/Ductus.FluentDocker.XUnit/README.md @@ -0,0 +1,62 @@ +# FluentDocker for XUnit + +In addition to the standard _FluentDocker_ usage, it adds the ability to use easy testing with containers via _XUnit_. + +For example, fire up a Postgres container inside the test could look like this + +```cs +public class PostgresXUnitTests : IClassFixture +{ + [Fact] + public void Test() + { + // We now have a running Postgres + // and a valid connection string to use. + } +} +``` + +This library enables `docker` and `docker-compose` interactions using a _Fluent API_. It is supported on Linux, Windows and Mac. It also has support for the legacy `docker-machine` interactions. + +**Have a look at the [project site](https://github.com/mariotoffia/FluentDocker) for more information.** + +**Sample Fluent API usage** +```cs + using ( + var container = + new Builder().UseContainer() + .UseImage("kiasaki/alpine-postgres") + .ExposePort(5432) + .WithEnvironment("POSTGRES_PASSWORD=mysecretpassword") + .WaitForPort("5432/tcp", 30000 /*30s*/) + .Build() + .Start()) + { + var config = container.GetConfiguration(true); + Assert.AreEqual(ServiceRunningState.Running, config.State.ToServiceState()); + } +``` +The following snippet fires up Postgres and waits for it to be ready. It uses docker-compose file to perform the task. +```cs + var file = Path.Combine(Directory.GetCurrentDirectory(), + (TemplateString) "Resources/ComposeTests/WordPress/docker-compose.yml"); + + using (var svc = new Builder() + .UseContainer() + .UseCompose() + .FromFile(file) + .RemoveOrphans() + .WaitForHttp("wordpress", "http://localhost:8000/wp-admin/install.php") + .Build().Start()) + { + // We now have a running WordPress with a MySql database + var installPage = await "http://localhost:8000/wp-admin/install.php".Wget(); + + Assert.IsTrue(installPage.IndexOf("https://wordpress.org/", StringComparison.Ordinal) != -1); + Assert.AreEqual(1, svc.Hosts.Count); // The host used by compose + Assert.AreEqual(2, svc.Containers.Count); // We can access each individual container + Assert.AreEqual(2, svc.Images.Count); // And the images used. + } +``` + +👀 It has tons of features, including a low-level command style, services and finally, the Fluent API on top of it. \ No newline at end of file