ldap/codec/core/src/test/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeControlTest.java

/*
 *  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
 *
 *    https://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.
 *
 */
package org.apache.directory.api.ldap.codec.controls.search.entryChange;


import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;

import java.nio.ByteBuffer;

import org.apache.directory.api.asn1.DecoderException;
import org.apache.directory.api.asn1.EncoderException;
import org.apache.directory.api.asn1.util.Asn1Buffer;
import org.apache.directory.api.ldap.codec.osgi.AbstractCodecServiceTest;
import org.apache.directory.api.ldap.model.exception.LdapException;
import org.apache.directory.api.ldap.model.message.controls.ChangeType;
import org.apache.directory.api.ldap.model.message.controls.EntryChange;
import org.apache.directory.api.ldap.model.name.Dn;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.parallel.Execution;
import org.junit.jupiter.api.parallel.ExecutionMode;

/**
 * Test the EntryChangeControlTest codec
 *
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
@Execution( ExecutionMode.CONCURRENT)
public class EntryChangeControlTest extends AbstractCodecServiceTest
{
    /**
     * Test the decoding of a EntryChangeControl
     */
    @Test
    public void testDecodeEntryChangeControlSuccess() throws DecoderException
    {
        ByteBuffer bb = ByteBuffer.allocate( 0x0D );
        bb.put( new byte[]
            {
                0x30, 0x0B,                     // EntryChangeNotification ::= SEQUENCE {
                  0x0A, 0x01, 0x08,             //     changeType ENUMERATED {
                                                //         modDN (8)
                                                //     }
                  0x04, 0x03,
                    'a', '=', 'b',              //     previousDN LDAPDN OPTIONAL, -- modifyDN ops. only
                  0x02, 0x01, 0x10              //     changeNumber INTEGER OPTIONAL } -- if supported
            } );
        bb.flip();

        EntryChangeFactory factory = ( EntryChangeFactory ) codec.getResponseControlFactories().get( 
            EntryChange.OID );
        EntryChange entryChange = factory.newControl();
        factory.decodeValue( entryChange, bb.array() );

        assertEquals( ChangeType.MODDN, entryChange.getChangeType() );
        assertEquals( "a=b", entryChange.getPreviousDn().toString() );
        assertEquals( 16, entryChange.getChangeNumber() );

        // Check the reverse encoding
        Asn1Buffer asn1Buffer = new Asn1Buffer();

        factory.encodeValue( asn1Buffer, entryChange );

        assertArrayEquals( bb.array(),  asn1Buffer.getBytes().array() );
    }


    /**
     * Test the decoding of a EntryChangeControl
     */
    @Test
    public void testDecodeEntryChangeControlSuccessLongChangeNumber() throws DecoderException
    {
        ByteBuffer bb = ByteBuffer.allocate( 0x13 );
        bb.put( new byte[]
            {
                0x30, 0x11,                     // EntryChangeNotification ::= SEQUENCE {
                  0x0A, 0x01, 0x08,             //     changeType ENUMERATED {
                                                //         modDN (8)
                                                //     }
                  0x04, 0x03,
                    'a', '=', 'b',              //     previousDN LDAPDN OPTIONAL, -- modifyDN ops. only
                  0x02, 0x07,                   //     changeNumber INTEGER OPTIONAL } -- if supported
                    0x12, 0x34, 0x56, 0x78, ( byte ) 0x9A, ( byte ) 0xBC, ( byte ) 0xDE
            } );
        bb.flip();

        EntryChangeFactory factory = ( EntryChangeFactory ) codec.getResponseControlFactories().get( 
            EntryChange.OID );
        EntryChange entryChange = factory.newControl();
        factory.decodeValue( entryChange, bb.array() );

        assertEquals( ChangeType.MODDN, entryChange.getChangeType() );
        assertEquals( "a=b", entryChange.getPreviousDn().toString() );
        assertEquals( 5124095576030430L, entryChange.getChangeNumber() );

        // Check the reverse encoding
        Asn1Buffer asn1Buffer = new Asn1Buffer();

        factory.encodeValue( asn1Buffer, entryChange );

        assertArrayEquals( bb.array(),  asn1Buffer.getBytes().array() );
    }


    /**
     * Test the decoding of a EntryChangeControl with a add and a change number
     */
    @Test
    public void testDecodeEntryChangeControlWithADDAndChangeNumber() throws DecoderException
    {
        ByteBuffer bb = ByteBuffer.allocate( 0x08 );
        bb.put( new byte[]
            {
                0x30, 0x06,                 // EntryChangeNotification ::= SEQUENCE {
                  0x0A, 0x01, 0x01,         //     changeType ENUMERATED {
                                            //         Add (1)
                                            //     }
                  0x02, 0x01, 0x10          //     changeNumber INTEGER OPTIONAL -- if supported
                                            // }
            } );
        bb.flip();

        EntryChangeFactory factory = ( EntryChangeFactory ) codec.getResponseControlFactories().get( 
            EntryChange.OID );
        EntryChange entryChange = factory.newControl();
        factory.decodeValue( entryChange, bb.array() );

        assertEquals( ChangeType.ADD, entryChange.getChangeType() );
        assertNull( entryChange.getPreviousDn() );
        assertEquals( 16, entryChange.getChangeNumber() );

        // Check the reverse encoding
        Asn1Buffer asn1Buffer = new Asn1Buffer();

        factory.encodeValue( asn1Buffer, entryChange );

        assertArrayEquals( bb.array(),  asn1Buffer.getBytes().array() );
    }


    /**
     * Test the decoding of a EntryChangeControl with a add so we should not
     * have a PreviousDN
     */
    @Test
    public void testDecodeEntryChangeControlWithADDAndPreviousDNBad() throws DecoderException
    {
        ByteBuffer bb = ByteBuffer.allocate( 0x0D );
        bb.put( new byte[]
            {
                0x30, 0x0B,                 // EntryChangeNotification ::= SEQUENCE {
                  0x0A, 0x01, 0x01,         //     changeType ENUMERATED {
                                            //         ADD (1)
                                            //     }
                  0x04, 0x03,
                    'a', '=', 'b',          //     previousDN LDAPDN OPTIONAL, --
                                            //     modifyDN ops. only
                  0x02, 0x01, 0x10          //     changeNumber INTEGER OPTIONAL -- if supported
                                            // }
            } );
        bb.flip();

        EntryChangeFactory factory = ( EntryChangeFactory ) codec.getResponseControlFactories().get( 
            EntryChange.OID );
        EntryChange entryChange = factory.newControl();

        assertThrows( DecoderException.class, ( ) ->
        {
            factory.decodeValue( entryChange, bb.array() );
        } );
    }


    /**
     * Test the decoding of a EntryChangeControl with a add and nothing else
     */
    @Test
    public void testDecodeEntryChangeControlWithADD() throws DecoderException
    {
        ByteBuffer bb = ByteBuffer.allocate( 0x05 );
        bb.put( new byte[]
            {
                0x30, 0x03,                 // EntryChangeNotification ::= SEQUENCE {
                  0x0A, 0x01, 0x01,         //     changeType ENUMERATED {
                                            //         ADD (1)
                                            //     }
                                            // }
            } );
        bb.flip();

        EntryChangeFactory factory = ( EntryChangeFactory ) codec.getResponseControlFactories().get( 
            EntryChange.OID );
        EntryChange entryChange = factory.newControl();
        factory.decodeValue( entryChange, bb.array() );

        assertEquals( ChangeType.ADD, entryChange.getChangeType() );
        assertNull( entryChange.getPreviousDn() );
        assertEquals( EntryChange.UNDEFINED_CHANGE_NUMBER, entryChange.getChangeNumber() );

        // Check the reverse encoding
        Asn1Buffer asn1Buffer = new Asn1Buffer();

        factory.encodeValue( asn1Buffer, entryChange );

        assertArrayEquals( bb.array(),  asn1Buffer.getBytes().array() );
    }


    /**
     * Test the decoding of a EntryChangeControl with a wrong changeType and
     * nothing else
     */
    @Test
    public void testDecodeEntryChangeControlWithWrongChangeType() throws DecoderException
    {
        ByteBuffer bb = ByteBuffer.allocate( 0x05 );
        bb.put( new byte[]
            {
                0x30, 0x03,             // EntryChangeNotification ::= SEQUENCE {
                0x0A, 0x01, 0x03,       //     changeType ENUMERATED {
                                        //         BAD Change Type
                                        //     }
                                        // }
            } );
        bb.flip();

        EntryChangeFactory factory = ( EntryChangeFactory ) codec.getResponseControlFactories().get( 
            EntryChange.OID );
        EntryChange entryChange = factory.newControl();

        assertThrows( DecoderException.class, ( ) ->
        {
            factory.decodeValue( entryChange, bb.array() );
        } );
    }


    /**
     * Test the decoding of a EntryChangeControl with a wrong changeNumber
     */
    @Test
    public void testDecodeEntryChangeControlWithWrongChangeNumber() throws DecoderException
    {
        ByteBuffer bb = ByteBuffer.allocate( 0x1C );
        bb.put( new byte[]
            {
                0x30, 0x1A,                 // EntryChangeNotification ::= SEQUENCE {
                  0x0A, 0x01, 0x08,         //     changeType ENUMERATED {
                                            //         modDN (8)
                                            //     }
                  0x04, 0x03,
                    'a', '=', 'b',          //     previousDN LDAPDN OPTIONAL, -- modifyDN ops. only
                  0x02, 0x10,               //     changeNumber INTEGER OPTIONAL -- if supported
                    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
                    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
            } );
        bb.flip();

        EntryChangeFactory factory = ( EntryChangeFactory ) codec.getResponseControlFactories().get( 
            EntryChange.OID );
        EntryChange entryChange = factory.newControl();

        assertThrows( DecoderException.class, ( ) ->
        {
            factory.decodeValue( entryChange, bb.array() );
        } );
    }


    /**
     * Test encoding of a EntryChangeControl.
     */
    @Test
    public void testEncodeEntryChangeControl() throws DecoderException, EncoderException, LdapException
    {
        ByteBuffer bb = ByteBuffer.allocate( 0x0D );
        bb.put( new byte[]
            {
                0x30, 0x0B,                 // EntryChangeNotification ::= SEQUENCE {
                  0x0A, 0x01, 0x08,         //     changeType ENUMERATED {
                                            //         modDN (8)
                                            //     }
                  0x04, 0x03,
                    'a', '=', 'b',          //     previousDN LDAPDN OPTIONAL, -- modifyDN ops. only
                  0x02, 0x01, 0x10,         //     changeNumber INTEGER OPTIONAL -- if supported
            } );

        bb.flip();

        EntryChangeFactory factory = ( EntryChangeFactory ) codec.getResponseControlFactories().get( 
            EntryChange.OID );
        EntryChange entryChange = factory.newControl();
        factory.decodeValue( entryChange, bb.array() );

        entryChange.setChangeType( ChangeType.MODDN );
        entryChange.setChangeNumber( 16 );
        entryChange.setPreviousDn( new Dn( "a=b" ) );

        // Check the reverse encoding
        Asn1Buffer asn1Buffer = new Asn1Buffer();

        factory.encodeValue( asn1Buffer, entryChange );

        assertArrayEquals( bb.array(),  asn1Buffer.getBytes().array() );
    }


    /**
     * Test encoding of a EntryChangeControl with a long changeNumber.
     */
    @Test
    public void testEncodeEntryChangeControlLong() throws DecoderException, EncoderException, LdapException
    {
        ByteBuffer bb = ByteBuffer.allocate( 0x13 );
        bb.put( new byte[]
            {
                0x30, 0x11,                 // EntryChangeNotification ::= SEQUENCE {
                  0x0A, 0x01, 0x08,         //     changeType ENUMERATED {
                                            //         modDN (8)
                                            //     }
                  0x04, 0x03,
                    'a', '=', 'b',          //     previousDN LDAPDN OPTIONAL, -- modifyDN ops. only
                  0x02, 0x07,               //     changeNumber INTEGER OPTIONAL -- if supported
                    0x12, 0x34, 0x56, 0x78, ( byte ) 0x9a, ( byte ) 0xbc, ( byte ) 0xde
            } );

        bb.flip();

        EntryChangeFactory factory = ( EntryChangeFactory ) codec.getResponseControlFactories().get( 
            EntryChange.OID );
        EntryChange entryChange = factory.newControl();
        factory.decodeValue( entryChange, bb.array() );

        entryChange.setChangeType( ChangeType.MODDN );
        entryChange.setChangeNumber( 5124095576030430L );
        entryChange.setPreviousDn( new Dn( "a=b" ) );

        // Check the reverse encoding
        Asn1Buffer asn1Buffer = new Asn1Buffer();

        factory.encodeValue( asn1Buffer, entryChange );

        assertArrayEquals( bb.array(),  asn1Buffer.getBytes().array() );
    }
}