/*
 * AWS IoT Over-the-air Update v3.4.0
 * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

/**
 * @file requestJob_Mqtt_harness.c
 * @brief Implements the proof harness for requestJob_Mqtt function.
 */
/* Include headers for mqtt interface. */
#include "ota_mqtt_private.h"

/* Stub required to combine a set of strings(to form a topic). */
size_t __CPROVER_file_local_ota_mqtt_c_stringBuilder( char * pBuffer,
                                                      size_t bufferSizeBytes,
                                                      const char * strings[] )
{
    size_t stringLength;

    /* pBuffer is initialized in requestJob_Mqtt function before passing it to the
     * stringBuilder function and thus cannot be NULL. */
    __CPROVER_assert( pBuffer != NULL,
                      "Unable to use pBuffer: passed pointer value is NULL." );

    /* strings is initialized requestJob_Mqtt function before passing it to the
     * stringBuilder function and thus cannot be NULL. */
    __CPROVER_assert( strings != NULL,
                      "Unable to use strings: passed pointer value is NULL." );

    /* The size of the static pbuffer is declared inside requestJob_Mqtt
     * function. */
    __CPROVER_assume( stringLength > 0U && stringLength < bufferSizeBytes );

    return stringLength;
}

/* Stub required to convert a decimal number into a string. */
size_t __CPROVER_file_local_ota_mqtt_c_stringBuilderUInt32Decimal( char * pBuffer,
                                                                   size_t bufferSizeBytes,
                                                                   uint32_t value )
{
    size_t buffersize;

    /* Output can only be at most 10 characters as max unsigned 32-bit integer value is 10 characters long */
    __CPROVER_assume( buffersize > 0 && buffersize <= 10U );

    /* pBuffer is always initialized before passing it to the stringBuilderUInt32Decimal
     * function and thus should not be NULL. */
    __CPROVER_assert( pBuffer != NULL,
                      "Unable to use pBuffer: passed pointer value is NULL." );


    return buffersize;
}

/* Stub required to convert a hexadecimal number into a string. */
OtaMqttStatus_t __CPROVER_file_local_ota_mqtt_c_subscribeToJobNotificationTopics( const OtaAgentContext_t * pAgentCtx )
{
    OtaMqttStatus_t mqttStatus;

    return mqttStatus;
}

/* Stub to user defined MQTT-publish operation. */
OtaMqttStatus_t stubMqttPublish( const char * const pacTopic,
                                 uint16_t usTopicLen,
                                 const char * pcMsg,
                                 uint32_t ulMsgSize,
                                 uint8_t ucQoS )
{
    OtaMqttStatus_t mqttstatus;

    return mqttstatus;
}

/*****************************************************************************/

void requestJob_Mqtt_harness()
{
    OtaAgentContext_t agent;
    OtaInterfaces_t otaInterface;
    size_t size;

    /* This variable is used to size the thingname. A device thingname must
     * have a minimum length of 1 and a maximum length of 128. */
    __CPROVER_assume( size >= 1 && size < 128U );

    /* publish reference to the mqtt function is expected to be assigned by the user and thus
     * assumed not to be NULL. */
    otaInterface.mqtt.publish = stubMqttPublish;

    agent.pOtaInterface = &otaInterface;
    agent.pThingName[ size ] = '\0';

    /* Ota agent is declared globally and cannot be NULL. */
    requestJob_Mqtt( &agent );
}