Added tests for outagedb class - #1

classes/outagedb.php

@@ -30,14 +30,14 @@ use Box\Spout\Common\Exception\InvalidArgumentException;
 final class outagedb
 {
     /**
-     * @var Singleton reference created on first use.
+     * @var outagedb Singleton reference created on first use.
      */
     private static $singleton = null;
 
     /**
      * Returns the singleton instance.
      *
-     * @return The singleton object.
+     * @return outagedb The singleton object.
      */
     public static function get() {
         if (is_null(self::$singleton)) {
@@ -138,7 +138,8 @@ final class outagedb
     /**
      * Deletes an outage from the database.
      *
-     * @param $id Outage ID to delete
+     * @param $id outage Outage ID to delete
+     * @throws InvalidArgumentException If ID is not valid.
      */
     public function delete($id) {
         global $DB;

tests/outagedb_test.php

@@ -0,0 +1,164 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Tests performed on outage class.
+ *
+ * @package    auth_outage
+ * @author     Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
+ * @copyright  Catalyst IT
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+use \auth_outage\outage;
+use \auth_outage\outagedb;
+
+defined('MOODLE_INTERNAL') || die();
+
+
+class outagedb_test extends advanced_testcase
+{
+    /**
+     * Make sure the db context is a singleton.
+     */
+    public function test_singleton() {
+        self::assertSame(outagedb::get(), outagedb::get(), 'Must always get same instance.');
+    }
+
+    /**
+     * Make sure we can save and update.
+     */
+    public function test_save() {
+        $this->resetAfterTest(true);
+        $db = outagedb::get();
+        // Save new outage.
+        $id = $db->save($this->createoutage(1));
+        // Update it.
+        $outage = $this->createoutage(2);
+        $outage->id = $id;
+        $db->save($outage);
+    }
+
+    /**
+     * Make sure we can get existing entries and null if not found.
+     */
+    public function test_getbyid() {
+        $this->resetAfterTest(true);
+        $db = outagedb::get();
+        // Create something.
+        $id = $db->save($this->createoutage(1));
+        // Get should work.
+        $outage = $db->getbyid($id);
+        self::assertNotNull($outage);
+        // Delete it.
+        $db->delete($id);
+        // Get should be null.
+        $outage = $db->getbyid($id);
+        self::assertNull($outage);
+    }
+
+    /**
+     * Make sure we can delete stuff.
+     */
+    public function test_delete() {
+        $this->resetAfterTest(true);
+        $db = outagedb::get();
+        // Create something.
+        $id = $db->save($this->createoutage(1));
+        // Delete it.
+        $db->delete($id);
+        // Should not exist anymore.
+        self::assertNull($db->getbyid($id));
+    }
+
+    /**
+     * Make sure getall brings all entries.
+     */
+    public function test_getall() {
+        $this->resetAfterTest(true);
+        $db = outagedb::get();
+        $amount = 10;
+        // Should start empty.
+        $outages = $db->getall();
+        self::assertSame([], $outages);
+        // Create some stuff outages.
+        for ($i = 0; $i < $amount; $i++) {
+            $db->save($this->createoutage($i));
+        }
+        // Count entries created.
+        self::assertSame($amount, count($db->getall()));
+    }
+
+    /**
+     * Perform some tests on the data itself, checking values after inserted and updated.
+     */
+    public function test_basiccrud() {
+        return;
+        $this->resetAfterTest(true);
+        $db = outagedb::get();
+
+        // Create some outages.
+        $outages = [];
+        for ($i = 1; $i <= 10; $i++) {
+            $outage = $this->createoutage($i);
+            $id = $db->save($outage);
+            $outages[$id] = $outage;
+        }
+
+        // With all created outages.
+        foreach ($outages as $id => $outage) {
+            // Get it.
+            $inserted = $db->getbyid($id);
+            self::assertNotNull($inserted);
+            // Check its data.
+            foreach (['starttime', 'stoptime', 'warningduration', 'title', 'description'] as $field) {
+                self::assertSame($outage->$field, $inserted->$field, 'Field ' . $field . ' does not match.');
+            }
+            // Check generated data.
+            self::assertGreaterThan(0, $inserted->id);
+            self::assertGreaterThan(0, $inserted->lastmodified);
+            self::assertNotNull($inserted->createdby);
+            self::assertNotNull($inserted->modifiedby);
+            // Change it.
+            $inserted->title = 'Title ID' . $id;
+            $db->save($inserted);
+            // Get it again and check data.
+            $updated = $db->getbyid($id);
+            self::assertSame('Title ID' . $id, $updated->title);
+            self::assertSame($inserted->description, $updated->description);
+            // Delete it.
+            $db->delete($id);
+            $deleted = $db->getbyid($id);
+            self::assertNull($deleted);
+        }
+    }
+
+    /**
+     * Helper function to create an outage for tests.
+     *
+     * @param $i int Used to populate the information.
+     * @return outage The created outage.
+     */
+    private function createoutage($i) {
+        return new outage([
+            'starttime' => $i * 100,
+            'stoptime' => $i * 100 + 50,
+            'warningduration' => $i * 60,
+            'title' => 'The Title ' . $i,
+            'description' => 'A <b>description</b> in HTML.'
+        ]);
+    }
+}