Merge pull request #2784 from irontec/PROVIDER-2043-add-entitiy-ApplicationServerSets

Add entity application server sets

Author: danigargar

asterisk/agi/composer.json

@@ -57,7 +57,7 @@
     },
     "require": {
         "friendsofphp/proxy-manager-lts": "^1.0",
-        "irontec/ivoz-provider-bundle": "^2.5",
+        "irontec/ivoz-provider-bundle": "^2.6.11",
         "irontec/replacements": "^1.0",
         "php-mime-mail-parser/php-mime-mail-parser": "^7.0",
         "symfony/flex": "^1.9",

asterisk/agi/composer.lock

@@ -0,0 +1,30 @@
+Application Server Sets
+
+The Application Server Sets section allows users to manage sets of application servers by adding, deleting, and editing them.
+Overview
+
+An Application Server Set consists of the following attributes:
+
+    Name: The name of the Application Server Set (string, required).
+    Distribute Method: The method used for distributing tasks among servers (string, required). Possible values are:
+        "Round Robin"
+        "Hash"
+    Description: A brief description of the Application Server Set (string, optional).
+    Application Servers: A multi-select list where users can choose one or more application servers (string list). This can be left empty when creating an Application Server Set but is mandatory when editing.
+
+Features
+
+    Add: Allows the user to create a new Application Server Set by providing a Name and a Distribute Method. The Description is optional, and the Application Servers list can initially be empty.
+    Edit: Enables editing of an existing Application Server Set. While Name and Distribute Method remain mandatory, the Application Servers list must contain at least one selected server during the editing process.
+    Delete: Permits the removal of an existing Application Server Set.
+
+Field Descriptions
+Field	Description	Required
+Name	The unique name of the Application Server Set.	Yes
+Distribute Method	The method of distributing tasks (Round Robin or Hash).	Yes
+Description	An optional description of the set.	No
+Application Servers	A multi-select list of chosen application servers. Can be empty on creation, but required on editing.	No (creation), Yes (editing)
+Usage Notes
+
+    When creating a new Application Server Set, ensure that both Name and Distribute Method are provided.
+    The Application Servers list can be left empty when first creating the set but must be populated with at least one server upon editing.

doc/sphinx/administration_portal/platform/infrastructure/application_server_sets.rst

@@ -10,4 +10,5 @@ Sections in this group list the components of the platform and are not meant to
     proxy_users
     proxy_trunks
     media_relay_sets
-    application_servers
+    application_servers
+    application_server_sets

doc/sphinx/administration_portal/platform/infrastructure/index.rst

@@ -40,6 +40,15 @@ public function load(ObjectManager $manager)
         $this->sanitizeEntityValues($item2);
         $manager->persist($item2);
 
+        $item3 = $this->createEntityInstance(ApplicationServer::class);
+        (function () use ($fixture) {
+            $this->setIp("127.1.1.2");
+            $this->setName("test002");
+        })->call($item3);
+
+        $this->addReference('_reference_ProviderApplicationServer3', $item3);
+        $this->sanitizeEntityValues($item3);
+        $manager->persist($item3);
 
         $manager->flush();
     }

