Skip to content

Commit

Permalink
Add doctest for Search Quickstart (#134)
Browse files Browse the repository at this point in the history
  • Loading branch information
@uglide
uglide authored May 19, 2023
1 parent 7d2b006 commit b0324f2
Show file tree
Hide file tree
Showing 3 changed files with 277 additions and 26 deletions.
35 changes: 35 additions & 0 deletions .github/workflows/doctests.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Documentation Tests

on:
push:
pull_request:

workflow_dispatch:

permissions:
contents: read

jobs:
doctests:
runs-on: ubuntu-latest
services:
redis-stack:
image: redis/redis-stack-server:latest
options: >-
--health-cmd "redis-cli ping" --health-interval 10s --health-timeout 5s --health-retries 5
ports:
- 6379:6379
steps:
- uses: actions/checkout@v3
- name: .NET Core 6
uses: actions/setup-dotnet@v2
with:
dotnet-version: '6.0.x'
- name: .NET Core 7
uses: actions/setup-dotnet@v2
with:
dotnet-version: '7.0.x'
- name: run tests
working-directory: tests/Doc
run: |
dotnet test
50 changes: 24 additions & 26 deletions tests/Doc/Doc.csproj
View file
Original file line number Diff line number Diff line change
@@ -1,26 +1,24 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<IsWindows>$([System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::get_Windows())))</IsWindows>
<TargetFrameworks Condition=" '$(IsWindows)' == 'true'">net6.0;net7.0;net481</TargetFrameworks>
<TargetFrameworks Condition=" '$(IsWindows)' != 'true'">net6.0;net7.0</TargetFrameworks>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<LangVersion>latest</LangVersion>


<IsPackable>false</IsPackable>
<OutputType>Module</OutputType>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
<PackageReference Include="xunit" Version="2.4.2" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
<PackageReference Include="StackExchange.Redis" Version="2.6.104" />
</ItemGroup>

</Project>
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<IsWindows>$([System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::get_Windows())))</IsWindows>
<TargetFrameworks Condition=" '$(IsWindows)' == 'true'">net6.0;net7.0;net481</TargetFrameworks>
<TargetFrameworks Condition=" '$(IsWindows)' != 'true'">net6.0;net7.0</TargetFrameworks>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<LangVersion>latest</LangVersion>
<IsPackable>false</IsPackable>
<OutputType>Module</OutputType>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
<PackageReference Include="xunit" Version="2.4.2" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
<PackageReference Include="StackExchange.Redis" Version="2.6.104" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\..\src\NRedisStack\NRedisStack.csproj" />
</ItemGroup>
</Project>
218 changes: 218 additions & 0 deletions tests/Doc/SearchQuickstartExample.cs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,218 @@
// EXAMPLE: search_quickstart
using NRedisStack.RedisStackCommands;
using NRedisStack.Search;
using NRedisStack.Search.Aggregation;
using NRedisStack.Search.Literals.Enums;
using StackExchange.Redis;

// REMOVE_START
namespace NRedisStack.Doc;
// REMOVE_END

