Merge pull request #3 from ReneSchwarzer/develop

Version 0.0.7-alpha

Author: ReneSchwarzer

.gitignore

@@ -32,6 +32,9 @@ bld/
 [Ll]og/
 [Ll]ogs/
 
+# Visual Studi Code
+.vscode
+
 # Visual Studio 2015/2017 cache/options directory
 .vs/
 # Uncomment if you have tasks that create the project's static files in wwwroot

README.md

@@ -23,6 +23,7 @@ WebExpress.WebIndex is part of the WebExpress family. The project provides a rev
 to enable a quick and efficient search for data. The index can be filtered using the 
 wql (webexpress query language). Even though the reverse index is part of the WebExpress 
 family, it can also be used in other projects (outside of WebExpress).
+For detailed information about WebIndex, see [concept](https://github.com/ReneSchwarzer/WebExpress.WebIndex/blob/main/doc/concept.md).
 
 # Download 
 The current binaries are available for download [here](https://github.com/ReneSchwarzer/WebExpress/releases).

doc/concept.md

@@ -0,0 +1,47 @@
+using Xunit.Abstractions;
+
+namespace WebExpress.WebIndex.Test.DocumentStore
+{
+    /// <summary>
+    /// Test class for testing the document store.
+    /// </summary>
+    /// <param name="fixture">The log.</param>
+    /// <param name="output">The test context.</param>
+    public abstract class UnitTestDocumentStore<T>(T fixture, ITestOutputHelper output) : IClassFixture<T> where T : class
+    {
+        /// <summary>
+        /// Returns the log.
+        /// </summary>
+        protected ITestOutputHelper Output { get; private set; } = output;
+
+        /// <summary>
+        /// Returns the test context.
+        /// </summary>
+        protected T Fixture { get; private set; } = fixture;
+
+    	/// <summary>
+        /// Returns the context.
+        /// </summary>
+        protected IIndexDocumemntContext Context { get; private set; }
+
+        /// <summary>
+        /// It sets up the preconditions for a unit test.
+        /// </summary>
+        protected void Preconditions()
+        {
+            var context = new IndexContext();
+
+            context.IndexDirectory = Path.Combine(context.IndexDirectory, Path.GetFileNameWithoutExtension(Path.GetRandomFileName()));
+            Context = new IndexDocumemntContext(context, new Term.IndexTokenAnalyzer(context));
+        }
+
+        /// <summary>
+        /// It performs cleanup tasks after a unit test.
+        /// </summary>
+        protected void Postconditions()
+        {
+            Context.TokenAnalyzer.Dispose();
+            Directory.Delete(Context.IndexDirectory, true);
+        }
+    }
+}

src/WebExpress.WebIndex.Test/DocumentStore/UnitTestDocumentStore.cs

@@ -0,0 +1,200 @@
+using WebExpress.WebIndex.Memory;
+using WebExpress.WebIndex.Test.Document;
+using WebExpress.WebIndex.Test.Fixture;
+using Xunit.Abstractions;
+
+namespace WebExpress.WebIndex.Test.DocumentStore
+{
+    /// <summary>
+    /// Test class for testing the memory-based document store.
+    /// </summary>
+    public class UnitTestDocumentStoreMemoryA : UnitTestDocumentStore<UnitTestIndexFixtureIndexA>
+    {
+        /// <summary>
+        /// Constructor
+        /// </summary>
+        /// <param name="fixture">The log.</param>
+        /// <param name="output">The test context.</param>
+        public UnitTestDocumentStoreMemoryA(UnitTestIndexFixtureIndexA fixture, ITestOutputHelper output)
+            : base(fixture, output)
+        {
+        }
+
+        /// <summary>
+        /// Creates a document store.
+        /// </summary>
+        [Fact]
+        public void Create()
+        {
+            // preconditions
+            var context = new IndexContext();
+
+            // test execution
+            var documentStore = new IndexMemoryDocumentStore<UnitTestIndexTestDocumentA>(context, 5);
+
+            // postconditions
+            documentStore.Dispose();
+        }
+
+        /// <summary>
+        /// Adds items to a document store.
+        /// </summary>
+        [Fact]
+        public void Add()
+        {
+            // preconditions
+            Preconditions();
+            var documentStore = new IndexMemoryDocumentStore<UnitTestIndexTestDocumentA>(Context, 5);
+
+            documentStore.Clear();
+
+            // test execution
+            documentStore.Add(Fixture.TestData[0]);
+            documentStore.Add(Fixture.TestData[1]);
+
+            var i = documentStore.GetItem(Fixture.TestData[0].Id);
+
+            Assert.True(i != null && i.Id == Fixture.TestData[0].Id);
+
+            // postconditions
+            documentStore.Dispose();
+            Postconditions();
+        }
+
+        /// <summary>
+        /// Update an entry in the reverse index where the item has a first name change.
+        /// </summary>
+        [Fact]
+        public void UpdateWithChange()
+        {
+            // preconditions
+            Preconditions();
+            var documentStore = new IndexMemoryDocumentStore<UnitTestIndexTestDocumentA>(Context, 5);
+
+            documentStore.Clear();
+            documentStore.Add(Fixture.TestData[0]);
+            documentStore.Add(Fixture.TestData[1]);
+
+            var name = "Update_" + Fixture.TestData[0].Text;
+            var changed = new UnitTestIndexTestDocumentA
+            {
+                Id = Fixture.TestData[0].Id,
+                Text = name,
+            };
+
+            // test execution
+            documentStore.Update(changed);
+
+            var all = documentStore.All;
+
+            Assert.Equal(all.Select(x => x.Id).OrderBy(x => x), Fixture.TestData.Take(2).Select(x => x.Id).OrderBy(x => x));
+            Assert.True(all.Where(x => x.Text == name).Any());
+
+            // postconditions
+            documentStore.Dispose();
+            Postconditions();
+        }
+
+        /// <summary>
+        /// Changes an entry in the reverse index without the element to be changed having any changes.
+        /// </summary>
+        [Fact]
+        public void UpdateWithoutChanges()
+        {
+            // preconditions
+            Preconditions();
+            var documentStore = new IndexMemoryDocumentStore<UnitTestIndexTestDocumentA>(Context, 5);
+
+            documentStore.Clear();
+            documentStore.Add(Fixture.TestData[0]);
+            documentStore.Add(Fixture.TestData[1]);
+
+            // test execution
+            documentStore.Update(Fixture.TestData[0]);
+            var all = documentStore.All;
+
+            Assert.Equal(all.Select(x => x.Id).OrderBy(x => x), Fixture.TestData.Take(2).Select(x => x.Id).OrderBy(x => x));
+            Assert.True(all.Where(x => x.Text == Fixture.TestData[0].Text).Any());
+
+            // postconditions
+            documentStore.Dispose();
+            Postconditions();
+        }
+
+        /// <summary>
+        /// Removes an entry from the document store.
+        /// </summary>
+        [Fact]
+        public void Remove()
+        {
+            // preconditions
+            Preconditions();
+            var documentStore = new IndexMemoryDocumentStore<UnitTestIndexTestDocumentA>(Context, 5);
+
+            documentStore.Clear();
+            documentStore.Add(Fixture.TestData[0]);
+            documentStore.Add(Fixture.TestData[1]);
+
+            // test execution
+            documentStore.Delete(Fixture.TestData[0]);
+            var all = documentStore.All;
+
+            Assert.Equal(all.Select(x => x.Id).OrderBy(x => x), Fixture.TestData.Where(x => x.Id == Fixture.TestData[1].Id).Select(x => x.Id));
+
+            // postconditions
+            documentStore.Dispose();
+            Postconditions();
+        }
+
+        /// <summary>
+        /// Retrieve a entry of the reverse index.
+        /// </summary>
+        [Fact]
+        public void Retrieve()
+        {
+            // preconditions
+            Preconditions();
+            var documentStore = new IndexMemoryDocumentStore<UnitTestIndexTestDocumentA>(Context, 5);
+
+            documentStore.Clear();
+            documentStore.Add(Fixture.TestData[0]);
+            documentStore.Add(Fixture.TestData[1]);
+
+            // test execution
+            var item = documentStore.GetItem(Fixture.TestData[0].Id);
+
+            Assert.NotNull(documentStore);
+            Assert.NotNull(item);
+
+            // postconditions
+            documentStore.Dispose();
+            Postconditions();
+        }
+
+        /// <summary>
+        /// Return all entries of the document store.
+        /// </summary>
+        [Fact]
+        public void All()
+        {
+            // preconditions
+            Preconditions();
+            var documentStore = new IndexMemoryDocumentStore<UnitTestIndexTestDocumentA>(Context, 5);
+
+            documentStore.Clear();
+            foreach (var item in Fixture.TestData)
+            {
+                documentStore.Add(item);
+            }
+
+            // test execution
+            var all = documentStore.All;
+
+            Assert.True(all.Select(x => x.Id).OrderBy(x => x).SequenceEqual(Fixture.TestData.Select(x => x.Id).OrderBy(x => x)));
+
+            // postconditions
+            documentStore.Dispose();
+            Postconditions();
+        }
+    }
+}