ApiQueryTestBase.php

Go to the documentation of this file.

<?php
abstract class ApiQueryTestBase extends ApiTestCase {

        const PARAM_ASSERT = <<<STR
Each parameter must be an array of two elements,
first - an array of params to the API call,
and the second array - expected results as returned by the API
STR;

        protected function merge( /*...*/ ) {
                $request = array();
                $expected = array();
                foreach ( func_get_args() as $v ) {
                        list( $req, $exp ) = $this->validateRequestExpectedPair( $v );
                        $request = array_merge_recursive( $request, $req );
                        $this->mergeExpected( $expected, $exp );
                }
                return array( $request, $expected );
        }

        private function validateRequestExpectedPair( $v ) {
                $this->assertType( 'array', $v, self::PARAM_ASSERT );
                $this->assertEquals( 2, count($v), self::PARAM_ASSERT );
                $this->assertArrayHasKey( 0, $v, self::PARAM_ASSERT );
                $this->assertArrayHasKey( 1, $v, self::PARAM_ASSERT );
                $this->assertType( 'array', $v[0], self::PARAM_ASSERT );
                $this->assertType( 'array', $v[1], self::PARAM_ASSERT );
                return $v;
        }

        private function mergeExpected( &$all, $item ) {
                foreach ( $item as $k => $v ) {
                        if ( array_key_exists( $k, $all ) ) {
                                if ( is_array ( $all[$k] ) ) {
                                        $this->mergeExpected( $all[$k], $v );
                                } else {
                                        $this->assertEquals( $all[$k], $v );
                                }
                        } else {
                                $all[$k] = $v;
                        }
                }
        }

        protected function check( $values ) {
                list( $req, $exp ) = $this->validateRequestExpectedPair( $values );
                if ( !array_key_exists( 'action', $req ) ) {
                        $req['action'] = 'query';
                }
                foreach ( $req as &$val ) {
                        if ( is_array( $val ) ) {
                                $val = implode( '|', array_unique( $val ) );
                        }
                }
                $result = $this->doApiRequest( $req );
                $this->assertResult( array( 'query' => $exp ), $result[0], $req );
        }

        protected function assertResult( $exp, $result, $message = '' ) {
                try {
                        $this->assertResultRecursive( $exp, $result );
                } catch ( Exception $e ) {
                        if ( is_array( $message ) ) {
                                $message = http_build_query( $message );
                        }
                        print( "\nRequest: $message\n" );
                        print( "\nExpected:\n" );
                        print_r( $exp );
                        print( "\nResult:\n" );
                        print_r( $result );
                        throw $e; // rethrow it
                }
        }

        private function assertResultRecursive( $expected, $result ) {
                reset( $expected );
                reset( $result );
                while ( true ) {
                        $e = each( $expected );
                        $r = each( $result );
                        // If either of the arrays is shorter, abort. If both are done, success.
                        $this->assertEquals( (bool)$e, (bool)$r );
                        if ( !$e ) {
                                break; // done
                        }
                        // continue only if keys are identical or both keys are numeric
                        $this->assertTrue( $e['key'] === $r['key'] || ( is_numeric( $e['key'] ) && is_numeric( $r['key'] ) ) );
                        // don't compare pageids
                        if ( $e['key'] !== 'pageid' ) {
                                // If values are arrays, compare recursively, otherwise compare with ===
                                if ( is_array( $e['value'] ) && is_array( $r['value'] ) ) {
                                        $this->assertResultRecursive( $e['value'], $r['value'] );
                                } else {
                                        $this->assertEquals( $e['value'], $r['value'] );
                                }
                        }
                }
        }
}