Capability for federated scope

Added additional capability in the provisioning API to signal whether
the federation scope values can be used.

This is based on whether the lookup server upload is enabled or not.

Signed-off-by: Vincent Petry <vincent@nextcloud.com>

2 files changed, 103 insertions, 0 deletions

diff --git a/apps/provisioning_api/lib/Capabilities.php b/apps/provisioning_api/lib/Capabilities.php
index 398502ae31c..d355e4db4c2 100644
--- a/apps/provisioning_api/lib/Capabilities.php
+++ b/apps/provisioning_api/lib/Capabilities.php
@@ -23,6 +23,7 @@
 
 namespace OCA\Provisioning_API;
 
+use OCA\FederatedFileSharing\FederatedShareProvider;
 use OCP\App\IAppManager;
 use OCP\Capabilities\ICapability;
 
@@ -41,10 +42,20 @@ class Capabilities implements ICapability {
 	 * @return array Array containing the apps capabilities
 	 */
 	public function getCapabilities() {
+		$federationScopesEnabled = false;
+
+		$federatedFileSharingEnabled = $this->appManager->isEnabledForUser('federatedfilesharing');
+		if ($federatedFileSharingEnabled) {
+			/** @var FederatedShareProvider $shareProvider */
+			$shareProvider = \OC::$server->query(FederatedShareProvider::class);
+			$federationScopesEnabled = $shareProvider->isLookupServerUploadEnabled();
+		}
+
 		return [
 			'provisioning_api' => [
 				'version' => $this->appManager->getAppVersion('provisioning_api'),
 				'AccountPropertyScopesVersion' => 2,
+				'AccountPropertyScopesFederationEnabled' => $federationScopesEnabled,
 			]
 		];
 	}
diff --git a/apps/provisioning_api/tests/CapabilitiesTest.php b/apps/provisioning_api/tests/CapabilitiesTest.php
new file mode 100644
index 00000000000..89a4215d273
--- /dev/null
+++ b/apps/provisioning_api/tests/CapabilitiesTest.php
@@ -0,0 +1,92 @@
+<?php
+/**
+ * @copyright Copyright (c) 2021 Vincent Petry <vincent@nextcloud.com>
+ *
+ * @author Vincent Petry <vincent@nextcloud.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\Provisioning_API\Tests\unit;
+
+use OCA\FederatedFileSharing\FederatedShareProvider;
+use OCA\Provisioning_API\Capabilities;
+use OCP\App\IAppManager;
+use PHPUnit\Framework\MockObject\MockObject;
+use Test\TestCase;
+
+/**
+ * Capabilities test for provisioning API.
+ *
+ * Note: group DB needed because of usage of overwriteService()
+ *
+ * @package OCA\Provisioning_API\Tests
+ * @group DB
+ */
+class CapabilitiesTest extends TestCase {
+
+	/** @var Capabilities */
+	protected $capabilities;
+
+	/** @var IAppManager|MockObject */
+	protected $appManager;
+
+	public function setUp(): void {
+		parent::setUp();
+		$this->appManager = $this->createMock(IAppManager::class);
+		$this->capabilities = new Capabilities($this->appManager);
+
+		$this->appManager->expects($this->once())
+			->method('getAppVersion')
+			->with('provisioning_api')
+			->willReturn('1.12');
+	}
+
+	public function getCapabilitiesProvider() {
+		return [
+			[false, false, false],
+			[true, false, false],
+			[true, true, true],
+		];
+	}
+
+	/**
+	 * @dataProvider getCapabilitiesProvider
+	 */
+	public function testGetCapabilities($federationAppEnabled, $lookupServerEnabled, $expectedFederationScopesEnabled) {
+		$this->appManager->expects($this->once())
+		   ->method('isEnabledForUser')
+		   ->with('federatedfilesharing')
+		   ->willReturn($federationAppEnabled);
+
+		$federatedShareProvider = $this->createMock(FederatedShareProvider::class);
+		$this->overwriteService(FederatedShareProvider::class, $federatedShareProvider);
+
+		$federatedShareProvider->expects($this->any())
+			 ->method('isLookupServerUploadEnabled')
+			 ->willReturn($lookupServerEnabled);
+
+		$expected = [
+			'provisioning_api' => [
+				'version' => '1.12',
+				'AccountPropertyScopesVersion' => 2,
+				'AccountPropertyScopesFederationEnabled' => $expectedFederationScopesEnabled,
+			],
+		];
+		$this->assertSame($expected, $this->capabilities->getCapabilities());
+	}
+}