First working version

Author: schmengler

.gitignore

@@ -0,0 +1,4 @@
+/composer.lock
+/vendor
+.phpunit.result.cache
+.idea

composer.json

@@ -0,0 +1,24 @@
+{
+  "name": "integer-net/deployer-timer",
+  "description": "Collect duration of deployer tasks",
+  "minimum-stability": "stable",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Fabian Schmengler",
+      "email": "fs@integer-net.de"
+    }
+  ],
+  "require": {
+    "roave/security-advisories": "dev-master",
+    "deployer/deployer": "v6.4.3"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "8.0.5"
+  },
+  "autoload": {
+    "psr-4":  {
+      "IntegerNet\\DeployerTimer\\": "src/"
+    }
+  }
+}

recipe/timer.php

@@ -0,0 +1,25 @@
+<?php
+declare(strict_types=1);
+
+namespace Deployer;
+
+use Deployer\Task\Task;
+use IntegerNet\DeployerTimer\DecorateAllTasks;
+use IntegerNet\DeployerTimer\TimerTaskDecorator;
+
+function timerCsv(string $fileName)
+{
+    $deployer = Deployer::get();
+    $decorateAllTasks = new DecorateAllTasks($deployer);
+    $timer = new TimerTaskDecorator();
+    $decorateAllTasks->with($timer);
+    $tasks = $deployer->tasks->toArray();
+    /** @var Task $lastTask */
+    $lastTask = array_pop($tasks);
+    $collectResultTask = uniqid('timer_result-', true);
+    task(
+        $collectResultTask, function() use ($timer, $fileName) {
+        file_put_contents($fileName, $timer->resultsAsCsv());
+    });
+    after($lastTask->getName(), $collectResultTask);
+}

src/Clock.php

@@ -0,0 +1,9 @@
+<?php
+declare(strict_types=1);
+
+namespace IntegerNet\DeployerTimer;
+
+interface Clock
+{
+    public function microtime(): float;
+}

src/DecorateAllTasks.php

@@ -0,0 +1,34 @@
+<?php
+declare(strict_types=1);
+
+namespace IntegerNet\DeployerTimer;
+
+use Deployer\Deployer;
+use Deployer\Task\Task;
+
+class DecorateAllTasks
+{
+    /**
+     * @var Deployer
+     */
+    private $deployer;
+
+    public function __construct(Deployer $deployer)
+    {
+        $this->deployer = $deployer;
+    }
+
+    public function with(TaskDecorator $decorator): void
+    {
+        foreach ($this->deployer->tasks as $taskName => $task) {
+            $beforeName = $taskName . '.' . $decorator->name() . '.before';
+            $afterName = $taskName . '.' . $decorator->name() . '.after';
+            $this->deployer->tasks->set($beforeName, (new Task($beforeName, $decorator->callbackBefore($taskName)))->shallow());
+            $this->deployer->tasks->set($afterName, (new Task($afterName, $decorator->callbackAfter($taskName)))->shallow());
+            if (!in_array($task->getName(), [$beforeName, $afterName], true)) {
+                $task->addBefore($beforeName);
+                $task->addAfter($afterName);
+            }
+        }
+    }
+}

src/FakeClock.php

@@ -0,0 +1,28 @@
+<?php
+declare(strict_types=1);
+
+namespace IntegerNet\DeployerTimer;
+
+class FakeClock implements Clock
+{
+    /**
+     * @var float
+     */
+    private $timestamp;
+
+    public function __construct(float $timestamp)
+    {
+        $this->timestamp = $timestamp;
+    }
+
+    public function microtime(): float
+    {
+        return $this->timestamp;
+    }
+
+    public function advanceMs(int $ms): void
+    {
+        $this->timestamp += ($ms * 0.001);
+    }
+
+}

src/SystemClock.php

@@ -0,0 +1,12 @@
+<?php
+declare(strict_types=1);
+
+namespace IntegerNet\DeployerTimer;
+
+class SystemClock implements Clock
+{
+    public function microtime(): float
+    {
+        return \microtime(true);
+    }
+}

src/TaskDecorator.php

@@ -0,0 +1,13 @@
+<?php
+declare(strict_types=1);
+
+namespace IntegerNet\DeployerTimer;
+
+interface TaskDecorator
+{
+    public function name(): string;
+
+    public function callbackBefore(string $taskName): callable;
+
+    public function callbackAfter(string $taskName): callable;
+}

src/TimerEvent.php

@@ -0,0 +1,51 @@
+<?php
+declare(strict_types=1);
+
+namespace IntegerNet\DeployerTimer;
+
+class TimerEvent
+{
+    public const TYPE_BEGIN = 'BEGIN';
+    public const TYPE_END = 'END';
+    /**
+     * @var string
+     */
+    private $type;
+    /**
+     * @var string
+     */
+    private $taskName;
+    /**
+     * @var float
+     */
+    private $timestamp;
+    /**
+     * @var float
+     */
+    private $duration;
+
+    public function __construct(string $type, string $taskName, float $timestamp, float $duration)
+    {
+        $this->type = $type;
+        $this->taskName = $taskName;
+        $this->timestamp = $timestamp;
+        $this->duration = $duration;
+    }
+
+    private function asArray()
+    {
+        return [$this->type, $this->taskName, round($this->timestamp, 3), round($this->duration, 3)];
+    }
+
+    public function asCsvLine(): string
+    {
+        $f = fopen('php://memory', 'rb+');
+        if (fputcsv($f, $this->asArray()) === false) {
+            throw new \RuntimeException('Cannot format TimerEvent as CSV');
+        }
+        rewind($f);
+        $line = stream_get_contents($f);
+        fclose($f);
+        return rtrim($line);
+    }
+}

src/TimerEvents.php

@@ -0,0 +1,26 @@
+<?php
+declare(strict_types=1);
+
+namespace IntegerNet\DeployerTimer;
+
+class TimerEvents
+{
+    /**
+     * @var TimerEvent[]
+     */
+    private $items = [];
+
+    public function append(TimerEvent $event)
+    {
+        $this->items[] = $event;
+    }
+
+    public function asCsv(): string
+    {
+        $lines = [];
+        foreach ($this->items as $item) {
+            $lines[] = $item->asCsvLine();
+        }
+        return implode("\n", $lines);
+    }
+}