/****************************************************************
 * Copyright (C) 2006 LAMS Foundation (http://lamsfoundation.org)
 * =============================================================
 * License Information: http://lamsfoundation.org/licensing/lams/2.0/
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2.0
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
 * USA
 *
 * http://www.gnu.org/licenses/gpl.txt
 * ****************************************************************
 */
package org.lamsfoundation.testharness.admin;

import org.lamsfoundation.testharness.AbstractTest;
import org.lamsfoundation.testharness.TestUtil;

/**
 * @version
 *
 *          <p>
 *          <a href="AdminTest.java.html"><i>View Source</i></a>
 *          </p>
 *
 * @author <a href="mailto:fyang@melcoe.mq.edu.au">Fei Yang</a>
 */
public class AdminTest extends AbstractTest {

    private static final String DEFAULT_COURSE_NAME = "Course";

    private String createCourseURL;
    private String createUserURL;
    private String addRolesURL;
    private String courseName;
    private String courseId;
    private String storedUsersFileName;

    public AdminTest(String testName, Integer minDelay, Integer maxDelay, String createCourseURL, String createUserURL,
	    String addRolesURL, String courseId, String courseName, String storedUsersFileName) {
	super(testName, minDelay, maxDelay);
	this.createCourseURL = createCourseURL;
	this.createUserURL = createUserURL;
	this.addRolesURL = addRolesURL;
	this.courseName = courseName == null ? TestUtil.buildName(testName, AdminTest.DEFAULT_COURSE_NAME)
		: TestUtil.buildName(testName, courseName);
	this.courseId = courseId;
	this.storedUsersFileName = storedUsersFileName;
    }

    public final String getCourseId() {
	return courseId;
    }

    public final String getCourseName() {
	return courseName;
    }

    public final void setCourseId(String courseId) {
	this.courseId = courseId;
    }

    public final void setCourseName(String courseName) {
	this.courseName = courseName;
    }

    /**
     * let MockAdmin do what he should do login, create course and then create users
     *
     * @exception TestHarnessExcepton
     * @exception RuntimeException
     */
    @Override
    protected void startTest() {
	MockAdmin admin = (MockAdmin) users[0];
	admin.login();
	if (courseId == null) {
	    setCourseId(admin.createCourse(createCourseURL, courseName));
	}
	admin.createUsers(createUserURL, addRolesURL, courseId, storedUsersFileName);
    }
}