/*
 *  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
 *
 *    http://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.server.core.jndi;


import static org.apache.directory.server.core.integ.IntegrationUtils.getSystemContext;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;

import javax.naming.NamingEnumeration;
import javax.naming.NamingException;
import javax.naming.directory.Attribute;
import javax.naming.directory.Attributes;
import javax.naming.directory.BasicAttribute;
import javax.naming.directory.BasicAttributes;
import javax.naming.directory.DirContext;
import javax.naming.ldap.LdapContext;

import org.apache.directory.api.ldap.model.ldif.LdifUtils;
import org.apache.directory.server.core.annotations.CreateDS;
import org.apache.directory.server.core.integ.AbstractLdapTestUnit;
import org.apache.directory.server.core.integ.ApacheDSTestExtension;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;


/**
 * Contributed by Luke Taylor to fix DIRSERVER-169.
 *
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
@ExtendWith( ApacheDSTestExtension.class )
@CreateDS(name = "AddIT")
public class AddJndiIT extends AbstractLdapTestUnit
{
    /**
     * Test that attribute name case is preserved after adding an entry
     * in the case the user added them.  This is to test DIRSERVER-832.
     */
    @Test
    public void testAddCasePreservedOnAttributeNames() throws Exception
    {
        LdapContext sysRoot = getSystemContext( getService() );
        
        Attributes attrs = new BasicAttributes( true );
        Attribute oc = new BasicAttribute( "ObjectClass", "top" );
        oc.add( "PERSON" );
        oc.add( "organizationalPerson" );
        oc.add( "inetORGperson" );
        Attribute cn = new BasicAttribute( "Cn", "Kevin Spacey" );
        Attribute dc = new BasicAttribute( "sN", "Spacey" );
        attrs.put( oc );
        attrs.put( cn );
        attrs.put( dc);
        sysRoot.createSubcontext( "uID=kevin", attrs );
        Attributes returned = sysRoot.getAttributes( "UID=kevin" );
        
        NamingEnumeration<? extends Attribute> attrList = returned.getAll();
        
        while( attrList.hasMore() )
        {
            Attribute attr = attrList.next();
            
            if ( attr.getID().equalsIgnoreCase( "uid" ) )
            {
                assertEquals( "uid", attr.getID() );
            }
            
            if ( attr.getID().equalsIgnoreCase( "objectClass" ) )
            {
                assertEquals( "objectClass", attr.getID() );
            }
            
            if ( attr.getID().equalsIgnoreCase( "sn" ) )
            {
                assertEquals( "sn", attr.getID() );
            }
            
            if ( attr.getID().equalsIgnoreCase( "cn" ) )
            {
                assertEquals( "cn", attr.getID() );
            }
        }
    }

    /**
     * Test that we can't add an entry with an attribute type not within
     * any of the MUST or MAY of any of its objectClasses
     * 
     * @throws Exception on error
     */
    @Test
    public void testAddAttributesNotInObjectClasses() throws Exception
    {
        LdapContext sysRoot = getSystemContext( getService() );

        Attributes attrs = LdifUtils.createJndiAttributes(
            "ObjectClass: top",
            "cn: kevin Spacey",
            "dc: ke" );

        String base = "uid=kevin";

        //create subcontext
        try
        {
            sysRoot.createSubcontext( base, attrs );
            fail( "Should not reach this state" );
        }
        catch ( NamingException e )
        {
            assertTrue( true );
        }
    }


    /**
     * Test that we can't add an entry with an attribute with a bad syntax
     *
     * @throws Exception on error
     */
    @Test
    public void testAddAttributesBadSyntax() throws Exception
    {
        LdapContext sysRoot = getSystemContext( getService() );

        Attributes attrs = LdifUtils.createJndiAttributes(
            "ObjectClass: top",
            "ObjectClass: person",
            "cn: kevin Spacey",
            "sn: ke",
            "telephoneNumber: 0123456abc" );

        String base = "sn=kevin";

        // create subcontext
        try
        {
            sysRoot.createSubcontext( base, attrs );
            fail( "Should not reach this state" );
        }
        catch ( NamingException e )
        {
            assertTrue( true );
        }
    }


    /**
     * test case for DIRSERVER-1442
     */
    @Test
    public void testAddAttributeWithEscapedPlusCharacter() throws Exception
    {
        Attributes entry = LdifUtils.createJndiAttributes(
            "ObjectClass: top",
            "ObjectClass: inetorgperson",
            "cn: John+Doe",
            "sn: +Name+" );

        LdapContext sysRoot = getSystemContext( getService() );
        DirContext dc = sysRoot.createSubcontext( "cn=John\\+Doe", entry );

        ServerLdapContext sc = ( ServerLdapContext ) dc;

        assertTrue( sc.getDn().toString().contains( "+" ) );

        try
        {
            Object obj = sysRoot.lookup( "cn=John\\+Doe" );
            assertNotNull( obj );
        }
        catch ( Exception e )
        {
            fail( e.getMessage() );
        }

        try
        {
            Attributes result = sysRoot.getAttributes( "cn=John\\+Doe" );
            assertNotNull( result );

            Attribute cn = result.get( "cn" );
            assertNotNull( cn );
            assertEquals( 1, cn.size() );
        }
        catch ( Exception e )
        {
            fail( e.getMessage() );
        }
    }
}
