gremlin-dotnet/test/Gremlin.Net.UnitTest/Process/Traversal/TraversalTests.cs

#region License

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

#endregion

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Xunit;
using Gremlin.Net.Process.Traversal;
using Gremlin.Net.Structure;

namespace Gremlin.Net.UnitTest.Process.Traversal
{
    public class TraversalTests
    {
        [Theory]
        [InlineData(1)]
        [InlineData("test")]
        public void ShouldReturnAvailableTraverserObjWhenNextIsCalled(object traverserObj)
        {
            var traversal = new TestTraversal(new List<object?> { traverserObj });

            var actualObj = traversal.Next();

            Assert.Equal(traverserObj, actualObj);

            Assert.Null(traversal.Next());
        }

        [Theory]
        [InlineData(1)]
        [InlineData("test")]
        public void ShouldCheckHasNext(object traverserObj)
        {
            var traversal = new TestTraversal(new List<object?> { traverserObj });

            Assert.True(traversal.HasNext());
            Assert.True(traversal.HasNext());

            var actualObj = traversal.Next();
            Assert.Equal(traverserObj, actualObj);

            Assert.False(traversal.HasNext());
            Assert.False(traversal.HasNext());
        }

        [Fact]
        public void ShouldReturnAllResultObjsWhenToListIsCalled()
        {
            var objs = new List<object?>(20);
            for (var i = 0; i < 20; i++)
                objs.Add(i);
            var traversal = new TestTraversal(objs);

            var traversedObjs = traversal.ToList();

            Assert.Equal(objs.Count, traversedObjs.Count);
            for (var i = 0; i < objs.Count; i++)
                Assert.Equal(objs[i], traversedObjs[i]);
        }

        [Theory]
        [InlineData(3)]
        [InlineData(10)]
        public void ShouldReturnCorrectNrOfResultObjsWhenNextIsCalledWithAmountArgument(int nrOfResults)
        {
            var objs = new List<object?>(20);
            for (var i = 0; i < 20; i++)
                objs.Add(i);
            var traversal = new TestTraversal(objs);

            var traversedObjs = traversal.Next(nrOfResults);

            var traversedObjsList = traversedObjs.ToList();
            Assert.Equal(nrOfResults, traversedObjsList.Count);
            for (var i = 0; i < nrOfResults; i++)
                Assert.Equal(objs[i], traversedObjsList[i]);
        }

        private List<object?> UnfoldBulks(IReadOnlyList<object?> objs, IReadOnlyList<long> bulks)
        {
            var unfoldedObjs = new List<object?>();
            for (var traverserIdx = 0; traverserIdx < objs.Count; traverserIdx++)
            for (var currentBulkObjIdx = 0; currentBulkObjIdx < bulks[traverserIdx]; currentBulkObjIdx++)
                unfoldedObjs.Add(objs[traverserIdx]);
            return unfoldedObjs;
        }

        [Fact]
        public void ShouldDrainAllTraversersWhenIterateIsCalled()
        {
            var someObjs = new List<object?> { 1, 2, 3 };
            var traversal = new TestTraversal(someObjs);

            var drainedTraversal = traversal.Iterate();

            Assert.Null(drainedTraversal.Next());
        }

        [Fact]
        public void ShouldReturnNullWhenNextIsCalledAndNoTraverserIsAvailable()
        {
            var expectedFirstObj = 1;
            var traversal = new TestTraversal(new List<object?> { expectedFirstObj });

            var actualFirstObj = traversal.Next();
            var actualSecondObj = traversal.Next();

            Assert.Equal(expectedFirstObj, actualFirstObj);
            Assert.Null(actualSecondObj);
        }

        [Fact]
        public void ShouldReturnTraversalsTraverserWhenNextTraverserIsCalled()
        {
            var someObjs = new List<object?> { 1, 2, 3 };
            var traversal = new TestTraversal(someObjs);

            var traverser = traversal.NextTraverser();

            Assert.Equal(someObjs[0], traverser.Object);
        }

        [Fact]
        public void ShouldReturnAllTraverserObjsWhenToListIsCalled()
        {
            var expectedObjs = new List<object?> { 1, 2, 3 };
            var traversal = new TestTraversal(expectedObjs);

            var traversedObjs = traversal.ToList();

            Assert.Equal(expectedObjs, traversedObjs);
        }

        [Fact]
        public void ShouldReturnAllTraverserObjWithoutDuplicatesWhenToSetIsCalled()
        {
            var traverserObjs = new List<object?> { 1, 1, 2, 3 };
            var traversal = new TestTraversal(traverserObjs);

            var traversedObjSet = traversal.ToSet();

            Assert.Equal(3, traversedObjSet.Count);
            Assert.Equal(new HashSet<object?>(traverserObjs), traversedObjSet);
        }

