Add cli test runner

Author: ircmaxell

.php-cs-fixer.php

@@ -11,6 +11,7 @@
     ->name('.php_cs')
     ->exclude('vendor')
     ->exclude('.git')
+    ->exclude('coverage')
     ->in(__DIR__);
 
 return (new PhpCsFixer\Config())

README.md

@@ -37,3 +37,11 @@ To dump the graph, simply use the built-in dumper:
 $dumper = new PHPCfg\Printer\Text();
 echo $dumper->printScript($script);
 ```
+
+## CLI
+
+You can leverage the CLI binary to generate debug traces of the CFG for any file, or for printing GraphViz visualizations.
+
+```shell
+bin/php-cfg dot -o output.dot path/to/file.php
+```

bin/php-cfg

@@ -0,0 +1,13 @@
+#!/usr/bin/env php
+<?php
+require_once(__DIR__ . '/../vendor/autoload.php');
+
+// Init App with name and version
+$app = new Ahc\Cli\Application('PHP-CFG', 'v0.0.1');
+
+$app->add(new PHPCfg\Cli\PrintCommand, 'p');
+$app->add(new PHPCfg\Cli\DotCommand, 'd');
+
+$app->add(new PHPCfg\Cli\RunTestCommand);
+
+$app->handle($_SERVER['argv']); // if argv[1] is `i` or `init` it executes InitCommand

composer.json

@@ -11,15 +11,20 @@
     "require": {
         "php": ">=8.1",
         "nikic/php-parser": "^5.0",
-        "phpdocumentor/graphviz": "^1.0.4"
+        "phpdocumentor/graphviz": "^1.0.4",
+        "adhocore/cli": "^v1.0.0"
     },
     "require-dev": {
         "phpunit/phpunit": ">=10.0",
         "friendsofphp/php-cs-fixer": ">=3.86"
     },
     "autoload": {
         "psr-4": {
-            "PHPCfg\\": "lib/PHPCfg/"
+            "PHPCfg\\": "lib/PHPCfg/",
+            "PHPCfg\\Cli\\": "src/Cli"
         }
-    }
+    },
+    "bin": [
+        "bin/php-cfg"
+    ]
 }

demo.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * This file is part of PHP-CFG, a Control flow graph implementation for PHP
+ *
+ * @copyright 2015 Anthony Ferrara. All rights reserved
+ * @license MIT See LICENSE at the root of the project for more info
+ */
+
+namespace PHPCfg\Cli;
+
+use Ahc\Cli\Input\Command;
+use PHPCfg\Parser;
+use PHPCfg\Script;
+use PHPCfg\Traverser;
+use PHPCfg\Visitor;
+use PhpParser\ParserFactory;
+
+abstract class BaseCommand extends Command
+{
+    protected function exec(string $file, string $code, bool $optimize): Script
+    {
+        $parser = new Parser((new ParserFactory())->createForNewestSupportedVersion());
+
+        $traverser = new Traverser();
+
+        if ($optimize) {
+            $traverser->addVisitor(new Visitor\Simplifier());
+        }
+
+        $script = $parser->parse($code, $file);
+        $traverser->traverse($script);
+        return $script;
+    }
+}

src/Cli/BaseCommand.php

@@ -0,0 +1,53 @@
+<?php
+
+/**
+ * This file is part of PHP-CFG, a Control flow graph implementation for PHP
+ *
+ * @copyright 2015 Anthony Ferrara. All rights reserved
+ * @license MIT See LICENSE at the root of the project for more info
+ */
+
+namespace PHPCfg\Cli;
+
+use Ahc\Cli\Output\Color;
+use PHPCfg\Printer;
+
+class DotCommand extends BaseCommand
+{
+    public function __construct()
+    {
+        parent::__construct('dot', 'Print GraphViz DOT Representation');
+
+        $help = "Todo";
+
+        $this
+            ->argument('<file>', 'File to process')
+            ->option('-n|--no-optimize', 'Disable Optimizers')
+            ->option('-o|--output', 'Output File', null, '-')
+        ;
+    }
+
+    public function execute($file, $optimize, $output)
+    {
+        $io = $this->app()->io();
+        $color = new Color();
+
+        if (file_exists($file)) {
+            $code = file_get_contents($file);
+        } else {
+            $io->write($color->error("Unknown file $file"));
+            return 1;
+        }
+
+        $script = $this->exec($file, $code, $optimize);
+
+        $dumper = new Printer\GraphViz();
+        $result = $dumper->printScript($script);
+        if ($output === '-') {
+            $io->write($result);
+        } else {
+            file_put_contents($output, $result);
+            $io->write("Saved to {$output}", true);
+        }
+    }
+}

src/Cli/DotCommand.php

@@ -0,0 +1,46 @@
+<?php
+
+/**
+ * This file is part of PHP-CFG, a Control flow graph implementation for PHP
+ *
+ * @copyright 2015 Anthony Ferrara. All rights reserved
+ * @license MIT See LICENSE at the root of the project for more info
+ */
+
+namespace PHPCfg\Cli;
+
+use Ahc\Cli\Output\Color;
+use PHPCfg\Printer;
+
+class PrintCommand extends BaseCommand
+{
+    public function __construct()
+    {
+        parent::__construct('print', 'Print CFG Representation');
+
+
+        $this
+            ->argument('<file>', 'File to process')
+            ->option('-n|--no-optimize', 'Disable Optimizers', 'boolval', false)
+            ->option('-a|--attributes', 'Render Attributes', 'boolval', false)
+        ;
+    }
+
+    public function execute($file, $optimize, $attributes)
+    {
+        $io = $this->app()->io();
+        $color = new Color();
+
+        if (file_exists($file)) {
+            $code = file_get_contents($file);
+        } else {
+            $io->write($color->error("Unknown file $file"));
+            return 1;
+        }
+
+        $script = $this->exec($file, $code, $optimize);
+
+        $dumper = new Printer\Text($attributes);
+        $io->write($dumper->printScript($script), true);
+    }
+}

src/Cli/PrintCommand.php

@@ -0,0 +1,47 @@
+<?php
+
+/**
+ * This file is part of PHP-CFG, a Control flow graph implementation for PHP
+ *
+ * @copyright 2015 Anthony Ferrara. All rights reserved
+ * @license MIT See LICENSE at the root of the project for more info
+ */
+
+namespace PHPCfg\Cli;
+
+use Ahc\Cli\Output\Color;
+use PHPCfg\Printer;
+
+class RunTestCommand extends BaseCommand
+{
+    public function __construct()
+    {
+        parent::__construct('run-test', 'Run test name - Used for generating results when writing code tests');
+
+        $help = "Todo";
+
+        $this
+            ->argument('<test>', 'Name of test to run (without .test suffix)')
+        ;
+    }
+
+    public function execute($test)
+    {
+        $io = $this->app()->io();
+        $color = new Color();
+
+        $file = __DIR__ . '/../../test/code/' . $test . '.test';
+
+        if (file_exists($file)) {
+            [$code] = explode('-----', file_get_contents($file), 2);
+        } else {
+            $io->write($color->error("Unknown file $file"));
+            return 1;
+        }
+
+        $script = $this->exec($file, $code, true);
+
+        $dumper = new Printer\Text();
+        $io->write($dumper->printScript($script), true);
+    }
+}