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

"""Test configurations for nose

This module contains nose plugin hooks that configures Beam tests which
includes ValidatesRunner test and E2E integration test.

TODO(BEAM-3713): Remove this module once nose is removed.
"""

from __future__ import absolute_import

from nose.plugins import Plugin


class BeamTestPlugin(Plugin):
  """A nose plugin for Beam testing that registers command line options

  This plugin is registered through setuptools in entry_points.
  """

  def options(self, parser, env):
    """Add '--test-pipeline-options' and '--not_use-test-runner-api'
    to command line option to avoid unrecognized option error thrown by nose.

    The value of this option will be processed by TestPipeline and used to
    build customized pipeline for ValidatesRunner tests.
    """
    parser.add_option('--test-pipeline-options',
                      action='store',
                      type=str,
                      help='providing pipeline options to run tests on runner')
    parser.add_option('--not-use-test-runner-api',
                      action='store_true',
                      default=False,
                      help='whether not to use test-runner-api')