Skip to content

add NRT test #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Goals of this project

* Provide an idiomatic F# API for interacting with MongoDB.
* Provide support for F# types for interacting with MongoDB.
* Have an implementation that is fully testable without connecting to a server.
* Isomorphic bson serialization for C# and F#.

Expand Down Expand Up @@ -84,6 +84,13 @@ If you want to auto-generate `ObjectId` (as the Id of the collection), add `[<CL
The case of the discriminated union is stored in `_t` key.
Each value of the DU is serialized as an `object` using its corresponding value name.

## Nullable Reference Type
NRT are serialized as:
* `null` if `Null`
* `object` if `NonNull` object

:warning: As of now, NRT can't be considered `null` when deserializing if value is missing.

# License
The contents of this library are made available under the [Apache License, Version 2.0][license].

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
<Compile Include="Serialization\FSharpListSerializationTests.fs" />
<Compile Include="Serialization\FSharpMapSerializationTests.fs" />
<Compile Include="Serialization\FSharpOptionSerializationTests.fs" />
<Compile Include="Serialization\FSharpNRTSerializationTests.fs" />
<Compile Include="Serialization\FSharpValueOptionSerializationTests.fs" />
<Compile Include="Serialization\FSharpRecordSerializationTests.fs" />
<Compile Include="Serialization\FSharpSetSerializationTests.fs" />
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
(*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*)

namespace FSharp.MongoDB.Bson.Tests.Serialization

open MongoDB.Bson
open FsUnit
open NUnit.Framework

module FSharpNRTSerialization =

type Primitive =
{ String : string | null }

[<Test>]
let ``test serialize nullable reference (null) in a record type``() =
let value = { String = null }

let result = serialize value
let expected = BsonDocument([ BsonElement("String", BsonNull.Value) ])

result |> should equal expected

[<Test>]
let ``test deserialize nullable reference (null) in a record type)``() =
// FIXME: this shall support deserializing missing null value for NRT
// as of now this means NRT can't be a missing value while deserializing
// let doc = BsonDocument()
let doc = BsonDocument([ BsonElement("String", BsonNull.Value) ])

let result = deserialize<Primitive> doc
let expected = { String = null }

result |> should equal expected

[<Test>]
let ``test serialize nullable reference (some) in a record type``() =
let value = { String = "A String" }

let result = serialize value
let expected = BsonDocument([ BsonElement("String", BsonString "A String") ])

result |> should equal expected

[<Test>]
let ``test deserialize nullable reference (some) in a record type``() =
let doc = BsonDocument([ BsonElement("String", BsonString "A String") ])

let result = deserialize<Primitive> doc
let expected = { String = "A String" }

result |> should equal expected
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
(* Copyright (c) 2015 MongoDB, Inc.
*
(*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
Expand Down
Loading