Merge pull request #38 from frne/file_validation_test

Checks for INI, JSON, XML and YAML file validation.

Author: Thinkscape

README.md

@@ -24,6 +24,13 @@ It currently ships with the following Diagnostic Checks:
  * [SecurityAdvisory](#securityadvisory) - check installed composer dependencies against SensioLabs SA database,
  * [StreamWrapperExists](#streamwrapperexists) - make sure given stream wrapper is available.
 
+File validation checks:
+
+ * [IniFile](#inifile) - check if given INI file is available and valid,
+ * [JsonFile](#jsonfile) - check if given JSON file is available and valid,
+ * [XmlFile](#xmlfile) - check if given XML file is available and valid,
+ * [YamlFile](#yamlfile) - check if given YAML file is available and valid
+
 ## Using diagnostics with Zend Framework 2
 
 1. Install the [ZFTool module](https://github.com/zendframework/ZFTool).
@@ -421,7 +428,6 @@ $checkLocal  = new Memcache('127.0.0.1'); // default port
 $checkBackup = new Memcache('10.0.30.40', 11212);
 ````
 
-
 ### PhpVersion
 
 Check if current PHP version matches the given requirement. The test accepts 2 parameters - baseline version and
@@ -489,7 +495,6 @@ $security = new SecurityAdvisory();
 $security = new SecurityAdvisory('/var/www/project/composer.lock');
 ````
 
-
 ### StreamWrapperExists
 
 Check if a given stream wrapper (or an array of wrappers) is available. For example:
@@ -505,3 +510,52 @@ $checkCompression = new StreamWrapperExists(array(
     'zip'
 ));
 ````
+
+### IniFile
+
+Read an INI-file from the given path and try to parse it.
+
+````php
+<?php
+use ZendDiagnostics\Check\IniFile;
+
+$checkIniFile = new IniFile('/my/path/to/file.ini');
+$checkIniFile = new IniFile(['file1.ini', 'file2.ini', '...']);
+````
+
+### JsonFile
+
+Read a JSON-file from the given path and try to decode it.
+
+````php
+<?php
+use ZendDiagnostics\Check\JsonFile;
+
+$checkJsonFile = new JsonFile('/my/path/to/file.json');
+$checkJsonFile = new JsonFile(['file1.json', 'file2.json', '...']);
+````
+
+
+### XmlFile
+
+Read an XML-file from the given path, try to parse it and validate it agaist its DTD schema if possible.
+
+````php
+<?php
+use ZendDiagnostics\Check\XmlFile;
+
+$checkXmlFile = new XmlFile('/my/path/to/file.xml');
+$checkXmlFile = new XmlFile(['file1.xml', 'file2.xml', '...']);
+````
+
+### YamlFile
+
+Read a YAML-file from the given path and try to parse it.
+
+````php
+<?php
+use ZendDiagnostics\Check\YamlFile;
+
+$checkYamlFile = new YamlFile('/my/path/to/file.yml');
+$checkYamlFile = new YamlFile(['file1.yml', 'file2.yml', '...']);
+````

composer.json

@@ -19,11 +19,13 @@
     },
     "require-dev": {
         "zendframework/zend-loader"  : "2.*",
-        "sensiolabs/security-checker": "1.3.*@dev"
+        "sensiolabs/security-checker": "1.3.*@dev",
+        "symfony/yaml": "v2.3.11"
     },
     "suggest" : {
         "ext-bcmath" : "Required by Check\\CpuPerformance",
-        "sensiolabs/security-checker": "Required by Check\\SecurityAdvisory"
+        "sensiolabs/security-checker": "Required by Check\\SecurityAdvisory",
+        "symfony/yaml": "Required by Check\\YamlFile"
     },
     "extra": {
         "branch-alias": {

src/ZendDiagnostics/Check/AbstractFileCheck.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace ZendDiagnostics\Check;
+
+use InvalidArgumentException;
+use Traversable;
+use ZendDiagnostics\Result\Failure;
+use ZendDiagnostics\Result\FailureInterface;
+use ZendDiagnostics\Result\ResultInterface;
+use ZendDiagnostics\Result\Success;
+
+/**
+ * Abstract class for handling different file checks
+ */
+abstract class AbstractFileCheck extends AbstractCheck
+{
+    /**
+     * @var array|Traversable
+     */
+    protected $files;
+
+    /**
+     * @param  string|array|Traversable $files Path name or an array / Traversable of paths
+     * @throws InvalidArgumentException
+     */
+    public function __construct($files)
+    {
+        if (is_object($files) && !$files instanceof Traversable) {
+            throw new InvalidArgumentException(
+                'Expected a file name (string) , an array or Traversable of strings, got ' . get_class($files)
+            );
+        }
+
+        if (!is_object($files) && !is_array($files) && !is_string($files)) {
+            throw new InvalidArgumentException('Expected a file name (string) or an array of strings');
+        }
+
+        if (is_string($files)) {
+            $this->files = array($files);
+        } else {
+            $this->files = $files;
+        }
+    }
+
+    /**
+     * @return ResultInterface
+     */
+    public function check()
+    {
+        foreach ($this->files as $file) {
+            if (!is_file($file) or !is_readable($file)) {
+                return new Failure(sprintf('File "%s" does not exist or is not readable!', $file));
+            }
+
+            if (($validationResult = $this->validateFile($file)) instanceof FailureInterface) {
+                return $validationResult;
+            }
+        }
+
+        return new Success('All files are available and valid');
+    }
+
+    /**
+     * Validates a specific file type and returns a check result
+     *
+     * @param string $file
+     * @return ResultInterface
+     */
+    abstract protected function validateFile($file);
+}

src/ZendDiagnostics/Check/IniFile.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace ZendDiagnostics\Check;
+
+use ZendDiagnostics\Result\Failure;
+use ZendDiagnostics\Result\Success;
+use ZendDiagnostics\Result\ResultInterface;
+
+/**
+ * Checks if an INI file is available and valid
+ */
+class IniFile extends AbstractFileCheck
+{
+    /**
+     * @param string $file
+     * @return ResultInterface
+     */
+    protected function validateFile($file)
+    {
+        if (!is_array($ini = parse_ini_file($file)) or count($ini) < 1 ) {
+            return new Failure(sprintf('Could not parse INI file "%s"!', $file));
+        }
+
+        return new Success();
+    }
+}

src/ZendDiagnostics/Check/JsonFile.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace ZendDiagnostics\Check;
+
+use ZendDiagnostics\Result\Failure;
+use ZendDiagnostics\Result\Success;
+use ZendDiagnostics\Result\ResultInterface;
+
+/**
+ * Checks if a JSON file is available and valid
+ */
+class JsonFile extends AbstractFileCheck
+{
+    /**
+     * @param string $file
+     * @return ResultInterface
+     */
+    protected function validateFile($file)
+    {
+        if (is_null(json_decode(file_get_contents($file)))) {
+            return new Failure(sprintf('Could no decode JSON file "%s"', $file));
+        }
+
+        return new Success();
+    }
+}

src/ZendDiagnostics/Check/XmlFile.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace ZendDiagnostics\Check;
+
+use XMLReader;
+use ZendDiagnostics\Result\Failure;
+use ZendDiagnostics\Result\Success;
+use ZendDiagnostics\Result\ResultInterface;
+
+/**
+ * Checks if an XML file is available and valid
+ */
+class XmlFile extends AbstractFileCheck
+{
+    /**
+     * @param string $file
+     * @return ResultInterface
+     */
+    protected function validateFile($file)
+    {
+        $xmlReader = new XMLReader();
+
+        if (!$xmlReader->open($file)) {
+            return new Failure(sprintf('Could not open "%s" with XMLReader!', $file));
+        }
+
+        $xmlReader->setParserProperty(XMLReader::VALIDATE, true);
+
+        if (!$xmlReader->isValid()) {
+            return new Failure(sprintf('File "%s" is not valid XML!', $file));
+        }
+
+        if (!@simplexml_load_file($file)) {
+            return new Failure(sprintf('File "%s" is not well-formed XML!', $file));
+        }
+
+        return new Success();
+    }
+}

src/ZendDiagnostics/Check/YamlFile.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace ZendDiagnostics\Check;
+
+use Symfony\Component\Yaml\Exception\ParseException;
+use Symfony\Component\Yaml\Parser;
+use ZendDiagnostics\Result\Failure;
+use ZendDiagnostics\Result\ResultInterface;
+use ZendDiagnostics\Result\Success;
+
+/**
+ * Checks if a YAML file is available and valid
+ */
+class YamlFile extends AbstractFileCheck
+{
+    /**
+     * @param string $file
+     * @return ResultInterface
+     */
+    protected function validateFile($file)
+    {
+        if (class_exists('Symfony\Component\Yaml\Parser')) {
+            $parser = new Parser();
+
+            try {
+                $parser->parse(file_get_contents($file));
+            } catch (ParseException $e) {
+                return new Failure(sprintf('Unable to parse YAML file "%s"!', $file), $e->getMessage());
+            }
+
+            return new Success();
+        }
+
+        if (function_exists('yaml_parse_file')) {
+            if (@yaml_parse_file($file) === false) {
+                return new Failure(sprintf('Unable to parse YAML file "%s"!', $file));
+            }
+
+            return new Success();
+        }
+
+        return new Failure('No YAML-parser found! Please install "symfony/yaml" or "PECL yaml >= 0.4.0".');
+    }
+}