StackExchange / StackExchange/StackExchange.Redis

Unit test using AddCondition from ITransaction does not works

Open
#2,259 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

⚙️ area:API ❔ question
Dominant language
C#
Stars
6.2k
Forks
1.6k
Avg merge
1d 15h
Merged PRs (30d)
43

Description

Good evening.
How do I mock the method AddCondition from ITransaction?

My class:

public class SampleRedisRepository
{
        private const string cFIELD_STATUS = "STATUS";
        private const string cFIELD_STATUS_TIME = "STATUS_TIME";
        private const string cFIELD_STATUS_DESCRIPTION = "STATUS_DESCRIPTION";
        private const string cPATH = nameof(SampleRedisRepository);
        private const string cFIELD_REQUEST_TYPE = "REQUEST_TYPE";
        private const string cFIELD_CREATION_TIME = "CREATION_TIME";
        private const string cFIELD_STATUS_HISTORY = "STATUS_HISTORY";
        private readonly int _redisDbNumber;
        private readonly IDatabase _database;
        private readonly ILogger<SampleRedisRepository> _logger;

        public SampleRedisRepository(IDatabase database, ILogger<SampleRedisRepository> logger, int redisDbNumber)
        {
            _database = database ?? throw new ArgumentNullException(nameof(database));
            _logger = logger ?? throw new ArgumentNullException(nameof(logger));
            _redisDbNumber = redisDbNumber;
        }

        public void Create<TRequest>(Guid requestId) where TRequest : class
        {
            var requestType = typeof(TRequest).FullName;
            var key = CreateKey(requestId);
            var redisTime = GetRedisTime();

            var tran = _database.CreateTransaction();

            var crKeyNotExists = tran.AddCondition(Condition.KeyNotExists(key));

            tran.HashSetAsync(key, new HashEntry[] {
                new HashEntry(cFIELD_REQUEST_TYPE, requestType),
                new HashEntry(cFIELD_CREATION_TIME, redisTime),
                new HashEntry(cFIELD_STATUS, $"{ERequestStatus.InProgress}"),
                new HashEntry(cFIELD_STATUS_TIME, redisTime),
                new HashEntry(cFIELD_STATUS_DESCRIPTION, "created"),
             });

            if (tran.Execute())
            {
                _logger.LogDebug($"Request Id:{requestId} created.");
                return;
            }

            if (!crKeyNotExists.WasSatisfied)
                throw new InvalidOperationException($"Request Id:{requestId} already exists.");

            throw new InvalidOperationException($"Error on create request Id:{requestId}.");
        }

        private long GetRedisTime() => (long)_database.ScriptEvaluate("return redis.call('TIME')[1]");

        public static RedisKey CreateKey(Guid requestId) => $"{cPATH}:{requestId}";
}

My unit test:

[Fact]
public void Create_Test()
{
            int redisNumber = 2;
            Guid requestId = Guid.NewGuid();
            var key = SampleRedisRepository.CreateKey(requestId);
            RedisResult redisTime = RedisResult.Create(123456);

            var mqTransaction = new Mock<ITransaction>();
            mqTransaction
                .Setup(t => t.AddCondition(Condition.KeyNotExists(key)))
                .Returns(????); // => PROBLEM!! How do I create an instance of ConditionResult ??

            var mqDatabase = new Mock<IDatabase>();
            mqDatabase
                .Setup(d => d.CreateTransaction(It.IsAny<object?>()))
                .Returns(mqTransaction.Object);

            mqDatabase
                .Setup(d => d.ScriptEvaluate("return redis.call('TIME')[1]", It.IsAny<RedisKey[]?>(), It.IsAny<RedisValue[]?>(), It.IsAny<CommandFlags>()))
                .Returns(redisTime);

            var initialData = new Dictionary<string, string>()
            {
                { "Redis:DbNumber", redisNumber.ToString() }
            };

            var configuration = new ConfigurationBuilder()
                .AddInMemoryCollection(initialData)
                .Build();

            var repository = new SampleRedisRepository(mqDatabase.Object, Mock.Of<ILogger<SampleRedisRepository>>(), redisNumber);

            repository.Create<SimpleClassToTest>(requestId);

            mqDatabase.Verify(c => c.CreateTransaction(It.IsAny<object?>()), Times.Once());

            mqTransaction.Verify(c => c.HashSetAsync(
                key,
                It.Is<HashEntry[]>(he => he.Any(
                    h => h.Name.Equals("STATUS")
                    && h.Value.Equals($"{ERequestStatus.InProgress}")
                    && h.Name.Equals("REQUEST_TYPE")
                    && h.Value.Equals(typeof(SimpleClassToTest).FullName)
                    && h.Name.Equals("STATUS_DESCRIPTION")
                    && h.Value.Equals("created")
                    && h.Name.Equals("STATUS_TIME")
                    && h.Value.Equals(redisTime)
                )),
                It.IsAny<CommandFlags>()), Times.Once());
}

I cannot create an instance of ConditionResult because the constructor is internal. See line 827 of Condition.cs

Many thanks.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with Condition.cs around line 827 and the ITransaction.AddCondition call shown in the issue, then inspect the Create_Test setup for the expected ConditionResult behavior. Done means the test can exercise SampleRedisRepository.Create without relying on inaccessible constructors and verifies the transaction path described in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, redis
Domain
databases, testing
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.