repo_zf1/tests/Zend/Ldap/Ldif/SimpleEncoderTest.php

<?php
/**
 * Zend Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://framework.zend.com/license/new-bsd
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category   Zend
 * @package    Zend_Ldap
 * @subpackage UnitTests
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */

/**
 * Zend_Ldap_TestCase
 */
require_once dirname(dirname(__FILE__)) . DIRECTORY_SEPARATOR . 'TestCase.php';
/**
 * @see Zend_Ldap_Ldif_Encoder
 */
require_once 'Zend/Ldap/Ldif/Encoder.php';

/**
 * @category   Zend
 * @package    Zend_Ldap
 * @subpackage UnitTests
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */

class Zend_Ldap_Ldif_SimpleEncoderTest extends Zend_Ldap_TestCase
{
    public static function stringEncodingProvider()
    {
        $testData = array(
            array('cn=Barbara Jensen, ou=Product Development, dc=airius, dc=com',
                'cn=Barbara Jensen, ou=Product Development, dc=airius, dc=com'),
            array('Babs is a big sailing fan, and travels extensively in search of perfect sailing conditions.',
                'Babs is a big sailing fan, and travels extensively in search of perfect sailing conditions.'),
            array("\x00 NULL CHAR first", base64_encode("\x00 NULL CHAR first")),
            array("\n LF CHAR first", base64_encode("\n LF CHAR first")),
            array("\r CR CHAR first", base64_encode("\r CR CHAR first")),
            array(' SPACE CHAR first', base64_encode(' SPACE CHAR first')),
            array(': colon CHAR first', base64_encode(': colon CHAR first')),
            array('< less-than CHAR first', base64_encode('< less-than CHAR first')),
            array("\x7f CHR(127) first", base64_encode("\x7f CHR(127) first")),
            array("NULL CHAR \x00 in string", base64_encode("NULL CHAR \x00 in string")),
            array("LF CHAR \n in string", base64_encode("LF CHAR \n in string")),
            array("CR CHAR \r in string", base64_encode("CR CHAR \r in string")),
            array("CHR(127) \x7f in string", base64_encode("CHR(127) \x7f in string")),
            array('Ä first', base64_encode('Ä first')),
            array('in Ä string', base64_encode('in Ä string')),
            array('last char is a string ', base64_encode('last char is a string '))
        );
        return $testData;
    }

    /**
     * @dataProvider stringEncodingProvider
     */
    public function testStringEncoding($string, $expected)
    {
        $this->assertEquals($expected, Zend_Ldap_Ldif_Encoder::encode($string));
    }

    public static function attributeEncodingProvider()
    {
        $testData = array(
            array(array('dn' => 'cn=Barbara Jensen, ou=Product Development, dc=airius, dc=com'),
                'dn: cn=Barbara Jensen, ou=Product Development, dc=airius, dc=com'),
            array(array('dn' => 'cn=Jürgen Österreicher, ou=Äpfel, dc=airius, dc=com'),
                'dn:: ' . base64_encode('cn=Jürgen Österreicher, ou=Äpfel, dc=airius, dc=com')),
            array(array('description' => 'Babs is a big sailing fan, and travels extensively in search of perfect sailing conditions.'),
                'description: Babs is a big sailing fan, and travels extensively in search of p' . PHP_EOL . ' erfect sailing conditions.'),
            array(array('description' => "CHR(127) \x7f in string"),
                'description:: ' . base64_encode("CHR(127) \x7f in string")),
            array(array('description' => '1234567890123456789012345678901234567890123456789012345678901234 567890'),
                'description: 1234567890123456789012345678901234567890123456789012345678901234 ' . PHP_EOL . ' 567890'),
        );
        return $testData;
    }

    /**
     * @dataProvider attributeEncodingProvider
     */
    public function testAttributeEncoding($array, $expected)
    {
        $actual = Zend_Ldap_Ldif_Encoder::encode($array);
        $this->assertEquals($expected, $actual);
    }

