Plugin testing library. This library provides the the implementation of the GCJsonCallbacks to test configuration parsing of a plugin. Without this functionality, the plugin would have to mock every related json function, which would be cumbersome. More...

#include "json.h"

Functions
GCJsonCallbacks	gcGetJsonCallbacks (const char *json_data)
	Get the JSON callbacks from a JSON string.

void	gcFreeJsonCallbacks (GCJsonCallbacks)
	Free the JSON callbacks.

Detailed Description

Plugin testing library. This library provides the the implementation of the GCJsonCallbacks to test configuration parsing of a plugin. Without this functionality, the plugin would have to mock every related json function, which would be cumbersome.

Installing the library

Each plugin is responsible for building and linking the testing library (which is implemented in Rust).

Building

# The binary will be placed at ./target/debug/libgc_testing_clib.so

cargo build --package gc_testing_clib --target-dir ./target

Copy/linking the include files

Linking the include files is highly recommended in order to keep it updated to the latest version. The include files are located in the include directory.

Linking the library

# Assumes that the library is built in the "target/debug" directory and the include files are in the "include"

directory gcc *.c -Iinclude -Ltarget/debug -lgc_testing_clib -o target/test.out

Usage

The library provides the following functions:

gcGetJsonCallbacks
gcFreeJsonCallbacks

The return value of gcGetJsonCallbacks can be used to create the GCPluginInterface.

GCJsonCallbacks createInterfaceMock(const char* json_data, GCPluginInterface interface){
    GCJsonCallbacks* json_callbacks = gcGetJsonCallbacks(json_data);
    GCPluginConfig pluginConfig = {
                .subscribedDatapointsCount = 0,
                .subscribedDatapoints = NULL,
                .ownDatapointsCount = 0,
                .ownDatapoints = NULL,
                .pluginJsonConfig = *json_callbacks;
    }
    interface->config = pluginConfig; interface->ctx = NULL;
    interface->publishDatapointValueCallback = NULL;
    interface->logSystemCallback = NULL;
    interface->logAuditCallback = NULL;
    interface->releaseDatapointValueCallback = NULL;
    interface->getLastDatapointValueCallback = NULL;
 
    return json_callbacks;
}
 
int main(){
    GCPluginInterface interface;
    GCJsonCallbacks json_callbacks = createInterfaceMock("{\"key\":\"value\"}", interface);
 
    // Use the interface to test configuration parsing
    gcFreeJsonCallbacks(json_callbacks);
}

Function Documentation

◆ gcFreeJsonCallbacks()

void gcFreeJsonCallbacks ( GCJsonCallbacks )

Free the JSON callbacks.

This function will free the JSON callbacks and the data field.

Parameters

callbacks The JSON callbacks

◆ gcGetJsonCallbacks()

GCJsonCallbacks gcGetJsonCallbacks ( const char * json_data )

Get the JSON callbacks from a JSON string.

This function will copy the JSON string and set it as the data field of the GCJsonCallbacks. The data can then be used by the various JSON callbacks.

Once the data is no longer needed, it should be freed using gcFreeJsonCallbacks.