public class SearchQuickstartExample
{
[Fact]
public void run()
{
// STEP_START connect
var redis = ConnectionMultiplexer.Connect("localhost:6379");
var db = redis.GetDatabase();
var ft = db.FT();
var json = db.JSON();
// STEP_END

// REMOVE_START
try
{
ft.DropIndex("idx:bicycle");
}
catch
{
}
// REMOVE_END

// STEP_START data_sample
var bike1 = new
{
Brand = "Diaz Ltd",
Model = "Dealer Sl",
Price = 7315.58M,
Description = "The Diaz Ltd Dealer Sl is a reliable choice" +
" for urban cycling. The Diaz Ltd Dealer Sl " +
"is a comfortable choice for urban cycling.",
Condition = "used"
};
// STEP_END

var bicycles = new[]
{
bike1,
new
{
Brand = "Bridges Group",
Model = "Project Pro",
Price = 3610.82M,
Description =
"This mountain bike is perfect for mountain biking. " +
"The Bridges Group Project Pro is a responsive choice" +
" for mountain biking.",
Condition = "used"
},
new
{
Brand = "Vega, Cole and Miller",
Model = "Group Advanced",
Price = 8961.42M,
Description =
"The Vega, Cole and Miller Group Advanced provides an " +
"excellent ride. With its fast carbon frame and 24 gears," +
" this bicycle is perfect for any terrain.",
Condition = "used"
},
new
{
Brand = "Powell-Montgomery",
Model = "Angle Race",
Price = 4050.27M,
Description =
"The Powell-Montgomery Angle Race is a smooth choice for" +
" road cycling. The Powell-Montgomery Angle Race" +
" provides a durable ride.",
Condition = "used"
},
new
{
Brand = "Gill-Lewis",
Model = "Action Evo",
Price = 283.68M,
Description =
"The Gill-Lewis Action Evo provides a smooth ride. " +
"The Gill-Lewis Action Evo provides an excellent ride.",
Condition = "used"
},
new
{
Brand = "Rodriguez-Guerrero",
Model = "Drama Comp",
Price = 4462.55M,
Description =
"This kids bike is perfect for young riders. With its " +
"excellent aluminum frame and 12 gears, this bicycle " +
"is perfect for any terrain.",
Condition = "new"
},
new
{
Brand = "Moore PLC",
Model = "Award Race",
Price = 3790.76M,
Description =
"This olive folding bike features a carbon frame and" +
" 27.5 inch wheels. This folding bike is perfect for" +
" compact storage and transportation.",
Condition = "new"
},
new
{
Brand = "Hall, Haley and Hayes",
Model = "Weekend Plus",
Price = 2008.4M,
Description =
"The Hall, Haley and Hayes Weekend Plus provides a" +
" comfortable ride. This blue kids bike features a" +
" steel frame and 29.0 inch wheels.",
Condition = "new"
},
new
{
Brand = "Peck-Carson",
Model = "Sun Hybrid",
Price = 9874.95M,
Description =
"With its comfortable aluminum frame and 25 gears," +
" this bicycle is perfect for any terrain. The " +
"Peck-Carson Sun Hybrid provides a comfortable ride.",
Condition = "new"
},
new
{
Brand = "Fowler Ltd",
Model = "Weekend Trail",
Price = 3833.71M,
Description =
"The Fowler Ltd Letter Trail is a comfortable choice" +
" for transporting cargo. This cargo bike is " +
"perfect for transporting cargo.",
Condition = "refurbished"
}
};

// STEP_START define_index
var schema = new Schema()
.AddTextField(new FieldName("$.Brand", "Brand"))
.AddTextField(new FieldName("$.Model", "Model"))
.AddTextField(new FieldName("$.Description", "Description"))
.AddNumericField(new FieldName("$.Price", "Price"))
.AddTagField(new FieldName("$.Condition", "Condition"));
// STEP_END

// STEP_START create_index
ft.Create(
"idx:bicycle",
new FTCreateParams().On(IndexDataType.JSON).Prefix("bicycle:"),
schema);
// STEP_END

// STEP_START add_documents
for (int i = 0; i < bicycles.Length; i++)
{
json.Set($"bicycle:{i}", "$", bicycles[i]);
}
// STEP_END

// STEP_START query_single_term_and_num_range
var query = new Query("folding @Price:[1000 4000]");
var res = ft.Search("idx:bicycle", query).Documents;
Console.WriteLine(string.Join("\n", res.Select(x => x["json"])));
// Prints: {"Brand":"Moore PLC","Model":"Award Race","Price":3790.76,
// "Description":"This olive folding bike features a carbon frame
// and 27.5 inch wheels. This folding bike is perfect for compact
// storage and transportation.","Condition":"new"}
// STEP_END
// REMOVE_START
Assert.Single(res);
Assert.Equal("bicycle:6", res[0].Id);
// REMOVE_END

// STEP_START query_single_term_limit_fields
var cargoQuery = new Query("cargo").ReturnFields("Price");
var cargoRes = ft.Search("idx:bicycle", cargoQuery).Documents;
Console.WriteLine(cargoRes.First()["Price"]);
// Prints: 3833.71
// STEP_END
// REMOVE_START
Assert.Single(cargoRes);
Assert.Equal("bicycle:9", cargoRes[0].Id);
// REMOVE_END

// STEP_START simple_aggregation
var request = new AggregationRequest("*").GroupBy(
"@Condition", Reducers.Count().As("Count"));
var result = ft.Aggregate("idx:bicycle", request);

for (var i = 0; i < result.TotalResults; i++)
{
var row = result.GetRow(i);
Console.WriteLine($"{row["Condition"]} - {row["Count"]}");
}

// Prints:
// refurbished - 1
// used - 5
// new - 4
// STEP_END
// REMOVE_START
Assert.Equal(3, result.TotalResults);
// REMOVE_END
}
}

0 comments on commit b0324f2

Please sign in to comment.