| /* |
| * 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.extras.controls.syncrepl_impl; |
| |
| |
| 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.api.LdapApiService; |
| import org.apache.directory.api.ldap.codec.osgi.DefaultLdapCodecService; |
| import org.apache.directory.api.ldap.extras.controls.SynchronizationModeEnum; |
| import org.apache.directory.api.ldap.extras.controls.syncrepl.syncRequest.SyncRequestValue; |
| import org.apache.directory.api.util.Strings; |
| import org.junit.jupiter.api.BeforeAll; |
| import org.junit.jupiter.api.Test; |
| import org.junit.jupiter.api.parallel.Execution; |
| import org.junit.jupiter.api.parallel.ExecutionMode; |
| |
| /** |
| * Test the SyncRequestControlValue codec |
| * |
| * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> |
| */ |
| @Execution( ExecutionMode.CONCURRENT) |
| public class SyncRequestValueControlTest |
| { |
| private static LdapApiService codec; |
| |
| @BeforeAll |
| public static void init() |
| { |
| codec = new DefaultLdapCodecService(); |
| codec.registerRequestControl( new SyncRequestValueFactory( codec ) ); |
| } |
| |
| |
| private void testReverseEncoding( SyncRequestValue syncRequestValue, ByteBuffer bb ) |
| { |
| // Test reverse encoding |
| Asn1Buffer asn1Buffer = new Asn1Buffer(); |
| |
| SyncRequestValueFactory factory = new SyncRequestValueFactory( codec ); |
| factory.encodeValue( asn1Buffer, syncRequestValue ); |
| assertArrayEquals( bb.array(), asn1Buffer.getBytes().array() ); |
| } |
| |
| |
| @Test |
| public void testEncodeSyncRequestValue() throws Exception |
| { |
| ByteBuffer bb = ByteBuffer.allocate( 0x05 ); |
| bb.put( new byte[] |
| { |
| 0x30, 0x03, |
| 0x0A, 0x01, 0x01 |
| } ); |
| |
| SyncRequestValueFactory factory = ( SyncRequestValueFactory ) codec.getRequestControlFactories(). |
| get( SyncRequestValue.OID ); |
| SyncRequestValue syncRequestValue = factory.newControl(); |
| factory.decodeValue( syncRequestValue, bb.array() ); |
| |
| |
| // Test reverse encoding |
| testReverseEncoding( syncRequestValue, bb ); |
| } |
| |
| |
| /** |
| * Test the decoding of a SyncRequestValue control with a refreshOnly mode |
| */ |
| @Test |
| public void testDecodeSyncRequestValueControlRefreshOnlySuccess() throws DecoderException, EncoderException |
| { |
| ByteBuffer bb = ByteBuffer.allocate( 0x0D ); |
| bb.put( new byte[] |
| { |
| 0x30, 0x0B, // syncRequestValue ::= SEQUENCE { |
| 0x0A, 0x01, 0x01, // mode ENUMERATED { |
| // refreshOnly (1) |
| // } |
| 0x04, 0x03, |
| 'a', 'b', 'c', // cookie syncCookie OPTIONAL, |
| 0x01, 0x01, 0x00 // reloadHint BOOLEAN DEFAULT FALSE |
| } ); |
| |
| bb.flip(); |
| |
| SyncRequestValueFactory factory = ( SyncRequestValueFactory ) codec.getRequestControlFactories(). |
| get( SyncRequestValue.OID ); |
| SyncRequestValue syncRequestValue = factory.newControl(); |
| factory.decodeValue( syncRequestValue, bb.array() ); |
| |
| assertEquals( SynchronizationModeEnum.REFRESH_ONLY, syncRequestValue.getMode() ); |
| assertEquals( "abc", Strings.utf8ToString( syncRequestValue.getCookie() ) ); |
| assertEquals( false, syncRequestValue.isReloadHint() ); |
| |
| // Test reverse encoding |
| bb = ByteBuffer.allocate( 0x0A ); |
| bb.put( new byte[] |
| { |
| 0x30, 0x08, // syncRequestValue ::= SEQUENCE { |
| 0x0A, 0x01, 0x01, // mode ENUMERATED { |
| // refreshOnly (1) |
| // } |
| 0x04, 0x03, |
| 'a', 'b', 'c' // cookie syncCookie OPTIONAL, |
| } ); |
| bb.flip(); |
| |
| testReverseEncoding( syncRequestValue, bb ); |
| } |
| |
| |
| /** |
| * Test the decoding of a SyncRequestValue control with a refreshAndPersist mode |
| */ |
| @Test |
| public void testDecodeSyncRequestValueControlRefreshAndPersistSuccess() throws DecoderException, EncoderException |
| { |
| ByteBuffer bb = ByteBuffer.allocate( 0x0D ); |
| bb.put( new byte[] |
| { |
| 0x30, 0x0B, // syncRequestValue ::= SEQUENCE { |
| 0x0A, 0x01, 0x03, // mode ENUMERATED { |
| // refreshAndPersist (3) |
| // } |
| 0x04, 0x03, |
| 'a', 'b', 'c', // cookie syncCookie OPTIONAL, |
| 0x01, 0x01, 0x00 // reloadHint BOOLEAN DEFAULT FALSE |
| } ); |
| bb.flip(); |
| |
| SyncRequestValueFactory factory = ( SyncRequestValueFactory ) codec.getRequestControlFactories(). |
| get( SyncRequestValue.OID ); |
| SyncRequestValue syncRequestValue = factory.newControl(); |
| factory.decodeValue( syncRequestValue, bb.array() ); |
| |
| assertEquals( SynchronizationModeEnum.REFRESH_AND_PERSIST, syncRequestValue.getMode() ); |
| assertEquals( "abc", Strings.utf8ToString( syncRequestValue.getCookie() ) ); |
| assertEquals( false, syncRequestValue.isReloadHint() ); |
| |
| // Test reverse encoding |
| bb = ByteBuffer.allocate( 0x0A ); |
| bb.put( new byte[] |
| { |
| 0x30, 0x08, // syncRequestValue ::= SEQUENCE { |
| 0x0A, 0x01, 0x03, // mode ENUMERATED { |
| // refreshAndPersist (3) |
| // } |
| 0x04, 0x03, |
| 'a', 'b', 'c' // cookie syncCookie OPTIONAL, |
| } ); |
| bb.flip(); |
| |
| testReverseEncoding( syncRequestValue, bb ); |
| } |
| |
| |
| /** |
| * Test the decoding of a SyncRequestValue control with no cookie |
| */ |
| @Test |
| public void testDecodeSyncRequestValueControlNoCookie() throws DecoderException, EncoderException |
| { |
| ByteBuffer bb = ByteBuffer.allocate( 0x08 ); |
| bb.put( new byte[] |
| { |
| 0x30, 0x06, // syncRequestValue ::= SEQUENCE { |
| 0x0A, 0x01, 0x03, // mode ENUMERATED { |
| // refreshAndPersist (3) |
| // } |
| 0x01, 0x01, 0x00 // reloadHint BOOLEAN DEFAULT FALSE |
| } ); |
| bb.flip(); |
| |
| SyncRequestValueFactory factory = ( SyncRequestValueFactory ) codec.getRequestControlFactories(). |
| get( SyncRequestValue.OID ); |
| SyncRequestValue syncRequestValue = factory.newControl(); |
| factory.decodeValue( syncRequestValue, bb.array() ); |
| |
| assertEquals( SynchronizationModeEnum.REFRESH_AND_PERSIST, syncRequestValue.getMode() ); |
| assertNull( syncRequestValue.getCookie() ); |
| assertEquals( false, syncRequestValue.isReloadHint() ); |
| |
| // Test reverse encoding |
| bb = ByteBuffer.allocate( 0x05 ); |
| bb.put( new byte[] |
| { |
| 0x30, 0x03, // syncRequestValue ::= SEQUENCE { |
| 0x0A, 0x01, 0x03, // mode ENUMERATED { |
| // refreshAndPersist (3) |
| // } |
| } ); |
| bb.flip(); |
| |
| testReverseEncoding( syncRequestValue, bb ); |
| } |
| |
| |
| /** |
| * Test the decoding of a SyncRequestValue control with no cookie, a true |
| * reloadHint |
| */ |
| @Test |
| public void testDecodeSyncRequestValueControlNoCookieReloadHintTrue() throws DecoderException, EncoderException |
| { |
| ByteBuffer bb = ByteBuffer.allocate( 0x08 ); |
| bb.put( new byte[] |
| { |
| 0x30, 0x06, // syncRequestValue ::= SEQUENCE { |
| 0x0A, 0x01, 0x03, // mode ENUMERATED { |
| // refreshAndPersist (3) |
| // } |
| 0x01, 0x01, ( byte ) 0xFF // reloadHint BOOLEAN DEFAULT FALSE |
| } ); |
| bb.flip(); |
| |
| SyncRequestValueFactory factory = ( SyncRequestValueFactory ) codec.getRequestControlFactories(). |
| get( SyncRequestValue.OID ); |
| SyncRequestValue syncRequestValue = factory.newControl(); |
| factory.decodeValue( syncRequestValue, bb.array() ); |
| |
| assertEquals( SynchronizationModeEnum.REFRESH_AND_PERSIST, syncRequestValue.getMode() ); |
| assertNull( syncRequestValue.getCookie() ); |
| assertEquals( true, syncRequestValue.isReloadHint() ); |
| |
| // Test reverse encoding |
| testReverseEncoding( syncRequestValue, bb ); |
| } |
| |
| |
| /** |
| * Test the decoding of a SyncRequestValue control with no cookie, no |
| * reloadHint |
| */ |
| @Test |
| public void testDecodeSyncRequestValueControlNoCookieNoReloadHint() throws DecoderException, EncoderException |
| { |
| ByteBuffer bb = ByteBuffer.allocate( 0x05 ); |
| bb.put( new byte[] |
| { |
| 0x30, 0x03, // syncRequestValue ::= SEQUENCE { |
| 0x0A, 0x01, 0x03, // mode ENUMERATED { |
| // refreshAndPersist (3) |
| // } |
| } ); |
| bb.flip(); |
| |
| SyncRequestValueFactory factory = ( SyncRequestValueFactory ) codec.getRequestControlFactories(). |
| get( SyncRequestValue.OID ); |
| SyncRequestValue syncRequestValue = factory.newControl(); |
| factory.decodeValue( syncRequestValue, bb.array() ); |
| |
| assertEquals( SynchronizationModeEnum.REFRESH_AND_PERSIST, syncRequestValue.getMode() ); |
| assertNull( syncRequestValue.getCookie() ); |
| assertEquals( false, syncRequestValue.isReloadHint() ); |
| |
| // Test reverse encoding |
| testReverseEncoding( syncRequestValue, bb ); |
| } |
| |
| |
| /** |
| * Test the decoding of a SyncRequestValue control with no reloadHint |
| */ |
| @Test |
| public void testDecodeSyncRequestValueControlNoReloadHintSuccess() throws DecoderException, EncoderException |
| { |
| ByteBuffer bb = ByteBuffer.allocate( 0x0A ); |
| bb.put( new byte[] |
| { |
| 0x30, 0x08, // syncRequestValue ::= SEQUENCE { |
| 0x0A, 0x01, 0x03, // mode ENUMERATED { |
| // refreshAndPersist (3) |
| // } |
| 0x04, 0x03, |
| 'a', 'b', 'c' // cookie syncCookie OPTIONAL, |
| } ); |
| bb.flip(); |
| |
| SyncRequestValueFactory factory = ( SyncRequestValueFactory ) codec.getRequestControlFactories(). |
| get( SyncRequestValue.OID ); |
| SyncRequestValue syncRequestValue = factory.newControl(); |
| factory.decodeValue( syncRequestValue, bb.array() ); |
| |
| assertEquals( SynchronizationModeEnum.REFRESH_AND_PERSIST, syncRequestValue.getMode() ); |
| assertEquals( "abc", Strings.utf8ToString( syncRequestValue.getCookie() ) ); |
| assertEquals( false, syncRequestValue.isReloadHint() ); |
| |
| // Test reverse encoding |
| testReverseEncoding( syncRequestValue, bb ); |
| } |
| |
| |
| /** |
| * Test the decoding of a SyncRequestValue control with an empty cookie |
| */ |
| @Test |
| public void testDecodeSyncRequestValueControlEmptyCookie() throws DecoderException, EncoderException |
| { |
| ByteBuffer bb = ByteBuffer.allocate( 0x07 ); |
| bb.put( new byte[] |
| { |
| 0x30, 0x05, // syncRequestValue ::= SEQUENCE { |
| 0x0A, 0x01, 0x03, // mode ENUMERATED { |
| // refreshAndPersist (3) |
| // } |
| 0x04, 0x00, // cookie syncCookie OPTIONAL, |
| } ); |
| bb.flip(); |
| |
| SyncRequestValueFactory factory = ( SyncRequestValueFactory ) codec.getRequestControlFactories(). |
| get( SyncRequestValue.OID ); |
| SyncRequestValue syncRequestValue = factory.newControl(); |
| factory.decodeValue( syncRequestValue, bb.array() ); |
| |
| assertEquals( SynchronizationModeEnum.REFRESH_AND_PERSIST, syncRequestValue.getMode() ); |
| assertEquals( "", Strings.utf8ToString( syncRequestValue.getCookie() ) ); |
| assertEquals( false, syncRequestValue.isReloadHint() ); |
| |
| // Test reverse encoding |
| bb = ByteBuffer.allocate( 0x05 ); |
| bb.put( new byte[] |
| { |
| 0x30, 0x03, // syncRequestValue ::= SEQUENCE { |
| 0x0A, 0x01, 0x03, // mode ENUMERATED { |
| // refreshAndPersist (3) |
| // } |
| } ); |
| bb.flip(); |
| |
| testReverseEncoding( syncRequestValue, bb ); |
| } |
| |
| |
| /** |
| * Test the decoding of a SyncRequestValue control with an empty sequence |
| */ |
| @Test |
| public void testDecodeSyncRequestValueControlEmptySequence() throws DecoderException |
| { |
| ByteBuffer bb = ByteBuffer.allocate( 0x02 ); |
| bb.put( new byte[] |
| { |
| 0x30, 0x00 // syncRequestValue ::= SEQUENCE { |
| } ); |
| bb.flip(); |
| |
| SyncRequestValueFactory factory = ( SyncRequestValueFactory ) codec.getRequestControlFactories(). |
| get( SyncRequestValue.OID ); |
| SyncRequestValue syncRequestValue = factory.newControl(); |
| |
| assertThrows( DecoderException.class, ( ) -> |
| { |
| factory.decodeValue( syncRequestValue, bb.array() ); |
| } ); |
| } |
| |
| |
| /** |
| * Test the decoding of a SyncRequestValue control with no mode |
| */ |
| @Test |
| public void testDecodeSyncRequestValueControlNoMode() throws DecoderException |
| { |
| ByteBuffer bb = ByteBuffer.allocate( 0x07 ); |
| bb.put( new byte[] |
| { |
| 0x30, 0x05, // syncRequestValue ::= SEQUENCE { |
| 0x04, 0x03, |
| 'a', 'b', 'c' // cookie syncCookie OPTIONAL, |
| } ); |
| bb.flip(); |
| |
| SyncRequestValueFactory factory = ( SyncRequestValueFactory ) codec.getRequestControlFactories(). |
| get( SyncRequestValue.OID ); |
| SyncRequestValue syncRequestValue = factory.newControl(); |
| |
| assertThrows( DecoderException.class, ( ) -> |
| { |
| factory.decodeValue( syncRequestValue, bb.array() ); |
| } ); |
| } |
| } |