Add unit testing + fix memcache expiry (zero = unlimited TTL)

Author: Michiel Vancoillie

.travis.yml

@@ -0,0 +1,12 @@
+language: php
+services:
+  - memcache
+php:
+  - "5.4"
+  - "5.3"
+before_script:
+  - chmod 777 tests/travis/memcache-setup.sh
+  - ./tests/travis/memcache-setup.sh
+  - composer install
+
+script: phpunit tests

README.md

@@ -1,7 +1,8 @@
-cache
-=====
+# tdt/cache
 
-This repository holds a wrapper around a caching system. You can use NoCache if no caching system is installed, or MemCache. This allows the user to provide caching in his code, and switch to other 
+[![Build Status](https://travis-ci.org/tdt/cache.png)](https://travis-ci.org/tdt/cache)
+
+This repository holds a wrapper around a caching system. You can use NoCache if no caching system is installed, or MemCache. This allows the user to provide caching in his code, and switch to other
 caching systems later on if necessary.
 
 # Usage

src/tdt/cache/Cache.php

@@ -3,6 +3,7 @@
  * The caching class. Depending on the globals given in the config it will be able to set and get a variable
  *
  * Usage of an implementation:
+ *
  *   $c = Cache::getInstance();
  *   $element = $c->get($id);
  *   if(is_null($element)){
@@ -13,8 +14,9 @@
  * @package tdt\cache
  * @copyright (C) 2011,2013 by iRail vzw/asbl, OKFN Belgium vzw/asbl
  * @license AGPLv3
- * @author Jan Vansteenlandt <[email protected]>
- * @author Pieter Colpaert   <[email protected]>
+ * @author Jan Vansteenlandt    <[email protected]>
+ * @author Michiel Vancoillie   <[email protected]>
+ * @author Pieter Colpaert      <[email protected]>
  */
 
 namespace tdt\cache;
@@ -24,9 +26,9 @@
 abstract class Cache{
     private static $instance;
     protected $config = array();
-    
-    
-    protected function __construct(array $config){        
+
+
+    protected function __construct(array $config){
         $this->config = $config;
     }
 
@@ -35,27 +37,31 @@ protected function __construct(array $config){
      * system = name of the caching system i.e. MemCache, NoCache,...
      * host = the host on which the caching system runs
      * port = the port on which to connect to the host
-     * 
+     *
      * If NoCache is used, no host or port is necessary.
      */
-    
-    public static function getInstance(array $config){                 
-        if(!isset(self::$instance)){           
+
+    public static function getInstance(array $config){
+        if(!isset(self::$instance)){
             if(isset($config["system"])){
-                $cacheclass = 'tdt\\cache\\TDT' . $config["system"];
-                if(class_exists($cacheclass)){                    
+                $cacheclass = 'tdt\\cache\\' . $config["system"];
+                if(class_exists($cacheclass)){
                     self::$instance = new $cacheclass($config);
                 }else{
-                    throw new TDTException(551,array("tdt\cache\ ".$config["system"]));
+                    throw new TDTException(551, array("tdt\\cache\\".$config["system"]));
                 }
             }else{
-                throw new TDTException(500,array("The system was not set in the configuration"));
-            }            
-            
+                throw new TDTException(500, array("The cache system was not set in the configuration"));
+            }
+
         }
         return self::$instance;
-    }  
-    
+    }
+
+    public static function destroy(){
+        self::$instance = null;
+    }
+
     abstract public function set($key, $value, $TTL = 60);
     abstract public function get($key);
     abstract public function delete($key);

src/tdt/cache/TDTMemCache.php renamed to src/tdt/cache/MemCache.php

@@ -2,12 +2,13 @@
 
 /**
  * MemCache implementation of Cache
- * 
+ *
  * @package The-Datatank/aspects/caching
  * @copyright (C) 2011,2013 by iRail vzw/asbl
  * @license AGPLv3
- * @author Jan Vansteenlandt <[email protected]>
- * @author Pieter Colpaert   <[email protected]>
+ * @author Jan Vansteenlandt    <[email protected]>
+ * @author Michiel Vancoillie   <[email protected]>
+ * @author Pieter Colpaert      <[email protected]>
  */
 
 namespace tdt\cache;
@@ -16,7 +17,7 @@
 use Monolog\Logger;
 use Monolog\Handler\StreamHandler;
 
-class TDTMemCache extends Cache {
+class MemCache extends Cache {
 
     private $memcache;
 
@@ -29,21 +30,23 @@ protected function __construct($config) {
          * In memcache, the old but stable implementation in PHP of memcached the persistent connection works like charm
          * In memcached however there is a severe bug which leads to a memory leak. If you'd take over code from this class to implement memcached, DON'T use the persistent connect!
          */
-        
+
         if(!isset($this->config["host"])){
-            throw new TDTException(500, array("No host has been given to cache to."));
+            // the default host for memcached localhost
+            $this->config["host"] = "localhost";
         }
-        
+
         if(!isset($this->config["port"])){
-            $this->config["port"] = 11211; // the default port for memcached is 11211
+            // the default port for memcached is 11211
+            $this->config["port"] = 11211;
         }
-        
+
         if (!$this->memcache->pconnect($this->config["host"], $this->config["port"])) {
             if (isset($this->config["log_dir"])) {
                 $log_dir = rtrim($this->config["log_dir"], "/");
                 $log = new Logger('cache');
                 $log->pushHandler(new StreamHandler($log_dir . "/log_". date('Y-m-d') . ".txt", Logger::CRITICAL));
-                $log->addCritical("Could not connect to memcached.", $this->config);                
+                $log->addCritical("Could not connect to memcached.", $this->config);
             }else{
                 /*
                  * if we have no log directory, it's no use to throw a TDTException
@@ -54,9 +57,7 @@ protected function __construct($config) {
     }
 
     public function set($key, $value, $timeout = 60) {
-        if ($timeout > 0) {
-            $this->memcache->set($key, $value, FALSE, $timeout); //the true flag will compress the value using zlib
-        }
+        $this->memcache->set($key, $value, FALSE, $timeout); //the true flag will compress the value using zlib
     }
 
     public function get($key) {
@@ -67,7 +68,7 @@ public function get($key) {
     }
 
     public function delete($key) {
-        $this->memcache->delete($key, 0);
+        $this->memcache->delete($key);
     }
 
 }

src/tdt/cache/TDTNoCache.php renamed to src/tdt/cache/NoCache.php

@@ -1,30 +1,32 @@
 <?php
 /**
  * Dummy class - when no cache could be installed on the system (e.g. cheap hosts)
- * 
+ *
  * @package The-Datatank/aspects/caching
  * @copyright (C) 2011 by iRail vzw/asbl
  * @license AGPLv3
- * @author Jan Vansteenlandt <[email protected]>
- * @author Pieter Colpaert   <[email protected]>
+ * @author Jan Vansteenlandt    <[email protected]>
+ * @author Michiel Vancoillie   <[email protected]>
+ * @author Pieter Colpaert      <[email protected]>
  */
+
 namespace tdt\cache;
 
-class TDTNoCache extends Cache{
+class NoCache extends Cache{
     protected function __construct(){
-        
+
     }
 
     public function set($key,$value, $timeout=60){
-        //do nothing
+        // do nothing
     }
 
     public function get($key){
         return null;
     }
 
     public function delete($key){
-        //do nothing
+        // do nothing
     }
-    
+
 }

tests/CacheTest.php

@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * Quick test of the caching systems
+ *
+ * @copyright (C) 2011 by iRail vzw/asbl
+ * @license AGPLv3
+ * @author Michiel Vancoillie
+ */
+
+require "vendor/autoload.php";
+
+use tdt\cache\MemCache;
+use tdt\cache\NoCache;
+use tdt\cache\Cache;
+
+class CacheTest extends \PHPUnit_Framework_TestCase{
+
+    public function testCache(){
+        // Test nocache
+        $nocache = $this->_createCacheInstance("NoCache");
+        $nocache->set("key","value", 0);
+        $this->assertNull($nocache->get("key"), "NoCache shouldn't be caching!");
+        Cache::destroy();
+
+        // Test memcached
+        $memcache = $this->_createCacheInstance("MemCache");
+        $memcache->set("key","value", 0);
+        $this->assertEquals("value", $memcache->get("key"), "MemCache didn't cache!");
+        $memcache->set("key2","value2", 2);
+        $this->assertEquals("value2", $memcache->get("key2"), "MemCache didn't cache expiring value!");
+        sleep(1);
+        $this->assertEquals("value2", $memcache->get("key2"), "MemCache didn't cache expiring value (1s)!");
+        sleep(1);
+        $this->assertNull($memcache->get("key2"), "Memcache didn't expire 'key2'.");
+        $memcache->delete("key");
+        $this->assertNull($memcache->get("key"), "Memcache didn't delete 'key'.");
+        Cache::destroy();
+    }
+
+    private function _createCacheInstance($type){
+        $config = array("system" => $type);
+        $cache = Cache::getInstance($config);
+        $this->assertInstanceOf('tdt\cache\Cache', $cache, "Could not construct $type instance");
+
+        return $cache;
+    }
+
+}

tests/travis/memcache-setup.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+printf "yes\n" | pecl install memcache
+echo "extension=memcache.so" >> `php --ini | grep "Loaded Configuration" | sed -e "s|.*:\s*||"`