Skip to content

Commit

Permalink
Author fuzz tests and fix a comment-related issue (#2935)
Browse files Browse the repository at this point in the history 
Co-authored-by: James Newton-King <james@newtonking.com>
  • Loading branch information
@Porges @JamesNK
Porges and JamesNK committed Apr 17, 2024
1 parent 55a7204 commit 2eaa475
Show file tree
Hide file tree
Showing 7 changed files with 288 additions and 7 deletions.
4 changes: 4 additions & 0 deletions Build/build.ps1
View file
Expand Up @@ -133,6 +133,10 @@ task Package -depends Build {
robocopy $sourceDir $workingDir\Package\Source\Src /MIR /NFL /NDL /NJS /NC /NS /NP /XD bin obj TestResults AppPackages .vs artifacts /XF *.suo *.user *.lock.json | Out-Default robocopy $sourceDir $workingDir\Package\Source\Src /MIR /NFL /NDL /NJS /NC /NS /NP /XD bin obj TestResults AppPackages .vs artifacts /XF *.suo *.user *.lock.json | Out-Default
robocopy $buildDir $workingDir\Package\Source\Build /MIR /NFL /NDL /NJS /NC /NS /NP /XD Temp /XF runbuild.txt | Out-Default robocopy $buildDir $workingDir\Package\Source\Build /MIR /NFL /NDL /NJS /NC /NS /NP /XD Temp /XF runbuild.txt | Out-Default
robocopy $docDir $workingDir\Package\Source\Doc /MIR /NFL /NDL /NJS /NC /NS /NP | Out-Default robocopy $docDir $workingDir\Package\Source\Doc /MIR /NFL /NDL /NJS /NC /NS /NP | Out-Default

# include fuzz tests in ADO pipeline artifacts
mkdir $workingDir\FuzzTests
Copy-Item -Path $sourceDir\Newtonsoft.Json.FuzzTests\bin\Release\net6.0\* -Destination $workingDir\FuzzTests


Compress-Archive -Path $workingDir\Package\* -DestinationPath $workingDir\$zipFileName Compress-Archive -Path $workingDir\Package\* -DestinationPath $workingDir\$zipFileName
} }
Expand Down
85 changes: 85 additions & 0 deletions Src/Newtonsoft.Json.FuzzTests/FuzzTests.cs
View file
@@ -0,0 +1,85 @@
using System;
using System.IO;

namespace Newtonsoft.Json.FuzzTests
{
public static class Fuzzers
{
static readonly JsonSerializer jsonSerializer = new();

public static void FuzzDeserialization(ReadOnlySpan<byte> buffer)
{
try
{
using var ms = new MemoryStream(buffer.ToArray());
using var sr = new StreamReader(ms);
using var reader = new JsonTextReader(sr);
jsonSerializer.Deserialize(reader);
}
catch (JsonException)
{
// this can be JsonReaderException, JsonWriterException, or JsonSerializationException;
// the latter two can be thrown by deserializing into a json object
return;
// ignore - known/expected exceptions are okay
}
}

public static void FuzzSerialization(ReadOnlySpan<byte> buffer)
{
object? deserialized;
try
{
deserialized = Deserialize(buffer);
}
catch
{
return;
}

// see if this throws
Serialize(deserialized);
}

public static void FuzzIdempotent(ReadOnlySpan<byte> buffer)
{
string serialized1;
try
{
serialized1 = Serialize(Deserialize(buffer));
}
catch
{
return;
}

var serialized2 = Serialize(Deserialize(serialized1));
if (serialized1 != serialized2)
{
throw new Exception($"not idempotent: {serialized1} {serialized2}");
}
}

private static string Serialize(object? o)
{
using var sw1 = new StringWriter();
jsonSerializer.Serialize(sw1, o);
return sw1.ToString();
}

private static object? Deserialize(string input)
{
using var sr = new StringReader(input);
using var tr = new JsonTextReader(sr);
return jsonSerializer.Deserialize(tr);
}

private static object? Deserialize(ReadOnlySpan<byte> bytes)
{
using var ms = new MemoryStream(bytes.ToArray());
using var sr = new StreamReader(ms);
using var reader = new JsonTextReader(sr);
return jsonSerializer.Deserialize(reader);
}
}
}
21 changes: 21 additions & 0 deletions Src/Newtonsoft.Json.FuzzTests/Newtonsoft.Json.FuzzTests.csproj
View file
@@ -0,0 +1,21 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFrameworks>net6.0</TargetFrameworks>
<LangVersion>9.0</LangVersion>
<VersionPrefix>1.0</VersionPrefix>
<Authors>James Newton-King</Authors>
<Company>Newtonsoft</Company>
<Product>Json.NET</Product>
<NeutralLanguage>en-US</NeutralLanguage>
<Copyright>Copyright © James Newton-King 2008</Copyright>
<AssemblyName>Newtonsoft.Json.FuzzTests</AssemblyName>
<RootNamespace>Newtonsoft.Json.FuzzTests</RootNamespace>
<IsPackable>false</IsPackable>
<Nullable>enable</Nullable>
<!-- Disabled because SourceLink isn't referenced to calculate paths -->
<DeterministicSourcePaths>false</DeterministicSourcePaths>
</PropertyGroup>
<ItemGroup>
<ProjectReference Include="..\Newtonsoft.Json\Newtonsoft.Json.csproj" />
</ItemGroup>
</Project>
127 changes: 127 additions & 0 deletions Src/Newtonsoft.Json.Tests/FuzzRegressionTests.cs
View file
@@ -0,0 +1,127 @@
#region License
// Copyright (c) 2007 James Newton-King
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
#endregion

