DOC-4345 added testable version of home page JSON example

Author: andy-stark-redis

tests/Doc/HomeJsonExample.cs

@@ -0,0 +1,175 @@
+// EXAMPLE: cs_home_json
+
+// STEP_START import
+using NRedisStack.RedisStackCommands;
+using NRedisStack.Search;
+using NRedisStack.Search.Aggregation;
+using NRedisStack.Search.Literals.Enums;
+using NRedisStack.Tests;
+using StackExchange.Redis;
+// STEP_END
+
+// REMOVE_START
+namespace Doc;
+[Collection("DocsTests")]
+// REMOVE_END
+
+// HIDE_START
+public class HomeJsonExample
+{
+
+    [SkipIfRedis(Is.OSSCluster)]
+    public void run()
+    {
+        // STEP_START connect
+        var muxer = ConnectionMultiplexer.Connect("localhost:6379");
+        var db = muxer.GetDatabase();
+        // STEP_END
+
+        //REMOVE_START
+        // Clear any keys here before using them in tests.
+        db.KeyDelete(new RedisKey[] { "user:1", "user:2", "user:3" });
+        db.FT().DropIndex("idx:users");
+        //REMOVE_END
+        // HIDE_END
+
+        // STEP_START create_data
+        var user1 = new
+        {
+            name = "Paul John",
+            email = "[email protected]",
+            age = 42,
+            city = "London"
+        };
+
+        var user2 = new
+        {
+            name = "Eden Zamir",
+            email = "[email protected]",
+            age = 29,
+            city = "Tel Aviv"
+        };
+
+        var user3 = new
+        {
+            name = "Paul Zamir",
+            email = "[email protected]",
+            age = 35,
+            city = "Tel Aviv"
+        };
+        // STEP_END
+
+        // STEP_START make_index
+        var schema = new Schema()
+            .AddTextField(new FieldName("$.name", "name"))
+            .AddTagField(new FieldName("$.city", "city"))
+            .AddNumericField(new FieldName("$.age", "age"));
+
+        bool indexCreated = db.FT().Create(
+            "idx:users",
+            new FTCreateParams()
+                .On(IndexDataType.JSON)
+                .Prefix("user:"),
+            schema
+        );
+        // STEP_END
+
+        // Tests for 'make_index' step.
+        // REMOVE_START
+        Assert.True(indexCreated);
+        // REMOVE_END
+
+
+        // STEP_START add_data
+        bool user1Set = db.JSON().Set("user:1", "$", user1);
+        bool user2Set = db.JSON().Set("user:2", "$", user2);
+        bool user3Set = db.JSON().Set("user:3", "$", user3);
+        // STEP_END
+
+        // Tests for 'add_data' step.
+        // REMOVE_START
+        Assert.True(user1Set);
+        Assert.True(user2Set);
+        Assert.True(user3Set);
+        // REMOVE_END
+
+
+        // STEP_START query1
+        SearchResult findPaulResult = db.FT().Search(
+            "idx:users",
+            new Query("Paul @age:[30 40]")
+        );
+        Console.WriteLine(string.Join(
+            ", ",
+            findPaulResult.Documents.Select(x => x["json"])
+        ));
+        // >>> {"name":"Paul Zamir","email":"[email protected]", ...
+        // STEP_END
+
+        // Tests for 'query1' step.
+        // REMOVE_START
+        Assert.Equal(
+            "{\"name\":\"Paul Zamir\",\"email\":\"[email protected]\",\"age\":35,\"city\":\"Tel Aviv\"}",
+            string.Join(", ", findPaulResult.Documents.Select(x => x["json"]))
+        );
+        // REMOVE_END
+
+
+        // STEP_START query2
+        var citiesResult = db.FT().Search(
+            "idx:users",
+            new Query("Paul")
+                .ReturnFields(new FieldName("$.city", "city"))
+        );
+        Console.WriteLine(string.Join(
+            ", ",
+            citiesResult.Documents.Select(x => x["city"]).OrderBy(x => x)
+        ));
+        // >>> London, Tel Aviv
+        // STEP_END
+
+        // Tests for 'query2' step.
+        // REMOVE_START
+        Assert.Equal(
+            "London, Tel Aviv",
+            string.Join(", ", citiesResult.Documents.Select(x => x["city"]).OrderBy(x => x))
+        );
+        // REMOVE_END
+
+
+        // STEP_START query3
+        AggregationRequest aggRequest = new AggregationRequest("*")
+            .GroupBy("@city", Reducers.Count().As("count"));
+
+        AggregationResult aggResult = db.FT().Aggregate("idx:users", aggRequest);
+        IReadOnlyList<Dictionary<string, RedisValue>> resultsList =
+                                                        aggResult.GetResults();
+
+        for (var i = 0; i < resultsList.Count; i++)
+        {
+            Dictionary<string, RedisValue> item = resultsList.ElementAt(i);
+            Console.WriteLine($"{item["city"]} - {item["count"]}");
+        }
+        // >>> London - 1
+        // >>> Tel Aviv - 2
+        // STEP_END
+
+        // Tests for 'query3' step.
+        // REMOVE_START
+        Assert.Equal(2, resultsList.Count);
+
+        Dictionary<string, RedisValue> testItem = resultsList.ElementAt(0);
+        Assert.Equal("London", testItem["city"]);
+        Assert.Equal(1, testItem["count"]);
+
+        testItem = resultsList.ElementAt(1);
+        Assert.Equal("Tel Aviv", testItem["city"]);
+        Assert.Equal(2, testItem["count"]);
+        // REMOVE_END
+
+
+        // HIDE_START
+    }
+}
+// HIDE_END
+