/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
* add the following below this CDDL HEADER, with the fields enclosed
* by brackets "[]" replaced with your own identifying information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
*/
package org.opends.server.protocols.ldap;
import org.opends.server.core.DirectoryServer;
import org.opends.server.protocols.asn1.*;
import org.opends.server.types.*;
import static org.opends.server.util.ServerConstants.EOL;
import org.opends.messages.Message;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertTrue;
import java.util.ArrayList;
import java.util.Iterator;
/**
* This class defines a set of tests for the
* org.opends.server.protocol.ldap.CompareRequestProtocolOp class.
*/
public class TestCompareResponseProtocolOp extends LdapTestCase
{
/**
* The protocol op type for compare requests.
*/
public static final byte OP_TYPE_COMPARE_REQUEST = 0x6E;
/**
* The protocol op type for compare responses.
*/
public static final byte OP_TYPE_COMPARE_RESPONSE = 0x6F;
/**
* The result code for compare result operations.
*/
private static final int resultCode = 10;
/**
* The error message to use for compare result operations.
*/
private static final Message resultMsg = Message.raw("Test Successful");
/**
* The DN to use for compare result operations
*/
private DN dn;
@BeforeClass
public void setupDN()
{
//Setup the DN to use in the response tests.
AttributeType attribute =
DirectoryServer.getDefaultAttributeType("testAttribute");
AttributeValue attributeValue = AttributeValues.create(attribute, "testValue");
RDN[] rdns = new RDN[1];
rdns[0] = RDN.create(attribute, attributeValue);
dn = new DN(rdns);
}
/**
* Test to make sure the class processes the right LDAP op type.
*
* @throws Exception If the test failed unexpectedly.
*/
@Test
public void testOpType() throws Exception
{
CompareResponseProtocolOp compareResponse = new CompareResponseProtocolOp(
resultCode);
assertEquals(compareResponse.getType(), OP_TYPE_COMPARE_RESPONSE);
}
/**
* Test to make sure the class returns the correct protocol name.
*
* @throws Exception If the test failed unexpectedly.
*/
@Test
public void testProtocolOpName() throws Exception
{
CompareResponseProtocolOp compareResponse = new CompareResponseProtocolOp(
resultCode);
assertEquals(compareResponse.getProtocolOpName(), "Compare Response");
}
/**
* Test the constructors to make sure the right objects are constructed.
*
* @throws Exception If the test failed unexpectedly.
*/
@Test
public void testConstructors() throws Exception
{
CompareResponseProtocolOp compareResponse;
ArrayList<LDAPAttribute> attributes;
//Test to make sure the constructor with result code param works.
compareResponse = new CompareResponseProtocolOp(resultCode);
assertEquals(compareResponse.getResultCode(), resultCode);
//Test to make sure the constructor with result code and error message
//params works.
compareResponse = new CompareResponseProtocolOp(resultCode, resultMsg);
assertEquals(compareResponse.getErrorMessage(), resultMsg);
assertEquals(compareResponse.getResultCode(), resultCode);
//Test to make sure the constructor with result code, message, dn, and
//referal params works.
ArrayList<String> referralURLs = new ArrayList<String>();
referralURLs.add("ds1.example.com");
referralURLs.add("ds2.example.com");
referralURLs.add("ds3.example.com");
compareResponse = new CompareResponseProtocolOp(resultCode, resultMsg, dn,
referralURLs);
assertEquals(compareResponse.getErrorMessage(), resultMsg);
assertEquals(compareResponse.getResultCode(), resultCode);
assertEquals(compareResponse.getMatchedDN(), dn);
assertEquals(compareResponse.getReferralURLs(), referralURLs);
}
/**
* Test the decode method when an empty element is passed
*
* @throws Exception If the test failed unexpectedly.
*/
@Test(expectedExceptions = LDAPException.class)
public void testDecodeEmptyElement() throws Exception
{
ByteStringBuilder builder = new ByteStringBuilder();
ASN1Writer writer = ASN1.getWriter(builder);
writer.writeStartSequence(OP_TYPE_COMPARE_RESPONSE);
writer.writeEndSequence();
ASN1Reader reader = ASN1.getReader(builder.toByteString());
LDAPReader.readProtocolOp(reader);
}
/**
* Test the decode method when an element with a invalid result code is
* passed
*
* @throws Exception If the test failed unexpectedly.
*/
@Test(expectedExceptions = LDAPException.class)
public void testDecodeInvalidResultCode() throws Exception
{
ByteStringBuilder builder = new ByteStringBuilder();
ASN1Writer writer = ASN1.getWriter(builder);
writer.writeStartSequence(OP_TYPE_COMPARE_RESPONSE);
writer.writeOctetString("Invalid Data");
writer.writeNull();
writer.writeNull();
writer.writeEndSequence();
ASN1Reader reader = ASN1.getReader(builder.toByteString());
LDAPReader.readProtocolOp(reader);
}
/**
* Test the decode method when an element with a invalid dn is
* passed. Never throws an exception as long as the element is not null.
* This is the expected behavior.
*
* @throws Exception If the test failed unexpectedly.
*/
@Test
public void testDecodeInvalidDN() throws Exception
{
ByteStringBuilder builder = new ByteStringBuilder();
ASN1Writer writer = ASN1.getWriter(builder);
writer.writeStartSequence(OP_TYPE_COMPARE_RESPONSE);
writer.writeInteger(resultCode);
writer.writeNull();
writer.writeNull();
writer.writeEndSequence();
ASN1Reader reader = ASN1.getReader(builder.toByteString());
LDAPReader.readProtocolOp(reader);
}
/**
* Test the decode method when an element with a invalid result message is
* passed. Never throws an exception as long as the element is not null.
* This is the expected behavior.
*
* @throws Exception If the test failed unexpectedly.
*/
@Test
public void testDecodeInvalidResultMsg() throws Exception
{
ByteStringBuilder builder = new ByteStringBuilder();
ASN1Writer writer = ASN1.getWriter(builder);
writer.writeStartSequence(OP_TYPE_COMPARE_RESPONSE);
writer.writeInteger(resultCode);
writer.writeOctetString(dn.toString());
writer.writeNull();
writer.writeEndSequence();
ASN1Reader reader = ASN1.getReader(builder.toByteString());
LDAPReader.readProtocolOp(reader);
}
/**
* Test the decode method when an element with a invalid referral URL is
* passed. Never throws an exception as long as the element is not null.
* This is the expected behavior.
*
* @throws Exception If the test failed unexpectedly.
*/
@Test
public void testDecodeInvalidReferralURLs() throws Exception
{
ByteStringBuilder builder = new ByteStringBuilder();
ASN1Writer writer = ASN1.getWriter(builder);
writer.writeStartSequence(OP_TYPE_COMPARE_RESPONSE);
writer.writeInteger(resultCode);
writer.writeOctetString(dn.toString());
writer.writeOctetString(resultMsg.toString());
writer.writeNull();
writer.writeEndSequence();
ASN1Reader reader = ASN1.getReader(builder.toByteString());
LDAPReader.readProtocolOp(reader);
}
/**
* Test the encode and decode methods and corner cases.
*
* @throws Exception If the test failed unexpectedly.
*/
@Test
public void testEncodeDecode() throws Exception
{
ByteStringBuilder builder = new ByteStringBuilder();
ASN1Writer writer = ASN1.getWriter(builder);
CompareResponseProtocolOp deleteEncoded;
CompareResponseProtocolOp deleteDecoded;
ArrayList<String> referralURLs = new ArrayList<String>();
referralURLs.add("ds1.example.com");
referralURLs.add("ds2.example.com");
referralURLs.add("ds3.example.com");
//Test case for a full encode decode operation with normal params.
deleteEncoded = new CompareResponseProtocolOp(resultCode, resultMsg, dn,
referralURLs);
deleteEncoded.write(writer);
ASN1Reader reader = ASN1.getReader(builder.toByteString());
deleteDecoded = (CompareResponseProtocolOp)LDAPReader.readProtocolOp(reader);
assertEquals(deleteEncoded.getType(), OP_TYPE_COMPARE_RESPONSE);
assertEquals(deleteEncoded.getMatchedDN().compareTo(
deleteDecoded.getMatchedDN()),
0);
assertEquals(deleteEncoded.getErrorMessage(),
deleteDecoded.getErrorMessage());
assertEquals(deleteEncoded.getResultCode(), deleteDecoded.getResultCode());
assertEquals(deleteEncoded.getReferralURLs(),
deleteDecoded.getReferralURLs());
//Test case for a full encode decode operation with an empty DN params.
deleteEncoded = new CompareResponseProtocolOp(resultCode, resultMsg, DN.nullDN(),
referralURLs);
builder.clear();
deleteEncoded.write(writer);
reader = ASN1.getReader(builder.toByteString());
deleteDecoded = (CompareResponseProtocolOp)LDAPReader.readProtocolOp(reader);
assertEquals(deleteDecoded.getMatchedDN(), null);
//Test case for a full empty referral url param.
ArrayList<String> emptyReferralURLs = new ArrayList<String>();
deleteEncoded = new CompareResponseProtocolOp(resultCode, resultMsg, dn,
emptyReferralURLs);
builder.clear();
deleteEncoded.write(writer);
reader = ASN1.getReader(builder.toByteString());
deleteDecoded = (CompareResponseProtocolOp)LDAPReader.readProtocolOp(reader);
assertTrue(deleteDecoded.getReferralURLs() == null);
//Test case for a full encode decode operation with resultCode param only.
deleteEncoded = new CompareResponseProtocolOp(resultCode);
builder.clear();
deleteEncoded.write(writer);
reader = ASN1.getReader(builder.toByteString());
deleteDecoded = (CompareResponseProtocolOp)LDAPReader.readProtocolOp(reader);
assertEquals(deleteDecoded.getMatchedDN(), null);
assertEquals(deleteDecoded.getErrorMessage(), null);
assertEquals(deleteEncoded.getResultCode(), deleteDecoded.getResultCode());
assertTrue(deleteDecoded.getReferralURLs() == null);
}
/**
* Test the toString (single line) method.
*
* @throws Exception If the test fails unexpectedly.
*/
@Test
public void TestToStringSingleLine() throws Exception
{
CompareResponseProtocolOp compareResponse;
StringBuilder buffer = new StringBuilder();
StringBuilder key = new StringBuilder();
ArrayList<String> referralURLs = new ArrayList<String>();
referralURLs.add("ds1.example.com");
referralURLs.add("ds2.example.com");
referralURLs.add("ds3.example.com");
compareResponse = new CompareResponseProtocolOp(resultCode, resultMsg, dn,
referralURLs);
compareResponse.toString(buffer);
key.append("CompareResponse(resultCode="+resultCode+", " +
"errorMessage="+resultMsg+", matchedDN="+dn.toString()+", " +
"referralURLs={");
Iterator<String> iterator = referralURLs.iterator();
key.append(iterator.next());
while (iterator.hasNext())
{
key.append(", ");
key.append(iterator.next());
}
key.append("})");
assertEquals(buffer.toString(), key.toString());
}
/**
* Test the toString (multi line) method.
*
* @throws Exception If the test fails unexpectedly.
*/
@Test
public void TestToStringMultiLine() throws Exception
{
CompareResponseProtocolOp compareResponse;
StringBuilder buffer = new StringBuilder();
StringBuilder key = new StringBuilder();
ArrayList<String> referralURLs = new ArrayList<String>();
referralURLs.add("ds1.example.com");
referralURLs.add("ds2.example.com");
referralURLs.add("ds3.example.com");
int indent = 5;
int i;
compareResponse = new CompareResponseProtocolOp(resultCode, resultMsg, dn,
referralURLs);
compareResponse.toString(buffer, indent);
StringBuilder indentBuf = new StringBuilder(indent);
for (i=0 ; i < indent; i++)
{
indentBuf.append(' ');
}
key.append(indentBuf);
key.append("Compare Response");
key.append(EOL);
key.append(indentBuf);
key.append(" Result Code: ");
key.append(resultCode);
key.append(EOL);
key.append(indentBuf);
key.append(" Error Message: ");
key.append(resultMsg);
key.append(EOL);
key.append(indentBuf);
key.append(" Matched DN: ");
key.append(dn.toString());
key.append(EOL);
key.append(indentBuf);
key.append(" Referral URLs: ");
key.append(EOL);
for (String url : referralURLs)
{
key.append(indentBuf);
key.append(" ");
key.append(url);
key.append(EOL);
}
assertEquals(buffer.toString(), key.toString());
}
}