/*
 *
 * 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.qpid.interop.coordinator;

import junit.framework.Assert;

/**
 * An OptOutTestCase is a test case that automatically fails. It is used when a list of test clients has been generated
 * from a compulsory invite, but only some of those clients have responded to a specific test case invite. The clients
 * that did not respond, are automatically given a fail for the test.
 *
 * <p><table id="crc"><caption>CRC Card</caption>
 * <tr><th> Responsibilities <th> Collaborations
 * <tr><td> Fail the test with a suitable reason.
 * </table>
 */
public class OptOutTestCase extends CoordinatingTestCase
{
    /**
     * Creates a new coordinating test case with the specified name.
     *
     * @param name The test case name.
     */
    public OptOutTestCase(String name)
    {
        super(name);
    }

    /** Generates an appropriate test failure assertion. */
    public void testOptOut()
    {
        Assert.fail("One of " + getSender() + " and " + getReceiver() + " opted out of the test.");
    }
}
