Merge branch 'artifacts'

docs/en/configuring.md

@@ -58,8 +58,9 @@ php-censor:
     status:
       commit: false # This option allow/deny to post status to Github commit
   build:
-    remove_builds:      true # This option allow/deny build cleaning
+    remove_builds:          true  # This option allow/deny build cleaning
-    writer_buffer_size: 500  # BuildErrorWriter buffer size (count of inserts in one SQL query)
+    writer_buffer_size:     500   # BuildErrorWriter buffer size (count of inserts in one SQL query)
+    allow_public_artifacts: false # This option allow/deny to generate public artifacts (PHPUnit code coverage html report, Pdepend html reports)
   security:
     disable_auth:    false # This option allows/deny you to disable authentication for PHP Censor
     default_user_id: 1     # Default user when authentication disabled

src/PHPCensor/Command/InstallCommand.php

@@ -291,8 +291,9 @@ class InstallCommand extends Command
                 ],
             ],
             'build' => [
-                'remove_builds'      => true,
+                'remove_builds'          => true,
-                'writer_buffer_size' => 500,
+                'writer_buffer_size'     => 500,
+                'allow_public_artifacts' => true,
             ],
             'security' => [
                 'disable_auth'    => false,

src/PHPCensor/Command/RunCommand.php

@@ -163,7 +163,7 @@ class RunCommand extends Command
                 $build->setStatus(Build::STATUS_FAILED);
                 $build->setFinishDate(new \DateTime());
                 $store->save($build);
-                $build->removeBuildDirectory();
+                $build->removeBuildDirectory(true);
                 continue;
             }
 

src/PHPCensor/Logging/BuildDBLogHandler.php

@@ -70,7 +70,7 @@ class BuildDBLogHandler extends AbstractProcessingHandler
     protected function write(array $record)
     {
         $message = (string)$record['message'];
-        $message = str_replace($this->build->currentBuildPath, './', $message);
+        $message = str_replace($this->build->getBuildPath(), './', $message);
 
         $this->logValue .= $message . PHP_EOL;
 

src/PHPCensor/Model/Build.php

@@ -4,6 +4,7 @@ namespace PHPCensor\Model;
 
 use PHPCensor\Builder;
 use PHPCensor\Store\BuildErrorStore;
+use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Yaml\Parser as YamlParser;
 use PHPCensor\Model;
 use b8\Store\Factory;
@@ -44,6 +45,16 @@ class Build extends Model
      */
     protected $newErrorsCount = null;
 
+    /**
+     * @var string
+     */
+    protected $buildDirectory;
+
+    /**
+     * @var string
+     */
+    protected $buildBranchDirectory;
+
     /**
      * @var array
      */
@@ -683,8 +694,6 @@ class Build extends Model
         return Factory::getStore('BuildMeta', 'PHPCensor')->getByBuildId($this->getId());
     }
 
-    public $currentBuildPath;
-
     /**
     * Get link to commit from another source (i.e. Github)
     */
@@ -885,8 +894,42 @@ class Build extends Model
     }
 
     /**
-     * Return the path to run this build into.
+     * @return string|null
-     *
+     */
+    public function getBuildDirectory()
+    {
+        if (!$this->getId()) {
+            return null;
+        }
+
+        if (empty($this->buildDirectory)) {
+            $this->buildDirectory = $this->getProjectId() . '/' . $this->getId() . '_' . substr(
+                md5(($this->getId() . '_' . $this->getCreateDate()->format('Y-m-d H:i:s'))
+            ), 0, 8);
+        }
+
+        return $this->buildDirectory;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getBuildBranchDirectory()
+    {
+        if (!$this->getId()) {
+            return null;
+        }
+
+        if (empty($this->buildBranchDirectory)) {
+            $this->buildBranchDirectory = $this->getProjectId() . '/' . $this->getBranch() . '_' . substr(
+                md5(($this->getBranch() . '_' . $this->getProject()->getCreateDate()->format('Y-m-d H:i:s'))
+            ), 0, 8);
+        }
+
+        return $this->buildBranchDirectory;
+    }
+
+    /**
      * @return string|null
      */
     public function getBuildPath()
@@ -895,23 +938,15 @@ class Build extends Model
             return null;
         }
 