library/DataFixtures/ORM/ProviderApplicationServer.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace DataFixtures\ORM;
+
+use Doctrine\Bundle\FixturesBundle\Fixture;
+use Doctrine\Common\DataFixtures\FixtureInterface;
+use Doctrine\Persistence\ObjectManager;
+use Doctrine\ORM\Mapping\ClassMetadata;
+use Ivoz\Provider\Domain\Model\ApplicationServerSet\ApplicationServerSet;
+
+class ProviderApplicationServerSet extends Fixture implements FixtureInterface
+{
+    use \DataFixtures\FixtureHelperTrait;
+
+    /**
+     * {@inheritDoc}
+     */
+    public function load(ObjectManager $manager)
+    {
+        $fixture = $this;
+        $this->disableLifecycleEvents($manager);
+        $manager->getClassMetadata(ApplicationServerSet::class)->setIdGeneratorType(ClassMetadata::GENERATOR_TYPE_NONE);
+        $manager->getConnection()->exec(
+            'INSERT INTO ApplicationServerSets (id, name, distributeMethod, description) VALUES (0, "default", "hash", "Default application server set")'
+        );
+
+        $item1 = $this->createEntityInstance(ApplicationServerSet::class);
+        (function () use ($fixture) {
+            $this->setName('BlueApSet');
+            $this->setDistributeMethod('hash');
+            $this->setDescription('An Application Server Set');
+        })->call($item1);
+
+        $this->addReference('_reference_ProviderApplicationServerSet1', $item1);
+        $this->sanitizeEntityValues($item1);
+        $manager->persist($item1);
+
+        $item2 = $this->createEntityInstance(ApplicationServerSet::class);
+        (function () use ($fixture) {
+            $this->setName('GreenApSet');
+            $this->setDistributeMethod('rr');
+            $this->setDescription('Another Application Server Set');
+        })->call($item2);
+
+        $this->addReference('_reference_ProviderApplicationServerSet2', $item2);
+        $this->sanitizeEntityValues($item2);
+        $manager->persist($item2);
+
+        $manager->flush();
+    }
+}

library/DataFixtures/ORM/ProviderApplicationServerSet.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace DataFixtures\ORM;
+
+use Doctrine\Bundle\FixturesBundle\Fixture;
+use Doctrine\Common\DataFixtures\FixtureInterface;
+use Doctrine\Persistence\ObjectManager;
+use Doctrine\ORM\Mapping\ClassMetadata;
+use Ivoz\Provider\Domain\Model\ApplicationServerSetRelApplicationServer\ApplicationServerSetRelApplicationServer;
+
+class ProviderApplicationServerSetRelApplicationServers extends Fixture implements FixtureInterface
+{
+    use \DataFixtures\FixtureHelperTrait;
+
+    /**
+     * {@inheritDoc}
+     */
+    public function load(ObjectManager $manager)
+    {
+        $fixture = $this;
+        $this->disableLifecycleEvents($manager);
+        $manager->getClassMetadata(ApplicationServerSetRelApplicationServer::class)->setIdGeneratorType(ClassMetadata::GENERATOR_TYPE_NONE);
+        $manager->getConnection()->exec(
+            'INSERT INTO ApplicationServerSetRelApplicationServers(applicationServerId, applicationServerSetId ) SELECT id, 0 FROM ApplicationServers'
+        );
+        $item1 = $this->createEntityInstance(ApplicationServerSetRelApplicationServer::class);
+        (function () use ($fixture) {
+            $this->setApplicationServer($fixture->getReference('_reference_ProviderApplicationServer1'));
+            $this->setApplicationServerSet($fixture->getReference('_reference_ProviderApplicationServerSet1'));
+        })->call($item1);
+        $this->addReference('_reference_ApplicationServerSetRelApplicationServer1', $item1);
+        $this->sanitizeEntityValues($item1);
+        $manager->persist($item1);
+
+        $item2 = $this->createEntityInstance(ApplicationServerSetRelApplicationServer::class);
+        (function () use ($fixture) {
+            $this->setApplicationServer($fixture->getReference('_reference_ProviderApplicationServer2'));
+            $this->setApplicationServerSet($fixture->getReference('_reference_ProviderApplicationServerSet1'));
+        })->call($item2);
+        $this->addReference('_reference_ApplicationServerSetRelApplicationServer2', $item2);
+        $this->sanitizeEntityValues($item2);
+
+        $item3 = $this->createEntityInstance(ApplicationServerSetRelApplicationServer::class);
+        (function () use ($fixture) {
+            $this->setApplicationServer($fixture->getReference('_reference_ProviderApplicationServer1'));
+            $this->setApplicationServerSet($fixture->getReference('_reference_ProviderApplicationServerSet2'));
+        })->call($item3);
+        $this->addReference('_reference_ApplicationServerSetRelApplicationServer3', $item3);
+        $this->sanitizeEntityValues($item3);
+
+        $item4 = $this->createEntityInstance(ApplicationServerSetRelApplicationServer::class);
+        (function () use ($fixture) {
+            $this->setApplicationServer($fixture->getReference('_reference_ProviderApplicationServer3'));
+            $this->setApplicationServerSet($fixture->getReference('_reference_ProviderApplicationServerSet2'));
+        })->call($item4);
+        $this->addReference('_reference_ApplicationServerSetRelApplicationServer4', $item4);
+        $this->sanitizeEntityValues($item4);
+
+        $manager->flush();
+    }
+}

