tests/Util/VFSTrait.php

   1 <?php
   2
   3 namespace Friendica\Test\Util;
   4
   5
   6 use org\bovigo\vfs\vfsStream;
   7 use org\bovigo\vfs\vfsStreamDirectory;
   8
   9 trait VFSTrait
  10 {
  11         /**
  12          * @var vfsStreamDirectory The Stream Directory
  13          */
  14         protected $root;
  15
  16         /**
  17          * Sets up the Virtual File System for Friendica with common files (config, dbstructure)
  18          */
  19         protected function setUpVfsDir() {
  20                 // the used directories inside the App class
  21                 $structure = [
  22                         'config' => [],
  23                         'bin' => [],
  24                         'static' => [],
  25                         'test' => [],
  26                         'logs' => [],
  27                 ];
  28
  29                 // create a virtual directory and copy all needed files and folders to it
  30                 $this->root = vfsStream::setup('friendica', 0777, $structure);
  31
  32                 $this->setConfigFile('dbstructure.config.php', true);
  33                 $this->setConfigFile('defaults.config.php', true);
  34                 $this->setConfigFile('settings.config.php', true);
  35                 $this->setConfigFile('local.config.php');
  36         }
  37
  38         /**
  39          * Copying a config file from the file system to the Virtual File System
  40          *
  41          * @param string $filename The filename of the config file
  42          * @param bool $static True, if the folder `static` instead of `config` should be used
  43          */
  44         protected function setConfigFile($filename, bool $static = false)
  45         {
  46                 $file = dirname(__DIR__) . DIRECTORY_SEPARATOR .
  47                         '..' . DIRECTORY_SEPARATOR .
  48                         ($static ? 'static' : 'config') . DIRECTORY_SEPARATOR .
  49                         $filename;
  50
  51                 if (file_exists($file)) {
  52                         vfsStream::newFile($filename)
  53                                 ->at($this->root->getChild(($static ? 'static' : 'config')))
  54                                 ->setContent(file_get_contents($file));
  55                 }
  56         }
  57
  58         /**
  59          * Delets a config file from the Virtual File System
  60          *
  61          * @param string $filename The filename of the config file
  62          * @param bool $static True, if the folder `static` instead of `config` should be used
  63          */
  64         protected function delConfigFile($filename, bool $static = false)
  65         {
  66                 if ($this->root->hasChild(($static ? 'static' : 'config') . '/' . $filename)) {
  67                         $this->root->getChild(($static ? 'static' : 'config'))->removeChild($filename);
  68                 }
  69         }
  70 }