~ruther/NosSmooth

ref: 7a30c95d162ec3a3ce1691f7b72b20e515a7c785 NosSmooth/Tests/NosSmooth.Core.Tests/Contracts/ContractTests.cs -rw-r--r-- 13.8 KiB
7a30c95d — Rutherther tests(core): add tests for contracts 2 years ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
//
//  ContractTests.cs
//
//  Copyright (c) František Boháček. All rights reserved.
//  Licensed under the MIT license. See LICENSE file in the project root for full license information.

using System;
using System.Threading;
using System.Threading.Tasks;
using NosSmooth.Core.Contracts;
using Remora.Results;
using Shouldly;
using Xunit;

namespace NosSmooth.Core.Tests.Contracts;

/// <summary>
/// Tests basics of contract system.
/// </summary>
public class ContractTests
{
    /// <summary>
    /// Tests that the contract is executed.
    /// </summary>
    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
    [Fact]
    public async Task Test_GetsExecuted()
    {
        var contractor = new Contractor();
        var mock = new MockClass();

        var contract = new ContractBuilder<long, DefaultStates, NoErrors>(contractor, DefaultStates.None)
            .SetMoveAction(DefaultStates.None, mock.Setup, DefaultStates.Requested)
            .SetMoveFilter<ContractData<long>>(DefaultStates.Requested, DefaultStates.ResponseObtained)
            .SetFillData<ContractData<long>>(DefaultStates.ResponseObtained, d => d.Data)
            .Build();

        contract.CurrentState.ShouldBe(DefaultStates.None);
        await contract.OnlyExecuteAsync();
        contract.CurrentState.ShouldBe(DefaultStates.Requested);
        mock.Executed.ShouldBeTrue();
        mock.ExecutedTimes.ShouldBe(1);
    }

    /// <summary>
    /// Tests that the contract response is obtained.
    /// </summary>
    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
    [Fact]
    public async Task Test_ResponseObtained()
    {
        var contractor = new Contractor();
        var mock = new MockClass();

        var contract = new ContractBuilder<long, DefaultStates, NoErrors>(contractor, DefaultStates.None)
            .SetMoveAction(DefaultStates.None, mock.Setup, DefaultStates.Requested)
            .SetMoveFilter<ContractData<long>>(DefaultStates.Requested, DefaultStates.ResponseObtained)
            .SetFillData<ContractData<long>>(DefaultStates.ResponseObtained, d => d.Data)
            .Build();

        await contract.OnlyExecuteAsync();
        contract.Register();
        await contractor.Update(new ContractData<long>(5));
        contract.CurrentState.ShouldBe(DefaultStates.ResponseObtained);
        contract.Data.ShouldBe(5);

        await contractor.Update(new ContractData<long>(10));
        contract.Data.ShouldBe(5);
        contract.Unregister();

        mock.ExecutedTimes.ShouldBe(1);
    }

    /// <summary>
    /// Tests that the contract response is obtained.
    /// </summary>
    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
    [Fact]
    public async Task Test_WaitFor()
    {
        var contractor = new Contractor();
        var mock = new MockClass();

        var contract = new ContractBuilder<long, DefaultStates, NoErrors>(contractor, DefaultStates.None)
            .SetMoveAction(DefaultStates.None, mock.Setup, DefaultStates.Requested)
            .SetMoveFilter<ContractData<long>>(DefaultStates.Requested, DefaultStates.ResponseObtained)
            .SetFillData<ContractData<long>>(DefaultStates.ResponseObtained, d => d.Data)
            .Build();

        Task.Run
        (
            async () =>
            {
                await Task.Delay(500);
                await contractor.Update(new ContractData<long>(15));
            }
        );

        var result = await contract.WaitForAsync(DefaultStates.ResponseObtained);
        result.IsSuccess.ShouldBeTrue();
        result.Entity.ShouldBe(15);
        contract.IsRegistered.ShouldBeFalse(); // trust the contract for now.
        contract.CurrentState.ShouldBe(DefaultStates.ResponseObtained);
        mock.ExecutedTimes.ShouldBe(1);
    }

