dlt-test-filetransfer.c

Go to the documentation of this file.

/*
 * @licence app begin@
 * SPDX license identifier: MPL-2.0
 *
 * Copyright (C) 2011-2015, BMW AG
 *
 * This file is part of GENIVI Project DLT - Diagnostic Log and Trace.
 *
 * This Source Code Form is subject to the terms of the
 * Mozilla Public License (MPL), v. 2.0.
 * If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * For further information see http://www.genivi.org/.
 * @licence end@
 */

/*******************************************************************************
**                                                                            **
**  SRC-MODULE: dlt-test-client.c                                             **
**                                                                            **
**  TARGET    : linux                                                         **
**                                                                            **
**  PROJECT   : DLT                                                           **
**                                                                            **
**  AUTHOR    : Alexander Wenzel Alexander.AW.Wenzel@bmw.de                   **
**                                                                            **
**  PURPOSE   :                                                               **
**                                                                            **
**  REMARKS   :                                                               **
**                                                                            **
**  PLATFORM DEPENDANT [yes/no]: yes                                          **
**                                                                            **
**  TO BE CHANGED BY USER [yes/no]: no                                        **
**                                                                            **
*******************************************************************************/

/*******************************************************************************
**                      Author Identity                                       **
********************************************************************************
**                                                                            **
** Initials     Name                       Company                            **
** --------     -------------------------  ---------------------------------- **
**  aw          Alexander Wenzel           BMW                                **
*******************************************************************************/


#include <dlt_filetransfer.h>     /*Needed for transferring files with the dlt protocol*/
#include <dlt.h>                /*Needed for dlt logging*/

DLT_DECLARE_CONTEXT(mainContext)

DLT_DECLARE_CONTEXT(fileContext)

char *file1;
char *file2;
char *file3_1;
char *file3_2;
char *file3_3;
int i,countPackages, transferResult;
static int g_numFailed = 0;

void printTestResultPositiveExpected(const char *function, int result){

    if(result >= 0){
        printf("%s successful\n",function);
    }
    else
    {
        printf("%s failed\n",function);
        g_numFailed++;
    }

}

void printTestResultNegativeExpected(const char *function, int result){

    if(result < 0){
        printf("%s successful\n",function);
    }
    else
    {
        printf("%s failed\n",function);
        g_numFailed++;
    }

}

int testFile1Run1(){
    //Just some log to the main context
    DLT_LOG(mainContext,DLT_LOG_INFO,DLT_STRING("Started testF1P1 - dlt_user_log_file_complete"),DLT_STRING(file1));

    //Here's the line where the dlt file transfer is called. The method call needs a context, the absolute file path, will the file be deleted after transfer and the timeout between the packages
    transferResult = dlt_user_log_file_complete(&fileContext,file1,0,20);
    if(transferResult < 0 )
    {
            printf("Error: dlt_user_log_file_complete\n");
            return transferResult;
    }
    //Just some log to the main context
    DLT_LOG(mainContext,DLT_LOG_INFO,DLT_STRING("Finished testF1P1"),DLT_STRING(file1));

    printTestResultPositiveExpected(__FUNCTION__,transferResult);

    return transferResult;
}

