RavenDB.TestDriver 7.1.0

Prefix Reserved
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package RavenDB.TestDriver --version 7.1.0
                    
NuGet\Install-Package RavenDB.TestDriver -Version 7.1.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="RavenDB.TestDriver" Version="7.1.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="RavenDB.TestDriver" Version="7.1.0" />
                    
Directory.Packages.props
<PackageReference Include="RavenDB.TestDriver" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add RavenDB.TestDriver --version 7.1.0
                    
#r "nuget: RavenDB.TestDriver, 7.1.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#addin nuget:?package=RavenDB.TestDriver&version=7.1.0
                    
Install as a Cake Addin
#tool nuget:?package=RavenDB.TestDriver&version=7.1.0
                    
Install as a Cake Tool

RavenDB .NET Test Driver

You're looking at RavenDB Test Driver Client (SDK) NuGet release.
It makes it easy to write tests that require RavenDB instance, leveraging embedded server and providing you friendly API.

RavenDB is a NoSQL database that fuses extreme performance with ease-of-use, offering above the roof developer experience.
Learn more at https://ravendb.net or visit our GitHub repository.

Installation

Get the latest stable version from NuGet.

Learning resources

Community

Getting started

Configure

var testServerOptions = new TestServerOptions
{
    // Looks for the newest version on your machine including 3.1.15 and any newer patches
    // but not major new releases (default is .NET version at time of server release).
    FrameworkVersion = "3.1.15+",

    // Specifies where ravendb server binaries are located (Optional)
    ServerDirectory = "PATH_TO_RAVENDB_SERVER",

    // Specifies where ravendb data will be placed/located (Optional)
    DataDirectory = "PATH_TO_RAVENDB_DATADIR", 
};

ConfigureServer(testServerOptions);

Write a test

using Raven.Client.Documents;
using Raven.TestDriver;
using Xunit;
using System.Linq;
using Raven.Client.Documents.Indexes;

namespace RavenDBTestDriverFullExample
{

    public class RavenDBTestDriver : RavenTestDriver
    {
        static RavenDBTestDriver()
        {
            // ConfigureServer() must be set before calling GetDocumentStore()
            // and can only be set once per test run.
            ConfigureServer(new TestServerOptions
            {
                DataDirectory = "C:\\RavenDBTestDir"
            });
        }
        // This allows us to modify the conventions of the store we get from 'GetDocumentStore'
        protected override void PreInitialize(IDocumentStore documentStore)
        {
            documentStore.Conventions.MaxNumberOfRequestsPerSession = 50;
        }

        [Fact]
        public void MyFirstTest()
        {
            // GetDocumentStore() evokes the Document Store, which establishes and manages communication
            // between your client application and a RavenDB cluster via HTTP requests.
            using (var store = GetDocumentStore())
            {
                store.ExecuteIndex(new TestDocumentByName());
                using (var session = store.OpenSession())
                {
                    session.Store(new TestDocument { Name = "Hello world!" });
                    session.Store(new TestDocument { Name = "Goodbye..." });
                    session.SaveChanges();
                }
                // If we want to query documents, sometimes we need to wait for the indexes to catch up  
                // to prevent using stale indexes.
                WaitForIndexing(store);

                // Sometimes we want to debug the test itself. This method redirects us to the studio
                // so that we can see if the code worked as expected (in this case, created two documents).
                WaitForUserToContinueTheTest(store);

                // Queries are defined in the session scope.
                // If there is no relevant index to quickly answer the query, RavenDB creates an auto-index
                // based on the query parameters.
                // This query will use the static index defined in lines 63-70 and filter the results by name.
                using (var session = store.OpenSession())
                {
                    var query = session.Query<TestDocument, TestDocumentByName>()
                        .Where(x => x.Name == "hello").ToList();
                    Assert.Single(query);
                }
            }
        }
    }
    // AbstractIndexCreationTask allows you to create and manually define a static index. 
    public class TestDocumentByName : AbstractIndexCreationTask<TestDocument>
    {
        public TestDocumentByName()
        {
            Map = docs => from doc in docs select new { doc.Name };
            Indexes.Add(x => x.Name, FieldIndexing.Search);
        }
    }

    public class TestDocument
    {
        public string Name { get; set; }
    }
}

Contributing

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on RavenDB.TestDriver:

Package Downloads
ECommerce.Data.RavenDbProvider

a resilient abstract data access. StartPoint ECommerce.DataAccess based on Hexagonal architecture gives you the capacity to access any data source with retrying and fallback action

GitHub repositories (10)

Showing the top 10 popular GitHub repositories that depend on RavenDB.TestDriver:

