src/test/java/org/apache/sling/serviceusermapping/impl/ServiceUserMapperImplTest.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
 *
 *   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.sling.serviceusermapping.impl;

import java.util.Dictionary;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.Map;

import junit.framework.TestCase;

import org.apache.sling.commons.testing.osgi.MockBundle;
import org.apache.sling.serviceusermapping.ServiceUserMapping;
import org.apache.sling.serviceusermapping.ServiceUserValidator;
import org.apache.sling.commons.testing.osgi.MockBundleContext;
import org.junit.Test;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.Constants;
import org.osgi.framework.ServiceReference;
import org.osgi.framework.ServiceRegistration;

public class ServiceUserMapperImplTest {
    private static final String BUNDLE_SYMBOLIC1 = "bundle1";

    private static final String BUNDLE_SYMBOLIC2 = "bundle2";

    private static final String SUB = "sub";

    private static final String NONE = "none";

    private static final String SAMPLE = "sample";

    private static final String ANOTHER = "another";

    private static final String SAMPLE_SUB = "sample_sub";

    private static final String ANOTHER_SUB = "another_sub";

    private static final Bundle BUNDLE1 = new MockBundle(10) {
        @Override
        public String getSymbolicName() {
            return BUNDLE_SYMBOLIC1;
        };

        @Override
        public java.util.Dictionary<?, ?> getHeaders() {
            return new Hashtable<String, Object>();
        };

        @Override
        public java.util.Dictionary<?, ?> getHeaders(String locale) {
            return getHeaders();
        };
    };


    private static final Bundle BUNDLE2 = new MockBundle(10) {
        @Override
        public String getSymbolicName() {
            return BUNDLE_SYMBOLIC2;
        };

        @Override
        public java.util.Dictionary<?, ?> getHeaders(String locale) {
            return getHeaders();
        };
    };


    @Test
    public void test_getServiceUserID() {
        @SuppressWarnings("serial")
        Map<String, Object> config = new HashMap<String, Object>() {
            {
                put("user.mapping", new String[] {
                    BUNDLE_SYMBOLIC1 + "=" + SAMPLE, //
                    BUNDLE_SYMBOLIC2 + "=" + ANOTHER, //
                    BUNDLE_SYMBOLIC1 + ":" + SUB + "=" + SAMPLE_SUB, //
                    BUNDLE_SYMBOLIC2 + ":" + SUB + "=" + ANOTHER_SUB //
                });
                put("user.default", NONE);
            }
        };

        final ServiceUserMapperImpl sum = new ServiceUserMapperImpl();
        sum.configure(null, config);

        TestCase.assertEquals(SAMPLE, sum.getServiceUserID(BUNDLE1, null));
        TestCase.assertEquals(ANOTHER, sum.getServiceUserID(BUNDLE2, null));
        TestCase.assertEquals(SAMPLE, sum.getServiceUserID(BUNDLE1, ""));
        TestCase.assertEquals(ANOTHER, sum.getServiceUserID(BUNDLE2, ""));
        TestCase.assertEquals(SAMPLE_SUB, sum.getServiceUserID(BUNDLE1, SUB));
        TestCase.assertEquals(ANOTHER_SUB, sum.getServiceUserID(BUNDLE2, SUB));
    }
    