    public function testChangedWrapCount()
    {
        $input = '56789012345678901234567890';
        $expected = 'dn: 567890' . PHP_EOL . ' 1234567890' . PHP_EOL . ' 1234567890';
        $output = Zend_Ldap_Ldif_Encoder::encode(array('dn' => $input), array('wrap' => 10));
        $this->assertEquals($expected, $output);
    }

    public function testEncodeMultipleAttributes()
    {
        $data = array(
            'a' => array('a', 'b'),
            'b' => 'c',
            'c' => '',
            'd' => array(),
            'e' => array(''));
        $expected = 'a: a' . PHP_EOL .
            'a: b' . PHP_EOL .
            'b: c' . PHP_EOL .
            'c: ' . PHP_EOL .
            'd: ' . PHP_EOL .
            'e: ';
        $actual = Zend_Ldap_Ldif_Encoder::encode($data);
        $this->assertEquals($expected, $actual);
    }

    public function testEncodeUnsupportedType()
    {
        $this->assertNull(Zend_Ldap_Ldif_Encoder::encode(new stdClass()));
    }

    public function testSorting()
    {
        $data=array(
            'cn'          => array('name'),
            'dn'          => 'cn=name,dc=example,dc=org',
            'host'        => array('a', 'b', 'c'),
            'empty'       => array(),
            'boolean'     => array('TRUE', 'FALSE'),
            'objectclass' => array('account', 'top'),
        );
        $expected = 'version: 1' . PHP_EOL .
            'dn: cn=name,dc=example,dc=org' . PHP_EOL .
            'objectclass: account' . PHP_EOL .
            'objectclass: top' . PHP_EOL .
            'boolean: TRUE' . PHP_EOL .
            'boolean: FALSE' . PHP_EOL .
            'cn: name' . PHP_EOL .
            'empty: ' . PHP_EOL .
            'host: a' . PHP_EOL .
            'host: b' . PHP_EOL .
            'host: c';
        $actual = Zend_Ldap_Ldif_Encoder::encode($data);
        $this->assertEquals($expected, $actual);

        $expected = 'version: 1' . PHP_EOL .
            'cn: name' . PHP_EOL .
            'dn: cn=name,dc=example,dc=org' . PHP_EOL .
            'host: a' . PHP_EOL .
            'host: b' . PHP_EOL .
            'host: c' . PHP_EOL .
            'empty: ' . PHP_EOL .
            'boolean: TRUE' . PHP_EOL .
            'boolean: FALSE' . PHP_EOL .
            'objectclass: account' . PHP_EOL .
            'objectclass: top';
        $actual = Zend_Ldap_Ldif_Encoder::encode($data, array('sort' => false));
        $this->assertEquals($expected, $actual);
    }

    public function testNodeEncoding()
    {
        $node = $this->_createTestNode();
        $expected = 'version: 1' . PHP_EOL .
            'dn: cn=name,dc=example,dc=org' . PHP_EOL .
            'objectclass: account' . PHP_EOL .
            'objectclass: top' . PHP_EOL .
            'boolean: TRUE' . PHP_EOL .
            'boolean: FALSE' . PHP_EOL .
            'cn: name' . PHP_EOL .
            'empty: ' . PHP_EOL .
            'host: a' . PHP_EOL .
            'host: b' . PHP_EOL .
            'host: c';
        $actual = $node->toLdif();
        $this->assertEquals($expected, $actual);

        $actual = Zend_Ldap_Ldif_Encoder::encode($node);
        $this->assertEquals($expected, $actual);
    }

    public function testSupressVersionHeader()
    {
        $data=array(
            'cn'          => array('name'),
            'dn'          => 'cn=name,dc=example,dc=org',
            'host'        => array('a', 'b', 'c'),
            'empty'       => array(),
            'boolean'     => array('TRUE', 'FALSE'),
            'objectclass' => array('account', 'top'),
        );
        $expected = 'dn: cn=name,dc=example,dc=org' . PHP_EOL .
            'objectclass: account' . PHP_EOL .
            'objectclass: top' . PHP_EOL .
            'boolean: TRUE' . PHP_EOL .
            'boolean: FALSE' . PHP_EOL .
            'cn: name' . PHP_EOL .
            'empty: ' . PHP_EOL .
            'host: a' . PHP_EOL .
            'host: b' . PHP_EOL .
            'host: c';
        $actual = Zend_Ldap_Ldif_Encoder::encode($data, array('version' => null));
        $this->assertEquals($expected, $actual);
    }

