V14: Reintroduce umbraco api controller as obsolete (#16263)

* Revert "v14: Remove mentions of UmbracoApiController (#15863)"

This reverts commit 30e2dea57a.

* Obsolete UmbracoApiController

* Added a few more obsoletion messages

* Removed some of the reintroduced stuff again

* Add obsoletion to FrontEndRoutes controller

---------

Co-authored-by: kjac <kja@umbraco.dk>

tests/Umbraco.Tests.Integration/TestServerTest/UmbracoTestServerTestBase.cs

@@ -105,6 +105,18 @@ namespace Umbraco.Cms.Tests.Integration.TestServerTest
             });
         }
 
+        /// <summary>
+        /// Prepare a url before using <see cref="Client"/>.
+        /// This returns the url but also sets the HttpContext.request into to use this url.
+        /// </summary>
+        /// <returns>The string URL of the controller action.</returns>
+        protected string PrepareApiControllerUrl<T>(Expression<Func<T, object>> methodSelector)
+            where T : UmbracoApiController
+        {
+            var url = LinkGenerator.GetUmbracoApiService(methodSelector);
+            return PrepareUrl(url);
+        }
+
         protected string GetManagementApiUrl<T>(Expression<Func<T, object>> methodSelector)
             where T : ManagementApiControllerBase
         {

tests/Umbraco.Tests.Integration/Umbraco.Web.Website/Security/MemberAuthorizeTests.cs

@@ -67,6 +67,36 @@ namespace Umbraco.Cms.Tests.Integration.Umbraco.Web.Website.Security
             Assert.AreEqual(HttpStatusCode.Redirect, response.StatusCode);
             Assert.AreEqual(cookieAuthenticationOptions.Value.AccessDeniedPath.ToString(), response.Headers.Location?.AbsolutePath);
         }
+
+        [Test]
+        [LongRunning]
+        public async Task Secure_ApiController_Should_Return_Unauthorized_WhenNotLoggedIn()
+        {
+            _memberManagerMock.Setup(x => x.IsLoggedIn()).Returns(false);
+            var url = PrepareApiControllerUrl<TestApiController>(x => x.Secure());
+
+            var response = await Client.GetAsync(url);
+
+            Assert.AreEqual(HttpStatusCode.Unauthorized, response.StatusCode);
+        }
+
+        [Test]
+        [LongRunning]
+        public async Task Secure_ApiController_Should_Return_Forbidden_WhenNotAuthorized()
+        {
+            _memberManagerMock.Setup(x => x.IsLoggedIn()).Returns(true);
+            _memberManagerMock.Setup(x => x.IsMemberAuthorizedAsync(
+                     It.IsAny<IEnumerable<string>>(),
+                     It.IsAny<IEnumerable<string>>(),
+                     It.IsAny<IEnumerable<int>>()))
+                .ReturnsAsync(false);
+
+            var url = PrepareApiControllerUrl<TestApiController>(x => x.Secure());
+
+            var response = await Client.GetAsync(url);
+
+            Assert.AreEqual(HttpStatusCode.Forbidden, response.StatusCode);
+        }
     }
 
     public class TestSurfaceController : SurfaceController
@@ -91,4 +121,10 @@ namespace Umbraco.Cms.Tests.Integration.Umbraco.Web.Website.Security
         [UmbracoMemberAuthorize]
         public IActionResult Secure() => NoContent();
     }
+
+    public class TestApiController : UmbracoApiController
+    {
+        [UmbracoMemberAuthorize]
+        public IActionResult Secure() => NoContent();
+    }
 }

tests/Umbraco.Tests.UnitTests/AutoFixture/Customizations/UmbracoCustomizations.cs

@@ -47,6 +47,14 @@ internal class UmbracoCustomizations : ICustomization
         fixture.Customize<HostingSettings>(x =>
             x.With(settings => settings.ApplicationVirtualPath, string.Empty));
 
