From 18ca4903ffb44c858a2dd4d05c9ecf947499ac63 Mon Sep 17 00:00:00 2001 From: Frederic Marec Date: Fri, 28 Sep 2018 09:01:04 +0200 Subject: [PATCH] Add tests for data persistence binding Add test tree structures Add tests for persistence binding Add dependency in README.md Change-Id: If3fa3450fa61cd7e440712354b123d02934e2488 Signed-off-by: Frederic Marec (cherry picked from commit 5663caee2540dbc769d39c1e255c35493169b037) --- README.md | 44 +++++++++++++------- test/CMakeLists.txt | 27 +++++++++++++ test/afb-test.sh | 29 ++++++++++++++ test/etc/CMakeLists.txt | 31 ++++++++++++++ test/etc/aft-persistence-test.json | 22 ++++++++++ test/fixtures/CMakeLists.txt | 30 ++++++++++++++ test/fixtures/test1.json | 5 +++ test/tests/CMakeLists.txt | 31 ++++++++++++++ test/tests/persistence_BasicAPITest.lua | 71 +++++++++++++++++++++++++++++++++ 9 files changed, 275 insertions(+), 15 deletions(-) create mode 100644 test/CMakeLists.txt create mode 100755 test/afb-test.sh create mode 100644 test/etc/CMakeLists.txt create mode 100644 test/etc/aft-persistence-test.json create mode 100644 test/fixtures/CMakeLists.txt create mode 100644 test/fixtures/test1.json create mode 100644 test/tests/CMakeLists.txt create mode 100644 test/tests/persistence_BasicAPITest.lua diff --git a/README.md b/README.md index fb420dc..979d35e 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,52 @@ # Database Binding + This binding provide a database API with key/value semantics. The backend is currently a Berkeley DB. ## Verbs + * **insert**: - This verb insert a key/value pair in the database. - If the key already exist, the verb fails. - + + This verb insert a key/value pair in the database. + If the key already exist, the verb fails. + * **update**: - This verb update an existing record. - If the key doesn't exist, the verb fails. - + + This verb update an existing record. + If the key doesn't exist, the verb fails. + * **delete**: - This verb remove an existing key/value pair from the database. - If no matching record is found, the verb fails. + + This verb remove an existing key/value pair from the database. + If no matching record is found, the verb fails. * **read**: - This verb get the value associated with the specified key. - If no matching record is found, the verb fails. + + This verb get the value associated with the specified key. + If no matching record is found, the verb fails. ## Arguments + * The **read** and **delete** verbs need only a **key** to work: -``` + +```code { - "key": "mykey" + "key": "mykey" } ``` * The **insert** and **update** verbs need a **key** and a **value** to work: -``` + +```code { - "key": "mykey", - "value": "my value" + "key": "mykey", + "value": "my value" } ``` + The **value** can be any valid json. + +## Dependencies + +You must install BerkeleyDB and GDBM \ No newline at end of file diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt new file mode 100644 index 0000000..71a121a --- /dev/null +++ b/test/CMakeLists.txt @@ -0,0 +1,27 @@ +########################################################################### +# Copyright 2015 - 2018 IoT.bzh +# +# author:Frédéric Marec +# +# 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. +########################################################################### + + +# Include any directory not starting with _ +# ----------------------------------------------------- +PROJECT_SUBDIRS_ADD(${PROJECT_SRC_DIR_PATTERN}) + +ADD_TEST(NAME AGL_SERVICE_DATA-PERSISTENCE_TESTS + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMAND afb-test.sh ${CMAKE_BINARY_DIR} +) \ No newline at end of file diff --git a/test/afb-test.sh b/test/afb-test.sh new file mode 100755 index 0000000..38c46ff --- /dev/null +++ b/test/afb-test.sh @@ -0,0 +1,29 @@ +#!/bin/sh + +BINDER=$(command -v afb-daemon) +AFBTEST="$(pkg-config --variable libdir afb-test)/aft.so" +PROCNAME="aft-persistence" +PORT=1234 +TOKEN= +LOGFILE="test.log" +[ "$1" ] && BUILDDIR="$1" || exit 1 + +TESTPACKAGEDIR="${BUILDDIR}/package-test" +export AFT_CONFIG_PATH="${TESTPACKAGEDIR}/etc" +export AFT_PLUGIN_PATH="${TESTPACKAGEDIR}/var:${TESTPACKAGEDIR}/lib/plugins" + +pkill $PROCNAME + +timeout -s 9 10 "${BINDER}" --name="${PROCNAME}" \ + --port="${PORT}" \ + --roothttp=. \ + --tracereq=common \ + --token=${TOKEN} \ + --workdir="${TESTPACKAGEDIR}" \ + --binding="../package/lib/afb-persistence-binding.so" \ + --binding="$AFBTEST" \ + --call="aft-persistence/launch_all_tests:{}" \ + --call="aft-persistence/exit:{}" \ + -vvv > "${LOGFILE}" 2>&1 + +find "${BUILDDIR}" -name test_results.log -exec cat {} \; diff --git a/test/etc/CMakeLists.txt b/test/etc/CMakeLists.txt new file mode 100644 index 0000000..1ee805b --- /dev/null +++ b/test/etc/CMakeLists.txt @@ -0,0 +1,31 @@ +########################################################################### +# Copyright 2018 IoT.bzh +# +# author:Frédéric Marec +# +# 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. +########################################################################### + +################################################## +# Data persistence test configuration files +################################################## +PROJECT_TARGET_ADD(afb-test-config) + + file(GLOB CONF_FILES "*.json") + + add_input_files("${CONF_FILES}") + + SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES + LABELS "TEST-CONFIG" + OUTPUT_NAME ${TARGET_NAME} + ) \ No newline at end of file diff --git a/test/etc/aft-persistence-test.json b/test/etc/aft-persistence-test.json new file mode 100644 index 0000000..9e5839c --- /dev/null +++ b/test/etc/aft-persistence-test.json @@ -0,0 +1,22 @@ +{ + "id": "http://iot.bzh/download/public/schema/json/ctl-schema.json#", + "$schema": "http://iot.bzh/download/public/schema/json/ctl-schema.json#", + "metadata": { + "uid": "Test", + "version": "1.0", + "api": "aft-persistence", + "info": "AFB-test binding configuration file to test persistence api.", + "require": [ + "persistence" + ] + }, + "testVerb": { + "uid": "launch_all_tests", + "info": "Launch all the tests", + "action": "lua://AFT#_launch_test", + "args": { + "trace": "persistence", + "files": ["persistence_BasicAPITest.lua"] + } + } +} \ No newline at end of file diff --git a/test/fixtures/CMakeLists.txt b/test/fixtures/CMakeLists.txt new file mode 100644 index 0000000..e7864b2 --- /dev/null +++ b/test/fixtures/CMakeLists.txt @@ -0,0 +1,30 @@ +########################################################################### +# Copyright 2018 IoT.bzh +# +# author:Frédéric Marec +# +# 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. +########################################################################### + +################################################## +# Data persistence test configuration files +################################################## +PROJECT_TARGET_ADD(data-files) + + file(GLOB DATA_FILES "*.json") + add_input_files("${DATA_FILES}") + + SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES + LABELS "TEST-DATA" + OUTPUT_NAME ${TARGET_NAME} + ) diff --git a/test/fixtures/test1.json b/test/fixtures/test1.json new file mode 100644 index 0000000..d0b3a8f --- /dev/null +++ b/test/fixtures/test1.json @@ -0,0 +1,5 @@ +{"test": + { + "test":"test" + } +} \ No newline at end of file diff --git a/test/tests/CMakeLists.txt b/test/tests/CMakeLists.txt new file mode 100644 index 0000000..c03658a --- /dev/null +++ b/test/tests/CMakeLists.txt @@ -0,0 +1,31 @@ +########################################################################### +# Copyright 2018 IoT.bzh +# +# author:Frédéric Marec +# +# 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. +########################################################################### + + +################################################## +# Data persistence Lua Scripts +################################################## +PROJECT_TARGET_ADD(test-files) + + file(GLOB LUA_FILES "*.lua") + add_input_files("${LUA_FILES}") + + SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES + LABELS "TEST-DATA" + OUTPUT_NAME ${TARGET_NAME} + ) \ No newline at end of file diff --git a/test/tests/persistence_BasicAPITest.lua b/test/tests/persistence_BasicAPITest.lua new file mode 100644 index 0000000..6d65697 --- /dev/null +++ b/test/tests/persistence_BasicAPITest.lua @@ -0,0 +1,71 @@ +--[[ + Copyright (C) 2018 "IoT.bzh" + Author Frédéric Marec + + 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. + + + NOTE: strict mode: every global variables should be prefixed by '_' +--]] + +local testPrefix ="persistence_BasicAPITest_" + +-- This tests the 'insert' verb of the persistence API +_AFT.testVerbStatusSuccess(testPrefix.."insert","persistence","insert", {key="TEST", value="myvalue"}, nil, + function() + _AFT.callVerb("persistence", "delete", {key="TEST"}) + end) + +-- This tests the 'delete' verb of the persistence API +_AFT.testVerbStatusSuccess(testPrefix.."delete","persistence","delete", {key="TEST"}, + function() + _AFT.callVerb("persistence", "insert", {key="TEST", value="myvalue"}) + end, nil) + +-- This tests the 'update' verb of the persistence API +_AFT.testVerbStatusSuccess(testPrefix.."update","persistence","update", {key="TEST", value="test"}, + function() + _AFT.callVerb("persistence", "insert", {key="TEST", value="myvalue"}) + end, + function() + _AFT.callVerb("persistence", "delete", {key="TEST"}) + end) + +-- This tests the 'read' verb of the persistence API +_AFT.testVerbStatusSuccess(testPrefix.."read","persistence","read", {key="TEST"}, + function() + _AFT.callVerb("persistence", "insert", {key="TEST", value="myvalue"}) + end, + function() + _AFT.callVerb("persistence", "delete", {key="TEST"}) + end) + +-- This tests the 'read' verb of the persistence API +_AFT.testVerbStatusError(testPrefix.."read-unknow-value","persistence","read", {key="TEST"}, nil, nil) + +-- This tests the 'insert' verb of the persistence API +_AFT.testVerbStatusError(testPrefix.."insert-without-value","persistence","insert", {key="TEST"}, nil, + function() + _AFT.callVerb("persistence", "delete", {key="TEST"}) + end) + +-- This tests the 'delete' verb of the persistence API +_AFT.testVerbStatusError(testPrefix.."delete-unknow-key","persistence","delete", {key="TEST"}, nil, nil) + +-- This tests the 'insert' verb of the persistence API +_AFT.testVerbStatusError(testPrefix.."insert-with-anything","persistence","insert", {value="talenka"}, nil, nil) + +-- This tests the 'update' verb of the persistence API +_AFT.testVerbStatusError(testPrefix.."update-unkwon-null-value","persistence","update", {key=null}, nil, nil) + +_AFT.exitAtEnd() -- 2.16.6