int testFile1Run2(){
    int total_size, used_size;

    //Get the information how many packages have the file
    countPackages = dlt_user_log_file_packagesCount(&fileContext,file1);
    if(countPackages < 0 )
    {
            printf("Error: dlt_user_log_file_packagesCount\n");
            printTestResultPositiveExpected(__FUNCTION__,countPackages);
            return -1;
    }
    //Just some log to the main context
    DLT_LOG(mainContext,DLT_LOG_INFO,DLT_STRING("Started testF1P2 - transfer single package"),DLT_STRING(file1));

    //Logs the header of the file transfer. For more details see Mainpage.c.
    //The header gives information about the file serial number, filename (with absolute path), filesize, packages of file, buffer size
    transferResult = dlt_user_log_file_header(&fileContext,file1);
    if(transferResult >= 0)
    {
        //Loop to log all packages
        for(i=1;i<=countPackages;i++)
        {
            dlt_user_check_buffer(&total_size, &used_size);
            if((total_size - used_size) < (total_size/2))
            {
                printf("Error: dlt_user_log_file_data\n");
                printTestResultPositiveExpected(__FUNCTION__,transferResult);
                break;
            }

            //Logs one single package to the file context
            transferResult = dlt_user_log_file_data(&fileContext,file1,i,20);
            if(transferResult < 0)
            {
                printf("Error: dlt_user_log_file_data\n");
                printTestResultPositiveExpected(__FUNCTION__,transferResult);
                return transferResult;
            }
        }

        //Logs the end of the file transfer. For more details see Mainpage.c
        //The end gives just information about the file serial number but is needed to signal that the file transfer has correctly finished and needed for the file transfer plugin of the dlt viewer.
        transferResult = dlt_user_log_file_end(&fileContext,file1,0);
        if(transferResult < 0)
        {
            printf("Error: dlt_user_log_file_end\n");
            printTestResultPositiveExpected(__FUNCTION__,transferResult);
            return transferResult;
        }
    }
    else
    {
        printf("Error: dlt_user_log_file_header\n");
        printTestResultPositiveExpected(__FUNCTION__,transferResult);
        return transferResult;
    }

    //Just some log to main context
    DLT_LOG(mainContext,DLT_LOG_INFO,DLT_STRING("Finished testF1P2 - transfer single package"),DLT_STRING(file1));
    printTestResultPositiveExpected(__FUNCTION__,transferResult);
    return 0;
}
int testFile2Run1(){
    //Just some log to main context
    DLT_LOG(mainContext,DLT_LOG_INFO,DLT_STRING("Started testF2P1 - dlt_user_log_file_complete"),DLT_STRING(file2));

    //Here's the line where the dlt file transfer is called. The method call needs a context, the absolute file path, will the file be deleted after transfer and the timeout between the packages
    transferResult = dlt_user_log_file_complete(&fileContext,file2,0,20);
    if(transferResult < 0)
    {
        printf("Error: dlt_user_log_file_complete\n");
        printTestResultPositiveExpected(__FUNCTION__,transferResult);
        return transferResult;
    }
    //Just some log to main context
    DLT_LOG(mainContext,DLT_LOG_INFO,DLT_STRING("Finished testF2P1"),DLT_STRING(file2));
    printTestResultPositiveExpected(__FUNCTION__,transferResult);
    return transferResult;
}

int testFile2Run2(){
    int total_size, used_size;

    //Get the information how many packages have the file
    countPackages = dlt_user_log_file_packagesCount(&fileContext,file2);
    if(countPackages < 0 )
    {
            printf("Error: dlt_user_log_file_packagesCount\n");
            printTestResultPositiveExpected(__FUNCTION__,countPackages);
            return -1;
    }

    //Just some log to the main context
    DLT_LOG(mainContext,DLT_LOG_INFO,DLT_STRING("Started testF2P2 - transfer single package"),DLT_STRING(file2));

    //Logs the header of the file transfer. For more details see Mainpage.c.
    //The header gives information about the file serial number, filename (with absolute path), filesize, packages of file, buffer size
    transferResult = dlt_user_log_file_header(&fileContext,file2);
    if( transferResult >= 0){

        //Loop to log all packages
        for(i=1;i<=countPackages;i++)
        {
            dlt_user_check_buffer(&total_size, &used_size);
            if((total_size - used_size) < (total_size/2))
            {
                printf("Error: dlt_user_log_file_data\n");
                printTestResultPositiveExpected(__FUNCTION__,transferResult);
                break;
            }

            //Logs one single package to the file context
            transferResult = dlt_user_log_file_data(&fileContext,file2,i,20);
            if(transferResult < 0)
            {
                printf("Error: dlt_user_log_file_data\n");
                printTestResultPositiveExpected(__FUNCTION__,transferResult);
                return transferResult;
            }
        }

        //Logs the end of the file transfer. For more details see Mainpage.c
        //The end gives just information about the file serial number but is needed to signal that the file transfer has correctly finished and needed for the file transfer plugin of the dlt viewer.
        transferResult = dlt_user_log_file_end(&fileContext,file2,0);
        if(transferResult < 0)
        {
            printf("Error: dlt_user_log_file_end\n");
            printTestResultPositiveExpected(__FUNCTION__,transferResult);
            return transferResult;
        }
    }
    else
    {
        printf("Error: dlt_user_log_file_header\n");
        printTestResultPositiveExpected(__FUNCTION__,transferResult);
        return transferResult;
    }
    //Just some log to the main context
    DLT_LOG(mainContext,DLT_LOG_INFO,DLT_STRING("Finished testF2P2"),DLT_STRING(file2));
    printTestResultPositiveExpected(__FUNCTION__,transferResult);
    return 0;
}

int testFile3Run1(){

    //Just some log to the main context
    DLT_LOG(mainContext,DLT_LOG_INFO,DLT_STRING("Started testF3P1"),DLT_STRING(file3_1));

    //Here's the line where the dlt file transfer is called. The method call needs a context, the absolute file path, will the file be deleted after transfer and the timeout between the packages
    transferResult = dlt_user_log_file_complete(&fileContext,file3_1,0,20);
    if(transferResult < 0)
    {
        //Error expected because file doesn't exist
        //printf("Error: dlt_user_log_file_complete\n");
        //Just some log to the main context
        DLT_LOG(mainContext,DLT_LOG_INFO,DLT_STRING("Finished testF3P1"),DLT_STRING(file3_1));
        printTestResultNegativeExpected(__FUNCTION__,transferResult);
        return transferResult;
    }
    printTestResultNegativeExpected(__FUNCTION__,transferResult);
    return transferResult;
}


