File: UtilityTest\CancellationSeriesTests.cs
Web Access
Project: src\src\Workspaces\CoreTest\Microsoft.CodeAnalysis.Workspaces.UnitTests.csproj (Microsoft.CodeAnalysis.Workspaces.UnitTests)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
 
// NOTE: This code is derived from an implementation originally in dotnet/project-system:
// https://github.com/dotnet/project-system/blob/bdf69d5420ec8d894f5bf4c3d4692900b7f2479c/tests/Microsoft.VisualStudio.ProjectSystem.Managed.UnitTests/Threading/Tasks/CancellationSeriesTests.cs
//
// See the commentary in https://github.com/dotnet/roslyn/pull/50156 for notes on incorporating changes made to the
// reference implementation.
 
using System;
using System.Linq;
using System.Threading;
using Microsoft.CodeAnalysis.Threading;
using Xunit;
 
namespace Roslyn.Utilities;
 
public sealed class CancellationSeriesTests
{
    [Fact]
    public void CreateNext_ReturnsNonCancelledToken()
    {
        using var series = new CancellationSeries();
        var token = series.CreateNext();
 
        Assert.False(token.IsCancellationRequested);
        Assert.True(token.CanBeCanceled);
    }
 
    [Fact]
    public void CreateNext_CancelsPreviousToken()
    {
        using var series = new CancellationSeries();
        var token1 = series.CreateNext();
 
        Assert.False(token1.IsCancellationRequested);
 
        var token2 = series.CreateNext();
 
        Assert.True(token1.IsCancellationRequested);
        Assert.False(token2.IsCancellationRequested);
 
        var token3 = series.CreateNext();
 
        Assert.True(token2.IsCancellationRequested);
        Assert.False(token3.IsCancellationRequested);
    }
 
    [Fact]
    public void CreateNext_ThrowsIfDisposed()
    {
        var series = new CancellationSeries();
 
        series.Dispose();
 
        Assert.Throws<ObjectDisposedException>(() => series.CreateNext());
    }
 
    [Fact]
    public void CreateNext_ReturnsCancelledTokenIfSuperTokenAlreadyCancelled()
    {
        var cts = new CancellationTokenSource();
 
        using var series = new CancellationSeries(cts.Token);
        cts.Cancel();
 
        var token = series.CreateNext();
 
        Assert.True(token.IsCancellationRequested);
    }
 
    [Fact]
    public void CreateNext_ReturnsCancelledTokenIfInputTokenAlreadyCancelled()
    {
        var cts = new CancellationTokenSource();
 
        using var series = new CancellationSeries();
        cts.Cancel();
 
        var token = series.CreateNext(cts.Token);
 
        Assert.True(token.IsCancellationRequested);
    }
 
    [Fact]
    public void CancellingSuperTokenCancelsIssuedToken()
    {
        var cts = new CancellationTokenSource();
 
        using var series = new CancellationSeries(cts.Token);
        var token = series.CreateNext();
 
        Assert.False(token.IsCancellationRequested);
 
        cts.Cancel();
 
        Assert.True(token.IsCancellationRequested);
    }
 
    [Fact]
    public void CancellingInputTokenCancelsIssuedToken()
    {
        var cts = new CancellationTokenSource();
 
        using var series = new CancellationSeries();
        var token = series.CreateNext(cts.Token);
 
        Assert.False(token.IsCancellationRequested);
 
        cts.Cancel();
 
        Assert.True(token.IsCancellationRequested);
    }
 
    [Fact]
    public void CreateNext_HandlesExceptionsFromPreviousTokenRegistration()
    {
        using var series = new CancellationSeries();
        var token1 = series.CreateNext();
 
        var exception = new Exception();
 
        token1.Register(() => throw exception);
 
        var aggregateException = Assert.Throws<AggregateException>(() => series.CreateNext());
 
        Assert.Same(exception, aggregateException.InnerExceptions.Single());
        Assert.True(token1.IsCancellationRequested);
    }
}