Skip to content

Porting old Umbraco API Controller [Unit Testing] #6524

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 8 commits into from
Oct 11, 2024
Merged

Porting old Umbraco API Controller [Unit Testing] #6524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
dec9aef
Change heading
erikjanwestendorp Oct 5, 2024
e946616
Add attributes
erikjanwestendorp Oct 5, 2024
284b75a
Delete obsolete message
erikjanwestendorp Oct 5, 2024
fbb480e
Update v15
erikjanwestendorp Oct 5, 2024
bd4ac8d
Update 14/umbraco-cms/implementation/unit-testing.md
erikjanwestendorp Oct 7, 2024
9590ec7
Change UmbracoApiController to Controller
erikjanwestendorp Oct 10, 2024
a1ba5a1
Change heading to `Controller`
erikjanwestendorp Oct 10, 2024
7a6b563
Update Unit Test
erikjanwestendorp Oct 10, 2024
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
18 changes: 8 additions & 10 deletions 14/umbraco-cms/implementation/unit-testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,23 +159,21 @@ public class PageSurfaceControllerTests
`ServiceContext.CreatePartial()` has optional parameters, and by naming them you only need to mock the dependencies that you need, for example: `ServiceContext.CreatePartial(contentService: Mock.Of<IContentService>());`
{% endhint %}

## Testing an UmbracoApiController
## Testing a Controller

See [Reference documentation on UmbracoApiControllers](../reference/routing/umbraco-api-controllers/README.md#locally-declared-controller).

{% hint style="warning" %}
The example below uses UmbracoApiController which is obsolete in Umbraco 14 and will be removed in Umbraco 15.
{% endhint %}

```csharp
public class ProductsController : UmbracoApiController
[ApiController]
[Route("/umbraco/api/products")]
public class ProductsController : Controller
{
public IEnumerable<string> GetAllProducts()
{
return new[] { "Table", "Chair", "Desk", "Computer", "Beer fridge" };
}

[HttpGet]
[HttpGet("getallproductsjson")]
public JsonResult GetAllProductsJson()
{
return new JsonResult(this.GetAllProducts());
Expand All @@ -199,15 +197,15 @@ public class ProductsControllerTests

var result = this.controller.GetAllProducts();

Assert.AreEqual(expected, result);
Assert.That(expected == result);
}

[Test]
public void WhenGetAllProductsJson_ThenReturnViewModelWithExpectedJson()
{
var json = serializer.Serialize(this.controller.GetAllProductsJson().Value);
var json = JsonSerializer.Serialize(this.controller.GetAllProductsJson().Value);

Assert.AreEqual("[\"Table\",\"Chair\",\"Desk\",\"Computer\",\"Beer fridge\"]", json);
Assert.That("[\"Table\",\"Chair\",\"Desk\",\"Computer\",\"Beer fridge\"]" == json);
}
}
```
Expand Down
18 changes: 8 additions & 10 deletions 15/umbraco-cms/implementation/unit-testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,23 +159,21 @@ public class PageSurfaceControllerTests
`ServiceContext.CreatePartial()` has optional parameters, and by naming them you only need to mock the dependencies that you need, for example: `ServiceContext.CreatePartial(contentService: Mock.Of<IContentService>());`
{% endhint %}

## Testing an UmbracoApiController
## Testing a Controller

See [Reference documentation on UmbracoApiControllers](../reference/routing/umbraco-api-controllers/README.md#locally-declared-controller).

{% hint style="warning" %}
The example below uses UmbracoApiController which is obsolete in Umbraco 14 and will be removed in Umbraco 15.
{% endhint %}

```csharp
public class ProductsController : UmbracoApiController
[ApiController]
[Route("/umbraco/api/products")]
public class ProductsController : Controller
{
public IEnumerable<string> GetAllProducts()
{
return new[] { "Table", "Chair", "Desk", "Computer", "Beer fridge" };
}

[HttpGet]
[HttpGet("getallproductsjson")]
public JsonResult GetAllProductsJson()
{
return new JsonResult(this.GetAllProducts());
Expand All @@ -199,15 +197,15 @@ public class ProductsControllerTests

var result = this.controller.GetAllProducts();

Assert.AreEqual(expected, result);
Assert.That(expected == result);
}

[Test]
public void WhenGetAllProductsJson_ThenReturnViewModelWithExpectedJson()
{
var json = serializer.Serialize(this.controller.GetAllProductsJson().Value);
var json = JsonSerializer.Serialize(this.controller.GetAllProductsJson().Value);

Assert.AreEqual("[\"Table\",\"Chair\",\"Desk\",\"Computer\",\"Beer fridge\"]", json);
Assert.That("[\"Table\",\"Chair\",\"Desk\",\"Computer\",\"Beer fridge\"]" == json);
}
}
```
Expand Down
Loading