    @Test
    public void test_getServiceUserID_WithServiceUserValidator() {
        @SuppressWarnings("serial")
        Map<String, Object> config = new HashMap<String, Object>() {
            {
                put("user.mapping", new String[] {
                    BUNDLE_SYMBOLIC1 + "=" + SAMPLE, //
                    BUNDLE_SYMBOLIC2 + "=" + ANOTHER, //
                    BUNDLE_SYMBOLIC1 + ":" + SUB + "=" + SAMPLE_SUB, //
                    BUNDLE_SYMBOLIC2 + ":" + SUB + "=" + ANOTHER_SUB //
                });
                put("user.default", NONE);
            }
        };

        final ServiceUserMapperImpl sum = new ServiceUserMapperImpl();
        sum.configure(null, config);
        ServiceUserValidator serviceUserValidator = new ServiceUserValidator() {
            
            public boolean isValid(String serviceUserId, String serviceName,
                    String subServiceName) {
                if (SAMPLE.equals(serviceUserId)) {
                    return false;
                }
                return true;
            }
        };
        sum.bindServiceUserValidator(serviceUserValidator, null);

        TestCase.assertEquals(null, sum.getServiceUserID(BUNDLE1, null));
        TestCase.assertEquals(ANOTHER, sum.getServiceUserID(BUNDLE2, null));
        TestCase.assertEquals(null, sum.getServiceUserID(BUNDLE1, ""));
        TestCase.assertEquals(ANOTHER, sum.getServiceUserID(BUNDLE2, ""));
        TestCase.assertEquals(SAMPLE_SUB, sum.getServiceUserID(BUNDLE1, SUB));
        TestCase.assertEquals(ANOTHER_SUB, sum.getServiceUserID(BUNDLE2, SUB));
    }

    @Test
    public void test_amendment() {
        @SuppressWarnings("serial")
        Map<String, Object> config = new HashMap<String, Object>() {
            {
                put("user.mapping", new String[] {
                    BUNDLE_SYMBOLIC1 + "=" + SAMPLE, //
                    BUNDLE_SYMBOLIC1 + ":" + SUB + "=" + SAMPLE_SUB, //
                });
                put("user.default", NONE);
            }
        };

        final ServiceUserMapperImpl sum = new ServiceUserMapperImpl();
        sum.configure(null, config);
        final MappingConfigAmendment mca1 = new MappingConfigAmendment();
        @SuppressWarnings("serial")
        final Map<String, Object> mca1Config = new HashMap<String, Object>() {
            {
                put("user.mapping", new String [] {BUNDLE_SYMBOLIC2 + "=" + ANOTHER});
                put(Constants.SERVICE_ID, 1L);
                put(Constants.SERVICE_RANKING, 100);
            }
        };
        mca1.configure(mca1Config);
        sum.bindAmendment(mca1, mca1Config);
        final MappingConfigAmendment mca2 = new MappingConfigAmendment();
        @SuppressWarnings("serial")
        final Map<String, Object> mca2Config = new HashMap<String, Object>() {
            {
                put("user.mapping", new String [] {BUNDLE_SYMBOLIC2 + ":" + SUB + "=" + ANOTHER_SUB});
                put(Constants.SERVICE_ID, 2L);
                put(Constants.SERVICE_RANKING, 200);
            }
        };
        mca2.configure(mca2Config);
        sum.bindAmendment(mca2, mca2Config);

        TestCase.assertEquals(SAMPLE, sum.getServiceUserID(BUNDLE1, null));
        TestCase.assertEquals(ANOTHER, sum.getServiceUserID(BUNDLE2, null));
        TestCase.assertEquals(SAMPLE, sum.getServiceUserID(BUNDLE1, ""));
        TestCase.assertEquals(ANOTHER, sum.getServiceUserID(BUNDLE2, ""));
        TestCase.assertEquals(SAMPLE_SUB, sum.getServiceUserID(BUNDLE1, SUB));
        TestCase.assertEquals(ANOTHER_SUB, sum.getServiceUserID(BUNDLE2, SUB));
    }

