Merge pull request #4 from joncloud/migrate-readme-tests-to-xunit

Migrates readme tests from adhoc ps1 to xunit

Author: joncloud

README.md

@@ -36,6 +36,7 @@ Options:
   --timeout=<VALUE>     Sets the timeout of the request using System.TimeSpan.TryParse (https://docs.microsoft.com/en-us/dotnet/api/system.timespan.parse)
   --version             Displays the application verison.
   --xml=<ROOT_NAME>     Renders the content arguments as application/xml using the optional xml root name.
+  --stop-auto-redirects Prevents redirects from automatically being processed.
 
 Content:
 Repeat as many content arguments to create content sent with the HTTP request. Alternatively pipe raw content send as the HTTP request content.

TestReadmeVersion.ps1

@@ -10,12 +10,6 @@ variables:
   buildConfiguration: 'Release'
 
 steps:
-- task: PowerShell@2
-  displayName: Test Readme
-  inputs:
-    filePath: 'TestReadmeVersion.ps1'
-    failOnStderr: true
-
 - task: DotNetCoreCLI@2
   displayName: Pack https
   inputs:

azure-pipelines.yml

@@ -0,0 +1,16 @@
+using System.Xml.Linq;
+
+namespace Https.Tests
+{
+    public class HttpsCsprojFixture
+    {
+        public XDocument Document { get; }
+
+        public HttpsCsprojFixture()
+        {
+            var path = "../../../../../src/https/https.csproj";
+
+            Document = XDocument.Load(path);
+        }
+    }
+}

tests/https.Tests/HttpsCsprojFixture.cs

@@ -0,0 +1,57 @@
+using System;
+using System.IO;
+using System.Text;
+using System.Text.RegularExpressions;
+
+namespace Https.Tests
+{
+    public class Readme
+    {
+        public string InstallationVersion { get; }
+        public string UsageDocumentation { get; }
+
+        public Readme(string path)
+        {
+            if (string.IsNullOrWhiteSpace(path)) throw new ArgumentNullException(nameof(path));
+
+            var sb = new StringBuilder();
+            InstallationVersion = "";
+            UsageDocumentation = "";
+
+            var lines = File.ReadLines(path);
+            var record = false;
+            foreach (var line in lines)
+            {
+               
+                if (line.StartsWith("```bash"))
+                {
+                    record = true;
+                }
+                else if (line.StartsWith("```"))
+                {
+                    var text = sb.ToString();
+                    sb.Clear();
+
+                    if (text.StartsWith("dotnet tool"))
+                    {
+                        var match = Regex.Match(text, "dotnet tool install --global https --version (.+)-\\*");
+                        if (match.Success)
+                        {
+                            InstallationVersion = match.Groups[1].Value;
+                        }
+                    }
+                    else if (text.StartsWith("Usage"))
+                    {
+                        UsageDocumentation = text;
+                    }
+
+                    record = false;
+                }
+                else if (record)
+                {
+                    sb.AppendLine(line);
+                }
+            }
+        }
+    }
+}

tests/https.Tests/Readme.cs

@@ -0,0 +1,13 @@
+namespace Https.Tests
+{
+    public class ReadmeFixture
+    {
+        public Readme Readme { get; }
+        public ReadmeFixture()
+        {
+            Readme = new Readme(
+                "../../../../../README.md"
+            );
+        }
+    }
+}

tests/https.Tests/ReadmeFixture.cs

@@ -0,0 +1,49 @@
+using System.IO;
+using System.Linq;
+using System.Threading.Tasks;
+using System.Xml.Linq;
+using Xunit;
+
+namespace Https.Tests
+{
+    public class ReadmeTests : IClassFixture<HttpsCsprojFixture>, IClassFixture<ReadmeFixture>
+    {
+        readonly HttpsCsprojFixture _httpsCsprojFixture;
+        readonly ReadmeFixture _readmeFixture;
+        public ReadmeTests(HttpsCsprojFixture httpsCsprojFixture, ReadmeFixture readmeFixture)
+        {
+            _httpsCsprojFixture = httpsCsprojFixture;
+            _readmeFixture = readmeFixture;
+        }
+
+        [Fact]
+        public void Installation_ShouldListSameVersionAsCsproj()
+        {
+            var versionPrefixElement = _httpsCsprojFixture.Document
+                .Root
+                .Elements("PropertyGroup")
+                .Elements("VersionPrefix")
+                .FirstOrDefault();
+
+            Assert.NotNull(versionPrefixElement);
+
+            var expected = versionPrefixElement.Value;
+            var actual = _readmeFixture.Readme.InstallationVersion;
+
+            Assert.Equal(expected, actual);
+        }
+
+        [Fact]
+        public async Task Usage_ShouldListHelpDocument()
+        {
+            var httpsResult = await Https.ExecuteAsync("--help");
+
+            using var reader = new StreamReader(httpsResult.StdOut);
+
+            var expected = reader.ReadToEnd().TrimEnd();
+            var actual = _readmeFixture.Readme.UsageDocumentation.TrimEnd();
+
+            Assert.Equal(expected, actual);
+        }
+    }
+}