blob: 157d73c2616ab7e9102fa4486f4506304f4db605 [file] [log] [blame]
/*
* 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.compare;
import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
import static org.junit.jupiter.api.Assertions.assertThrows;
import java.nio.ByteBuffer;
import java.util.Map;
import org.apache.directory.api.asn1.DecoderException;
import org.apache.directory.api.asn1.EncoderException;
import org.apache.directory.api.asn1.ber.Asn1Decoder;
import org.apache.directory.api.asn1.util.Asn1Buffer;
import org.apache.directory.api.ldap.codec.api.LdapEncoder;
import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
import org.apache.directory.api.ldap.codec.api.ResponseCarryingException;
import org.apache.directory.api.ldap.codec.osgi.AbstractCodecServiceTest;
import org.apache.directory.api.ldap.model.message.CompareRequest;
import org.apache.directory.api.ldap.model.message.CompareResponseImpl;
import org.apache.directory.api.ldap.model.message.Control;
import org.apache.directory.api.ldap.model.message.Message;
import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
import org.apache.directory.api.ldap.model.message.controls.ManageDsaIT;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.parallel.Execution;
import org.junit.jupiter.api.parallel.ExecutionMode;
/**
* Test the CompareRequest codec
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@Execution( ExecutionMode.CONCURRENT)
public class CompareRequestTest extends AbstractCodecServiceTest
{
/**
* Test the decoding of a full CompareRequest
*/
@Test
public void testDecodeCompareRequestSuccess() throws DecoderException, EncoderException
{
ByteBuffer stream = ByteBuffer.allocate( 0x38 );
stream.put( new byte[]
{
0x30, 0x36, // LDAPMessage ::= SEQUENCE {
0x02, 0x01, 0x01, // messageID MessageID
// CHOICE { ..., compareRequest CompareRequest, ...
0x6E, 0x31, // CompareRequest ::= [APPLICATION 14] SEQUENCE {
0x04, 0x20, // entry LDAPDN,
'c', 'n', '=', 't', 'e', 's', 't', 'M', 'o', 'd', 'i', 'f', 'y',
',', 'o', 'u', '=', 'u', 's', 'e', 'r', 's', ',',
'o', 'u', '=', 's', 'y', 's', 't', 'e', 'm',
// ava AttributeValueAssertion }
0x30, 0x0D, // AttributeValueAssertion ::= SEQUENCE {
0x04, 0x04, // attributeDesc AttributeDescription,
't', 'e', 's', 't',
0x04, 0x05, // assertionValue AssertionValue }
'v', 'a', 'l', 'u', 'e'
} );
stream.flip();
// Allocate a LdapMessage Container
LdapMessageContainer<CompareRequest> container = new LdapMessageContainer<>( codec );
// Decode the CompareRequest PDU
Asn1Decoder.decode( stream, container );
// Check the decoded CompareRequest PDU
CompareRequest compareRequest = container.getMessage();
assertEquals( 1, compareRequest.getMessageId() );
assertEquals( "cn=testModify,ou=users,ou=system", compareRequest.getName().toString() );
assertEquals( "test", compareRequest.getAttributeId() );
assertEquals( "value", compareRequest.getAssertionValue().toString() );
// Check encode reverse
Asn1Buffer buffer = new Asn1Buffer();
LdapEncoder.encodeMessage( buffer, codec, compareRequest );
assertArrayEquals( stream.array(), buffer.getBytes().array() );
}
/**
* Test the decoding of an empty CompareRequest
*/
@Test
public void testDecodeCompareRequestEmptyRequest() throws DecoderException
{
ByteBuffer stream = ByteBuffer.allocate( 0x07 );
stream.put( new byte[]
{
0x30, 0x05, // LDAPMessage ::= SEQUENCE {
0x02, 0x01, 0x01, // messageID MessageID
// CHOICE { ..., compareRequest CompareRequest, ...
0x6E, 0x00 // CompareRequest ::= [APPLICATION 14] SEQUENCE {
} );
stream.flip();
// Allocate a LdapMessage Container
LdapMessageContainer<CompareRequest> container = new LdapMessageContainer<>( codec );
// Decode the CompareRequest PDU
assertThrows( DecoderException.class, ( ) ->
{
Asn1Decoder.decode( stream, container );
} );
}
/**
* Test the decoding of an empty entry CompareRequest
*/
@Test
public void testDecodeCompareRequestEmptyEntry() throws DecoderException
{
ByteBuffer stream = ByteBuffer.allocate( 0x18 );
stream.put( new byte[]
{
0x30, 0x16, // LDAPMessage ::= SEQUENCE {
0x02, 0x01, 0x01, // messageID MessageID
// CHOICE { ..., compareRequest CompareRequest, ...
0x6E, 0x11, // CompareRequest ::= [APPLICATION 14] SEQUENCE {
0x04, 0x00, // entry LDAPDN,
// ava AttributeValueAssertion }
0x30, 0x0D, // AttributeValueAssertion ::= SEQUENCE {
0x04, 0x04, // attributeDesc AttributeDescription,
't', 'e', 's', 't',
0x04, 0x05, // assertionValue AssertionValue }
'v', 'a', 'l', 'u', 'e'
} );
stream.flip();
// Allocate a LdapMessage Container
LdapMessageContainer<CompareRequest> container = new LdapMessageContainer<>( codec );
// Decode the CompareRequest PDU
assertThrows( DecoderException.class, ( ) ->
{
Asn1Decoder.decode( stream, container );
} );
}
/**
* Test the decoding of an empty ava
*/
@Test
public void testDecodeCompareRequestEmptyAVA() throws DecoderException
{
ByteBuffer stream = ByteBuffer.allocate( 0x2B );
stream.put( new byte[]
{
0x30, 0x29, // LDAPMessage ::= SEQUENCE {
0x02, 0x01, 0x01, // messageID MessageID
// CHOICE { ..., compareRequest CompareRequest, ...
0x6E, 0x24, // CompareRequest ::= [APPLICATION 14] SEQUENCE {
0x04, 0x20, // entry LDAPDN,
'c', 'n', '=', 't', 'e', 's', 't', 'M', 'o', 'd', 'i', 'f', 'y',
',', 'o', 'u', '=', 'u', 's', 'e', 'r', 's', ',',
'o', 'u', '=', 's', 'y', 's', 't', 'e', 'm',
// ava AttributeValueAssertion }
0x30, 0x00 // AttributeValueAssertion ::= SEQUENCE {
} );
stream.flip();
// Allocate a LdapMessage Container
LdapMessageContainer<CompareRequest> container = new LdapMessageContainer<>( codec );
// Decode the CompareRequest PDU
assertThrows( DecoderException.class, ( ) ->
{
Asn1Decoder.decode( stream, container );
} );
}
/**
* Test the decoding of an empty ava
*/
@Test
public void testDecodeCompareRequestInvalidDN() throws DecoderException
{
ByteBuffer stream = ByteBuffer.allocate( 0x2B );
stream.put( new byte[]
{
0x30, 0x29, // LDAPMessage ::= SEQUENCE {
0x02, 0x01, 0x01, // messageID MessageID
// CHOICE { ..., compareRequest CompareRequest, ...
0x6E, 0x24, // CompareRequest ::= [APPLICATION 14] SEQUENCE {
0x04, 0x20, // entry LDAPDN,
'c', 'n', ':', 't', 'e', 's', 't', 'M', 'o', 'd', 'i', 'f', 'y',
',', 'o', 'u', '=', 'u', 's', 'e', 'r', 's', ',',
'o', 'u', '=', 's', 'y', 's', 't', 'e', 'm',
// ava AttributeValueAssertion }
0x30, 0x00 // AttributeValueAssertion ::= SEQUENCE {
} );
stream.flip();
// Allocate a LdapMessage Container
LdapMessageContainer<CompareRequest> container = new LdapMessageContainer<>( codec );
// Decode the CompareRequest PDU
assertThrows( DecoderException.class, ( ) ->
{
try
{
Asn1Decoder.decode( stream, container );
fail( "We should never reach this point !!!" );
}
catch ( DecoderException de )
{
assertTrue( de instanceof ResponseCarryingException );
Message response = ( ( ResponseCarryingException ) de ).getResponse();
assertTrue( response instanceof CompareResponseImpl );
assertEquals( ResultCodeEnum.INVALID_DN_SYNTAX, ( ( CompareResponseImpl ) response ).getLdapResult()
.getResultCode() );
throw de;
}
} );
}
/**
* Test the decoding of an empty attributeDesc ava
*/
@Test
public void testDecodeCompareRequestEmptyAttributeDesc() throws DecoderException
{
ByteBuffer stream = ByteBuffer.allocate( 0x2D );
stream.put( new byte[]
{
0x30, 0x2B, // LDAPMessage ::= SEQUENCE {
0x02, 0x01, 0x01, // messageID MessageID
// CHOICE { ..., compareRequest CompareRequest, ...
0x6E, 0x26, // CompareRequest ::= [APPLICATION 14] SEQUENCE {
0x04, 0x20, // entry LDAPDN,
'c', 'n', '=', 't', 'e', 's', 't', 'M', 'o', 'd', 'i', 'f', 'y',
',', 'o', 'u', '=', 'u', 's', 'e', 'r', 's', ',',
'o', 'u', '=', 's', 'y', 's', 't', 'e', 'm',
// ava AttributeValueAssertion }
0x30, 0x02, // AttributeValueAssertion ::= SEQUENCE {
0x04, 0x00
} );
stream.flip();
// Allocate a LdapMessage Container
LdapMessageContainer<CompareRequest> container = new LdapMessageContainer<>( codec );
// Decode the CompareRequest PDU
assertThrows( DecoderException.class, ( ) ->
{
try
{
Asn1Decoder.decode( stream, container );
fail( "We should never reach this point !!!" );
}
catch ( DecoderException de )
{
assertTrue( de instanceof ResponseCarryingException );
Message response = ( ( ResponseCarryingException ) de ).getResponse();
assertTrue( response instanceof CompareResponseImpl );
assertEquals( ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX, ( ( CompareResponseImpl ) response ).getLdapResult()
.getResultCode() );
throw de;
}
} );
}
/**
* Test the decoding of an empty attributeValue ava
*/
@Test
public void testDecodeCompareRequestEmptyAttributeValue() throws DecoderException, EncoderException
{
ByteBuffer stream = ByteBuffer.allocate( 0x33 );
stream.put( new byte[]
{
0x30, 0x31, // LDAPMessage ::= SEQUENCE {
0x02, 0x01, 0x01, // messageID MessageID
// CHOICE { ..., compareRequest CompareRequest, ...
0x6E, 0x2C, // CompareRequest ::= [APPLICATION 14] SEQUENCE {
0x04, 0x20, // entry LDAPDN,
'c', 'n', '=', 't', 'e', 's', 't', 'M', 'o', 'd', 'i', 'f', 'y',
',', 'o', 'u', '=', 'u', 's', 'e', 'r', 's', ',',
'o', 'u', '=', 's', 'y', 's', 't', 'e', 'm',
// ava AttributeValueAssertion }
0x30, 0x08, // AttributeValueAssertion ::= SEQUENCE {
0x04, 0x04, // attributeDesc AttributeDescription,
't', 'e', 's', 't',
0x04, 0x00 // assertionValue AssertionValue }
} );
stream.flip();
// Allocate a LdapMessage Container
LdapMessageContainer<CompareRequest> container = new LdapMessageContainer<>( codec );
// Decode the CompareRequest PDU
Asn1Decoder.decode( stream, container );
// Check the decoded CompareRequest PDU
CompareRequest compareRequest = container.getMessage();
assertEquals( 1, compareRequest.getMessageId() );
assertEquals( "cn=testModify,ou=users,ou=system", compareRequest.getName().toString() );
assertEquals( "test", compareRequest.getAttributeId() );
assertEquals( "", compareRequest.getAssertionValue().toString() );
// Check encode reverse
Asn1Buffer buffer = new Asn1Buffer();
LdapEncoder.encodeMessage( buffer, codec, compareRequest );
assertArrayEquals( stream.array(), buffer.getBytes().array() );
}
/**
* Test the decoding of an compare request with controls
*/
@Test
public void testDecodeCompareRequestWithControls() throws DecoderException, EncoderException
{
ByteBuffer stream = ByteBuffer.allocate( 0x55 );
stream.put( new byte[]
{
0x30, 0x53, // LDAPMessage ::= SEQUENCE {
0x02, 0x01, 0x01, // messageID MessageID
// CHOICE { ..., compareRequest CompareRequest, ...
0x6E, 0x31, // CompareRequest ::= [APPLICATION 14] SEQUENCE {
0x04, 0x20, // entry LDAPDN,
'c', 'n', '=', 't', 'e', 's', 't', 'M', 'o', 'd', 'i', 'f', 'y',
',', 'o', 'u', '=', 'u', 's', 'e', 'r', 's', ',',
'o', 'u', '=', 's', 'y', 's', 't', 'e', 'm',
// ava AttributeValueAssertion }
0x30, 0x0D, // AttributeValueAssertion ::= SEQUENCE {
0x04, 0x04, // attributeDesc AttributeDescription,
't', 'e', 's', 't',
0x04, 0x05, // assertionValue AssertionValue }
'v', 'a', 'l', 'u', 'e',
( byte ) 0xA0, 0x1B, // A control
0x30, 0x19,
0x04, 0x17,
'2', '.', '1', '6', '.', '8', '4', '0', '.', '1', '.', '1', '1', '3', '7', '3', '0',
'.', '3', '.', '4', '.', '2'
} );
stream.flip();
// Allocate a LdapMessage Container
LdapMessageContainer<CompareRequest> container = new LdapMessageContainer<>( codec );
// Decode the CompareRequest PDU
Asn1Decoder.decode( stream, container );
// Check the decoded CompareRequest PDU
CompareRequest compareRequest = container.getMessage();
assertEquals( 1, compareRequest.getMessageId() );
assertEquals( "cn=testModify,ou=users,ou=system", compareRequest.getName().toString() );
assertEquals( "test", compareRequest.getAttributeId() );
assertEquals( "value", compareRequest.getAssertionValue().toString() );
// Check the Control
Map<String, Control> controls = compareRequest.getControls();
assertEquals( 1, controls.size() );
Control control = controls.get( "2.16.840.1.113730.3.4.2" );
assertEquals( "2.16.840.1.113730.3.4.2", control.getOid() );
assertTrue( control instanceof ManageDsaIT );
// Check the encoding
Asn1Buffer buffer = new Asn1Buffer();
LdapEncoder.encodeMessage( buffer, codec, compareRequest );
assertArrayEquals( stream.array(), buffer.getBytes().array() );
}
}