/*
 * Copyright (c) 2007, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

/*
 * $Id$
 */

package com.sun.ts.tests.common.webclient;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.sun.ts.lib.util.TestUtil;

/**
 * This class represents a logic sequence for executing a series of test cases
 * in a specific order. In this case, the execution order will be the same order
 * that the test cases were added to the sequence.
 *
 * The <code>TestSequence</code> has the added benefit of managing state between
 * the test invocations.
 */
public class TestSequence implements TestCase {

  private Map<String, TestCase> _testMap = null;

  private List<String> _testNameList = null;

  private String _name = "DEFAULT";

  private boolean _managed = false;

  /** Creates a new instance of TestSequence */
  public TestSequence() {
    _testMap = new HashMap<String, TestCase>();
    _testNameList = new ArrayList<String>();
  }

  /*
   * public methods
   * ========================================================================
   */

  /**
   * Executes the test sequence.
   *
   * @throws TestFailureException
   *           if any test in the sequence fails.
   */
  public void execute() throws TestFailureException {

    TestUtil.logTrace("[TestSequence] Beginning execution of sequence '" + _name
        + "' containing '" + _testNameList.size() + "' test entities.");

    TestCase cse;
    for (int i = 0, size = _testNameList.size(); i < size; i++) {
      String testName = _testNameList.get(i);
      TestUtil.logTrace("[TestSequence] Executing test case: " + testName);
      cse = _testMap.get(testName);
      if (_managed) {
        cse.setState(cse.getState());
      }
      cse.execute();
      TestUtil.logTrace("[TestSequence] Test case: " + testName + "complete.");
    }
    TestUtil.logTrace("[TestSequence] Sequence complete!");
  }

  /**
   * <code>enableStateManagement</code>, when enabled, will cause the test
   * sequence to manage state between test case invocations. By default, a test
   * sequence will not manage state.
   *
   * @param value
   *          a value of true enables session management.
   */
  public void enableStateManagement(boolean value) {
    _managed = value;
  }

  /**
   * Returns a value indicating whether state management is enabled or not.
   *
   * @return boolean value indicating state management status
   */
  public boolean isStateManagementEnabled() {
    return _managed;
  }

  /**
   * Adds a test case to the sequence denoted by a unique identifier.
   *
   * @param identifier
   *          for this test case
   * @param cs
   *          the test case
   */
  public void addTestCase(String identifier, TestCase cs) {
    _testMap.put(identifier, cs);
    _testNameList.add(identifier);
  }

  /**
   * Removes a test case from the sequence.
   *
   * @param identifier
   */
  public void removeTestCase(String identifier) {
    _testMap.remove(identifier);
    _testNameList.remove(identifier);
  }

  /**
   * Sets the name of this TestSequence. If not set, the default value is
   * "DEFAULT".
   *
   * @param name
   */
  public void setName(String name) {
    _name = name;
  }

  /**
   * Returns the name of this TestSequence.
   *
   * @return sequence name
   */
  public String getName() {
    return _name;
  }

  /**
   * Sets the initial state for the test sequence to use when invoking test
   * cases.
   *
   * @param state
   *          the initial state
   */
  public void setState(Object state) {
  }

  /**
   * Returns the state of the sequence. Note: This value can differ depending on
   * when it has been called in relation to when execute has been called.
   *
   * @return state of the sequence
   */
  public Object getState() {
    throw new UnsupportedOperationException();
  }

}
