lib/tests/datalib_update_with_unique_index_test.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 namespace core;
  18
  19 /**
  20  * Tests for {@link decompose_update_into_safe_changes()} and
  21  * {@link update_field_with_unique_index()}.
  22  *
  23  * @package   core
  24  * @copyright 2014 The Open University
  25  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  26  */
  27 class datalib_update_with_unique_index_test extends \advanced_testcase {
  28
  29     public function test_decompose_update_into_safe_changes_identity() {
  30         $this->assertEquals(array(), decompose_update_into_safe_changes(
  31                 array(1 => 1, 2 => 2), -1));
  32     }
  33
  34     public function test_decompose_update_into_safe_changes_no_overlap() {
  35         $this->assertEquals(array(array(1, 3), array(2, 4)), decompose_update_into_safe_changes(
  36                 array(1 => 3, 2 => 4), -1));
  37     }
  38
  39     public function test_decompose_update_into_safe_changes_shift() {
  40         $this->assertSame(array(array(3, 4), array(2, 3), array(1, 2)), decompose_update_into_safe_changes(
  41                 array(1 => 2, 2 => 3, 3 => 4), -1));
  42     }
  43
  44     public function test_decompose_decompose_update_into_safe_changes_simple_swap() {
  45         $this->assertEquals(array(array(1, -1), array(2, 1), array(-1, 2)), decompose_update_into_safe_changes(
  46                 array(1 => 2, 2 => 1), -1));
  47     }
  48
  49     public function test_decompose_update_into_safe_changes_cycle() {
  50         $this->assertEquals(array(array(1, -2), array(3, 1), array(2, 3), array(-2, 2)),
  51                 decompose_update_into_safe_changes(
  52                 array(1 => 2, 2 => 3 , 3 => 1), -2));
  53     }
  54
  55     public function test_decompose_update_into_safe_changes_complex() {
  56         $this->assertEquals(array(array(9, 10), array(8, 9),
  57                 array(1, -1), array(5, 1), array(7, 5), array(-1, 7),
  58                 array(4, -1), array(6, 4), array(-1, 6)), decompose_update_into_safe_changes(
  59                 array(1 => 7, 2 => 2, 3 => 3, 4 => 6, 5 => 1, 6 => 4, 7 => 5, 8 => 9, 9 => 10), -1));
  60     }
  61
  62     public function test_decompose_update_into_safe_changes_unused_value_id_used() {
  63         try {
  64             decompose_update_into_safe_changes(array(1 => 1), 1);
  65             $this->fail('Expected exception was not thrown');
  66         } catch (\coding_exception $e) {
  67             $this->assertEquals('Supposedly unused value 1 is actually used!', $e->a);
  68         }
  69     }
  70
  71     public function test_decompose_update_into_safe_changes_string_values() {
  72         // Sometimes this happens when data has been loaded from the database.
  73         $this->assertEquals(array(array(1, -1), array(2, 1),
  74                     array(3, 2), array(4, 3), array(-1, 4)),
  75                 decompose_update_into_safe_changes(
  76                     array(1 => '4', 2 => '1', 3 => '2', 4 => '3'), -1));
  77     }
  78
  79     public function test_reorder_rows() {
  80         global $DB;
  81         $dbman = $DB->get_manager();
  82         $this->resetAfterTest();
  83
  84         $table = new \xmldb_table('test_table');
  85         $table->setComment("This is a test'n drop table. You can drop it safely");
  86         $tablename = $table->getName();
  87
  88         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
  89         $table->add_field('otherid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0');
  90         $table->add_field('sortorder', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0');
  91         $table->add_field('otherdata', XMLDB_TYPE_TEXT, 'big', null, null, null);
  92         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
  93         $table->add_key('unique', XMLDB_KEY_UNIQUE, array('otherid', 'sortorder'));
  94         $dbman->create_table($table);
  95
  96         // Rows intentionally added in a slightly 'random' order.
  97         // Note we are testing hat the otherid = 1 rows don't get messed up,
  98         // as well as testing that the otherid = 2 rows are updated correctly.
  99         $DB->insert_record($tablename, array('otherid' => 2, 'sortorder' => 1, 'otherdata' => 'To become 4'));
 100         $DB->insert_record($tablename, array('otherid' => 2, 'sortorder' => 2, 'otherdata' => 'To become 1'));
 101         $DB->insert_record($tablename, array('otherid' => 1, 'sortorder' => 1, 'otherdata' => 'Other 1'));
 102         $DB->insert_record($tablename, array('otherid' => 1, 'sortorder' => 2, 'otherdata' => 'Other 2'));
 103         $DB->insert_record($tablename, array('otherid' => 2, 'sortorder' => 3, 'otherdata' => 'To stay at 3'));
 104         $DB->insert_record($tablename, array('otherid' => 2, 'sortorder' => 4, 'otherdata' => 'To become 2'));
 105
 106         update_field_with_unique_index($tablename, 'sortorder',
 107                 array(1 => 4, 2 => 1, 3 => 3, 4 => 2), array('otherid' => 2));
 108
 109         $this->assertEquals(array(
 110                 3 => (object) array('id' => 3, 'otherid' => 1, 'sortorder' => 1, 'otherdata' => 'Other 1'),
 111                 4 => (object) array('id' => 4, 'otherid' => 1, 'sortorder' => 2, 'otherdata' => 'Other 2'),
 112             ), $DB->get_records($tablename, array('otherid' => 1), 'sortorder'));
 113         $this->assertEquals(array(
 114                 2 => (object) array('id' => 2, 'otherid' => 2, 'sortorder' => 1, 'otherdata' => 'To become 1'),
 115                 6 => (object) array('id' => 6, 'otherid' => 2, 'sortorder' => 2, 'otherdata' => 'To become 2'),
 116                 5 => (object) array('id' => 5, 'otherid' => 2, 'sortorder' => 3, 'otherdata' => 'To stay at 3'),
 117                 1 => (object) array('id' => 1, 'otherid' => 2, 'sortorder' => 4, 'otherdata' => 'To become 4'),
 118             ), $DB->get_records($tablename, array('otherid' => 2), 'sortorder'));
 119     }
 120 }