# 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.

# The base class that should be used for tests.
from __future__ import absolute_import, division, print_function
import logging

from tests.common.test_vector import HS2, ImpalaTestMatrix

LOG = logging.getLogger('base_test_suite')


# Base class for tests.
class BaseTestSuite(object):
  ImpalaTestMatrix = ImpalaTestMatrix()

  @classmethod
  def add_test_dimensions(cls):
    """
    A hook for adding additional dimensions.

    By default load the table_info and exec_option dimensions, but if a test wants to
    add more dimensions or different dimensions they can override this function.
    """
    cls.ImpalaTestMatrix = ImpalaTestMatrix()

  @classmethod
  def default_test_protocol(cls):
    """See documentation in ImpalaTestSuite.default_test_protocol()."""
    return HS2