/**
 * 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.activemq.jaas;

import static org.junit.Assert.assertTrue;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;

import javax.security.auth.Subject;
import javax.security.auth.callback.CallbackHandler;

import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ErrorCollector;
import org.junit.rules.TemporaryFolder;
import org.junit.rules.TestName;

public class PropertiesLoginModuleRaceConditionTest {

    private static final String GROUPS_FILE = "groups.properties";
    private static final String USERS_FILE = "users.properties";
    private static final String USERNAME = "first";
    private static final String PASSWORD = "secret";
    private static final int TOTAL_LOGIN_ATTEMPTS = 25000;

    @Rule
    public final ErrorCollector e = new ErrorCollector();

    @Rule
    public final TemporaryFolder temp = new TemporaryFolder();

    @Rule
    public final TestName name = new TestName();

    private Map<String, String> options;
    private BlockingQueue<Exception> errors;
    private ExecutorService pool;
    private CallbackHandler callback;

    private static class LoginTester implements Runnable {
        private final CountDownLatch finished;
        private final BlockingQueue<Exception> errors;
        private final Map<String, String> options;
        private final CountDownLatch start;
        private final CallbackHandler callback;

        LoginTester(CountDownLatch start, CountDownLatch finished,
                BlockingQueue<Exception> errors, Map<String, String> options,
                CallbackHandler callbackHandler) {
            this.finished = finished;
            this.errors = errors;
            this.options = options;
            this.start = start;
            this.callback = callbackHandler;
        }

        @Override
        public void run() {
            try {
                start.await();

                Subject subject = new Subject();
                PropertiesLoginModule module = new PropertiesLoginModule();
                module.initialize(subject, callback, new HashMap<Object, Object>(),
                        options);
                module.login();
                module.commit();
            } catch (Exception e) {
                errors.offer(e);
            } finally {
                finished.countDown();
            }
        }
    }

    @Before
    public void before() throws FileNotFoundException, IOException {
        createUsers();
        createGroups();

        options = new HashMap<String, String>();
        options.put("reload", "true"); // Used to simplify reproduction of the
                                        // race condition
        options.put("org.apache.activemq.jaas.properties.user", USERS_FILE);
        options.put("org.apache.activemq.jaas.properties.group", GROUPS_FILE);
        options.put("baseDir", temp.getRoot().getAbsolutePath());

        // Large enough to hold all potential errors from concurrent attempts
        errors = new ArrayBlockingQueue<Exception>(TOTAL_LOGIN_ATTEMPTS);
        pool = Executors.newFixedThreadPool(processorCount());
        callback = new JassCredentialCallbackHandler(USERNAME, PASSWORD);
    }

    @After
    public void after() throws InterruptedException {
        pool.shutdown();
        assertTrue(pool.awaitTermination(500, TimeUnit.SECONDS));
        PropertiesLoader.resetUsersAndGroupsCache();
    }

    @Test
    public void raceConditionInUsersAndGroupsLoading() throws InterruptedException, FileNotFoundException, IOException {

        // Brute force approach to increase the likelihood of the race condition occurring
        // Submit many concurrent login attempts and let the thread pool handle concurrency
        final CountDownLatch start = new CountDownLatch(1);
        final CountDownLatch finished = new CountDownLatch(TOTAL_LOGIN_ATTEMPTS);

        // Submit all login tasks to the pool
        for (int i = 0; i < TOTAL_LOGIN_ATTEMPTS; i++) {
            pool.submit(new LoginTester(start, finished, errors, options, callback));
        }

        // Release all threads simultaneously to maximize concurrent load
        start.countDown();

        // Wait for all attempts to complete
        finished.await();

        if (isRaceConditionDetected()) {
            e.addError(new AssertionError("At least one race condition in PropertiesLoginModule "
                    + "has been encountered. Please examine the "
                    + "following stack traces for more details:"));
            for (Exception exception : errors) {
                e.addError(exception);
            }
        }
    }

    private boolean isRaceConditionDetected() {
        return errors.size() > 0;
    }

    private int processorCount() {
        return Runtime.getRuntime().availableProcessors();
    }

    private void store(Properties from, File to) throws FileNotFoundException, IOException {
        FileOutputStream output = new FileOutputStream(to);
        try {
            from.store(output, "Generated by " + name.getMethodName());
        } finally {
            output.close();
        }
    }

    private void createGroups() throws FileNotFoundException, IOException {
        Properties groups = new Properties();
        for (int i = 0; i < 100; i++) {
            groups.put("group" + i, "first,second,third");
        }
        store(groups, temp.newFile(GROUPS_FILE));
    }

    private void createUsers() throws FileNotFoundException, IOException {
        Properties users = new Properties();
        users.put(USERNAME, PASSWORD);
        users.put("second", PASSWORD);
        users.put("third", PASSWORD);
        store(users, temp.newFile(USERS_FILE));
    }
}