    @Test
    public void test_amendmentOverlap() {
        @SuppressWarnings("serial")
        final Map<String, Object> config = new HashMap<String, Object>() {
            {
                put("user.default", NONE);
            }
        };

        final ServiceUserMapperImpl sum = new ServiceUserMapperImpl();
        sum.configure(null, config);

        final MappingConfigAmendment mca1 = new MappingConfigAmendment();
        @SuppressWarnings("serial")
        final Map<String, Object> mca1Config = new HashMap<String, Object>() {
            {
                put("user.mapping", new String [] {BUNDLE_SYMBOLIC2 + "=" + ANOTHER});
                put(Constants.SERVICE_RANKING, 100);
            }
        };
        mca1.configure(mca1Config);
        final MappingConfigAmendment mca2 = new MappingConfigAmendment();
        @SuppressWarnings("serial")
        final Map<String, Object> mca2Config = new HashMap<String, Object>() {
            {
                put("user.mapping", new String [] {BUNDLE_SYMBOLIC2 + "=" + ANOTHER_SUB});
                put(Constants.SERVICE_RANKING, 200);
            }
        };
        mca2.configure(mca2Config);

        sum.bindAmendment(mca1, mca1Config);
        sum.bindAmendment(mca2, mca2Config);

        TestCase.assertEquals(ANOTHER_SUB, sum.getServiceUserID(BUNDLE2, ""));
    }



    @Test
    public void test_amendmentServiceUserMapping() {
        @SuppressWarnings("serial")
        Map<String, Object> config = new HashMap<String, Object>() {
            {
                put("user.mapping", new String[] {
                        BUNDLE_SYMBOLIC1 + "=" + SAMPLE, //
                        BUNDLE_SYMBOLIC1 + ":" + SUB + "=" + SAMPLE_SUB, //
                });
                put("user.default", NONE);
            }
        };

        final ServiceUserMapperImpl sum = new ServiceUserMapperImpl();
        final ServiceRegistrationContext bundleContext = new ServiceRegistrationContext();
        sum.configure(bundleContext, config);

        TestCase.assertEquals(2, bundleContext.getRegistrations(ServiceUserMapping.class.getName()).size());

        final MappingConfigAmendment mca1 = new MappingConfigAmendment();
        @SuppressWarnings("serial")
        final Map<String, Object> mca1Config = new HashMap<String, Object>() {
            {
                put("user.mapping", new String [] {BUNDLE_SYMBOLIC2 + "=" + ANOTHER});
                put(Constants.SERVICE_ID, 1L);
                put(Constants.SERVICE_RANKING, 100);
            }
        };
        mca1.configure(mca1Config);
        sum.bindAmendment(mca1, mca1Config);

        TestCase.assertEquals(3, bundleContext.getRegistrations(ServiceUserMapping.class.getName()).size());

        final MappingConfigAmendment mca2 = new MappingConfigAmendment();
        @SuppressWarnings("serial")
        final Map<String, Object> mca2Config = new HashMap<String, Object>() {
            {
                put("user.mapping", new String [] {BUNDLE_SYMBOLIC2 + ":" + SUB + "=" + ANOTHER_SUB});
                put(Constants.SERVICE_ID, 2L);
                put(Constants.SERVICE_RANKING, 200);
            }
        };
        mca2.configure(mca2Config);
        sum.bindAmendment(mca2, mca2Config);

        TestCase.assertEquals(4, bundleContext.getRegistrations(ServiceUserMapping.class.getName()).size());

        sum.unbindAmendment(mca1, mca1Config);

        TestCase.assertEquals(3, bundleContext.getRegistrations(ServiceUserMapping.class.getName()).size());
    }


    private class ServiceRegistrationContext extends MockBundleContext {



        final Map<String, Map<Object, Dictionary>> registrations = new HashMap<String, Map<Object, Dictionary>>();

        public ServiceRegistrationContext() {
            super(null);
        }

        @Override
        public ServiceRegistration registerService(String string, Object o, Dictionary dictionary) {
            if (!registrations.containsKey(string)) {
                registrations.put(string, new HashMap<Object, Dictionary>());
            }
            final Map<Object, Dictionary> serviceRegistrations = registrations.get(string);
            serviceRegistrations.put(o, dictionary);

            final Object registeredObject = o;


            return new ServiceRegistration() {
                public ServiceReference getReference() {
                    return null;
                }

                public void setProperties(Dictionary dictionary) {

                }

                public void unregister() {
                    serviceRegistrations.remove(registeredObject);
                }
            };
        }

        public Map<Object, Dictionary> getRegistrations(String name) {
            return registrations.get(name);
        }

    }

}