-        if (empty($this->currentBuildPath)) {
+        return RUNTIME_DIR . 'builds/' . $this->getBuildDirectory() . '/';
-            $buildDirectory         = $this->getId() . '_' . substr(md5(microtime(true)), 0, 5);
-            $this->currentBuildPath =
-                RUNTIME_DIR .
-                'builds' .
-                DIRECTORY_SEPARATOR .
-                $buildDirectory .
-                DIRECTORY_SEPARATOR;
-        }
-
-        return $this->currentBuildPath;
     }
 
     /**
      * Removes the build directory.
+     *
+     * @param boolean $withArtifacts
      */
-    public function removeBuildDirectory()
+    public function removeBuildDirectory($withArtifacts = false)
     {
         // Get the path and remove the trailing slash as this may prompt PHP
         // to see this as a directory even if it's a link.
@@ -921,11 +956,24 @@ class Build extends Model
             return;
         }
 
-        if (is_link($buildPath)) {
+        try {
-            // Remove the symlink without using recursive.
+            $fileSystem = new Filesystem();
-            exec(sprintf('rm "%s"', $buildPath));
+
-        } else {
+            if (is_link($buildPath)) {
-            exec(sprintf('rm -Rf "%s"', $buildPath));
+                // Remove the symlink without using recursive.
+                exec(sprintf('rm "%s"', $buildPath));
+            } else {
+                $fileSystem->remove($buildPath);
+            }
+
+            if ($withArtifacts) {
+                $buildDirectory = $this->getBuildDirectory();
+
+                $fileSystem->remove(PUBLIC_DIR . 'artifacts/pdepend/' . $buildDirectory);
+                $fileSystem->remove(PUBLIC_DIR . 'artifacts/phpunit/' . $buildDirectory);
+            }
+        } catch (\Exception $e) {
+
         }
     }
 

src/PHPCensor/Plugin/Option/PhpUnitOptions.php

@@ -2,6 +2,8 @@
 
 namespace PHPCensor\Plugin\Option;
 
+use b8\Config;
+
 /**
  * Class PhpUnitOptions validates and parse the option for the PhpUnitV2 plugin
  *
@@ -120,7 +122,14 @@ class PhpUnitOptions
              * Handles command aliases outside of the args option
              */
             if (isset($this->options['coverage']) && $this->options['coverage']) {
-                $this->addArgument('coverage-html', $this->location);
+                $allowPublicArtifacts = (bool)Config::getInstance()->get(
+                    'php-censor.build.allow_public_artifacts',
+                    true
+                );
+
+                if ($allowPublicArtifacts) {
+                    $this->addArgument('coverage-html', $this->location);
+                }
                 $this->addArgument('coverage-text');
             }
 

src/PHPCensor/Plugin/Pdepend.php

@@ -2,9 +2,11 @@
 
 namespace PHPCensor\Plugin;
 
+use b8\Config;
 use PHPCensor\Builder;
 use PHPCensor\Model\Build;
 use PHPCensor\Plugin;
+use Symfony\Component\Filesystem\Filesystem;
 
 /**
  * Pdepend Plugin - Allows Pdepend report
@@ -20,6 +22,11 @@ class Pdepend extends Plugin
      */
     protected $buildDirectory;
 
+    /**
+     * @var string
+     */
+    protected $buildBranchDirectory;
+
     /**
      * @var string Directory which needs to be scanned
      */
@@ -41,10 +48,14 @@ class Pdepend extends Plugin
     protected $pyramid;
 
     /**
-     * @var string Location on the server where the files are stored. Preferably in the webroot for inclusion
+     * @var string
-     *             in the readme.md of the repository
      */