    /// <summary>
    /// Tests that the contract response is obtained.
    /// </summary>
    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
    [Fact]
    public async Task Test_WaitForMoreStates()
    {
        var contractor = new Contractor();
        var mock = new MockClass();

        var contract = new ContractBuilder<long, ContractMultipleStates, NoErrors>
                (contractor, ContractMultipleStates.None)
            .SetMoveAction(ContractMultipleStates.None, mock.Setup, ContractMultipleStates.Requested)
            .SetMoveFilter<ContractData<long>>
                (ContractMultipleStates.Requested, ContractMultipleStates.ResponseObtained)
            .SetFillData<ContractData<long>>(ContractMultipleStates.ResponseObtained, d => d.Data)
            .SetMoveFilter<ContractData<bool>>
                (ContractMultipleStates.ResponseObtained, c => c.Data, ContractMultipleStates.AfterResponseObtained)
            .Build();

        Task.Run
        (
            async () =>
            {
                await Task.Delay(500);
                await contractor.Update(new ContractData<long>(15));
                await Task.Delay(200);
                await contractor.Update(new ContractData<bool>(true));
            }
        );

        var result = await contract.WaitForAsync(ContractMultipleStates.AfterResponseObtained);
        result.IsSuccess.ShouldBeTrue();
        result.Entity.ShouldBe(15);
        contract.IsRegistered.ShouldBeFalse(); // trust the contract for now.
        contract.CurrentState.ShouldBe(ContractMultipleStates.AfterResponseObtained);
        mock.ExecutedTimes.ShouldBe(1);
    }

    /// <summary>
    /// Tests that the contract response is obtained.
    /// </summary>
    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
    [Fact]
    public async Task Test_MoreStatesFollowed()
    {
        var contractor = new Contractor();
        var mock = new MockClass();

        var contract = new ContractBuilder<long, ContractMultipleStates, NoErrors>
                (contractor, ContractMultipleStates.None)
            .SetMoveAction(ContractMultipleStates.None, mock.Setup, ContractMultipleStates.Requested)
            .SetMoveFilter<ContractData<long>>
                (ContractMultipleStates.Requested, ContractMultipleStates.ResponseObtained)
            .SetFillData<ContractData<long>>(ContractMultipleStates.ResponseObtained, d => d.Data)
            .SetMoveFilter<ContractData<bool>>
                (ContractMultipleStates.ResponseObtained, c => c.Data, ContractMultipleStates.AfterResponseObtained)
            .Build();

        await contract.OnlyExecuteAsync();
        contract.Register();
        await contractor.Update(new ContractData<long>(15));
        await contractor.Update(new ContractData<bool>(true));
        contract.Unregister();
        var result = await contract.WaitForAsync(ContractMultipleStates.AfterResponseObtained);
        result.IsSuccess.ShouldBeTrue();
        result.Entity.ShouldBe(15);
        contract.IsRegistered.ShouldBeFalse(); // trust the contract for now.
        contract.CurrentState.ShouldBe(ContractMultipleStates.AfterResponseObtained);
        mock.ExecutedTimes.ShouldBe(1);
    }

    /// <summary>
    /// Tests that the contract response is obtained.
    /// </summary>
    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
    [Fact]
    public async Task Test_WaitForTimeout()
    {
        var contractor = new Contractor();
        var mock = new MockClass();

        var contract = new ContractBuilder<long, ContractMultipleStates, NoErrors>
                (contractor, ContractMultipleStates.None)
            .SetMoveAction(ContractMultipleStates.None, mock.Setup, ContractMultipleStates.Requested)
            .SetMoveFilter<ContractData<long>>
                (ContractMultipleStates.Requested, ContractMultipleStates.ResponseObtained)
            .SetFillData<ContractData<long>>(ContractMultipleStates.ResponseObtained, d => d.Data)
            .SetTimeout
            (
                ContractMultipleStates.ResponseObtained,
                TimeSpan.FromMilliseconds(100),
                ContractMultipleStates.AfterResponseObtained
            )
            .Build();

        Task.Run
        (
            async () =>
            {
                await Task.Delay(500);
                await contractor.Update(new ContractData<long>(15));
            }
        );

        var result = await contract.WaitForAsync(ContractMultipleStates.AfterResponseObtained);
        result.IsSuccess.ShouldBeTrue();
        result.Entity.ShouldBe(15);
        contract.IsRegistered.ShouldBeFalse(); // trust the contract for now.
        contract.CurrentState.ShouldBe(ContractMultipleStates.AfterResponseObtained);
        mock.ExecutedTimes.ShouldBe(1);
    }

