Test: Improve CacheFactory code coverage

Author: jim-parry

system/Cache/Handlers/WincacheHandler.php

@@ -1,4 +1,5 @@
-<?php namespace CodeIgniter\Cache\Handlers;
+<?php
+namespace CodeIgniter\Cache\Handlers;
 
 /**
  * CodeIgniter
@@ -35,9 +36,14 @@
  * @since      Version 3.0.0
  * @filesource
  */
-
 use CodeIgniter\Cache\CacheInterface;
 
+/**
+ * Cache handler for WinCache from Microsoft & IIS.
+ * Windows-only, so not testable on travis-ci.
+ * Unusable methods flagged for code coverage ignoring.
+ * 
+ */
 class WincacheHandler implements CacheInterface
 {
 
@@ -59,6 +65,7 @@ public function __construct($config)
 
 	/**
 	 * Takes care of any handler-specific setup that must be done.
+	 * @codeCoverageIgnore
 	 */
 	public function initialize()
 	{
@@ -69,6 +76,7 @@ public function initialize()
 
 	/**
 	 * Attempts to fetch an item from the cache store.
+	 * @codeCoverageIgnore
 	 *
 	 * @param string $key Cache item name
 	 *
@@ -79,7 +87,7 @@ public function get(string $key)
 		$key = $this->prefix . $key;
 
 		$success = false;
-		$data    = wincache_ucache_get($key, $success);
+		$data = wincache_ucache_get($key, $success);
 
 		// Success returned by reference from wincache_ucache_get()
 		return ($success) ? $data : false;
@@ -89,6 +97,7 @@ public function get(string $key)
 
 	/**
 	 * Saves an item to the cache store.
+	 * @codeCoverageIgnore
 	 *
 	 * @param string  $key   Cache item name
 	 * @param mixed   $value The data to save
@@ -107,6 +116,7 @@ public function save(string $key, $value, int $ttl = 60)
 
 	/**
 	 * Deletes a specific item from the cache store.
+	 * @codeCoverageIgnore
 	 *
 	 * @param string $key Cache item name
 	 *
@@ -124,6 +134,7 @@ public function delete(string $key)
 	/**
 	 * Performs atomic incrementation of a raw stored value.
 	 *
+	 * @codeCoverageIgnore
 	 * @param string  $key    Cache ID
 	 * @param integer $offset Step/value to increase by
 	 *
@@ -134,7 +145,7 @@ public function increment(string $key, int $offset = 1)
 		$key = $this->prefix . $key;
 
 		$success = false;
-		$value   = wincache_ucache_inc($key, $offset, $success);
+		$value = wincache_ucache_inc($key, $offset, $success);
 
 		return ($success === true) ? $value : false;
 	}
@@ -143,6 +154,7 @@ public function increment(string $key, int $offset = 1)
 
 	/**
 	 * Performs atomic decrementation of a raw stored value.
+	 * @codeCoverageIgnore
 	 *
 	 * @param string  $key    Cache ID
 	 * @param integer $offset Step/value to increase by
@@ -154,7 +166,7 @@ public function decrement(string $key, int $offset = 1)
 		$key = $this->prefix . $key;
 
 		$success = false;
-		$value   = wincache_ucache_dec($key, $offset, $success);
+		$value = wincache_ucache_dec($key, $offset, $success);
 
 		return ($success === true) ? $value : false;
 	}
@@ -163,6 +175,7 @@ public function decrement(string $key, int $offset = 1)
 
 	/**
 	 * Will delete all items in the entire cache.
+	 * @codeCoverageIgnore
 	 *
 	 * @return mixed
 	 */
@@ -175,6 +188,7 @@ public function clean()
 
 	/**
 	 * Returns information on the entire cache.
+	 * @codeCoverageIgnore
 	 *
 	 * The information returned and the structure of the data
 	 * varies depending on the handler.
@@ -191,6 +205,7 @@ public function getCacheInfo()
 	/**
 	 * Returns detailed information about the specific item in the cache.
 	 *
+	 * @codeCoverageIgnore
 	 * @param string $key Cache item name.
 	 *
 	 * @return mixed
@@ -201,15 +216,15 @@ public function getMetaData(string $key)
 
 		if ($stored = wincache_ucache_info(false, $key))
 		{
-			$age      = $stored['ucache_entries'][1]['age_seconds'];
-			$ttl      = $stored['ucache_entries'][1]['ttl_seconds'];
+			$age = $stored['ucache_entries'][1]['age_seconds'];
+			$ttl = $stored['ucache_entries'][1]['ttl_seconds'];
 			$hitcount = $stored['ucache_entries'][1]['hitcount'];
 
 			return [
-				'expire'   => $ttl - $age,
-				'hitcount' => $hitcount,
-				'age'      => $age,
-				'ttl'      => $ttl,
+				'expire'	 => $ttl - $age,
+				'hitcount'	 => $hitcount,
+				'age'		 => $age,
+				'ttl'		 => $ttl,
 			];
 		}
 

tests/system/Cache/CacheFactoryTest.php

@@ -1,7 +1,9 @@
-<?php namespace CodeIgniter\Cache;
+<?php
+namespace CodeIgniter\Cache;
 
 class CacheFactoryTest extends \CIUnitTestCase
 {
+
 	private static $directory = 'CacheFactory';
 	private $cacheFactory;
 	private $config;
@@ -13,7 +15,7 @@ protected function setUp()
 		$this->cacheFactory = new CacheFactory();
 
 		//Initialize path
-		$this->config             = new \Config\Cache();
+		$this->config = new \Config\Cache();
 		$this->config->storePath .= self::$directory;
 	}
 
@@ -77,7 +79,7 @@ public function testGetHandlerExceptionCacheHandlerNotFound()
 
 	public function testGetDummyHandler()
 	{
-		if (! is_dir($this->config->storePath))
+		if ( ! is_dir($this->config->storePath))
 		{
 			mkdir($this->config->storePath, 0555, true);
 		}
@@ -87,7 +89,27 @@ public function testGetDummyHandler()
 		$this->assertInstanceOf(\CodeIgniter\Cache\Handlers\DummyHandler::class, $this->cacheFactory->getHandler($this->config));
 
 		//Initialize path
-		$this->config             = new \Config\Cache();
+		$this->config = new \Config\Cache();
+		$this->config->storePath .= self::$directory;
+	}
+
+	public function testHandlesBadHandler()
+	{
+		if ( ! is_dir($this->config->storePath))
+		{
+			mkdir($this->config->storePath, 0555, true);
+		}
+
+		$this->config->handler = 'dummy';
+
+		if (stripos('win', php_uname()) === 0)
+			$this->assertTrue(true); // can't test properly if we are on Windows
+		else
+			$this->assertInstanceOf(\CodeIgniter\Cache\Handlers\DummyHandler::class, $this->cacheFactory->getHandler($this->config, 'wincache', 'wincache'));
+
+		//Initialize path
+		$this->config = new \Config\Cache();
 		$this->config->storePath .= self::$directory;
 	}
+
 }