AgentCollection.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Setup;

use ILIAS\Refinery\Factory as Refinery;
use ILIAS\Refinery\Transformation;
use Symfony\Component\Console\Input\InputInterface;

class AgentCollection implements Agent
{
    protected Refinery $refinery;

    protected array $agents;

    public function __construct(
        Refinery $refinery,
        array $agents
    ) {
        $this->refinery = $refinery;
        $this->agents = $agents;
    }

    public function getAgent(string $key): ?Agent
    {
        return $this->agents[$key] ?? null;
    }

    public function withRemovedAgent(string $key): AgentCollection
    {
        $clone = clone $this;
        unset($clone->agents[$key]);
        return $clone;
    }

    public function withAdditionalAgent(string $key, Agent $agent): AgentCollection
    {
        if (isset($this->agents[$key])) {
            throw new \LogicException("An agent with the name '$key' already exists.");
        }
        $clone = clone $this;
        $clone->agents[$key] = $agent;
        return $clone;
    }

    public function hasConfig(): bool
    {
        foreach ($this->agents as $c) {
            if ($c->hasConfig()) {
                return true;
            }
        }
        return false;
    }

    public function getArrayToConfigTransformation(): Transformation
    {
        return $this->refinery->in()->series([
            $this->refinery->custom()->transformation(function ($in): array {
                $out = [];
                foreach ($this->agents as $key => $agent) {
                    if (!$agent->hasConfig()) {
                        continue;
                    }
                    $val = $in[$key] ?? null;
                    $transformation = $agent->getArrayToConfigTransformation();
                    $out[$key] = $transformation($val);
                }
                return $out;
            }),
            $this->refinery->custom()->transformation(fn ($v): array => [$v]),
            $this->refinery->to()->toNew(ConfigCollection::class)
        ]);
    }

    public function getInstallObjective(Config $config = null): Objective
    {
        if (!is_null($config)) {
            $this->checkConfig($config);
        }

        return new ObjectiveCollection(
            "Collected Install Objectives",
            false,
            ...array_values(array_map(
                function (string $k, Agent $v) use ($config) {
                    if ($v->hasConfig()) {
                        return $v->getInstallObjective($config->getConfig($k));
                    } else {
                        return $v->getInstallObjective();
                    }
                },
                array_keys($this->agents),
                array_values($this->agents)
            ))
        );
    }

    public function getUpdateObjective(Config $config = null): Objective
    {
        if ($config !== null) {
            $this->checkConfig($config);
        }

        return new ObjectiveCollection(
            "Collected Update Objectives",
            false,
            ...array_values(array_map(
                function (string $k, Agent $v) use ($config): \ILIAS\Setup\Objective {
                    if ($config !== null) {
                        return $v->getUpdateObjective($config->maybeGetConfig($k));
                    }
                    return $v->getUpdateObjective();
                },
                array_keys($this->agents),
                array_values($this->agents)
            ))
        );
    }

    public function getBuildArtifactObjective(): Objective
    {
        return new ObjectiveCollection(
            "Collected Build Artifact Objectives",
            false,
            ...array_values(array_map(
                fn (Agent $v): \ILIAS\Setup\Objective => $v->getBuildArtifactObjective(),
                $this->agents
            ))
        );
    }

    public function getStatusObjective(Metrics\Storage $storage): Objective
    {
        return new ObjectiveCollection(
            "Collected Status Objectives",
            false,
            ...array_values(array_map(
                fn (string $k, Agent $v): \ILIAS\Setup\Objective => $v->getStatusObjective(
                    new Metrics\StorageOnPathWrapper($k, $storage)
                ),
                array_keys($this->agents),
                array_values($this->agents)
            ))
        );
    }

    public function getMigrations(): array
    {
        $migrations = [];
        foreach ($this->agents as $agent_key => $agent) {
            foreach ($agent->getMigrations() as $migration) {
                $key = (new \ReflectionClass($migration))->getShortName();
                $migrations[$agent_key . "." . $key] = $migration;
            }
        }

        return $migrations;
    }

    protected function getKey(Migration $migration): string
    {
        $names = explode("\\", get_class($migration));
        return array_pop($names);
    }

    protected function checkConfig(Config $config): void
    {
        if (!($config instanceof ConfigCollection)) {
            throw new \InvalidArgumentException(
                "Expected ConfigCollection for configuration."
            );
        }
    }

    public function getAgents(): array
    {
        return $this->agents;
    }

    public function getNamedObjectives(?Config $config = null): array
    {
        if (!is_null($config)) {
            $this->checkConfig($config);
        }

        $agents = $this->agents;
        $namedObjectives = [];

        foreach ($agents as $k => $agent) {
            if ($config) {
                $objectives = $agent->getNamedObjectives($config->maybeGetConfig($k));
            } else {
                $objectives = $agent->getNamedObjectives();
            }
            foreach ($objectives as $name => $constructor) {
                $namedObjectives["$k.$name"] = $constructor;
            }
        }

        ksort($namedObjectives);
        return $namedObjectives;
    }
}