XUnit Test Web API Assert Status code

Question

I am new in XUnit tests for Web API application. I am trying to make assertion of my response value with the status code 404, but I am not sure how to do so.

Here's my test code.

Assume the input is null, the test is expected to return NotFound or 404 status code.

  [Fact]
        public async Task getBooksById_NullInput_Notfound()
        {

            //Arrange
            var mockConfig = new Mock<IConfiguration>();
            var controller = new BookController(mockConfig.Object);

            //Act
            var response = await controller.GetBooksById(null);

            //Assert
            mockConfig.VerifyAll();

            Assert(response.StatusCode, HttpStatusCode.NotFound()); //How to achieve this?

        }

In the last line of this test method, I am not able to make response.StatusCode compile as in the response variable does not have StatusCode property. And there is no HttpStatusCode class that I can call...

Here's my GetBooksByID() method in the controller class.

 public class BookController : Controller
    {
        private RepositoryFactory _repositoryFactory = new RepositoryFactory();

        private IConfiguration _configuration;

        public BookController(IConfiguration configuration)
        {
            _configuration = configuration;
        }



        [HttpGet]
        [Route("api/v1/Books/{id}")]
        public async Task<IActionResult> GetBooksById(string id)
        {
            try
            {
                if (string.IsNullOrEmpty(id))
                {
                    return BadRequest();
                }

                var response = //bla

                //do something

                if (response == null)
                {
                    return NotFound();
                }
                return new ObjectResult(response);
            }
            catch (Exception e)
            {
                throw;
            }
        }

Thanks!

It won't compile because HttpStatusCode.NotFound() is not a method. Remove the parenthesis e.g. HttpStatusCode.NotFound. — Brad
– Brad, Commented Apr 19, 2018 at 6:51

superninja · Accepted Answer · 2018-04-19 07:16:31Z

7

You can check against returned type

// Act
var actualResult = await controller.GetBooksById(null);

// Assert
actualResult.Should().BeOfType<BadRequestResult>();

Should() and .BeOfType<T> are methods from FluentAssertions library, which available on Nuget

edited Apr 19, 2018 at 7:16

superninja

3,45110 gold badges41 silver badges78 bronze badges

answered Apr 19, 2018 at 7:01

Fabio

32.5k4 gold badges35 silver badges77 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

superninja Over a year ago

My bad, I didnt use using FluentAssertions;

superninja Over a year ago

sry, but NotFound is not compile, am I missing any other package?

Fabio Over a year ago

@Brad, this was an alternative approach to test for expected response, what OP actually tried to do. Seems approach suit OP.

bjnr · Accepted Answer · 2020-06-18 16:30:04Z

3

Assert.Equal(System.Net.HttpStatusCode.Unauthorized, response.StatusCode);

answered Jun 18, 2020 at 16:30

bjnr

3,4371 gold badge24 silver badges36 bronze badges

Comments

plyawn · Accepted Answer · 2019-09-29 20:29:02Z

2

Old question, but while the accepted answer is valid it pulls in another dependency that's helpful but not required to do this. The most straight forward approach is to reference:

using Microsoft.AspNetCore.Mvc;

Then test with:

Assert.IsAssignableFrom<NotFoundObjectResult>(response.Result);

assuming your method returns an ActionResult.

answered Sep 29, 2019 at 20:29

plyawn

4124 silver badges13 bronze badges

Comments

superninja · Accepted Answer · 2018-04-19 07:00:44Z

-1

After getting hints by @Brad, the code compiles and passed the test.

 response.ToString().Equals(HttpStatusCode.NotFound);

answered Apr 19, 2018 at 7:00

superninja

3,45110 gold badges41 silver badges78 bronze badges

Collectives™ on Stack Overflow

XUnit Test Web API Assert Status code

4 Answers 4

3 Comments

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

3 Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related