/*
 * 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.spark.sql.test.util

import org.scalatest.{FunSuite, Outcome}

import org.apache.carbondata.common.logging.LogServiceFactory

private[spark] abstract class CarbonFunSuite extends FunSuite {

  private val LOGGER = LogServiceFactory.getLogService(this.getClass.getCanonicalName)

  /**
   * Log the suite name and the test name before and after each test.
   *
   * Subclasses should never override this method. If they wish to run
   * custom code before and after each test, they should mix in
   * the {{org.scalatest.BeforeAndAfter}} trait instead.
   */
  final protected override def withFixture(test: NoArgTest): Outcome = {
    val testName = test.text
    val suiteName = this.getClass.getName
    val shortSuiteName = suiteName.replaceAll("org.apache.spark", "o.a.s")
    try {
      LOGGER.info(s"\n\n===== TEST OUTPUT FOR $shortSuiteName: '$testName' =====\n")
      test()
    } finally {
      LOGGER.info(s"\n\n===== FINISHED $shortSuiteName: '$testName' =====\n")
    }
  }

  protected def test(testName : scala.Predef.String, ignoreForIndexServer: Boolean,
                     testTags : org.scalatest.Tag*)
                    (testFun : => Unit): Unit = {
    if (ignoreForIndexServer) {
      // To skip testcase when useIndexServer property is set.
      if (System.getProperty("useIndexServer") == null) {
        super.test(testName)(testFun)
      }
    } else {
      // To run the testcase only when useIndexServer property is set.
      if (System.getProperty("useIndexServer") != null) {
        super.test(testName)(testFun)
      }
    }
  }

}
