Skip to content

ControllerBase.Problem should also set the StatusCode of the response #14672

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 9, 2019
Merged

ControllerBase.Problem should also set the StatusCode of the response #14672

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c9493d3
ControllerBase.Problem should also set the StatusCode of the response
huysentruitw Oct 2, 2019
b2521b9
Fix PR remarks
huysentruitw Oct 3, 2019
baa9261
Replace type conversions with type checks + check status of problemDe…
huysentruitw Oct 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions src/Mvc/Mvc.Core/src/ControllerBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1870,7 +1870,10 @@ public virtual ObjectResult Problem(
detail: detail,
instance: instance);

return new ObjectResult(problemDetails);
return new ObjectResult(problemDetails)
{
StatusCode = problemDetails.Status
};
}

/// <summary>
Expand Down Expand Up @@ -1946,7 +1949,10 @@ public virtual ActionResult ValidationProblem(
return new BadRequestObjectResult(validationProblem);
}

return new ObjectResult(validationProblem);
return new ObjectResult(validationProblem)
{
StatusCode = validationProblem.Status
};
}

/// <summary>
Expand Down
46 changes: 46 additions & 0 deletions src/Mvc/Mvc.Core/test/ControllerBaseTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2316,6 +2316,7 @@ public void ValidationProblemDetails_Works()
// Assert
var badRequestResult = Assert.IsType<BadRequestObjectResult>(actionResult);
var problemDetails = Assert.IsType<ValidationProblemDetails>(badRequestResult.Value);
Assert.Equal(400, badRequestResult.StatusCode);
Assert.Equal(400, problemDetails.Status);
Assert.Equal("One or more validation errors occurred.", problemDetails.Title);
Assert.Equal("https://tools.ietf.org/html/rfc7231#section-6.5.1", problemDetails.Type);
Expand Down Expand Up @@ -2348,6 +2349,48 @@ public void ValidationProblemDetails_UsesSpecifiedTitle()
Assert.Equal(detail, problemDetails.Detail);
}

[Fact]
public void ValidationProblemDetails_UsesSpecifiedStatusCode()
{
// Arrange
var options = GetApiBehaviorOptions();

var controller = new TestableController
{
ProblemDetailsFactory = new DefaultProblemDetailsFactory(Options.Create(options)),
};

// Act
var actionResult = controller.ValidationProblem(statusCode: 405);

// Assert
var objectResult = Assert.IsType<ObjectResult>(actionResult);
var problemDetails = Assert.IsType<ValidationProblemDetails>(objectResult.Value);
Assert.Equal(405, objectResult.StatusCode);
Assert.Equal(405, problemDetails.Status);
}

[Fact]
public void ValidationProblemDetails_StatusCode400_ReturnsBadRequestObjectResultFor2xCompatibility()
{
// Arrange
var options = GetApiBehaviorOptions();

var controller = new TestableController
{
ProblemDetailsFactory = new DefaultProblemDetailsFactory(Options.Create(options)),
};

// Act
var actionResult = controller.ValidationProblem(statusCode: 400);

// Assert
var badRequestResult = Assert.IsType<BadRequestObjectResult>(actionResult);
var problemDetails = Assert.IsType<ValidationProblemDetails>(badRequestResult.Value);
Assert.Equal(400, badRequestResult.StatusCode);
Assert.Equal(400, problemDetails.Status);
}

[Fact]
public void ProblemDetails_Works()
{
Expand All @@ -2371,6 +2414,7 @@ public void ProblemDetails_Works()
// Assert
var badRequestResult = Assert.IsType<ObjectResult>(actionResult);
var problemDetails = Assert.IsType<ProblemDetails>(badRequestResult.Value);
Assert.Equal(500, actionResult.StatusCode);
Assert.Equal(500, problemDetails.Status);
Assert.Equal("An error occured while processing your request.", problemDetails.Title);
Assert.Equal("https://tools.ietf.org/html/rfc7231#section-6.6.1", problemDetails.Type);
Expand All @@ -2396,6 +2440,7 @@ public void ProblemDetails_UsesPassedInValues()
// Assert
var badRequestResult = Assert.IsType<ObjectResult>(actionResult);
var problemDetails = Assert.IsType<ProblemDetails>(badRequestResult.Value);
Assert.Equal(500, actionResult.StatusCode);
Assert.Equal(500, problemDetails.Status);
Assert.Equal(title, problemDetails.Title);
Assert.Equal("https://tools.ietf.org/html/rfc7231#section-6.6.1", problemDetails.Type);
Expand All @@ -2419,6 +2464,7 @@ public void ProblemDetails_UsesPassedInStatusCode()
// Assert
var badRequestResult = Assert.IsType<ObjectResult>(actionResult);
var problemDetails = Assert.IsType<ProblemDetails>(badRequestResult.Value);
Assert.Equal(422, actionResult.StatusCode);
Assert.Equal(422, problemDetails.Status);
Assert.Equal("Unprocessable entity.", problemDetails.Title);
Assert.Equal("https://tools.ietf.org/html/rfc4918#section-11.2", problemDetails.Type);
Expand Down