Search code examples
c#unit-testingxunit

Assert an Exception using XUnit


I am a newbie to XUnit and Moq. I have a method which takes string as an argument.How to handle an exception using XUnit.

[Fact]
public void ProfileRepository_GetSettingsForUserIDWithInvalidArguments_ThrowsArgumentException() {
    //arrange
    ProfileRepository profiles = new ProfileRepository();
    //act
    var result = profiles.GetSettingsForUserID("");
    //assert
    //The below statement is not working as expected.
    Assert.Throws<ArgumentException>(() => profiles.GetSettingsForUserID(""));
}

Method under test

public IEnumerable<Setting> GetSettingsForUserID(string userid)
{            
    if (string.IsNullOrWhiteSpace(userid)) throw new ArgumentException("User Id Cannot be null");
    var s = profiles.Where(e => e.UserID == userid).SelectMany(e => e.Settings);
    return s;
}

Solution

  • The Assert.Throws expression will catch the exception and assert the type. You are however calling the method under test outside of the assert expression and thus failing the test case.

    [Fact]
    public void ProfileRepository_GetSettingsForUserIDWithInvalidArguments_ThrowsArgumentException()
    {
        //arrange
        ProfileRepository profiles = new ProfileRepository();
        // act & assert
        Assert.Throws<ArgumentException>(() => profiles.GetSettingsForUserID(""));
    }
    

    If bent on following AAA you can extract the action into its own variable.

    [Fact]
    public void ProfileRepository_GetSettingsForUserIDWithInvalidArguments_ThrowsArgumentException()
    {
        //arrange
        ProfileRepository profiles = new ProfileRepository();
        //act
        Action act = () => profiles.GetSettingsForUserID("");
        //assert
        ArgumentException exception = Assert.Throws<ArgumentException>(act);
        //The thrown exception can be used for even more detailed assertions.
        Assert.Equal("expected error message here", exception.Message);
    }
    

    Note how the exception can also be used for more detailed assertions

    If testing asynchronously, Assert.ThrowsAsync follows similarly to the previously given example, except that the assertion should be awaited,

    public async Task Some_Async_Test() {
    
        //...
    
        //Act
        Func<Task> act = () => subject.SomeMethodAsync();
    
        //Assert
        var exception = await Assert.ThrowsAsync<InvalidOperationException>(act);
    
        //...
    }