Commit a99c453a authored by Greg Williams's avatar Greg Williams
Browse files

Updated KineticClient_Put to allow NULL pointer to Value payload if length is... 

Updated KineticClient_Put to allow NULL pointer to Value payload if length is 0, since empty payload is valid and NULL acceptable in this case.
parent b70a8106

src/lib/kinetic_client.c

+5 −1
Original line number Diff line number Diff line
@@ -143,7 +143,11 @@ KineticStatus KineticClient_Put(KineticSession const * const session, 
    KINETIC_ASSERT(session != NULL);

    KINETIC_ASSERT(session->connection != NULL);

    KINETIC_ASSERT(entry != NULL);



    // Assert non-NULL value upon non-zero length

    if (entry->value.array.len > 0) {

        KINETIC_ASSERT(entry->value.array.data != NULL);

    }

    

    KINETIC_ASSERT(session->connection->pSession == session);

    KINETIC_ASSERT(session->connection == session->connection->pSession->connection);

test/system/test_system_put.c

+19 −57
Original line number Diff line number Diff line
@@ -22,30 +22,21 @@ 


static SystemTestFixture Fixture;

static KineticEntry Entry;

static uint8_t KeyData[1024];

static uint8_t KeyData[64];

static ByteBuffer KeyBuffer;

static uint8_t OtherKeyData[1024];

static ByteBuffer OtherKeyBuffer;

static uint8_t TagData[1024];

static uint8_t TagData[64];

static ByteBuffer TagBuffer;

static uint8_t VersionData[1024];

static uint8_t VersionData[64];

static ByteBuffer VersionBuffer;

static uint8_t NewVersionData[1024];

static ByteBuffer NewVersionBuffer;

static uint8_t OtherVersionData[1024];

static ByteBuffer OtherVersionBuffer;

static uint8_t ValueData[KINETIC_OBJ_SIZE];

static ByteBuffer ValueBuffer;



void setUp(void)

{

    SystemTestSetup(&Fixture, 2);

    SystemTestSetup(&Fixture, 3);

    KeyBuffer = ByteBuffer_CreateAndAppendCString(KeyData, sizeof(KeyData), "PUT test key");

    OtherKeyBuffer = ByteBuffer_CreateAndAppendCString(OtherKeyData, sizeof(OtherKeyData), "Some other PUT test key");

    TagBuffer = ByteBuffer_CreateAndAppendCString(TagData, sizeof(TagData), "SomeTagValue");

    VersionBuffer = ByteBuffer_CreateAndAppendCString(VersionData, sizeof(VersionData), "v1.0");

    NewVersionBuffer = ByteBuffer_CreateAndAppendCString(NewVersionData, sizeof(NewVersionData), "v2.0");

    OtherVersionBuffer = ByteBuffer_CreateAndAppendCString(OtherVersionData, sizeof(OtherVersionData), "v3.0");

    ValueBuffer = ByteBuffer_CreateAndAppendCString(ValueData, sizeof(ValueData), "lorem ipsum... blah blah blah... etc.");

}
@@ -67,74 +58,48 @@ void test_Put_should_create_new_object_on_device(void) 


    KineticStatus status = KineticClient_Put(&Fixture.session, &Entry, NULL);

    TEST_ASSERT_EQUAL_KineticStatus(KINETIC_STATUS_SUCCESS, status);



    TEST_ASSERT_EQUAL_ByteBuffer(VersionBuffer, Entry.dbVersion);

    TEST_ASSERT_ByteBuffer_NULL(Entry.newVersion);

    TEST_ASSERT_EQUAL_ByteBuffer(TagBuffer, Entry.tag);

    TEST_ASSERT_EQUAL_ByteBuffer(KeyBuffer, Entry.key);



    TEST_ASSERT_EQUAL(KINETIC_ALGORITHM_SHA1, Entry.algorithm);

}



void test_Put_should_create_another_new_object_on_device(void)

{

    Entry = (KineticEntry) {

        .key = OtherKeyBuffer,

        .newVersion = VersionBuffer,

        .tag = TagBuffer,

        .algorithm = KINETIC_ALGORITHM_SHA1,

        .value = ValueBuffer,

        .force = true,

    };



    KineticStatus status = KineticClient_Put(&Fixture.session, &Entry, NULL);

    TEST_ASSERT_EQUAL_KineticStatus(KINETIC_STATUS_SUCCESS, status);



    TEST_ASSERT_EQUAL_ByteBuffer(VersionBuffer, Entry.dbVersion);

    TEST_ASSERT_EQUAL_ByteBuffer(TagBuffer, Entry.tag);

    TEST_ASSERT_ByteBuffer_NULL(Entry.newVersion);

    TEST_ASSERT_EQUAL_ByteBuffer(OtherKeyBuffer, Entry.key);

    TEST_ASSERT_EQUAL_ByteBuffer(TagBuffer, Entry.tag);



    TEST_ASSERT_EQUAL(KINETIC_ALGORITHM_SHA1, Entry.algorithm);

}



