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                 ];
  27
  28                 // create a virtual directory and copy all needed files and folders to it
  29                 $this->root = vfsStream::setup('friendica', 0777, $structure);
  30
  31                 $this->setConfigFile('dbstructure.config.php', true);
  32                 $this->setConfigFile('defaults.config.php', true);
  33                 $this->setConfigFile('settings.config.php', true);
  34                 $this->setConfigFile('local.config.php');
  35         }
  36
  37         /**
  38          * Copying a config file from the file system to the Virtual File System
  39          *
  40          * @param string $filename The filename of the config file
  41          * @param bool $static True, if the folder `static` instead of `config` should be used
  42          */
  43         protected function setConfigFile($filename, bool $static = false)
  44         {
  45                 $file = dirname(__DIR__) . DIRECTORY_SEPARATOR .
  46                         '..' . DIRECTORY_SEPARATOR .
  47                         ($static ? 'static' : 'config') . DIRECTORY_SEPARATOR .
  48                         $filename;
  49
  50                 if (file_exists($file)) {
  51                         vfsStream::newFile($filename)
  52                                 ->at($this->root->getChild(($static ? 'static' : 'config')))
  53                                 ->setContent(file_get_contents($file));
  54                 }
  55         }
  56
  57         /**
  58          * Delets a config file from the Virtual File System
  59          *
  60          * @param string $filename The filename of the config file
  61          * @param bool $static True, if the folder `static` instead of `config` should be used
  62          */
  63         protected function delConfigFile($filename, bool $static = false)
  64         {
  65                 if ($this->root->hasChild(($static ? 'static' : 'config') . '/' . $filename)) {
  66                         $this->root->getChild(($static ? 'static' : 'config'))->removeChild($filename);
  67                 }
  68         }
  69 }