Repository Stars
JasperFx/wolverine
Supercharged .NET server side development!
Aguafrommars/TheIdServer
OpenID/Connect, OAuth2, WS-Federation and SAML 2.0 server based on Duende IdentityServer and ITFoxtec Identity SAML 2.0 with its admin UI
CommunityToolkit/Aspire
A community project with additional components and extensions for .NET Aspire
linkdotnet/Blog
A blog (engine) completely written in C# and Blazor. It aims to be a simple use and easy to extend platform. Blogposts are written in Markdown and are rendered to HTML. This gives all the flexibility needed to express yourself but also have an easy way of creating posts in the first place.
TcOpenGroup/TcOpen
Application framework for industrial automation built on top of TwinCAT3 and .NET.
RemyDuijkeren/NodaMoney
NodaMoney provides a library that treats Money as a first class citizen and handles all the ugly bits like currencies and formatting.
stoveproject/Stove
Domain Driven Design oriented application framework, meets CRUD needs
RemiBou/Toss.Blazor
Experimental project using AspNetCore Blazor
linkdotnet/BlogExamples
Contains all of my examples from various blog posts
ravendb/samples-yabt
"Yet Another Bug Tracker" solution sample for RavenDB and .NET with Angular UI
Version Downloads Last Updated
7.1.1-rc-71006 126 7/8/2025
7.1.0 1,743 7/1/2025
7.1.0-rc-71004 136 6/25/2025
7.1.0-rc-71003 141 6/18/2025
7.1.0-rc-71000 153 5/29/2025
7.0.4 607 6/25/2025
7.0.3 1,117 6/10/2025
7.0.2 6,157 4/29/2025
7.0.1 5,836 3/27/2025
7.0.0 13,395 2/4/2025
6.2.7 214 6/25/2025
6.2.6 835 6/10/2025
6.2.5 2,406 4/29/2025
6.2.4 2,514 3/18/2025
6.2.3 19,909 1/21/2025
6.2.2 28,530 12/11/2024
6.2.1 20,108 10/30/2024
6.2.0 7,965 9/17/2024
6.0.110 368 3/18/2025
6.0.109 806 1/21/2025
6.0.108 269 12/11/2024
6.0.107 871 10/30/2024
6.0.106 8,810 9/17/2024
6.0.105 19,439 7/23/2024
6.0.104 10,727 6/17/2024
6.0.103 6,518 5/16/2024
6.0.102 13,886 4/29/2024
6.0.101 34,523 3/19/2024
6.0.100 48,349 2/12/2024
6.0.4 4,535 1/19/2024
6.0.3 60,492 1/16/2024
6.0.2 2,483 12/27/2023
6.0.1 5,206 11/14/2023
6.0.0 4,217 10/2/2023
5.4.209 382 6/10/2025
5.4.208 1,218 4/29/2025
5.4.207 1,066 3/18/2025
5.4.206 10,020 1/21/2025
5.4.205 4,153 12/11/2024
5.4.204 8,521 10/30/2024
5.4.203 9,752 10/2/2024
5.4.202 601 9/17/2024
5.4.201 11,187 7/23/2024
5.4.200 16,502 6/17/2024
5.4.119 2,715 5/16/2024
5.4.118 3,054 4/29/2024
5.4.117 11,757 3/19/2024
5.4.116 9,075 2/12/2024
5.4.115 2,607 1/18/2024
5.4.114 166 1/16/2024
5.4.113 8,349 12/27/2023
5.4.112 113,504 11/14/2023
5.4.111 10,126 10/3/2023
5.4.110 3,551 9/12/2023
5.4.109 14,050 8/1/2023
5.4.107 5,101 6/23/2023
5.4.106 332 6/22/2023
5.4.105 748 6/20/2023
5.4.104 36,904 5/12/2023
5.4.103 27,189 3/30/2023
5.4.102 4,204 3/27/2023
5.4.101 15,425 2/13/2023
5.4.100 18,358 1/9/2023
5.4.5 54,908 11/21/2022
5.4.4 13,556 10/12/2022
5.4.3 799 10/10/2022
5.4.2 18,592 9/1/2022
5.4.1 35,343 7/19/2022
5.4.0 11,791 7/18/2022
5.3.108 40,180 1/9/2023
5.3.107 2,913 11/21/2022
5.3.106 554 10/10/2022
5.3.105 625 9/1/2022
5.3.104 1,915 7/18/2022
5.3.103 29,599 6/7/2022
5.3.102 56,163 4/19/2022
5.3.101 24,362 3/15/2022
5.3.100 31,993 2/1/2022
5.3.2 9,369 1/7/2022
5.3.1 5,742 12/21/2021
5.3.0 4,793 11/29/2021
5.2.116 224 8/1/2023
5.2.115 229 6/23/2023
5.2.114 219 6/22/2023
5.2.113 229 6/20/2023
5.2.112 498 5/12/2023
5.2.111 595 3/30/2023
5.2.110 875 3/27/2023
5.2.109 680 2/13/2023
5.2.108 3,326 1/9/2023
5.2.107 463 11/21/2022
5.2.106 553 10/10/2022
5.2.105 564 9/1/2022
5.2.104 600 7/18/2022
5.2.103 621 6/7/2022
5.2.102 11,229 4/19/2022
5.2.101 18,687 3/15/2022
5.2.100 919 2/1/2022
5.2.6 821 1/7/2022
5.2.5 492 12/21/2021
5.2.4 13,586 11/15/2021
5.2.3 8,618 9/29/2021
5.2.2 17,504 8/16/2021
5.2.1 2,255 7/1/2021
5.2.0 3,935 6/21/2021
5.1.13 490 12/21/2021
5.1.12 578 11/15/2021
5.1.11 607 9/29/2021
5.1.10 619 8/16/2021
5.1.9 11,890 7/1/2021
5.1.8 3,842 5/26/2021
5.1.7 20,557 4/23/2021
5.1.6 2,533 4/13/2021
5.1.5 7,871 3/1/2021
5.1.4 9,332 2/1/2021
5.1.3 895 1/25/2021
5.1.2 5,866 12/11/2020
5.1.1 2,385 12/1/2020
5.1.0 1,484 11/18/2020
5.0.14 1,145 6/16/2021
5.0.13 657 5/24/2021
5.0.12 12,055 4/23/2021
5.0.11 3,973 4/13/2021
5.0.10 794 3/1/2021
5.0.9 786 2/1/2021
5.0.8 2,366 1/25/2021
5.0.7 3,589 12/11/2020
5.0.6 715 12/1/2020
5.0.5 17,941 11/16/2020
5.0.4 941 11/10/2020
5.0.3 4,615 9/28/2020
5.0.2 7,445 8/17/2020
5.0.1 1,469 8/5/2020
5.0.0 4,249 7/23/2020
4.2.124 278 6/19/2023
4.2.123 3,020 6/7/2022
4.2.122 1,291 4/19/2022
4.2.121 1,096 3/15/2022
4.2.120 2,208 2/1/2022
4.2.119 513 12/21/2021
4.2.118 1,129 11/15/2021
4.2.117 1,033 9/29/2021
4.2.116 977 8/16/2021
4.2.115 1,014 7/1/2021
4.2.114 2,510 5/24/2021
4.2.113 2,598 4/23/2021
4.2.112 821 4/13/2021
4.2.111 3,133 3/1/2021
4.2.110 1,836 2/1/2021
4.2.109 718 1/25/2021
4.2.108 3,390 11/16/2020
4.2.107 713 11/10/2020
4.2.106 6,386 9/28/2020
4.2.105 10,850 8/17/2020
4.2.104 2,348 7/22/2020
4.2.103 13,708 5/25/2020
4.2.102 5,285 4/15/2020
4.2.101 11,757 3/3/2020
4.2.100 867 3/2/2020
4.2.8 15,338 1/21/2020
4.2.6 7,083 12/9/2019
4.2.5 2,703 11/25/2019
4.2.5-patch-42026 529 11/13/2019
4.2.4 3,411 10/14/2019
4.2.4-patch-42020 536 9/27/2019
4.2.3 12,922 8/26/2019
4.2.2 9,483 7/15/2019
4.2.1 1,786 6/27/2019
4.2.0 3,609 5/21/2019
4.2.0-rc-42008 558 5/8/2019
4.2.0-rc-42007 599 4/25/2019
4.2.0-rc-42005 581 4/17/2019
4.2.0-rc-42003 574 4/12/2019
4.2.0-rc-42002 579 4/5/2019
4.2.0-rc-42001 590 3/22/2019
4.2.0-rc-42000 574 3/22/2019
4.1.10 1,272 11/25/2019
4.1.9 776 10/14/2019
4.1.9-patch-41022 515 9/27/2019
4.1.8 2,161 8/26/2019
4.1.8-patch-41017 548 7/15/2019
4.1.7 837 6/27/2019
4.1.6 918 5/21/2019
4.1.5 1,591 4/15/2019
4.1.5-patch-41012 655 3/15/2019
4.1.4 11,061 2/13/2019
4.1.4-patch-41009 697 2/1/2019
4.1.4-patch-41008 2,205 1/7/2019
4.1.3 4,671 11/19/2018
4.1.3-patch-41006 1,223 11/5/2018
4.1.3-patch-41005 814 10/22/2018
4.1.2 5,662 10/15/2018
4.1.1 4,220 9/14/2018
4.1.0 1,653 8/31/2018
4.1.0-rc-41000 854 8/17/2018
4.0.11 1,194 2/28/2019
4.0.10 941 2/13/2019
4.0.10-patch-40057 654 2/1/2019
4.0.10-patch-40056 682 1/7/2019
4.0.9 977 11/19/2018
4.0.9-patch-40054 789 11/5/2018
4.0.9-patch-40052 766 10/22/2018
4.0.8 1,071 10/15/2018
4.0.7 1,083 8/31/2018
4.0.6 2,543 8/3/2018
4.0.6-patch-40047 998 7/2/2018
4.0.5 6,207 6/12/2018
4.0.4-patch-40038 1,155 5/18/2018
4.0.3 18,308 4/23/2018
4.0.3-patch-40034 1,640 3/30/2018
4.0.3-patch-40033 1,152 3/19/2018
4.0.3-patch-40031 1,199 3/7/2018
4.0.2 3,539 2/26/2018
4.0.1 1,499 2/20/2018
4.0.0 1,855 2/6/2018