Enable CI builds (#18)

* Add submodule for JSON Schema test suite
* Modify default test settings to use schema files from submodule
* Remove local settings files from repo
* Add pipelines and scripted build
* Disable automatic building of benchmark code on each test execution
* Modify path handling to work on Unix (\ vs / path separator)
* Adjust package names and disable packaging for projects that shouldn't build NuGet packages
* Remove Corvus.JsonHelpers, moving the handful of bits we're using into Corvus.Json.ExtendedTypes

Author: idg10

.gitignore

@@ -342,4 +342,8 @@ coverage.cobertura.xml
 
 # NCrunch files
 *.ncrunchsolution
-*.ncrunchproject
+*.ncrunchproject
+
+# Scripted build artifacts
+/_codeCoverage
+/_packages

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "JSON-Schema-Test-Suite"]
+	path = JSON-Schema-Test-Suite
+	url = https://github.com/json-schema-org/JSON-Schema-Test-Suite.git

JSON-Schema-Test-Suite

@@ -0,0 +1,34 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <Import Project="$(EndjinProjectPropsPath)" Condition="$(EndjinProjectPropsPath) != ''" />
+
+  <PropertyGroup>
+    <TargetFramework>net6.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
+    <Description>Defines .NET types representing data types found in JSON, including numerous types for specialized string forms such as JsonUuid and JsonDateTime.</Description>
+  </PropertyGroup>
+
+
+  <ItemGroup>
+    <PackageReference Include="Corvus.Extensions" Version="1.1.4" />
+    <PackageReference Include="Endjin.RecommendedPractices" Version="1.2.0">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="Microsoft.Extensions.Http" Version="6.0.0" />
+    <PackageReference Include="Microsoft.Extensions.ObjectPool" Version="6.0.5" />
+    <PackageReference Include="NodaTime" Version="3.1.0" />
+    <PackageReference Include="System.Buffers" Version="4.5.1" />
+    <PackageReference Include="System.Collections.Immutable" Version="6.0.0" />
+    <PackageReference Include="System.Text.Json" Version="6.0.4" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Update="StyleCop.Analyzers" Version="1.2.0-beta.333" />
+  </ItemGroup>
+
+</Project>

README.md

