Merge branch 'vnext' into vvk/diagnostic-in-context

Author: darrelmiller

build.cmd

@@ -1,21 +1,17 @@
 @echo off
-if "%~1"=="" goto :error
-
-SET VERSION=%~1
-
 Echo Building Microsoft.OpenApi
 
 SET PROJ=%~dp0src\Microsoft.OpenApi\Microsoft.OpenApi.csproj 
 dotnet build %PROJ% /t:restore /p:Configuration=Release
 dotnet build %PROJ% /t:build /p:Configuration=Release
-dotnet build %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts;Version=%VERSION%
+dotnet build %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts
 
 Echo Building Microsoft.OpenApi.Readers
 
 SET PROJ=%~dp0src\Microsoft.OpenApi.Readers\Microsoft.OpenApi.Readers.csproj 
 dotnet build %PROJ% /t:restore /p:Configuration=Release
 dotnet build %PROJ% /t:build /p:Configuration=Release
-dotnet build %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts;Version=%VERSION%
+dotnet build %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts
 
 goto :end
 :error

src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj

@@ -10,7 +10,7 @@
         <Company>Microsoft</Company>
         <Title>Microsoft.OpenApi.Readers</Title>
         <PackageId>Microsoft.OpenApi.Readers</PackageId>
-        <Version>1.1.4</Version>
+        <Version>1.2.0-preview</Version>
         <Description>OpenAPI.NET Readers for JSON and YAML documents</Description>
         <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
         <PackageTags>OpenAPI .NET</PackageTags>

src/Microsoft.OpenApi/Microsoft.OpenApi.csproj

@@ -10,7 +10,7 @@
         <Company>Microsoft</Company>
         <Title>Microsoft.OpenApi</Title>
         <PackageId>Microsoft.OpenApi</PackageId>
-        <Version>1.1.4</Version>
+        <Version>1.2.0-preview</Version>
         <Description>.NET models with JSON and YAML writers for OpenAPI specification</Description>
         <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
         <PackageTags>OpenAPI .NET</PackageTags>

src/Microsoft.OpenApi/Services/ComparisonContext.cs

@@ -0,0 +1,87 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+using System.Collections.Generic;
+using System.Linq;
+using Microsoft.OpenApi.Models;
+
+namespace Microsoft.OpenApi.Services
+{
+    /// <summary>
+    /// A class encapsulating the comparision context.
+    /// </summary>
+    public class ComparisonContext
+    {
+        private readonly IList<OpenApiDifference> _openApiDifferences = new List<OpenApiDifference>();
+        private readonly Stack<string> _path = new Stack<string>();
+        internal readonly OpenApiDocument SourceDocument;
+        internal readonly Stack<OpenApiSchema> SourceSchemaLoop = new Stack<OpenApiSchema>();
+        internal readonly OpenApiDocument TargetDocument;
+        internal readonly Stack<OpenApiSchema> TargetSchemaLoop = new Stack<OpenApiSchema>();
+        internal OpenApiComparerFactory OpenApiComparerFactory;
+
+        /// <summary>
+        /// Creates instance of <see cref="ComparisonContext"/>.
+        /// </summary>
+        public ComparisonContext(
+            OpenApiComparerFactory openApiComparerFactory,
+            OpenApiDocument sourceDocument,
+            OpenApiDocument targetDocument)
+        {
+            OpenApiComparerFactory = openApiComparerFactory;
+            SourceDocument = sourceDocument;
+            TargetDocument = targetDocument;
+        }
+
+        /// <summary>
+        /// Gets the list of open api differences.
+        /// </summary>
+        public IEnumerable<OpenApiDifference> OpenApiDifferences => _openApiDifferences;
+
+        /// <summary>
+        /// Pointer to the source of difference in the document.
+        /// </summary>
+        public string PathString => "#/" + string.Join("/", _path.Reverse());
+
+        /// <summary>
+        /// Adds an open api difference.
+        /// </summary>
+        /// <param name="openApiDifference">The open api difference to add.</param>
+        public void AddOpenApiDifference(OpenApiDifference openApiDifference)
+        {
+            if (openApiDifference == null)
+            {
+                throw Error.ArgumentNull(nameof(openApiDifference));
+            }
+
+            _openApiDifferences.Add(openApiDifference);
+        }
+
+        /// <summary>
+        /// Allow Rule to indicate difference occured at a deeper context level.
+        /// </summary>
+        /// <param name="segment">Identifier for the context.</param>
+        public void Enter(string segment)
+        {
+            _path.Push(segment);
+        }
+
+        /// <summary>
+        /// Exit from path context level.  Enter and Exit calls should be matched.
+        /// </summary>
+        public void Exit()
+        {
+            _path.Pop();
+        }
+
+        /// <summary>
+        /// Gets the comparer instance for the requested type.
+        /// </summary>
+        /// <typeparam name="T">Type of requested comparer.</typeparam>
+        /// <returns>Comparer instance to use when comparing requested type.</returns>
+        internal OpenApiComparerBase<T> GetComparer<T>()
+        {
+            return OpenApiComparerFactory.GetComparer<T>();
+        }
+    }
+}