-    protected $location;
+    protected $buildLocation;
+
+    /**
+     * @var string
+     */
+    protected $buildBranchLocation;
 
     /**
      * @return string
@@ -69,8 +80,11 @@ class Pdepend extends Plugin
         $this->pyramid = 'pyramid.svg';
         $this->chart   = 'chart.svg';
 
-        $this->buildDirectory = $build->getProjectId() . '/' . $build->getId();
+        $this->buildDirectory       = $build->getBuildDirectory();
-        $this->location       = PUBLIC_DIR . 'artifacts/pdepend/' . $this->buildDirectory;
+        $this->buildBranchDirectory = $build->getBuildBranchDirectory();
+
+        $this->buildLocation       = PUBLIC_DIR . 'artifacts/pdepend/' . $this->buildDirectory;
+        $this->buildBranchLocation = PUBLIC_DIR . 'artifacts/pdepend/' . $this->buildBranchDirectory;
     }
 
     /**
@@ -78,18 +92,26 @@ class Pdepend extends Plugin
      */
     public function execute()
     {
-        if (!file_exists($this->location)) {
+        $allowPublicArtifacts = (bool)Config::getInstance()->get(
-            mkdir($this->location, (0777 & ~umask()), true);
+            'php-censor.build.allow_public_artifacts',
+            true
+        );
+
+        $fileSystem = new Filesystem();
+
+        if (!$fileSystem->exists($this->buildLocation)) {
+            $fileSystem->mkdir($this->buildLocation, (0777 & ~umask()));
         }
-        if (!is_writable($this->location)) {
+
-            throw new \Exception(sprintf('The location %s is not writable or does not exist.', $this->location));
+        if (!is_writable($this->buildLocation)) {
+            throw new \Exception(sprintf(
+                'The location %s is not writable or does not exist.',
+                $this->buildLocation
+            ));
         }
 
         $pdepend = $this->findBinary('pdepend');
-
+        $cmd     = $pdepend . ' --summary-xml="%s" --jdepend-chart="%s" --overview-pyramid="%s" %s "%s"';
-        $cmd = $pdepend . ' --summary-xml="%s" --jdepend-chart="%s" --overview-pyramid="%s" %s "%s"';
-
-        $this->removeBuildArtifacts();
 
         // If we need to ignore directories
         if (count($this->builder->ignore)) {
@@ -100,39 +122,37 @@ class Pdepend extends Plugin
 
         $success = $this->builder->executeCommand(
             $cmd,
-            $this->location . DIRECTORY_SEPARATOR . $this->summary,
+            $this->buildLocation . DIRECTORY_SEPARATOR . $this->summary,
-            $this->location . DIRECTORY_SEPARATOR . $this->chart,
+            $this->buildLocation . DIRECTORY_SEPARATOR . $this->chart,
-            $this->location . DIRECTORY_SEPARATOR . $this->pyramid,
+            $this->buildLocation . DIRECTORY_SEPARATOR . $this->pyramid,
             $ignore,
             $this->directory
         );
 
+        if (!$allowPublicArtifacts) {
+            $fileSystem->remove($this->buildLocation);
+        }
+        if ($allowPublicArtifacts && file_exists($this->buildLocation)) {
+            $fileSystem->remove($this->buildBranchLocation);
+            $fileSystem->mirror($this->buildLocation, $this->buildBranchLocation);
+        }
+
         $config = $this->builder->getSystemConfig('php-censor');
 
-        if ($success) {
+        if ($allowPublicArtifacts && $success) {
             $this->builder->logSuccess(
                 sprintf(
-                    "\nPdepend successful.\nYou can use: %s,\n![Chart](%s \"Pdepend Chart\") and\n![Pyramid](%s \"Pdepend Pyramid\")\nfor inclusion in the readme.md file",
+                    "\nPdepend successful build report.\nYou can use report for this build for inclusion in the readme.md file:\n%s,\n![Chart](%s \"Pdepend Chart\") and\n![Pyramid](%s \"Pdepend Pyramid\")\n\nOr report for last build in the branch:\n%s,\n![Chart](%s \"Pdepend Chart\") and\n![Pyramid](%s \"Pdepend Pyramid\")\n",
                     $config['url'] . '/artifacts/pdepend/' . $this->buildDirectory . '/' . $this->summary,
                     $config['url'] . '/artifacts/pdepend/' . $this->buildDirectory . '/' . $this->chart,
-                    $config['url'] . '/artifacts/pdepend/' . $this->buildDirectory . '/' . $this->pyramid
+                    $config['url'] . '/artifacts/pdepend/' . $this->buildDirectory . '/' . $this->pyramid,
+                    $config['url'] . '/artifacts/pdepend/' . $this->buildBranchDirectory . '/' . $this->summary,
+                    $config['url'] . '/artifacts/pdepend/' . $this->buildBranchDirectory . '/' . $this->chart,
+                    $config['url'] . '/artifacts/pdepend/' . $this->buildBranchDirectory . '/' . $this->pyramid
                 )
             );
         }
 
         return $success;
     }
-
-    /**
-     * Remove files created from previous builds
-     */
-    protected function removeBuildArtifacts()
-    {
-        //Remove the created files first
-        foreach ([$this->summary, $this->chart, $this->pyramid] as $file) {
-            if (file_exists($this->location . DIRECTORY_SEPARATOR . $file)) {
-                unlink($this->location . DIRECTORY_SEPARATOR . $file);
-            }
-        }
-    }
 }

src/PHPCensor/Plugin/PhpUnit.php

@@ -2,6 +2,7 @@
 
 namespace PHPCensor\Plugin;
 
+use b8\Config;
 use PHPCensor;
 use PHPCensor\Builder;
 use PHPCensor\Model\Build;
@@ -11,6 +12,7 @@ use PHPCensor\Plugin\Util\PhpUnitResultJson;
 use PHPCensor\Plugin\Util\PhpUnitResultJunit;
 use PHPCensor\Plugin;
 use PHPCensor\ZeroConfigPluginInterface;
+use Symfony\Component\Filesystem\Filesystem;
 
 /**
  * PHP Unit Plugin - A rewrite of the original PHP Unit plugin
@@ -28,9 +30,21 @@ class PhpUnit extends Plugin implements ZeroConfigPluginInterface
     /**
      * @var string
      */
-    protected $location;
+    protected $buildBranchDirectory;
 
-    /** @var string[] Raw options from the config file */
+    /**
+     * @var string
+     */
+    protected $buildLocation;
+
+    /**
+     * @var string
+     */
+    protected $buildBranchLocation;
+
+    /**
+     * @var string[] Raw options from the config file
+     */
     protected $options = [];
 
     /**
@@ -57,10 +71,13 @@ class PhpUnit extends Plugin implements ZeroConfigPluginInterface
     {
         parent::__construct($builder, $build, $options);
 
-        $this->buildDirectory = $this->build->getProjectId() . '/' . $this->build->getId();
+        $this->buildDirectory       = $build->getBuildDirectory();
-        $this->location       = PUBLIC_DIR . 'artifacts/phpunit/' . $this->buildDirectory . '/coverage';
+        $this->buildBranchDirectory = $build->getBuildBranchDirectory();
 
-        $this->options = new PhpUnitOptions($options, $this->location);
+        $this->buildLocation       = PUBLIC_DIR . 'artifacts/phpunit/' . $this->buildDirectory;
+        $this->buildBranchLocation = PUBLIC_DIR . 'artifacts/phpunit/' . $this->buildBranchDirectory;
+
+        $this->options = new PhpUnitOptions($options, $this->buildLocation);
     }
 
     /**
@@ -128,9 +145,18 @@ class PhpUnit extends Plugin implements ZeroConfigPluginInterface
      * @param string $logFormat
      *
      * @return bool|mixed
+     *
+     * @throws \Exception
      */
     protected function runConfig($directory, $configFile, $logFormat)
     {
+        $allowPublicArtifacts = (bool)Config::getInstance()->get(
+            'php-censor.build.allow_public_artifacts',
+            true
+        );
+
+        $fileSystem = new Filesystem();
+
         $options   = clone $this->options;
         $buildPath = $this->build->getBuildPath();
 
@@ -145,8 +171,17 @@ class PhpUnit extends Plugin implements ZeroConfigPluginInterface
             $options->addArgument('configuration', $buildPath . $configFile);
         }
 
-        if (!file_exists($this->location) && $options->getOption('coverage')) {
+        if ($options->getOption('coverage') && $allowPublicArtifacts) {
-            mkdir($this->location, (0777 & ~umask()), true);
+            if (!$fileSystem->exists($this->buildLocation)) {
+                $fileSystem->mkdir($this->buildLocation, (0777 & ~umask()));
+            }
+
+            if (!is_writable($this->buildLocation)) {
+                throw new \Exception(sprintf(
+                    'The location %s is not writable or does not exist.',
+                    $this->buildLocation
+                ));
+            }
         }
 
         $arguments = $this->builder->interpolate($options->buildArgumentString());
@@ -154,6 +189,15 @@ class PhpUnit extends Plugin implements ZeroConfigPluginInterface
         $success   = $this->builder->executeCommand($cmd, $arguments, $directory);
         $output    = $this->builder->getLastOutput();
 
+        if (
+            $fileSystem->exists($this->buildLocation) &&
+            $options->getOption('coverage') &&
+            $allowPublicArtifacts
+        ) {
+            $fileSystem->remove($this->buildBranchLocation);
+            $fileSystem->mirror($this->buildLocation, $this->buildBranchLocation);
+        }
+
         $this->processResults($logFile, $logFormat);
 
         $config = $this->builder->getSystemConfig('php-censor');
@@ -171,12 +215,15 @@ class PhpUnit extends Plugin implements ZeroConfigPluginInterface
                 'lines'   => !empty($matches[3]) ? $matches[3] : '0.00',
             ]);
 
-            $this->builder->logSuccess(
+            if ($allowPublicArtifacts) {
-                sprintf(
+                $this->builder->logSuccess(
-                    "\nPHPUnit successful.\nYou can use coverage report: %s",
+                    sprintf(
-                    $config['url'] . '/artifacts/phpunit/' . $this->buildDirectory . '/coverage/index.html'
+                        "\nPHPUnit successful build coverage report.\nYou can use coverage report for this build: %s\nOr coverage report for last build in the branch: %s",
-                )
+                        $config['url'] . '/artifacts/phpunit/' . $this->buildDirectory . '/index.html',
-            );
+                        $config['url'] . '/artifacts/phpunit/' . $this->buildBranchDirectory . '/index.html'
+                    )
+                );
+            }
         }
 
         return $success;

src/PHPCensor/Service/BuildService.php

@@ -150,7 +150,8 @@ class BuildService
      */
     public function deleteBuild(Build $build)
     {
-        $build->removeBuildDirectory();
+        $build->removeBuildDirectory(true);
+
         return $this->buildStore->delete($build);
     }
 

src/PHPCensor/Service/ProjectService.php

@@ -2,8 +2,10 @@
 
 namespace PHPCensor\Service;
 
+use PHPCensor\Model\Build;
 use PHPCensor\Model\Project;
 use PHPCensor\Store\ProjectStore;
+use Symfony\Component\Filesystem\Filesystem;
 
 /**
  * The project service handles the creation, modification and deletion of projects.
@@ -120,6 +122,16 @@ class ProjectService
      */
     public function deleteProject(Project $project)
     {
+        try {
+            $fileSystem = new Filesystem();
+
+            $fileSystem->remove(RUNTIME_DIR . 'builds/' . $project->getId());
+            $fileSystem->remove(PUBLIC_DIR . 'artifacts/pdepend/' . $project->getId());
+            $fileSystem->remove(PUBLIC_DIR . 'artifacts/phpunit/' . $project->getId());
+        } catch (\Exception $e) {
+
+        }
+
         return $this->projectStore->delete($project);
     }