void test_Put_should_handle_0_length_keys(void)

void test_Put_should_handle_non_null_buffer_with_length_of_0(void)

{

    uint8_t KeyData0[128];

    ByteBuffer KeyBuffer0 = ByteBuffer_CreateAndAppendCString(KeyData0,

        sizeof(KeyData0), "");

    uint8_t ValueData0[128];

    ByteBuffer ValueBuffer0 = ByteBuffer_CreateAndAppendCString(ValueData0,

        sizeof(ValueData0), "");



    Entry = (KineticEntry) {

        .key = KeyBuffer0,

        .newVersion = VersionBuffer,

        .key = KeyBuffer,

        .tag = TagBuffer,

        .algorithm = KINETIC_ALGORITHM_SHA1,

        .value = ValueBuffer,

        .value = ValueBuffer0,

        .force = true,

    };



    KineticStatus status = KineticClient_Put(&Fixture.session, &Entry, NULL);

    TEST_ASSERT_EQUAL_KineticStatus(KINETIC_STATUS_SUCCESS, status);



    TEST_ASSERT_EQUAL_ByteBuffer(VersionBuffer, Entry.dbVersion);

    TEST_ASSERT_ByteBuffer_NULL(Entry.newVersion);

    TEST_ASSERT_EQUAL_ByteBuffer(TagBuffer, Entry.tag);

    TEST_ASSERT_EQUAL_SIZET_MESSAGE(0, Entry.key.bytesUsed,

    TEST_ASSERT_EQUAL_SIZET_MESSAGE(0, Entry.value.bytesUsed,

        "ByteBuffer used lengths do not match!");



    TEST_ASSERT_EQUAL(KINETIC_ALGORITHM_SHA1, Entry.algorithm);

}



void test_Put_should_handle_0_length_values(void)

void test_Put_should_handle_NULL_buffer_if_length_specified_as_0(void)

{

    uint8_t ValueData0[128];

    ByteBuffer ValueBuffer0 = ByteBuffer_CreateAndAppendCString(ValueData0,

        sizeof(ValueData0), "");

    ByteArray Value0 = {

        .data = NULL,

        .len = 0

    };

    ByteBuffer ValueBuffer0 = {

        .array = Value0

    };



    Entry = (KineticEntry) {

        .key = KeyBuffer,

        .newVersion = VersionBuffer,

        .tag = TagBuffer,

        .algorithm = KINETIC_ALGORITHM_SHA1,

        .value = ValueBuffer0,
@@ -143,13 +108,10 @@ void test_Put_should_handle_0_length_values(void) 


    KineticStatus status = KineticClient_Put(&Fixture.session, &Entry, NULL);

    TEST_ASSERT_EQUAL_KineticStatus(KINETIC_STATUS_SUCCESS, status);



    TEST_ASSERT_EQUAL_ByteBuffer(VersionBuffer, Entry.dbVersion);

    TEST_ASSERT_ByteBuffer_NULL(Entry.newVersion);

    TEST_ASSERT_EQUAL_ByteBuffer(TagBuffer, Entry.tag);

    TEST_ASSERT_EQUAL_SIZET_MESSAGE(0, Entry.value.bytesUsed,

        "ByteBuffer used lengths do not match!");



    TEST_ASSERT_EQUAL(KINETIC_ALGORITHM_SHA1, Entry.algorithm);

}

test/unit/test_kinetic_client_put.c

+21 −0
Original line number Diff line number Diff line
@@ -65,3 +65,24 @@ void test_KineticClient_Put_should_execute_PUT_operation(void) 


    TEST_ASSERT_EQUAL_KineticStatus(KINETIC_STATUS_VERSION_MISMATCH, status);

}



void test_KineticClient_Put_should_allow_NULL_pointer_to_value_data_if_length_is_zero(void)

{

    Session.connection = &Connection;

    Connection.pSession = &Session;

    ByteArray value = {

        .data = NULL,

        .len = 0,

    };

    KineticEntry entry = {.value = ByteBuffer_CreateWithArray(value)};

    KineticOperation operation;

    operation.connection = &Connection;

    

    KineticController_CreateOperation_ExpectAndReturn(&Session, &operation);

    KineticOperation_BuildPut_Expect(&operation, &entry);

    KineticController_ExecuteOperation_ExpectAndReturn(&operation, NULL, KINETIC_STATUS_VERSION_MISMATCH);



    KineticStatus status = KineticClient_Put(&Session, &entry, NULL);



    TEST_ASSERT_EQUAL_KineticStatus(KINETIC_STATUS_VERSION_MISMATCH, status);

}