PersistentObject/tests/persistent_session_identity_decorator/find_test.php

<?php
/**
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
 * @version //autogentag//
 * @filesource
 * @package PersistentObject
 * @subpackage Tests
 */

require_once 'test_case.php';

/**
 * Tests the load facilities of ezcPersistentSession.
 *
 * @package PersistentObject
 * @subpackage Tests
 */
class ezcPersistentSessionIdentityDecoratorFindTest extends ezcPersistentSessionIdentityDecoratorTest
{
    public static function suite()
    {
        return new PHPUnit_Framework_TestSuite( __CLASS__ );
    }

    // find

    public function testFindNoResult()
    {
        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->eq( $this->idSession->database->quoteIdentifier( 'id' ), 999 ) );
        $objects = $this->idSession->find( $q, 'PersistentTestObject' );
        $this->assertEquals( 0, count( $objects ) );
    }

    public function testFindSingleResult()
    {
        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->eq( $this->idSession->database->quoteIdentifier( 'id' ), 1 ) );
        $objects = $this->idSession->find( $q, 'PersistentTestObject' );
        $this->assertEquals( 1, count( $objects ) );
        $this->assertTrue( isset( $objects[1] ) );

        $first = $objects[1];

        $objects = $this->idSession->find( $q, 'PersistentTestObject' );
        $this->assertEquals( 1, count( $objects ) );
        $this->assertTrue( isset( $objects[1] ) );

        $second = $objects[1];

        $this->assertSame( $first, $second );
    }

    public function testFindSingleResultRefetch()
    {
        $this->idSession->options->refetch = true;

        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->eq( $this->idSession->database->quoteIdentifier( 'id' ), 1 ) );
        $objects = $this->idSession->find( $q, 'PersistentTestObject' );
        $this->assertEquals( 1, count( $objects ) );
        $this->assertTrue( isset( $objects[1] ) );

        $first = $objects[1];

        $objects = $this->idSession->find( $q, 'PersistentTestObject' );
        $this->assertEquals( 1, count( $objects ) );
        $this->assertTrue( isset( $objects[1] ) );

        $second = $objects[1];

        $this->assertNotSame( $first, $second );
    }

    public function testFindMultipleResult()
    {
        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->gt( $this->idSession->database->quoteIdentifier( 'id' ), 2 ) );

        $first = $this->idSession->find( $q, 'PersistentTestObject' );
        $this->assertEquals( 2, count( $first ) );

        $second = $this->idSession->find( $q, 'PersistentTestObject' );
        $this->assertEquals( 2, count( $second ) );
        
        foreach ( $first as $id => $object )
        {
            $this->assertSame( $first[$id], $second[$id] );
        }
    }

    public function testFindMultipleResultRefetch()
    {
        $this->idSession->options->refetch = true;

        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->gt( $this->idSession->database->quoteIdentifier( 'id' ), 2 ) );

        $first = $this->idSession->find( $q, 'PersistentTestObject' );
        $this->assertEquals( 2, count( $first ) );

        $second = $this->idSession->find( $q, 'PersistentTestObject' );
        $this->assertEquals( 2, count( $second ) );
        
        foreach ( $first as $id => $object )
        {
            $this->assertNotSame( $first[$id], $second[$id] );
        }
    }

    public function testFindUsingAliases()
    {
        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->eq( 'varchar', $q->bindValue( 'Ukraine' ) ) );

        $first = $this->idSession->find( $q, 'PersistentTestObject' );
        $this->assertEquals( 1, count( $first ) );

        $second = $this->idSession->find( $q, 'PersistentTestObject' );
        $this->assertEquals( 1, count( $second ) );

        foreach ( $first as $id => $object )
        {
            $this->assertSame( $first[$id], $second[$id] );
        }
    }

    public function testFindUsingAliasesRefetch()
    {
        $this->idSession->options->refetch = true;

        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->eq( 'varchar', $q->bindValue( 'Ukraine' ) ) );

        $first = $this->idSession->find( $q, 'PersistentTestObject' );
        $this->assertEquals( 1, count( $first ) );

        $second = $this->idSession->find( $q, 'PersistentTestObject' );
        $this->assertEquals( 1, count( $second ) );

        foreach ( $first as $id => $object )
        {
            $this->assertNotSame( $first[$id], $second[$id] );
        }
    }

    // findIterator

    public function testFindIteratorNoResult()
    {
        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->eq( $this->idSession->database->quoteIdentifier( 'id' ), 999 ) );
        $it = $this->idSession->findIterator( $q, 'PersistentTestObject' );

        $this->assertEquals( null, $it->next() );
    }

    public function testFindIteratorSingleResult()
    {
        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->eq( $this->idSession->database->quoteIdentifier( 'id' ), 1 ) );

        $firstItr  = $this->idSession->findIterator( $q, 'PersistentTestObject' );
        $secondItr = $this->idSession->findIterator( $q, 'PersistentTestObject' );
        
        $this->assertIteratorsSame(
            $firstItr,
            $secondItr
        );
    }

    public function testFindIteratorSingleResultRefetch()
    {
        $this->idSession->options->refetch = true;

        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->eq( $this->idSession->database->quoteIdentifier( 'id' ), 1 ) );

        $firstItr  = $this->idSession->findIterator( $q, 'PersistentTestObject' );
        $secondItr = $this->idSession->findIterator( $q, 'PersistentTestObject' );
        
        $this->assertIteratorsNotSame(
            $firstItr,
            $secondItr
        );
    }

    public function testFindIteratorMultipleResult()
    {
        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->gt( $this->idSession->database->quoteIdentifier( 'id' ), 2 ) );

        $firstItr = $this->idSession->findIterator( $q, 'PersistentTestObject' );
        $secondItr = $this->idSession->findIterator( $q, 'PersistentTestObject' );
        
        $this->assertIteratorsSame(
            $firstItr,
            $secondItr
        );
    }

    public function testFindIteratorMultipleResultRefetch()
    {
        $this->idSession->options->refetch = true;

        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->gt( $this->idSession->database->quoteIdentifier( 'id' ), 2 ) );

        $firstItr = $this->idSession->findIterator( $q, 'PersistentTestObject' );
        $secondItr = $this->idSession->findIterator( $q, 'PersistentTestObject' );
        
        $this->assertIteratorsNotSame(
            $firstItr,
            $secondItr
        );
    }

    public function testFindWithoutClassNameSingleResult()
    {
        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->eq( $this->idSession->database->quoteIdentifier( 'id' ), 1 ) );

        $objects = $this->idSession->find( $q );
        $this->assertEquals( 1, count( $objects ) );
        $this->assertTrue( isset( $objects[1] ) );

        $first = $objects[1];

        $objects = $this->idSession->find( $q );
        $this->assertEquals( 1, count( $objects ) );

        $second = $objects[1];

        $this->assertSame( $first, $second );
    }

    public function testFindWithoutClassNameSingleResultRefetch()
    {
        $this->idSession->options->refetch = true;

        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->eq( $this->idSession->database->quoteIdentifier( 'id' ), 1 ) );

        $objects = $this->idSession->find( $q );
        $this->assertEquals( 1, count( $objects ) );
        $this->assertTrue( isset( $objects[1] ) );

        $first = $objects[1];

        $objects = $this->idSession->find( $q );
        $this->assertEquals( 1, count( $objects ) );
        $this->assertTrue( isset( $objects[1] ) );

        $second = $objects[1];

        $this->assertNotSame( $first, $second );
    }

    public function testFindWithoutClassNameMultipleResult()
    {
        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->gt( $this->idSession->database->quoteIdentifier( 'id' ), 2 ) );
        $objects = $this->idSession->find( $q );
        $this->assertEquals( 2, count( $objects ) );

        $first = $this->idSession->find( $q, 'PersistentTestObject' );
        $this->assertEquals( 2, count( $first ) );

        $second = $this->idSession->find( $q, 'PersistentTestObject' );
        $this->assertEquals( 2, count( $second ) );
        
        foreach ( $first as $id => $object )
        {
            $this->assertSame( $first[$id], $second[$id] );
        }
    }

    public function testFindWithoutClassNameMultipleResultRefetch()
    {
        $this->idSession->options->refetch = true;

        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->gt( $this->idSession->database->quoteIdentifier( 'id' ), 2 ) );
        $objects = $this->idSession->find( $q );
        $this->assertEquals( 2, count( $objects ) );

        $first = $this->idSession->find( $q, 'PersistentTestObject' );
        $this->assertEquals( 2, count( $first ) );

        $second = $this->idSession->find( $q, 'PersistentTestObject' );
        $this->assertEquals( 2, count( $second ) );
        
        foreach ( $first as $id => $object )
        {
            $this->assertNotSame( $first[$id], $second[$id] );
        }
    }

    public function testFindIteratorWithoutClassNameSingleResult()
    {
        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->eq( $this->idSession->database->quoteIdentifier( 'id' ), 1 ) );

        $firstItr  = $this->idSession->findIterator( $q );
        $secondItr = $this->idSession->findIterator( $q );
        
        $this->assertIteratorsSame(
            $firstItr,
            $secondItr
        );
    }

    public function testFindIteratorWithoutClassNameSingleResultRefetch()
    {
        $this->idSession->options->refetch = true;

        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->eq( $this->idSession->database->quoteIdentifier( 'id' ), 1 ) );

        $firstItr  = $this->idSession->findIterator( $q );
        $secondItr = $this->idSession->findIterator( $q );
        
        $this->assertIteratorsNotSame(
            $firstItr,
            $secondItr
        );
    }

    public function testFindIteratorWithoutClassNameMultipleResult()
    {
        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->gt( $this->idSession->database->quoteIdentifier( 'id' ), 2 ) );

        $firstItr = $this->idSession->findIterator( $q );
        $secondItr = $this->idSession->findIterator( $q );
        
        $this->assertIteratorsSame(
            $firstItr,
            $secondItr
        );
    }

    public function testFindIteratorWithoutClassNameMultipleResultRefetch()
    {
        $this->idSession->options->refetch = true;

        $q = $this->idSession->createFindQuery( 'PersistentTestObject' );
        $q->where( $q->expr->gt( $this->idSession->database->quoteIdentifier( 'id' ), 2 ) );

        $firstItr = $this->idSession->findIterator( $q );
        $secondItr = $this->idSession->findIterator( $q );
        
        $this->assertIteratorsNotSame(
            $firstItr,
            $secondItr
        );
    }

    public function testFindIteratorFailureInvalidQueryParameterString()
    {
        try
        {
            $this->idSession->findIterator( 'foo' );
            $this->fail( 'Exception not thrown on invalid query parameter.' );
        }
        catch ( ezcBaseValueException $e )
        {
            $this->assertEquals(
                "The value 'foo' that you were trying to assign to setting 'query' is invalid. Allowed values are: ezcPersistentFindQuery (or ezcQuerySelect).",
                $e->getMessage()
            );
        }
    }

    public function testFindIteratorFailureInvalidQueryParameterObject()
    {
        try
        {
            $this->idSession->findIterator( new stdClass() );
            $this->fail( 'Exception not thrown on invalid query parameter.' );
        }
        catch ( ezcBaseValueException $e )
        {
            $this->assertEquals(
                "The value 'O:8:\"stdClass\":0:{}' that you were trying to assign to setting 'query' is invalid. Allowed values are: ezcPersistentFindQuery (or ezcQuerySelect).",
                $e->getMessage()
            );
        }
    }

    public function testFindIteratorFailureSelectQueryWithoutClass()
    {
        $q = $this->idSession->database->createSelectQuery();
        try
        {
            $this->idSession->findIterator( $q );
            $this->fail( 'Exception not thrown on invalid query parameter.' );
        }
        catch ( ezcBaseValueException $e )
        {
            $this->assertEquals(
                "The value '' that you were trying to assign to setting 'class' is invalid. Allowed values are: string (mandatory, if ezcQuerySelect is used).",
                $e->getMessage()
            );
        }
    }

    // helpers

    protected function assertIteratorsSame( Iterator $expected, Iterator $actual, $message = null )
    {
        $expected->rewind();
        $actual->rewind();

        while ( $expected->valid() && $actual->valid() )
        {
            $this->assertEquals(
                $expected->key(),
                $actual->key(),
                'Keys are not identical.' . ( $message !== null ? ' ' . $message : '' )
            );
            $this->assertSame(
                $expected->current(),
                $actual->current(),
                'Values are not identical.' . ( $message !== null ? ' ' . $message : '' )
            );

            $expected->next();
            $actual->next();
        }
        
        $this->assertFalse(
            $expected->valid(),
            'Expected iterator not finished.' . ( $message !== null ? ' ' . $message : '' ) 
        );
        $this->assertFalse(
            $actual->valid(),
            'Actual iterator not finished.' . ( $message !== null ? ' ' . $message : '' ) 
        );
    }

    protected function assertIteratorsNotSame( Iterator $expected, Iterator $actual, $message = null )
    {
        $expected->rewind();
        $actual->rewind();

        while ( $expected->valid() && $actual->valid() )
        {
            $this->assertEquals(
                $expected->key(),
                $actual->key(),
                'Keys are not identical.' . ( $message !== null ? ' ' . $message : '' )
            );
            $this->assertNotSame(
                $expected->current(),
                $actual->current(),
                'Values are not identical.' . ( $message !== null ? ' ' . $message : '' )
            );

            $expected->next();
            $actual->next();
        }
        
        $this->assertFalse(
            $expected->valid(),
            'Expected iterator not finished.' . ( $message !== null ? ' ' . $message : '' ) 
        );
        $this->assertFalse(
            $actual->valid(),
            'Actual iterator not finished.' . ( $message !== null ? ' ' . $message : '' ) 
        );
    }
}

?>