@@ -11,7 +11,7 @@
 
 namespace Corvus.Json
 {
-    public static class JsonConstants
+    internal static class JsonConstants
     {
         public const byte OpenBrace = (byte)'{';
         public const byte CloseBrace = (byte)'}';

Solutions/Corvus.Json.ExtendedTypes/Corvus.Json.ExtendedTypes.csproj

@@ -0,0 +1,34 @@
+// <copyright file="JsonHelpers.cs" company="Endjin Limited">
+// Copyright (c) Endjin Limited. All rights reserved.
+// </copyright>
+// Derived from code:
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+#pragma warning disable
+
+using System;
+using System.Buffers;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Runtime.CompilerServices;
+using System.Text;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace Corvus.Json
+{
+    internal static partial class JsonHelpers
+    {
+        // Copy of Array.MaxArrayLength. For byte arrays the limit is slightly larger
+        private const int MaxArrayLength = 0X7FEFFFFF;
+
+        /// <summary>
+        /// Returns <see langword="true"/> if <paramref name="value"/> is between
+        /// <paramref name="lowerBound"/> and <paramref name="upperBound"/>, inclusive.
+        /// </summary>
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public static bool IsInRangeInclusive(uint value, uint lowerBound, uint upperBound)
+            => (value - lowerBound) <= (upperBound - lowerBound);
+    }
+}

Solutions/Corvus.JsonHelpers/Corvus.Json/EncodedContentMediaTypeParseStatus.cs Solutions/Corvus.Json.ExtendedTypes/Corvus.Json/EncodedContentMediaTypeParseStatus.cs

@@ -0,0 +1,158 @@
+// <copyright file="JsonReaderHelper.cs" company="Endjin Limited">
+// Copyright (c) Endjin Limited. All rights reserved.
+// </copyright>
+// Derived from code:
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+#pragma warning disable
+
+using System;
+using System.Buffers;
+using System.Buffers.Text;
+using System.Diagnostics;
+using System.Diagnostics.CodeAnalysis;
+using System.Text;
+
+namespace Corvus.Json
+{
+    internal static partial class JsonReaderHelper
+    {
+        public static ReadOnlySpan<byte> GetUnescapedSpan(ReadOnlySpan<byte> utf8Source, int idx)
+        {
+            // The escaped name is always >= than the unescaped, so it is safe to use escaped name for the buffer length.
+            int length = utf8Source.Length;
+            byte[]? pooledName = null;
+
+            Span<byte> utf8Unescaped = length <= JsonConstants.StackallocThreshold ?
+                stackalloc byte[length] :
+                (pooledName = ArrayPool<byte>.Shared.Rent(length));
+
+            Unescape(utf8Source, utf8Unescaped, idx, out int written);
+            Debug.Assert(written > 0);
+
+            ReadOnlySpan<byte> propertyName = utf8Unescaped.Slice(0, written).ToArray();
+            Debug.Assert(!propertyName.IsEmpty);
+
+            if (pooledName != null)
+            {
+                new Span<byte>(pooledName, 0, written).Clear();
+                ArrayPool<byte>.Shared.Return(pooledName);
+            }
+
+            return propertyName;
+        }
+
+        internal static void Unescape(ReadOnlySpan<byte> source, Span<byte> destination, int idx, out int written)
+        {
+            Debug.Assert(idx >= 0 && idx < source.Length);
+            Debug.Assert(source[idx] == JsonConstants.BackSlash);
+            Debug.Assert(destination.Length >= source.Length);
+
+            source.Slice(0, idx).CopyTo(destination);
+            written = idx;
+
+            for (; idx < source.Length; idx++)
+            {
+                byte currentByte = source[idx];
+                if (currentByte == JsonConstants.BackSlash)
+                {
+                    idx++;
+                    currentByte = source[idx];
+
+                    if (currentByte == JsonConstants.Quote)
+                    {
+                        destination[written++] = JsonConstants.Quote;
+                    }
+                    else if (currentByte == 'n')
+                    {
+                        destination[written++] = JsonConstants.LineFeed;
+                    }
+                    else if (currentByte == 'r')
+                    {
+                        destination[written++] = JsonConstants.CarriageReturn;
+                    }
+                    else if (currentByte == JsonConstants.BackSlash)
+                    {
+                        destination[written++] = JsonConstants.BackSlash;
+                    }
+                    else if (currentByte == JsonConstants.Slash)
+                    {
+                        destination[written++] = JsonConstants.Slash;
+                    }
+                    else if (currentByte == 't')
+                    {
+                        destination[written++] = JsonConstants.Tab;
+                    }
+                    else if (currentByte == 'b')
+                    {
+                        destination[written++] = JsonConstants.BackSpace;
+                    }
+                    else if (currentByte == 'f')
+                    {
+                        destination[written++] = JsonConstants.FormFeed;
+                    }
+                    else if (currentByte == 'u')
+                    {
+                        // The source is known to be valid JSON, and hence if we see a \u, it is guaranteed to have 4 hex digits following it
+                        // Otherwise, the Utf8JsonReader would have alreayd thrown an exception.
+                        Debug.Assert(source.Length >= idx + 5);
+
+                        bool result = Utf8Parser.TryParse(source.Slice(idx + 1, 4), out int scalar, out int bytesConsumed, 'x');
+                        Debug.Assert(result);
+                        Debug.Assert(bytesConsumed == 4);
+                        idx += bytesConsumed;     // The loop iteration will increment idx past the last hex digit
+
+                        if (JsonHelpers.IsInRangeInclusive((uint)scalar, JsonConstants.HighSurrogateStartValue, JsonConstants.LowSurrogateEndValue))
+                        {
+                            // The first hex value cannot be a low surrogate.
+                            if (scalar >= JsonConstants.LowSurrogateStartValue)
+                            {
+                                throw new InvalidOperationException($"Read Invalid UTF16: {scalar}");
+                            }
+
+                            Debug.Assert(JsonHelpers.IsInRangeInclusive((uint)scalar, JsonConstants.HighSurrogateStartValue, JsonConstants.HighSurrogateEndValue));
+
+                            idx += 3;   // Skip the last hex digit and the next \u
+
+                            // We must have a low surrogate following a high surrogate.
+                            if (source.Length < idx + 4 || source[idx - 2] != '\\' || source[idx - 1] != 'u')
+                            {
+                                throw new InvalidOperationException("Read Invalid UTF16");
+                            }
+
+                            // The source is known to be valid JSON, and hence if we see a \u, it is guaranteed to have 4 hex digits following it
+                            // Otherwise, the Utf8JsonReader would have alreayd thrown an exception.
+                            result = Utf8Parser.TryParse(source.Slice(idx, 4), out int lowSurrogate, out bytesConsumed, 'x');
+                            Debug.Assert(result);
+                            Debug.Assert(bytesConsumed == 4);
+
+                            // If the first hex value is a high surrogate, the next one must be a low surrogate.
+                            if (!JsonHelpers.IsInRangeInclusive((uint)lowSurrogate, JsonConstants.LowSurrogateStartValue, JsonConstants.LowSurrogateEndValue))
+                            {
+                                throw new InvalidOperationException($"Read Invalid UTF16: {lowSurrogate}");
+                            }
+
+                            idx += bytesConsumed - 1;  // The loop iteration will increment idx past the last hex digit
+
+                            // To find the unicode scalar:
+                            // (0x400 * (High surrogate - 0xD800)) + Low surrogate - 0xDC00 + 0x10000
+                            scalar = (JsonConstants.BitShiftBy10 * (scalar - JsonConstants.HighSurrogateStartValue))
+                                + (lowSurrogate - JsonConstants.LowSurrogateStartValue)
+                                + JsonConstants.UnicodePlane01StartValue;
+                        }
+
+                        var rune = new Rune(scalar);
+                        int bytesWritten = rune.EncodeToUtf8(destination.Slice(written));
+                        Debug.Assert(bytesWritten <= 4);
+                        written += bytesWritten;
+                    }
+                }
+                else
+                {
+                    destination[written++] = currentByte;
+                }
+            }
+        }
+    }
+}

Solutions/Corvus.Json/Corvus.Json/IJsonArray.cs Solutions/Corvus.Json.ExtendedTypes/Corvus.Json/IJsonArray.cs

@@ -498,7 +498,22 @@ private static string FormatUri(Uri value)
 
         private static bool TryParseUri(string text, [NotNullWhen(true)] out Uri? value)
         {
-            return Uri.TryCreate(text, UriKind.Absolute, out value);
+            // Uri.TryCreate considers full-qualified file paths to be acceptable as absolute Uris.
+            // This means that on Linux "/abc" is considered an acceptable absolute Uri! (This is
+            // conceptually equivalent to "C:\abc" being an absolute Uri on Windows, but it's more
+            // of a problem because a lot of relative Uris of the kind you come across on the web
+            // look exactly like Unix file paths.)
+            // https://github.com/dotnet/runtime/issues/22718
+            // However, this only needs to be a problem if you insist that the Uri is absolute.
+            // If you accept either absolute or relative Uris, it will intepret "/abc" as a
+            // relative Uri on either Windows or Linux. It only interprets it as an absolute Uri
+            // if you pass UriKind.Absolute when parsing.
+            // This is why we take the peculiar-looking step of passing UriKind.RelativeOrAbsolute
+            // and then rejecting relative Uris. This causes this method to reject "/abc" on all
+            // platforms. Back when we passed UriKind.Absolute, this code incorrectly accepted
+            // "abc".
+            return Uri.TryCreate(text, UriKind.RelativeOrAbsolute, out value) &&
+                value.IsAbsoluteUri;
         }
     }
 }

Solutions/Corvus.Json/Corvus.Json/IJsonArray{T}.cs Solutions/Corvus.Json.ExtendedTypes/Corvus.Json/IJsonArray{T}.cs

@@ -0,0 +1,29 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <Import Project="$(EndjinProjectPropsPath)" Condition="$(EndjinProjectPropsPath) != ''" />
+
+  <PropertyGroup>
+    <TargetFramework>net6.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
+    <Description>Object models representing JSON Schema documents (201909 and 202012 drafts)</Description>
+  </PropertyGroup>
+
+
+  <ItemGroup>
+    <PackageReference Include="Endjin.RecommendedPractices" Version="1.2.0">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
+
+
+  <ItemGroup>
+    <ProjectReference Include="..\Corvus.Json.ExtendedTypes\Corvus.Json.ExtendedTypes.csproj" />
+  </ItemGroup>
+
+</Project>