int testFile3Run2(){

    //Get the information how many packages have the file
    countPackages = dlt_user_log_file_packagesCount(&fileContext,file3_2);
    if(countPackages < 0 )
    {
            //Error expected because file doesn't exist
            //printf("Error: dlt_user_log_file_packagesCount\n");
            //Just some log to the main context
            DLT_LOG(mainContext,DLT_LOG_INFO,DLT_STRING("Finished testF3P1"),DLT_STRING(file3_2));
            printTestResultNegativeExpected(__FUNCTION__,countPackages);
            return -1;
    }
    //Just some log to the main context
    DLT_LOG(mainContext,DLT_LOG_INFO,DLT_STRING("Started testF3P1"),DLT_STRING(file3_2));

    //Logs the header of the file transfer. For more details see Mainpage.c.
    //The header gives information about the file serial number, filename (with absolute path), filesize, packages of file, buffer size
    transferResult = dlt_user_log_file_header(&fileContext,file3_2);
    if( transferResult >= 0){

        //Loop to log all packages
        for(i=1;i<=countPackages;i++)
        {
            //Logs one single package to the file context
            transferResult = dlt_user_log_file_data(&fileContext,file3_2,i,20);
            if(transferResult < 0)
            {
                printf("Error: dlt_user_log_file_data\n");
                printTestResultNegativeExpected(__FUNCTION__,transferResult);
                return transferResult;
            }
        }

        //Logs the end of the file transfer. For more details see Mainpage.c
        //The end gives just information about the file serial number but is needed to signal that the file transfer has correctly finished and needed for the file transfer plugin of the dlt viewer.
        transferResult = dlt_user_log_file_end(&fileContext,file3_2,0);
        if(transferResult < 0)
        {
            printf("Error: dlt_user_log_file_end\n");
            printTestResultNegativeExpected(__FUNCTION__,transferResult);
            return transferResult;
        }
    }
    printTestResultNegativeExpected(__FUNCTION__,transferResult);
    return 0;
}


int testFile3Run3(){

    //Just some log to the main context
    DLT_LOG(mainContext,DLT_LOG_INFO,DLT_STRING("Started testF3P2"),DLT_STRING(file3_3));

    //Here's the line where the dlt file file info is called. The method call logs some information to dlt about the file, filesize, file serial number and number of packages
    transferResult = dlt_user_log_file_infoAbout(&fileContext,file3_3);
    if(transferResult < 0)
    {
        //Error expected because file doesn't exist
        //printf("Error: dlt_user_log_file_infoAbout\n");
        //Just some log to the main context
        DLT_LOG(mainContext,DLT_LOG_INFO,DLT_STRING("Finished testF3P2"),DLT_STRING(file3_3));
        printTestResultNegativeExpected(__FUNCTION__,transferResult);
        return transferResult;
    }
    printTestResultNegativeExpected(__FUNCTION__,transferResult);
    return 0;
}

int main(void)
{
    //First file contains some text
    file1 = "/usr/local/share/dlt-filetransfer/dlt-test-filetransfer-file";
    //Second file is a picture
    file2 = "/usr/local/share/dlt-filetransfer/dlt-test-filetransfer-image.png";
    //Third file doesn't exist. Just to test the reaction when the file isn't available.
    file3_1 = "dlt-test-filetransfer-doesntExist_1";
    //Third file doesn't exist. Just to test the reaction when the file isn't available.
    file3_2 = "dlt-test-filetransfer-doesntExist_2";
    //Third file doesn't exist. Just to test the reaction when the file isn't available.
    file3_3 = "dlt-test-filetransfer-doesntExist_3";

    //Register the application at the dlt-daemon
    DLT_REGISTER_APP("FLTR","Test Application filetransfer");

    //Register the context of the main program at the dlt-daemon
    DLT_REGISTER_CONTEXT(mainContext,"MAIN","Main context for filetransfer test");

    //Register the context in which the file transfer will be logged at the dlt-daemon
    DLT_REGISTER_CONTEXT(fileContext,"FLTR","Test Context for filetransfer");

    //More details in corresponding methods
    testFile1Run1();
    testFile1Run2();
    testFile2Run1();
    testFile2Run2();
    testFile3Run1();
    testFile3Run2();
    testFile3Run3();

    //Unregister the context in which the file transfer happened from the dlt-daemon
    DLT_UNREGISTER_CONTEXT(fileContext);
    //Unregister the context of the main program from the dlt-daemon
    DLT_UNREGISTER_CONTEXT(mainContext);
    //Unregister the app from the dlt-daemon
    DLT_UNREGISTER_APP();

    return g_numFailed == 0 ? 0 : 1;
}