/* SPDX-License-Identifier: Apache-2.0 */

/*
 * Copyright 2020-2023 Joel E. Anderson
 *
 * Licensed 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.
 */

#ifndef __STUMPLESS_TEST_HELPER_FIXTURE_HPP
#  define __STUMPLESS_TEST_HELPER_FIXTURE_HPP

#  include <cstdlib>
#  include <gtest/gtest.h>
#  include <string>
#  include <stumpless.h>

#  define BUFFER_TARGET_FIXTURE_CLASS( CLASS_NAME )                            \
class CLASS_NAME : public::testing::Test {                                     \
protected:                                                                     \
  char buffer[8192];                                                           \
  struct stumpless_target *target;                                             \
  struct stumpless_entry *basic_entry;                                         \
  const char *basic_message;                                                   \
                                                                               \
  virtual void                                                                 \
  SetUp( void ) {                                                              \
    buffer[0] = '\0';                                                          \
    target = stumpless_open_buffer_target( "info level testing",               \
                                           buffer,                             \
                                           sizeof( buffer ) );                 \
                                                                               \
    stumpless_set_target_default_app_name( target, "info-level-test" );        \
    stumpless_set_target_default_msgid( target, "default-message" );           \
    basic_entry = create_entry(  );                                            \
    basic_message = stumpless_get_entry_message( basic_entry );                \
  }                                                                            \
                                                                               \
  virtual void                                                                 \
  TearDown( void ) {                                                           \
    free( ( void * ) basic_message );                                          \
    stumpless_destroy_entry_and_contents( basic_entry );                       \
    stumpless_close_buffer_target( target );                                   \
  }                                                                            \
}

struct stumpless_entry *
create_empty_entry( void );

struct stumpless_entry *
create_entry( void );

/**
 * Creates an entry with all nullable fields set to NULL.
 *
 * @since release v2.2.0
 *
 * @return The newly-created entry, or NULL if an error occurred.
 */
struct stumpless_entry *
create_nil_entry( void );

/**
 * Returns a buffer holding the contents of the fuzz corpus file at the named
 * location in the test/corpora folder. For example, a name of "message/ascii"
 * will return the contents of the test/corpora/message/ascii file.
 *
 * The returned buffer must be destroyed with the delete[] operator when it is
 * no longer needed to avoid memory leaks.
 *
 * @param name The corpus file name.
 *
 * @return a buffer holding the contents of the file, or NULL if an error
 * occurred.
 */
const char *
load_corpus( const std::string& name );

#endif /* __STUMPLESS_TEST_HELPER_FIXTURE_HPP */