    public function testEncodingWithJapaneseCharacters()
    {
        $data=array(
            'dn'                         => 'uid=rogasawara,ou=営業部,o=Airius',
            'objectclass'                => array('top', 'person', 'organizationalPerson', 'inetOrgPerson'),
            'uid'                        => array('rogasawara'),
            'mail'                       => array('rogasawara@airius.co.jp'),
            'givenname;lang-ja'          => array('ロドニー'),
            'sn;lang-ja'                 => array('小笠原'),
            'cn;lang-ja'                 => array('小笠原 ロドニー'),
            'title;lang-ja'              => array('営業部 部長'),
            'preferredlanguage'          => array('ja'),
            'givenname'                  => array('ロドニー'),
            'sn'                         => array('小笠原'),
            'cn'                         => array('小笠原 ロドニー'),
            'title'                      => array('営業部 部長'),
            'givenname;lang-ja;phonetic' => array('ろどにー'),
            'sn;lang-ja;phonetic'        => array('おがさわら'),
            'cn;lang-ja;phonetic'        => array('おがさわら ろどにー'),
            'title;lang-ja;phonetic'     => array('えいぎょうぶ ぶちょう'),
            'givenname;lang-en'          => array('Rodney'),
            'sn;lang-en'                 => array('Ogasawara'),
            'cn;lang-en'                 => array('Rodney Ogasawara'),
            'title;lang-en'              => array('Sales, Director'),
        );
        $expected = 'dn:: dWlkPXJvZ2FzYXdhcmEsb3U95Za25qWt6YOoLG89QWlyaXVz' . PHP_EOL .
            'objectclass: top' . PHP_EOL .
            'objectclass: person' . PHP_EOL .
            'objectclass: organizationalPerson' . PHP_EOL .
            'objectclass: inetOrgPerson' . PHP_EOL .
            'uid: rogasawara' . PHP_EOL .
            'mail: rogasawara@airius.co.jp' . PHP_EOL .
            'givenname;lang-ja:: 44Ot44OJ44OL44O8' . PHP_EOL .
            'sn;lang-ja:: 5bCP56yg5Y6f' . PHP_EOL .
            'cn;lang-ja:: 5bCP56yg5Y6fIOODreODieODi+ODvA==' . PHP_EOL .
            'title;lang-ja:: 5Za25qWt6YOoIOmDqOmVtw==' . PHP_EOL .
            'preferredlanguage: ja' . PHP_EOL .
            'givenname:: 44Ot44OJ44OL44O8' . PHP_EOL .
            'sn:: 5bCP56yg5Y6f' . PHP_EOL .
            'cn:: 5bCP56yg5Y6fIOODreODieODi+ODvA==' . PHP_EOL .
            'title:: 5Za25qWt6YOoIOmDqOmVtw==' . PHP_EOL .
            'givenname;lang-ja;phonetic:: 44KN44Gp44Gr44O8' . PHP_EOL .
            'sn;lang-ja;phonetic:: 44GK44GM44GV44KP44KJ' . PHP_EOL .
            'cn;lang-ja;phonetic:: 44GK44GM44GV44KP44KJIOOCjeOBqeOBq+ODvA==' . PHP_EOL .
            'title;lang-ja;phonetic:: 44GI44GE44GO44KH44GG44G2IOOBtuOBoeOCh+OBhg==' . PHP_EOL .
            'givenname;lang-en: Rodney' . PHP_EOL .
            'sn;lang-en: Ogasawara' . PHP_EOL .
            'cn;lang-en: Rodney Ogasawara' . PHP_EOL .
            'title;lang-en: Sales, Director';
        $actual = Zend_Ldap_Ldif_Encoder::encode($data, array('sort' => false, 'version' => null));
        $this->assertEquals($expected, $actual);
    }
}