CSHARP-4420: EG tests for Atlas Search

build.cake

@@ -240,6 +240,13 @@ Task("TestAtlasDataLake")
         action: (BuildConfig buildConfig, Path testProject) =>
            RunTests(buildConfig, testProject, filter: "Category=\"AtlasDataLake\""));
 
+Task("TestAtlasSearch")
+    .IsDependentOn("Build")
+    .DoesForEach(
+        items: GetFiles("./**/MongoDB.Driver.Tests.csproj"),
+        action: (BuildConfig buildConfig, Path testProject) =>
+           RunTests(buildConfig, testProject, filter: "Category=\"AtlasSearch\""));
+
 Task("TestOcsp")
     .IsDependentOn("Build")
     .DoesForEach(

evergreen/evergreen.yml

@@ -684,6 +684,15 @@ functions:
           ${PREPARE_SHELL}
           evergreen/run-atlas-data-lake-test.sh
 
+  run-atlas-search-test:
+    - command: shell.exec
+      type: test
+      params:
+        working_dir: mongo-csharp-driver
+        script: |
+          ${PREPARE_SHELL}
+          ATLAS_SEARCH="${ATLAS_SEARCH}" evergreen/run-atlas-search-test.sh
+
   run-ocsp-test:
     - command: shell.exec
       type: test
@@ -1202,6 +1211,10 @@ tasks:
         - func: bootstrap-mongohoused
         - func: run-atlas-data-lake-test
 
+    - name: atlas-search-test
+      commands:
+        - func: run-atlas-search-test
+
     - name: test-serverless-net472
       exec_timeout_secs: 2700 # 45 minutes: 15 for setup + 30 for tests
       commands:
@@ -2068,6 +2081,13 @@ buildvariants:
   tasks:
     - name: atlas-data-lake-test
 
+- name: atlas-search-test
+  display_name: "Atlas Search Tests"
+  run_on:
+    - windows-64-vs2017-test
+  tasks:
+    - name: atlas-search-test
+
 - name: gssapi-auth-tests-windows
   run_on:
     - windows-64-vs2017-test

evergreen/run-atlas-search-test.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+set -o xtrace
+set -o errexit  # Exit the script with error if any of the commands fail
+
+############################################
+#            Main Program                  #
+############################################
+
+echo "Running Atlas Search driver tests"
+
+export ATLAS_SEARCH_TESTS_ENABLED=true
+
+powershell.exe .\\build.ps1 --target TestAtlasSearch

src/MongoDB.Driver/Linq/MongoQueryable.cs

@@ -21,6 +21,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using MongoDB.Bson.Serialization;
+using MongoDB.Driver.Core.Misc;
 using MongoDB.Driver.Search;
 
 namespace MongoDB.Driver.Linq

src/MongoDB.Driver/Search/Highlight.cs

@@ -0,0 +1,79 @@
+// Copyright 2010-present 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
+//
+// 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.
+
+using MongoDB.Bson;
+using MongoDB.Bson.Serialization.Attributes;
+
+namespace MongoDB.Driver.Search
+{
+    /// <summary>
+    /// Represents a result of highlighting.
+    /// </summary>
+    public sealed class Highlight
+    {
+        /// <summary>
+        /// Gets or sets the document field which returned a match.
+        /// </summary>
+        [BsonElement("path")]
+        public string Path { get; private set; }
+
+        /// <summary>
+        /// Gets or sets one or more objects containing the matching text and the surrounding text
+        /// (if any).
+        /// </summary>
+        [BsonElement("texts")]
+        public HighlightText[] Texts { get; private set; }
+
+        /// <summary>
+        /// Gets or sets the score assigned to this result.
+        /// </summary>
+        [BsonElement("score")]
+        public double Score { get; private set; }
+    }
+
+    /// <summary>
+    /// Represents the matching text or the surrounding text of a highlighting result.
+    /// </summary>
+    public class HighlightText
+    {
+        /// <summary>
+        /// Gets or sets the text from the field which returned a match.
+        /// </summary>
+        [BsonElement("value")]
+        public string Value { get; private set; }
+
+        /// <summary>
+        /// Gets or sets the type of text, matching or surrounding.
+        /// </summary>
+        [BsonElement("type")]
+        [BsonRepresentation(BsonType.String)]
+        public HighlightTextType Type { get; private set; }
+    }
+
+    /// <summary>
+    /// Represents the type of text in a highlighting result, matching or surrounding.
+    /// </summary>
+    public enum HighlightTextType
+    {
+        /// <summary>
+        /// Indicates that the text contains a match.
+        /// </summary>
+        Hit,
+
+        /// <summary>
+        /// Indicates that the text contains the text content adjacent to a matching string.
+        /// </summary>
+        Text
+    }
+}

src/MongoDB.Driver/Search/HighlightOptions.cs

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+using System;
+using System.Linq.Expressions;
 using MongoDB.Bson;
 using MongoDB.Bson.Serialization;
 using MongoDB.Driver.Core.Misc;
@@ -42,6 +44,27 @@ public HighlightOptions(PathDefinition<TDocument> path, int? maxCharsToExamine =
             _maxNumPassages = maxNumPassages;
         }
 
+        /// <summary>
+        /// Creates highlighting options.
+        /// </summary>
+        /// <param name="path">The document field to search.</param>
+        /// <param name="maxCharsToExamine">
+        /// The maximum number of characters to examine on a document when performing highlighting
+        /// for a field.
+        /// </param>
+        /// <param name="maxNumPassages">
+        /// The number of high-scoring passages to return per document in the highlighting results
+        /// for each field.
+        /// </param>
+        /// <returns>Highlighting options.</returns>
+        public HighlightOptions(
+            Expression<Func<TDocument, object>> path,
+            int? maxCharsToExamine = null,
+            int? maxNumPassages = null) :
+            this(new ExpressionFieldDefinition<TDocument>(path), maxCharsToExamine, maxNumPassages)
+        {
+        }
+
         /// <summary>
         /// Gets or sets the document field to search.
         /// </summary>