using System.IO;

#if DNXCORE50
using Xunit;
using Test = Xunit.FactAttribute;
using Assert = Newtonsoft.Json.Tests.XUnitAssert;
#else
using NUnit.Framework;
#endif

#pragma warning disable xUnit1013

namespace Newtonsoft.Json.Tests
{
[TestFixture]
public class FuzzRegressionTests : TestFixtureBase
{
private static readonly JsonSerializer jsonSerializer = new();

public static void Roundtrip(string buffer)
{
var serialized1 = Serialize(Deserialize(buffer));
var serialized2 = Serialize(Deserialize(serialized1));
Assert.AreEqual(serialized1, serialized2);
}

private static string Serialize(object o)
{
using var sw1 = new StringWriter();
jsonSerializer.Serialize(sw1, o);
return sw1.ToString();
}

private static object Deserialize(string input)
{
using var sr = new StringReader(input);
using var tr = new JsonTextReader(sr);
return jsonSerializer.Deserialize(tr);
}

[Test]
public void LineCommentWithStarSlashCases()
{
// Fuzzer found these cases:
// The Json "// comment with */" would be serialized as "/* comment with */*/".
// It is now serialized as "// comment with */".
//
// Ideally this would be a [Theory] but we are targetting both NUnit and XUnit.
//
// This is a list of inputs and where they caused a crash.
// - Note that these are not minimal/reduced inputs.
var cases = new[] {
"[//*/I33/\n91.//3", // ParsePositiveInfinity
"[//*/t3.9/\n91675795,77//3", // ParseTrue
"[//*/f33339/\n91675795878,787,[]//3", // ParseFalse
"[//*/N333331/\n,[]//3", // ParseNumberNaN
"[//*/{/\n,7//J:[@", // ParseProperty
"[//*/06.6/\n,[]//3", // ParseNumber
"[5,78,,[//*/3,3,new 4* ,,,,,,33/\n,,,,[],33,,,,,,17911055//3814", // ParseConstructor
"[//*/---------------------------------------------------------------------------------------------------------16.6/\n,[]//3", // ParseReadNumber
"[//6*/)3333/\n,[]//3", // ValidateEnd
"[//*/{'33/\n,33,33//3", // ReadStringIntoBuffer
"[//*//\n8 ,8 ", // ParseComment
@"[//ô [ /
//""ÿ /'/*////
//[7
//
//"" @'///
////
////
//[6
//
//
//[1
// "" x
///***
//[2
//
,'/J "" ' ", // WriteToken
"[2//***;****/,7*", // ReadNumberCharIntoBuffer
"[2///ÿ¢ ¢¢********/,,* ", // ParseValue
@"[// *//[
7//
// ""JJ· 
//',J
//
//',o@7,7
//',o@/ / "" ] 
//',o@7,7
//',o@Ó", // ParseComment
"[2//*/*", // ParsePostValue
"[//*/{A73/\n]1.//3:{\"'\":", // ReadUnquotedPropertyReportIfDone
};

foreach (var c in cases) {
Roundtrip(c);
}
}
}
}
19 changes: 17 additions & 2 deletions Src/Newtonsoft.Json.Tests/JsonTextWriterTest.cs
View file
Expand Up @@ -1699,7 +1699,8 @@ public void WriteComments()


w.WriteToken(r, true); w.WriteToken(r, true);


StringAssert.AreEqual(@"/*comment*//*hi*/*/{/*comment*/ StringAssert.AreEqual(@"//comment*//*hi*/
{/*comment*/
""Name"": /*comment*/ true/*comment after true*//*comment after comma*/, ""Name"": /*comment*/ true/*comment after true*//*comment after comma*/,
""ExpiryDate"": /*comment*/ new Constructor( ""ExpiryDate"": /*comment*/ new Constructor(
/*comment*/, /*comment*/,
Expand All @@ -1715,6 +1716,20 @@ public void WriteComments()
}/*comment *//*comment 1 */", sw.ToString()); }/*comment *//*comment 1 */", sw.ToString());
} }


[Test]
public void NewlinesInSingleLineComments()
{
// it’s not possible for this to be created by parsing JSON,
// but if someone gets creative with the API…
var sw = new StringWriter();
using (var w = new JsonTextWriter(sw))
{
w.WriteComment("*/\nsomething else");
}

StringAssert.AreEqual("//*/\n//something else\n", sw.ToString());
}

