summaryrefslogtreecommitdiffstats
path: root/tests/unit/db/mappertestutility.php
blob: 49e985f3b968a030fca805322a601510e68c0d7f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
<?php

/**
 * ownCloud - App Framework
 *
 * @author Bernhard Posselt
 * @copyright 2012 Bernhard Posselt dev@bernhard-posselt.com
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or any later version.
 *
 * This library 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 AFFERO GENERAL PUBLIC LICENSE for more details.
 *
 * You should have received a copy of the GNU Affero General Public
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 *
 */


namespace OCA\News\Tests\Unit\Db;


/**
 * Simple utility class for testing mappers
 */
abstract class MapperTestUtility extends \PHPUnit_Framework_TestCase {
    protected $db;
    private $query;
    private $pdoResult;
    private $queryAt;
    private $prepareAt;
    private $fetchAt;
    private $iterators;


    /**
     * Run this function before the actual test to either set or initialize the
     * db. After this the db can be accessed by using $this->db
     */
    protected function setUp(){
        parent::setUp();

        $this->db = $this->getMockBuilder(
            '\OCP\IDb')
            ->disableOriginalConstructor()
            ->getMock();

        $this->query = $this->getMock('Query', array('execute', 'bindValue'));
        $this->pdoResult = $this->getMock('Result', array('fetch', 'closeCursor'));
        $this->queryAt = 0;
        $this->prepareAt = 0;
        $this->iterators = array();
        $this->fetchAt = 0;
    }


    /**
     * Create mocks and set expected results for database queries
     * @param string $sql the sql query that you expect to receive
     * @param array $arguments the expected arguments for the prepare query
     * method
     * @param array $returnRows the rows that should be returned for the result
     * of the database query. If not provided, it wont be assumed that fetch
     * will be called on the result
     */
    protected function setMapperResult($sql, $arguments=array(), $returnRows=array(),
        $limit=null, $offset=null, $expectClose=false){

        $this->iterators[] = new ArgumentIterator($returnRows);

        $iterators = $this->iterators;
        $fetchAt = $this->fetchAt;

        $this->pdoResult->expects($this->any())
            ->method('fetch')
            ->will($this->returnCallback(
                function() use ($iterators, $fetchAt){
                    $iterator = $iterators[$fetchAt];
                    $result = $iterator->next();

                    if($result === false) {
                        $fetchAt++;
                    }

                    return $result;
                }
            ));
        if ($expectClose) {
            $closing = $this->once();
        } else {
            $closing = $this->any();
        }
        $this->pdoResult->expects($closing)
            ->method('closeCursor');

        $index = 1;
        foreach($arguments as $argument) {
            switch (gettype($argument)) {
                case 'integer':
                    $pdoConstant = \PDO::PARAM_INT;
                    break;

                case 'NULL':
                    $pdoConstant = \PDO::PARAM_NULL;
                    break;

                case 'boolean':
                    $pdoConstant = \PDO::PARAM_BOOL;
                    break;

                default:
                    $pdoConstant = \PDO::PARAM_STR;
                    break;
            }
            $this->query->expects($this->at($this->queryAt))
                ->method('bindValue')
                ->with($this->equalTo($index),
                    $this->equalTo($argument),
                    $this->equalTo($pdoConstant));
            $index++;
            $this->queryAt++;
        }

        $this->query->expects($this->at($this->queryAt))
            ->method('execute')
            ->with()
            ->will($this->returnValue($this->pdoResult));
        $this->queryAt++;

        if($limit === null && $offset === null) {
            $this->db->expects($this->at($this->prepareAt))
                ->method('prepareQuery')
                ->with($this->equalTo($sql))
                ->will(($this->returnValue($this->query)));
        } elseif($limit !== null && $offset === null) {
            $this->db->expects($this->at($this->prepareAt))
                ->method('prepareQuery')
                ->with($this->equalTo($sql), $this->equalTo($limit))
                ->will(($this->returnValue($this->query)));
        } elseif($limit === null && $offset !== null) {
            $this->db->expects($this->at($this->prepareAt))
                ->method('prepareQuery')
                ->with($this->equalTo($sql),
                    $this->equalTo(null),
                    $this->equalTo($offset))
                ->will(($this->returnValue($this->query)));
        } else  {
            $this->db->expects($this->at($this->prepareAt))
                ->method('prepareQuery')
                ->with($this->equalTo($sql),
                    $this->equalTo($limit),
                    $this->equalTo($offset))
                ->will(($this->returnValue($this->query)));
        }
        $this->prepareAt++;
        $this->fetchAt++;

    }


}


class ArgumentIterator {

    private $arguments;

    public function __construct($arguments){
        $this->arguments = $arguments;
    }

    public function next(){
        $result = array_shift($this->arguments);
        if($result === null){
            return false;
        } else {
            return $result;
        }
    }
}