        [Fact]
        public void ShouldApplyStrategiesWhenNextIsCalledAndNoTraversersPresent()
        {
            const int expectedObj = 531;
            var testStrategy = new TestTraversalStrategy(new List<Traverser> { new Traverser(expectedObj) });
            var testTraversal = new TestTraversal(new List<ITraversalStrategy> { testStrategy });

            var actualObj = testTraversal.Next();

            Assert.Equal(expectedObj, actualObj);
        }

        [Fact]
        public void ShouldBeUnfoldTraverserBulksWhenToListIsCalled()
        {
            var objs = new List<object?> { 1, 2, 3 };
            var bulks = new List<long> { 3, 2, 1 };
            var traversal = new TestTraversal(objs, bulks);

            var traversedObjs = traversal.ToList();

            var expectedObjs = UnfoldBulks(objs, bulks);
            Assert.Equal(expectedObjs, traversedObjs);
        }

        [Fact]
        public async Task ShouldDisposeAsyncCleanUpProperly()
        {
            var someObjs = new List<object?> { 1, 2, 3 };
            var traversal = new TestTraversal(someObjs);

            // Consume one element to initialize the enumerator
            traversal.Next();

            // DisposeAsync should complete without error
            await traversal.DisposeAsync();
        }

        [Fact]
        public async Task ShouldMoveNextAsyncReturnFalseWhenEmpty()
        {
            var traversal = new TestTraversal(new List<object?>());

            var hasMore = await traversal.MoveNextAsync();

            Assert.False(hasMore);
        }

        [Fact]
        public async Task ShouldMoveNextAsyncIterateAllElements()
        {
            var objs = new List<object?> { 1, 2, 3 };
            var traversal = new TestTraversal(objs);
            var results = new List<object?>();

            while (await traversal.MoveNextAsync())
            {
                results.Add(traversal.Current);
            }

            Assert.Equal(objs, results);
        }

        [Fact]
        public void ShouldExtractIdFromVertex()
        {
            var g = AnonymousTraversalSource.Traversal().With(null);

            // Test basic V() step with mixed ID types
            var vStart = g.V(1, new Vertex(2));
            Assert.Equal("g.V(1,2)", vStart.GremlinLang.GetGremlin());

            // Test V() step in the middle of a traversal
            var vMid = g.Inject("foo").V(1, new Vertex(2));
            Assert.Equal("g.inject(\"foo\").V(1,2)", vMid.GremlinLang.GetGremlin());

            // Test edge creation with from/to vertices
            var fromTo = g.AddE("Edge").From(new Vertex(1)).To(new Vertex(2));
            Assert.Equal("g.addE(\"Edge\").from(1).to(2)", fromTo.GremlinLang.GetGremlin());

            // Test mergeE() with Vertex in dictionary
            var mergeMap = new Dictionary<object, object>
            {
                { T.Label, "knows" },
                { Direction.Out, new Vertex(1) },
                { Direction.In, new Vertex(2) }
            };

            var mergeEStart = g.MergeE(mergeMap);
            // Verify the dictionary had Vertex IDs extracted (the map is mutated in place)
            Assert.Equal(1, mergeMap[Direction.Out]);
            Assert.Equal(2, mergeMap[Direction.In]);

            // Test mergeE() in the middle of a traversal
            var mergeMap2 = new Dictionary<object, object>
            {
                { T.Label, "knows" },
                { Direction.Out, new Vertex(1) },
                { Direction.In, new Vertex(2) }
            };
            var mergeEMid = g.Inject("foo").MergeE(mergeMap2);
            Assert.Equal(1, mergeMap2[Direction.Out]);
            Assert.Equal(2, mergeMap2[Direction.In]);
        }

        [Fact]
        public async Task ShouldUnfoldBulksViaMoveNextAsync()
        {
            var objs = new List<object?> { "a", "b" };
            var bulks = new List<long> { 2, 1 };
            var traversal = new TestTraversal(objs, bulks);

            var results = new List<object?>();
            while (await traversal.MoveNextAsync())
            {
                results.Add(traversal.Current);
            }

            // "a" with bulk 2 should yield "a", "a"; "b" with bulk 1 should yield "b"
            Assert.Equal(new List<object?> { "a", "a", "b" }, results);
        }

        [Fact]
        public async Task ShouldReturnCurrentObjectAsUntypedValue()
        {
            var traversal = new TestTraversal(new List<object?> { 42 });

            await traversal.MoveNextAsync();

            Assert.Equal(42, traversal.CurrentObject);
        }

        [Fact]
        public async Task ShouldDisposeAsyncBeforeAnyIteration()
        {
            var traversal = new TestTraversal(new List<object?> { 1, 2, 3 });

            // DisposeAsync before any iteration should not throw
            await traversal.DisposeAsync();
        }

        [Fact]
        public async Task ShouldIterateAsyncDrainAllResults()
        {
            var traversal = new TestTraversal(new List<object?> { 1, 2, 3 });

            var result = await traversal.IterateAsync();

            // After IterateAsync, MoveNextAsync should return false
            Assert.False(await result.MoveNextAsync());
        }
    }
}