+        fixture.Customize<BackOfficeAreaRoutes>(u => u.FromFactory(
+            () => new BackOfficeAreaRoutes(
+                Options.Create(new GlobalSettings()),
+                Mock.Of<IHostingEnvironment>(x =>
+                    x.ToAbsolute(It.IsAny<string>()) == "/umbraco" && x.ApplicationVirtualPath == string.Empty),
+                Mock.Of<IRuntimeState>(x => x.Level == RuntimeLevel.Run),
+                new UmbracoApiControllerTypeCollection(Enumerable.Empty<Type>))));
+
         fixture.Customize<PreviewRoutes>(u => u.FromFactory(
             () => new PreviewRoutes(
                 Options.Create(new GlobalSettings()),

tests/Umbraco.Tests.UnitTests/Umbraco.Web.Common/Routing/BackOfficeAreaRoutesTests.cs

@@ -0,0 +1,80 @@
+// Copyright (c) Umbraco.
+// See LICENSE for more details.
+
+using System.Linq;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Routing;
+using Microsoft.Extensions.Options;
+using Moq;
+using NUnit.Framework;
+using Umbraco.Cms.Api.Management.Controllers.Security;
+using Umbraco.Cms.Api.Management.Routing;
+using Umbraco.Cms.Core;
+using Umbraco.Cms.Core.Configuration.Models;
+using Umbraco.Cms.Core.Hosting;
+using Umbraco.Cms.Core.Services;
+using Umbraco.Cms.Web.Common.Attributes;
+using Umbraco.Cms.Web.Common.Controllers;
+using Umbraco.Extensions;
+using static Umbraco.Cms.Core.Constants.Web.Routing;
+
+namespace Umbraco.Cms.Tests.UnitTests.Umbraco.Web.Common.Routing;
+
+[TestFixture]
+public class BackOfficeAreaRoutesTests
+{
+    [TestCase(RuntimeLevel.BootFailed)]
+    [TestCase(RuntimeLevel.Unknown)]
+    [TestCase(RuntimeLevel.Boot)]
+    public void RuntimeState_No_Routes(RuntimeLevel level)
+    {
+        var routes = GetBackOfficeAreaRoutes(level);
+        var endpoints = new TestRouteBuilder();
+        routes.CreateRoutes(endpoints);
+
+        Assert.AreEqual(0, endpoints.DataSources.Count);
+    }
+
+    [Test]
+    [TestCase(RuntimeLevel.Run)]
+    [TestCase(RuntimeLevel.Upgrade)]
+    [TestCase(RuntimeLevel.Install)]
+    public void RuntimeState_All_Routes(RuntimeLevel level)
+    {
+        var routes = GetBackOfficeAreaRoutes(level);
+        var endpoints = new TestRouteBuilder();
+        routes.CreateRoutes(endpoints);
+
+        Assert.AreEqual(1, endpoints.DataSources.Count);
+        var route = endpoints.DataSources.First();
+        Assert.AreEqual(2, route.Endpoints.Count);
+
+        AssertMinimalBackOfficeRoutes(route);
+    }
+
+    private void AssertMinimalBackOfficeRoutes(EndpointDataSource route)
+    {
+        var endpoint1 = (RouteEndpoint)route.Endpoints[0];
+        Assert.AreEqual("umbraco/{action}/{id?}", endpoint1.RoutePattern.RawText);
+        Assert.AreEqual("Index", endpoint1.RoutePattern.Defaults[ActionToken]);
+        Assert.AreEqual(ControllerExtensions.GetControllerName<BackOfficeDefaultController>(), endpoint1.RoutePattern.Defaults[ControllerToken]);
+    }
+
+    private BackOfficeAreaRoutes GetBackOfficeAreaRoutes(RuntimeLevel level)
+    {
+        var globalSettings = new GlobalSettings();
+        var routes = new BackOfficeAreaRoutes(
+            Options.Create(globalSettings),
+            Mock.Of<IHostingEnvironment>(x =>
+                x.ToAbsolute(It.IsAny<string>()) == "/umbraco" && x.ApplicationVirtualPath == string.Empty),
+            Mock.Of<IRuntimeState>(x => x.Level == level),
+            new UmbracoApiControllerTypeCollection(() => new[] { typeof(Testing1Controller) }));
+
+        return routes;
+    }
+
+    [IsBackOffice]
+    private class Testing1Controller : UmbracoApiController
+    {
+    }
+}