Allow plugins to register generic assets capacities

Author: cedric-anne

phpunit/DbTestCase.php

@@ -37,6 +37,7 @@
 use Glpi\Asset\AssetDefinition;
 use Glpi\Asset\AssetDefinitionManager;
 use Glpi\Asset\Capacity;
+use Glpi\Asset\CapacityConfig;
 use Glpi\Dropdown\DropdownDefinition;
 
 class DbTestCase extends \GLPITestCase
@@ -540,13 +541,14 @@ protected function createTxtDocument(): Document
      */
     protected function enableCapacity(
         AssetDefinition $definition,
-        string $capacity_classname
+        string $capacity_classname,
+        ?CapacityConfig $config = new CapacityConfig()
     ): AssetDefinition {
         // Add new capacity
         $existing_capacities = $this->callPrivateMethod($definition, 'getDecodedCapacitiesField');
+        $existing_capacities[] = new Capacity(name: $capacity_classname, config: $config);
 
         $capacity_input = array_map(fn (Capacity $capacity) => $capacity->jsonSerialize(), $existing_capacities);
-        $capacity_input[] = ['name' => $capacity_classname];
 
         $this->updateItem(
             AssetDefinition::class,

phpunit/functional/Glpi/Asset/AssetDefinitionManagerTest.php

@@ -36,6 +36,10 @@
 
 use Change_Item;
 use DbTestCase;
+use Glpi\Asset\AssetDefinitionManager;
+use Glpi\Asset\Capacity;
+use Glpi\Asset\Capacity\AbstractCapacity;
+use Glpi\Asset\CapacityConfig;
 use Item_Problem;
 use Item_Ticket;
 use Profile;
@@ -214,4 +218,45 @@ public function testCommonITILTabRegistration(): void
             $this->assertEquals($expected_tabs, $tabs);
         }
     }
+
+    public function testRegisteredCapacity(): void
+    {
+        $definition = $this->initAssetDefinition();
+        $asset_classname = $definition->getAssetClassName();
+
+        $capacity_implementation = $this->createMock(AbstractCapacity::class);
+        $capacity_config = new CapacityConfig(['foo' => 'bar']);
+
+        // Register the capacity.
+        $manager = AssetDefinitionManager::getInstance();
+        $manager->registerCapacity($capacity_implementation);
+
+        $this->assertContains($capacity_implementation, $manager->getAvailableCapacities());
+        $this->assertEquals($capacity_implementation, $manager->getCapacity($capacity_implementation::class));
+
+        // `onCapacityEnabled` method is executed when the capacity is enabled.
+        $capacity_implementation->expects($this->once())
+            ->method('onCapacityEnabled')
+            ->with($asset_classname, $this->equalTo($capacity_config));
+        $this->enableCapacity($definition, $capacity_implementation::class, $capacity_config);
+
+        // `onObjectInstanciation` method is executed when an asset constructor is used.
+        $capacity_implementation->expects($this->once())
+            ->method('onObjectInstanciation')
+            ->with($this->isInstanceOf($asset_classname), $this->equalTo($capacity_config));
+        new $asset_classname();
+
+        // `onCapacityUpdated` method is executed when the capacity config is updated.
+        $new_config = new CapacityConfig(['bar' => 'baz']);
+        $capacity_implementation->expects($this->once())
+            ->method('onCapacityUpdated')
+            ->with($asset_classname, $this->equalTo($capacity_config), $this->equalTo($new_config));
+        $this->enableCapacity($definition, $capacity_implementation::class, $new_config);
+
+        // `onCapacityDisabled` method is executed when the capacity is disabled.
+        $capacity_implementation->expects($this->once())
+            ->method('onCapacityDisabled')
+            ->with($asset_classname, $this->equalTo($new_config));
+        $this->disableCapacity($definition, $capacity_implementation::class);
+    }
 }

src/Glpi/Asset/AssetDefinitionManager.php

@@ -320,6 +320,14 @@ public function getAssetTypesClassesNames(bool $with_namespace = true): array
         return $classes;
     }
 
+    /**
+     * Register a capacity.
+     */
+    public function registerCapacity(CapacityInterface $capacity): void
+    {
+        $this->capacities[$capacity::class] = $capacity;
+    }
+
     /**
      * Returns available capacities instances.
      *