/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup RtemsMessageValIdent
 */

/*
 * Copyright (C) 2020 embedded brains GmbH & Co. KG
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * This file is part of the RTEMS quality process and was automatically
 * generated.  If you find something that needs to be fixed or
 * worded better please post a report or patch to an RTEMS mailing list
 * or raise a bug report:
 *
 * https://www.rtems.org/bugs.html
 *
 * For information on updating and regenerating please refer to the How-To
 * section in the Software Requirements Engineering chapter of the
 * RTEMS Software Engineering manual.  The manual is provided as a part of
 * a release.  For development sources please refer to the online
 * documentation at:
 *
 * https://docs.rtems.org
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "tr-object-ident.h"

#include <rtems/test.h>

/**
 * @defgroup RtemsMessageValIdent spec:/rtems/message/val/ident
 *
 * @ingroup TestsuitesValidationNoClock0
 *
 * @brief Test the rtems_message_queue_ident() directive.
 *
 * This test case performs the following actions:
 *
 * - Run the generic object identification tests for Classic API message queue
 *   class objects defined by spec:/rtems/req/ident.
 *
 * @{
 */

#define NAME_LOCAL_OBJECT rtems_build_name( 'M', 'E', 'S', 'Q' )

static RTEMS_MESSAGE_QUEUE_BUFFER( 1 ) ClassicMessageIdentBuffers[ 1 ];

static rtems_message_queue_config ClassicObjectIdentConfig = {
  .name = NAME_LOCAL_OBJECT,
  .maximum_pending_messages = RTEMS_ARRAY_SIZE( ClassicMessageIdentBuffers ),
  .maximum_message_size = 1,
  .storage_area = ClassicMessageIdentBuffers,
  .storage_size = sizeof( ClassicMessageIdentBuffers ),
  .attributes = RTEMS_DEFAULT_ATTRIBUTES
};

static rtems_status_code ClassicMessageIdentAction(
  rtems_name name,
  uint32_t   node,
  rtems_id  *id
)
{
  return rtems_message_queue_ident( name, node, id );
}

/**
 * @brief Run the generic object identification tests for Classic API message
 *   queue class objects defined by spec:/rtems/req/ident.
 */
static void RtemsMessageValIdent_Action_0( void )
{
  rtems_status_code sc;
  rtems_id          id_local_object;

  sc = rtems_message_queue_construct(
    &ClassicObjectIdentConfig,
    &id_local_object
  );
  T_assert_rsc_success( sc );

  RtemsReqIdent_Run(
    id_local_object,
    NAME_LOCAL_OBJECT,
    ClassicMessageIdentAction
  );

  sc = rtems_message_queue_delete( id_local_object );
  T_rsc_success( sc );
}

/**
 * @fn void T_case_body_RtemsMessageValIdent( void )
 */
T_TEST_CASE( RtemsMessageValIdent )
{
  RtemsMessageValIdent_Action_0();
}

/** @} */