src/Microsoft.OpenApi/Services/OpenApiAnyComparer.cs

@@ -0,0 +1,72 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. 
+
+using System;
+using System.IO;
+using Microsoft.OpenApi.Any;
+using Microsoft.OpenApi.Writers;
+
+namespace Microsoft.OpenApi.Services
+{
+    /// <summary>
+    ///  Defines behavior for comparing properties of <see cref="IOpenApiAny"/>.
+    /// </summary>
+    public class OpenApiAnyComparer : OpenApiComparerBase<IOpenApiAny>
+    {
+        /// <summary>
+        /// Executes comparision against source and target <see cref="IOpenApiAny"/>.
+        /// </summary>
+        /// <param name="source">The source.</param>
+        /// <param name="target">The target.</param>
+        /// <param name="comparisonContext">Context under which to compare the source and target.</param>
+        public override void Compare(
+            IOpenApiAny source,
+            IOpenApiAny target,
+            ComparisonContext comparisonContext)
+        {
+            if (source == null && target == null)
+            {
+                return;
+            }
+
+            if (source == null || target == null)
+            {
+                comparisonContext.AddOpenApiDifference(
+                    new OpenApiDifference
+                    {
+                        OpenApiDifferenceOperation = OpenApiDifferenceOperation.Update,
+                        SourceValue = source,
+                        TargetValue = target,
+                        OpenApiComparedElementType = typeof(IOpenApiAny),
+                        Pointer = comparisonContext.PathString
+                    });
+
+                return;
+            }
+
+            var sourceStringWriter = new StringWriter();
+            var sourceWriter = new OpenApiJsonWriter(sourceStringWriter);
+
+            source.Write(sourceWriter, OpenApiSpecVersion.OpenApi3_0);
+            var sourceValue = sourceStringWriter.GetStringBuilder().ToString();
+
+            var targetStringWriter = new StringWriter();
+            var targetWriter = new OpenApiJsonWriter(targetStringWriter);
+
+            target.Write(targetWriter, OpenApiSpecVersion.OpenApi3_0);
+            var targetValue = targetStringWriter.GetStringBuilder().ToString();
+
+            if (string.Compare(sourceValue, targetValue, StringComparison.InvariantCulture) != 0)
+            {
+                comparisonContext.AddOpenApiDifference(new OpenApiDifference
+                {
+                    OpenApiDifferenceOperation = OpenApiDifferenceOperation.Update,
+                    OpenApiComparedElementType = typeof(IOpenApiAny),
+                    SourceValue = source,
+                    TargetValue = target,
+                    Pointer = comparisonContext.PathString
+                });
+            }
+        }
+    }
+}

src/Microsoft.OpenApi/Services/OpenApiComparer.cs

@@ -14,10 +14,23 @@ public static class OpenApiComparer
         /// <summary>
         /// Compares two <see cref="OpenApiDocument"/>s and returns a list of differences.
         /// </summary>
-        public static List<OpenApiDifference> Compare(OpenApiDocument source, OpenApiDocument target)
+        public static IEnumerable<OpenApiDifference> Compare(OpenApiDocument source, OpenApiDocument target)
         {
-            var diffs = new List<OpenApiDifference>();
-            return diffs;
+            if (source == null)
+            {
+                throw Error.ArgumentNull(nameof(source));
+            }
+
+            if (target == null)
+            {
+                throw Error.ArgumentNull(nameof(target));
+            }
+
+            var comparisonContext = new ComparisonContext(new OpenApiComparerFactory(), source, target);
+
+            new OpenApiDocumentComparer().Compare(source, target, comparisonContext);
+
+            return comparisonContext.OpenApiDifferences;
         }
     }
 }