Set errors to optional array instead of throwing exception

Author: Greg Bowler

composer.json

@@ -5,6 +5,7 @@
 
 	"require": {
 		"php": ">=7.2",
+		"ext-json": "*",
 		"phpgt/cli": "1.*",
 		"webmozart/glob": "4.*",
 		"composer/semver": "1.*"

composer.lock

@@ -1,6 +1,8 @@
 <?php
 namespace Gt\Build;
 
+use Webmozart\Glob\Glob;
+
 class Build {
 	/** @var TaskList */
 	protected $taskList;
@@ -16,11 +18,19 @@ public function __construct(
 		);
 	}
 
-	public function check():int {
+	public function check(array &$errors = null):int {
 		$count = 0;
 
 		foreach($this->taskList as $pathMatch => $task) {
-			$task->check();
+			$absolutePathMatch = implode(DIRECTORY_SEPARATOR, [
+				getcwd(),
+				$pathMatch,
+			]);
+			$fileList = Glob::glob($absolutePathMatch);
+			if(!empty($fileList)) {
+				$task->check($errors);
+			}
+
 			$count ++;
 		}
 
@@ -30,10 +40,10 @@ public function check():int {
 	/**
 	 * @return Task[]
 	 */
-	public function build():array {
+	public function build(array &$errors = null):array {
 		$updatedTasks = [];
 		foreach($this->taskList as $pathMatch => $task) {
-			if($task->build()) {
+			if($task->build($errors)) {
 				$updatedTasks []= $task;
 			}
 		}

src/Build.php

@@ -27,10 +27,9 @@ public function setDefault(string $path):void {
 		$this->defaultPath = $path;
 	}
 
-	public function run(
-		string $workingDirectory,
-		bool $continue = true
-	):void {
+	public function run(bool $continue = true):void {
+		$workingDirectory = $this->workingDirectory;
+
 		if(is_file($workingDirectory)) {
 			$workingDirectory = dirname($workingDirectory);
 		}
@@ -46,11 +45,23 @@ public function run(
 			$jsonPath= $this->defaultPath;
 		}
 
+		$startTime = microtime(true);
+
+		$errors = [];
 		$build = new Build($jsonPath, $workingDirectory);
-		$build->check();
+		$build->check($errors);
+
+		if(!empty($errors)) {
+			$this->stream->writeLine("The following errors occurred:", Stream::ERROR);
+
+			foreach($errors as $e) {
+				$this->stream->writeLine(" • " . $e);
+			}
+			exit(1);
+		}
 
 		do {
-			$updates = $build->build();
+			$updates = $build->build($errors);
 
 			foreach($updates as $update) {
 				$this->stream->writeLine(
@@ -60,9 +71,22 @@ public function run(
 				);
 			}
 
+			foreach($errors as $error) {
+				$this->stream->writeLine(
+					$error,
+					Stream::ERROR
+				);
+			}
+
 			// Quarter-second wait:
 			usleep(250000);
 		}
 		while($continue);
+
+		$deltaTime = round(
+			microtime(true) - $startTime,
+			1
+		);
+		$this->stream->writeLine("Build script completed in $deltaTime seconds");
 	}
 }

src/BuildRunner.php

@@ -1,14 +1,22 @@
 <?php
 namespace Gt\Build\Command;
 
+use Gt\Build\BuildRunner;
 use Gt\Cli\Argument\ArgumentValueList;
 use Gt\Cli\Command\Command;
 use Gt\Cli\Parameter\NamedParameter;
 use Gt\Cli\Parameter\Parameter;
+use Gt\Cli\Stream;
 
 class RunCommand extends Command {
 	public function run(ArgumentValueList $arguments = null):void {
-		$this->writeLine("Run command");
+		$stream = new Stream(
+			"php://stdin",
+			"php://stdout",
+			"php://stderr"
+		);
+		$buildRunner = new BuildRunner(getcwd(), $stream);
+		$buildRunner->run(false);
 	}
 
 	public function getName():string {

src/Command/RunCommand.php

@@ -27,22 +27,41 @@ public function __toString():string {
 		]);
 	}
 
-	public function check():bool {
+	public function check(array &$errors = null):bool {
 		$arg = $this->getArgumentToCheckVersionOfCommand();
 		$versionCommand = implode(" ", [
 			$this->name,
 			$arg,
 		]);
 
-		exec($versionCommand, $output, $return);
+		$descriptor = [
+			0 => ["pipe", "r"],
+			1 => ["pipe", "w"],
+			2 => ["pipe", "w"],
+		];
+		$proc = proc_open($versionCommand, $descriptor, $pipes);
 
-		if($return !== 0) {
-			throw new VersionCheckException($this->name);
+		do {
+			$status = proc_get_status($proc);
 		}
+		while($status["running"]);
+		$return = $status["exitcode"];
+		$output = "";
+
+		$output .= stream_get_contents($pipes[1]);
+		$output .= stream_get_contents($pipes[2]);
+		proc_close($proc);
 
-		$outputString = implode(" ", $output);
-		$versionInstalled = $this->getVersionFromVersionString($outputString);
+		if($return !== 0) {
+			if(is_null($errors)) {
+				throw new RequirementMissingException($this->name);
+			}
+			else {
+				$errors []= "Requirement missing: " . $this->name;
+			}
+		}
 
+		$versionInstalled = $this->getVersionFromVersionString($output);
 		return $this->isVersionStringValid($versionInstalled);
 	}
 

src/Requirement.php

@@ -0,0 +1,4 @@
+<?php
+namespace Gt\Build;
+
+class RequirementMissingException extends BuildException {}

src/RequirementMissingException.php

@@ -18,9 +18,8 @@ class Task {
 
 	protected $fileHashList = [];
 
-// TODO: PHP 7.2 object typehint
 	public function __construct(
-		$details,
+		object $details,
 		string $pathMatch = self::MATCH_EVERYTHING,
 		string $basePath = ""
 	) {
@@ -38,24 +37,28 @@ public function __toString():string {
 		return $this->name ?? $this->execute->command;
 	}
 
-	public function check():void {
+	public function check(array &$errors = null):void {
 		foreach($this->requirements as $requirement) {
-			if(!$requirement->check()) {
-				throw new UnsatisfiedRequirementVersion($requirement);
+			if(!$requirement->check($errors)) {
+				if(is_null($errors)) {
+					throw new UnsatisfiedRequirementVersion($requirement);
+				}
+				else {
+					$errors []= "Unsatisfied version: " . $requirement;
+				}
 			}
 		}
 	}
 
-	public function build():bool {
+	public function build(array &$errors = null):bool {
 		$changes = false;
 
 		foreach(Glob::glob($this->absolutePath) as $matchedPath) {
 			$hash = filemtime($matchedPath);
 			$existingHash = $this->fileHashList[$matchedPath] ?? null;
 
 			if($hash !== $existingHash) {
-				$this->execute();
-				$changes = true;
+				$changes = $this->execute($errors);
 			}
 
 			$this->fileHashList[$matchedPath] = $hash;
@@ -86,7 +89,7 @@ protected function setDetails($details):void {
 		}
 	}
 
-	protected function execute():void {
+	protected function execute(array &$errors = null):bool {
 		$previousCwd = getcwd();
 		chdir($this->basePath);
 
@@ -95,12 +98,40 @@ protected function execute():void {
 			$this->execute->arguments,
 		]);
 
-		exec($fullCommand, $output, $return);
+		$descriptor = [
+			0 => ["pipe", "r"],
+			1 => ["pipe", "w"],
+			2 => ["pipe", "w"],
+		];
+		$proc = proc_open($fullCommand, $descriptor, $pipes);
+
+		do {
+			$status = proc_get_status($proc);
+		} while($status["running"]);
 		chdir($previousCwd);
+		$output = "";
+
+		$return = $status["exitcode"];
+		$output .= stream_get_contents($pipes[1]);
+		$output .= stream_get_contents($pipes[2]);
+		proc_close($proc);
 
 		if($return !== 0) {
-			throw new TaskExecutionFailureException($fullCommand);
+			if(is_null($errors)) {
+				throw new TaskExecutionFailureException($fullCommand);
+			}
+			else {
+				$errors []= "ERROR executing "
+					. $this->execute->command
+					. ": "
+					. PHP_EOL
+					. $output;
+			}
+
+			return false;
 		}
+
+		return true;
 	}
 
 	protected function expandRelativePath(string $basePath):string {

src/Task.php

@@ -5,6 +5,7 @@
 
 class TaskList implements Iterator {
 	protected $pathMatches = [];
+	/** @var array Task[] */
 	protected $tasks = [];
 
 	protected $iteratorKey;