使用Moq在C#中Mock IAmazonS3时触发ArgumentException异常

测试代码 #

public class AmazonAnalysisTests
{
    private AmazonConfig _config;
    private AmazonAnalysis _amazonAnalysis;
    private Mock<IAmazonS3> _mockS3Client;


    [SetUp]
    public void SetUp()
    {
        _config = new AmazonConfig
        {
            AccessKeyId = "access_key",
            SecretAccessKey = "secret_key",
            Region = Amazon.RegionEndpoint.USEast1,
            BucketName = "test-bucket",
            RoleArn = "role_arn",
            SnsTopicArn = "sns_topic_arn",
            Url = "sqs_url"
        };

        _mockS3Client = new Mock<IAmazonS3>();

        _amazonAnalysis = new AmazonAnalysis(_mockS3Client.Object);
    }

    [Test]
    public void PutDocumentOnS3Bucket_UpdatesRecordStatus()
    {
        _mockS3Client.Setup(c => c.PutObject(It.IsAny<PutObjectRequest>()))
            .Returns(new PutObjectResponse { HttpStatusCode = System.Net.HttpStatusCode.OK });

        _amazonAnalysis.PutDocumentOnS3Bucket();

        // Assert
        _mockS3Client.Verify(client => client.PutObject(It.IsAny<PutObjectRequest>()), Times.Exactly(1));

    }
}

异常信息 #

System.ArgumentException : 'Null is not a valid constant value for this type.

Cette exception a été levée à l'origine dans cette pile des appels :      System.Reflection.Emit.TypeBuilder.SetConstantValue(System.Reflection.Emit.ModuleBuilder, int, System.Type, object)

原因分析 #

这个异常是因为Moq在动态生成IAmazonS3接口的实现时，遇到了接口中值类型可选参数默认值为null的方法。AWS SDK的IAmazonS3接口包含部分方法重载，其值类型参数的默认值被设为null，而值类型本身不能为null，导致Moq在反射生成代码时抛出错误。

解决办法 #

1. 升级Moq到最新稳定版 #

Moq 4.16及以上版本已经修复了值类型可选参数null默认值的处理问题。通过NuGet包管理器将Moq包升级至最新版本即可解决。

2. 设置Mock的DefaultValue属性 #

如果无法升级Moq，可以在创建Mock实例时指定DefaultValue = DefaultValue.Mock，让Moq自动为值类型参数生成默认实例，避免null值：

[SetUp]
public void SetUp()
{
    _config = new AmazonConfig
    {
        AccessKeyId = "access_key",
        SecretAccessKey = "secret_key",
        Region = Amazon.RegionEndpoint.USEast1,
        BucketName = "test-bucket",
        RoleArn = "role_arn",
        SnsTopicArn = "sns_topic_arn",
        Url = "sqs_url"
    };

    // 设置DefaultValue为Mock，自动生成值类型的默认实例
    _mockS3Client = new Mock<IAmazonS3> { DefaultValue = DefaultValue.Mock };

    _amazonAnalysis = new AmazonAnalysis(_mockS3Client.Object);
}

3. 使用AWS官方模拟客户端 #

如果上述方法无效，可以改用AWS SDK提供的官方模拟工具，比如通过AmazonS3Mock或配置MockAmazonS3Config创建模拟客户端，这类工具对AWS自身接口的兼容性更好。

内容的提问来源于stack exchange，提问作者Charles Plante