aspnetcore/test/Mvc.Api.Analyzers.Test/DeclaredApiResponseMetadataTest.cs

// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System.Collections.Generic;
using System.Collections.Immutable;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Moq;
using Xunit;

namespace Microsoft.AspNetCore.Mvc.Api.Analyzers
{
    public class DeclaredApiResponseMetadataTest
    {
        private readonly ReturnStatementSyntax ReturnStatement = SyntaxFactory.ReturnStatement();
        private readonly AttributeData AttributeData = new TestAttributeData();

        [Fact]
        public void Matches_ReturnsTrue_IfDeclaredMetadataIsImplicit_AndActualMetadataIsDefaultResponse()
        {
            // Arrange
            var declaredMetadata = DeclaredApiResponseMetadata.ImplicitResponse;
            var actualMetadata = new ActualApiResponseMetadata(ReturnStatement);

            // Act
            var matches = declaredMetadata.Matches(actualMetadata);

            // Assert
            Assert.True(matches);
        }

        [Fact]
        public void Matches_ReturnsTrue_IfDeclaredMetadataIsImplicit_AndActualMetadataReturns200()
        {
            // Arrange
            var declaredMetadata = DeclaredApiResponseMetadata.ImplicitResponse;
            var actualMetadata = new ActualApiResponseMetadata(ReturnStatement, 200);

            // Act
            var matches = declaredMetadata.Matches(actualMetadata);

            // Assert
            Assert.True(matches);
        }

        [Fact]
        public void Matches_ReturnsTrue_IfDeclaredMetadataIs200_AndActualMetadataIsDefaultResponse()
        {
            // Arrange
            var declaredMetadata = DeclaredApiResponseMetadata.ForProducesResponseType(200, AttributeData, Mock.Of<IMethodSymbol>());
            var actualMetadata = new ActualApiResponseMetadata(ReturnStatement);

            // Act
            var matches = declaredMetadata.Matches(actualMetadata);

            // Assert
            Assert.True(matches);
        }

        /// <example>
        /// [ProducesResponseType(201)]
        /// public IActionResult SomeAction => new Model();
        /// </example>
        [Fact]
        public void Matches_ReturnsTrue_IfDeclaredMetadataIs201_AndActualMetadataIsDefault()
        {
            // Arrange
            var declaredMetadata = DeclaredApiResponseMetadata.ForProducesResponseType(201, AttributeData, Mock.Of<IMethodSymbol>());
            var actualMetadata = new ActualApiResponseMetadata(ReturnStatement);

            // Act
            var matches = declaredMetadata.Matches(actualMetadata);

            // Assert
            Assert.True(matches);
        }

        /// <example>
        /// [ProducesResponseType(201)]
        /// public IActionResult SomeAction => Ok(new Model());
        /// </example>
        [Fact]
        public void Matches_ReturnsFalse_IfDeclaredMetadataIs201_AndActualMetadataIs200()
        {
            // Arrange
            var declaredMetadata = DeclaredApiResponseMetadata.ForProducesResponseType(201, AttributeData, Mock.Of<IMethodSymbol>());
            var actualMetadata = new ActualApiResponseMetadata(ReturnStatement, 200);

            // Act
            var matches = declaredMetadata.Matches(actualMetadata);

            // Assert
            Assert.False(matches);
        }

        [Fact]
        public void Matches_ReturnsTrue_IfDeclaredMetadataAndActualMetadataHaveSameStatusCode()
        {
            // Arrange
            var declaredMetadata = DeclaredApiResponseMetadata.ForProducesResponseType(302, AttributeData, Mock.Of<IMethodSymbol>());
            var actualMetadata = new ActualApiResponseMetadata(ReturnStatement, 302);

            // Act
            var matches = declaredMetadata.Matches(actualMetadata);

            // Assert
            Assert.True(matches);
        }

        [Theory]
        [InlineData(400)]
        [InlineData(409)]
        [InlineData(500)]
        public void Matches_ReturnsTrue_IfDeclaredMetadataIsDefault_AndActualMetadataIsErrorStatusCode(int actualStatusCode)
        {
            // Arrange
            var declaredMetadata = DeclaredApiResponseMetadata.ForProducesDefaultResponse(AttributeData, Mock.Of<IMethodSymbol>());
            var actualMetadata = new ActualApiResponseMetadata(ReturnStatement, actualStatusCode);

            // Act
            var matches = declaredMetadata.Matches(actualMetadata);

            // Assert
            Assert.True(matches);
        }

        [Fact]
        public void Matches_ReturnsFalse_IfDeclaredMetadataIsDefault_AndActualMetadataIsNotErrorStatusCode()
        {
            // Arrange
            var declaredMetadata = DeclaredApiResponseMetadata.ForProducesDefaultResponse(AttributeData, Mock.Of<IMethodSymbol>());
            var actualMetadata = new ActualApiResponseMetadata(ReturnStatement, 204);

            // Act
            var matches = declaredMetadata.Matches(actualMetadata);

            // Assert
            Assert.False(matches);
        }

        [Fact]
        public void Matches_ReturnsFalse_IfDeclaredMetadataIsDefault_AndActualMetadataIsDefaultResponse()
        {
            // Arrange
            var declaredMetadata = DeclaredApiResponseMetadata.ForProducesDefaultResponse(AttributeData, Mock.Of<IMethodSymbol>());
            var actualMetadata = new ActualApiResponseMetadata(ReturnStatement);

            // Act
            var matches = declaredMetadata.Matches(actualMetadata);

            // Assert
            Assert.False(matches);
        }

        private class TestAttributeData : AttributeData
        {
            protected override INamedTypeSymbol CommonAttributeClass => throw new System.NotImplementedException();

            protected override IMethodSymbol CommonAttributeConstructor => throw new System.NotImplementedException();

            protected override SyntaxReference CommonApplicationSyntaxReference => throw new System.NotImplementedException();

            protected override ImmutableArray<TypedConstant> CommonConstructorArguments => throw new System.NotImplementedException();

            protected override ImmutableArray<KeyValuePair<string, TypedConstant>> CommonNamedArguments => throw new System.NotImplementedException();
        }
    }
}