[Test] [Test]
public void DisposeSupressesFinalization() public void DisposeSupressesFinalization()
{ {
Expand Down Expand Up @@ -1820,4 +1835,4 @@ public override void Flush()
throw new NotImplementedException(); throw new NotImplementedException();
} }
} }
} }
14 changes: 14 additions & 0 deletions Src/Newtonsoft.Json.sln
View file
Expand Up @@ -16,6 +16,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Newtonsoft.Json.Tests", "Ne
EndProject EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Newtonsoft.Json.TestConsole", "Newtonsoft.Json.TestConsole\Newtonsoft.Json.TestConsole.csproj", "{3CC9C2DF-CD0A-4096-BF46-B4AFDF0147D2}" Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Newtonsoft.Json.TestConsole", "Newtonsoft.Json.TestConsole\Newtonsoft.Json.TestConsole.csproj", "{3CC9C2DF-CD0A-4096-BF46-B4AFDF0147D2}"
EndProject EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Newtonsoft.Json.FuzzTests", "Newtonsoft.Json.FuzzTests\Newtonsoft.Json.FuzzTests.csproj", "{00867C2B-409D-45B2-A78F-F291B6817F70}"
EndProject
Global Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -62,6 +64,18 @@ Global
{3CC9C2DF-CD0A-4096-BF46-B4AFDF0147D2}.Release|x64.Build.0 = Release|Any CPU {3CC9C2DF-CD0A-4096-BF46-B4AFDF0147D2}.Release|x64.Build.0 = Release|Any CPU
{3CC9C2DF-CD0A-4096-BF46-B4AFDF0147D2}.Release|x86.ActiveCfg = Release|Any CPU {3CC9C2DF-CD0A-4096-BF46-B4AFDF0147D2}.Release|x86.ActiveCfg = Release|Any CPU
{3CC9C2DF-CD0A-4096-BF46-B4AFDF0147D2}.Release|x86.Build.0 = Release|Any CPU {3CC9C2DF-CD0A-4096-BF46-B4AFDF0147D2}.Release|x86.Build.0 = Release|Any CPU
{00867C2B-409D-45B2-A78F-F291B6817F70}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{00867C2B-409D-45B2-A78F-F291B6817F70}.Debug|Any CPU.Build.0 = Debug|Any CPU
{00867C2B-409D-45B2-A78F-F291B6817F70}.Debug|x64.ActiveCfg = Debug|Any CPU
{00867C2B-409D-45B2-A78F-F291B6817F70}.Debug|x64.Build.0 = Debug|Any CPU
{00867C2B-409D-45B2-A78F-F291B6817F70}.Debug|x86.ActiveCfg = Debug|Any CPU
{00867C2B-409D-45B2-A78F-F291B6817F70}.Debug|x86.Build.0 = Debug|Any CPU
{00867C2B-409D-45B2-A78F-F291B6817F70}.Release|Any CPU.ActiveCfg = Release|Any CPU
{00867C2B-409D-45B2-A78F-F291B6817F70}.Release|Any CPU.Build.0 = Release|Any CPU
{00867C2B-409D-45B2-A78F-F291B6817F70}.Release|x64.ActiveCfg = Release|Any CPU
{00867C2B-409D-45B2-A78F-F291B6817F70}.Release|x64.Build.0 = Release|Any CPU
{00867C2B-409D-45B2-A78F-F291B6817F70}.Release|x86.ActiveCfg = Release|Any CPU
{00867C2B-409D-45B2-A78F-F291B6817F70}.Release|x86.Build.0 = Release|Any CPU
EndGlobalSection EndGlobalSection
GlobalSection(SolutionProperties) = preSolution GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE HideSolutionNode = FALSE
Expand Down
25 changes: 20 additions & 5 deletions Src/Newtonsoft.Json/JsonTextWriter.cs
View file
Expand Up @@ -784,10 +784,25 @@ public override void WriteValue(Uri? value)
public override void WriteComment(string? text) public override void WriteComment(string? text)
{ {
InternalWriteComment(); InternalWriteComment();


_writer.Write("/*"); // if text contains "*/" then it must have been a line comment
_writer.Write(text); if (text != null && text.IndexOf("*/", StringComparison.Ordinal) > -1)
_writer.Write("*/"); {
// each line must be emitted separately
var parts = text.Split('\n');
foreach (var part in parts)
{
_writer.Write("//");
_writer.Write(part);
_writer.Write("\n");
}
}
else
{
_writer.Write("/*");
_writer.Write(text);
_writer.Write("*/");
}
} }


/// <summary> /// <summary>
Expand Down Expand Up @@ -924,4 +939,4 @@ private int WriteNumberToBuffer(uint value, bool negative)
return totalLength; return totalLength;
} }
} }
} }

0 comments on commit 2eaa475

Please sign in to comment.