#!/usr/bin/python
# -*- coding: us-ascii -*-
# vim:ts=4:sw=4:softtabstop=0:smarttab

"""
Module Heading XXX
------------------

Some information about this module.

"""

from pycopia.QA import core


class XXXSampleTest(core.Test):
    """
    Purpose
    +++++++

    The purpose of this test case.

    Pass Criteria
    +++++++++++++

    What is the pass criteria?

    Start Condition
    +++++++++++++++

    What is the state of the DUT this test needs?

    End Condition
    +++++++++++++

    What changes to the condition or state of the DUT are made?

    Reference
    +++++++++

    Reference to design document or specification clause.

    Prerequistes
    ++++++++++++

    What tests must pass in order for this test to be ready to run?

    Procedure
    +++++++++

    - Step 1...
    - Step 2...
    - Step 3...

    """
    PREREQUISITES = []

    def execute(self):
        return self.incomplete("not implemented")


def get_suite(config):
    suite = core.TestSuite(config, name="MyNewSuite")
    suite.add_test(XXXSampleTest)
    return suite

def run(config):
    suite = get_suite(config)
    suite.run()