/*
*
* 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.
*
*/
using System;
using System.Text;
using Apache.Qpid.Messaging;
namespace Apache.Qpid.Integration.Tests.interop
{
/// Defines the possible test case roles that an interop test case can take on.
public enum Roles { SENDER, RECEIVER };
///
/// InteropClientTestCase provides an interface that classes implementing test cases from the interop testing spec
/// (http://cwiki.apache.org/confluence/display/qpid/Interop+Testing+Specification) should implement.
///
///
CRC Card
///
Responsibilities
///
Supply the name of the test case that this implements.
///
Accept/Reject invites based on test parameters.
///
Adapt to assigned roles.
///
Perform test case actions.
///
Generate test reports.
///
///
interface InteropClientTestCase
{
///
/// Should provide the name of the test case that this class implements. The exact names are defined in the
/// interop testing spec.
///
///
/// The name of the test case that this implements.
string GetName();
///
/// Determines whether the test invite that matched this test case is acceptable.
///
///
/// The invitation to accept or reject.
///
/// true to accept the invitation, false to reject it.
///
/// @throws JMSException Any JMSException resulting from reading the message are allowed to fall through.
bool AcceptInvite(IMessage inviteMessage);
///
/// Assigns the role to be played by this test case. The test parameters are fully specified in the
/// assignment message. When this method return the test case will be ready to execute.
///
///
/// The role to be played; sender or receiver.
/// The role assingment message, contains the full test parameters.
void AssignRole(Roles role, IMessage assignRoleMessage);
///
/// Performs the test case actions.
///
void Start();
///
/// Gets a report on the actions performed by the test case in its assigned role.
///
///
/// The session to create the report message in.
///
/// The report message.
IMessage GetReport(IChannel channel);
}
}