library/DataFixtures/ORM/ProviderApplicationServerSetRelApplicationServers.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Ivoz\Provider\Domain\Assembler\ApplicationServerSet;
+
+use Ivoz\Core\Domain\Assert\Assertion;
+use Ivoz\Core\Domain\DataTransferObjectInterface;
+use Ivoz\Core\Domain\Model\EntityInterface;
+use Ivoz\Core\Domain\Service\Assembler\CustomDtoAssemblerInterface;
+use Ivoz\Provider\Domain\Model\ApplicationServerSet\ApplicationServerSet;
+use Ivoz\Provider\Domain\Model\ApplicationServerSetRelApplicationServer\ApplicationServerSetRelApplicationServerInterface;
+
+class ApplicationServerSetDtoAssembler implements CustomDtoAssemblerInterface
+{
+    public function toDto(EntityInterface $entity, int $depth = 0, string $context = null): DataTransferObjectInterface
+    {
+        Assertion::isInstanceOf($entity, ApplicationServerSet::class);
+
+        $dto = $entity->toDto($depth);
+        $id = $entity->getId();
+
+        if (is_null($id)) {
+            return $dto;
+        }
+
+        if ($context === DataTransferObjectInterface::CONTEXT_SIMPLE) {
+            return $dto;
+        }
+
+        $relApplicationServers = $entity->getRelApplicationServers();
+        $applicationServerIds = array_map(
+            function (ApplicationServerSetRelApplicationServerInterface $relApplicationServer) {
+                return (int) $relApplicationServer
+                    ->getApplicationServer()
+                    ?->getId();
+            },
+            $relApplicationServers
+        );
+
+        $dto->setApplicationServers(
+            $applicationServerIds
+        );
+
+        return $dto;
+    }
+}

library/Ivoz/Provider/Domain/Assembler/ApplicationServerSet/ApplicationServerSetDtoAssembler.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace Ivoz\Provider\Domain\Model\ApplicationServerSet;
+
+use Ivoz\Core\Domain\Assert\Assertion;
+use Ivoz\Provider\Domain\Model\ApplicationServer\ApplicationServerInterface;
+use Ivoz\Provider\Domain\Model\ApplicationServerSetRelApplicationServer\ApplicationServerSetRelApplicationServerInterface;
+
+/**
+ * ApplicationServerSet
+ */
+class ApplicationServerSet extends ApplicationServerSetAbstract implements ApplicationServerSetInterface
+{
+    use ApplicationServerSetTrait;
+
+    /**
+     * @codeCoverageIgnore
+     * @return array<string, mixed>
+     */
+    public function getChangeSet(): array
+    {
+        return parent::getChangeSet();
+    }
+
+    /**
+     * Get id
+     * @codeCoverageIgnore
+     */
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    protected function sanitizeValues(): void
+    {
+        $this->sanitizeAvoidEmptyApplicationServers();
+    }
+
+    /**
+     * @return void
+     * @throws \Assert\AssertionFailedException
+     */
+    protected function sanitizeAvoidEmptyApplicationServers(): void
+    {
+        if ($this->isNew()) {
+            return;
+        }
+
+        $relApplicationServerSets = $this->getRelApplicationServers();
+
+        Assertion::notEmpty(
+            $relApplicationServerSets
+        );
+    }
+}