    /// <summary>
    /// Tests that the contract response is obtained.
    /// </summary>
    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
    [Fact]
    public async Task Test_MultipleContracts()
    {
        var contractor = new Contractor();
        var mock = new MockClass();

        var contract1 = new ContractBuilder<long, ContractMultipleStates, NoErrors>
                (contractor, ContractMultipleStates.None)
            .SetMoveAction(ContractMultipleStates.None, mock.Setup, ContractMultipleStates.Requested)
            .SetMoveFilter<ContractData<long>>
            (
                ContractMultipleStates.Requested,
                d => d.Data > 10 && d.Data < 20,
                ContractMultipleStates.ResponseObtained
            )
            .SetFillData<ContractData<long>>(ContractMultipleStates.ResponseObtained, d => d.Data)
            .Build();

        var contract2 = new ContractBuilder<long, ContractMultipleStates, NoErrors>
                (contractor, ContractMultipleStates.None)
            .SetMoveAction(ContractMultipleStates.None, mock.Setup, ContractMultipleStates.Requested)
            .SetMoveFilter<ContractData<long>>
                (ContractMultipleStates.Requested, d => d.Data > 20, ContractMultipleStates.ResponseObtained)
            .SetFillData<ContractData<long>>(ContractMultipleStates.ResponseObtained, d => d.Data)
            .Build();

        await contract1.OnlyExecuteAsync();
        await contract2.OnlyExecuteAsync();

        Task.Run
        (
            async () =>
            {
                await Task.Delay(500);
                await contractor.Update(new ContractData<long>(15));
                await Task.Delay(500);
                await contractor.Update(new ContractData<long>(25));
            }
        );

        var results = await Task.WhenAll
        (
            contract1.WaitForAsync(ContractMultipleStates.ResponseObtained),
            contract2.WaitForAsync(ContractMultipleStates.ResponseObtained)
        );
        results[0].IsSuccess.ShouldBeTrue();
        results[0].Entity.ShouldBe(15);
        results[1].IsSuccess.ShouldBeTrue();
        results[1].Entity.ShouldBe(25);
        contract1.CurrentState.ShouldBe(ContractMultipleStates.ResponseObtained);
        contract2.CurrentState.ShouldBe(ContractMultipleStates.ResponseObtained);
        mock.ExecutedTimes.ShouldBe(2);
    }

    /// <summary>
    /// Tests that the contract response is obtained.
    /// </summary>
    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
    [Fact]
    public async Task Test_ErrorsFired()
    {
        var contractor = new Contractor();
        var mock = new MockClass();

        var contract = new ContractBuilder<long, ContractMultipleStates, ContractError>
                (contractor, ContractMultipleStates.None)
            .SetMoveAction(ContractMultipleStates.None, mock.Setup, ContractMultipleStates.Requested)
            .SetMoveFilter<ContractData<long>>
                (ContractMultipleStates.Requested, ContractMultipleStates.ResponseObtained)
            .SetFillData<ContractData<long>>(ContractMultipleStates.ResponseObtained, d => d.Data)
            .SetError<ContractData<long>>
            (
                ContractMultipleStates.Requested,
                d =>
                {
                    if (d.Data == 15)
                    {
                        return ContractError.Error1;
                    }

                    return null;
                }
            )
            .Build();

        Task.Run
        (
            async () =>
            {
                await Task.Delay(500);
                await contractor.Update(new ContractData<long>(15));
            }
        );

        var result = await contract.WaitForAsync(ContractMultipleStates.AfterResponseObtained);
        result.IsSuccess.ShouldBeFalse();
        result.Error.ShouldBeOfType<ContractError<ContractError>>();
        ((ContractError<ContractError>)result.Error).Error.ShouldBe(ContractError.Error1);
        contract.CurrentState.ShouldBe(ContractMultipleStates.Requested);
        contract.IsRegistered.ShouldBeFalse();
        mock.ExecutedTimes.ShouldBe(1);
    }
}

/// <summary>
/// A class for verifying setup was called.
/// </summary>
public class MockClass
{
    /// <summary>
    /// Gets the number of times <see cref="Setup"/> was called.
    /// </summary>
    public int ExecutedTimes { get; private set; }

    /// <summary>
    /// Gets whether <see cref="Executed"/> was executed.
    /// </summary>
    public bool Executed { get; private set; }

    /// <summary>
    /// Sets Executed to true..
    /// </summary>
    /// <param name="data">The data. should be null.</param>
    /// <param name="ct">The cancellation token used for cancelling the operation.</param>
    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
    public Task<Result<bool>> Setup(object? data, CancellationToken ct)
    {
        if (data is not null)
        {
            throw new ArgumentException("Should be null.", nameof(data));
        }

        Executed = true;
        ExecutedTimes++;
        return Task.FromResult(Result<bool>.FromSuccess(true));
    }
}
Do not follow this link