<div dir="ltr"><div dir="ltr"><div>Thanks for the review!</div><div>I will re generate the patch with corrections<br> </div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Wed, Jul 17, 2019 at 10:12 PM Gedare Bloom <<a href="mailto:gedare@rtems.org">gedare@rtems.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div>On Wed, Jul 10, 2019 at 1:49 AM Vaibhav Gupta <<a href="mailto:vaibhavgupta40@gmail.com" target="_blank">vaibhavgupta40@gmail.com</a>> wrote:<br>
><br>
> ---<br>
> testsuites/psxtests/Makefile.am | 7 +<br>
> testsuites/psxtests/<a href="http://configure.ac" rel="noreferrer" target="_blank">configure.ac</a> | 1 +<br>
> testsuites/psxtests/psxndbm01/init.c | 260 +++++++++++++++++++++++++++<br>
> 3 files changed, 268 insertions(+)<br>
> create mode 100644 testsuites/psxtests/psxndbm01/init.c<br>
><br>
> diff --git a/testsuites/psxtests/Makefile.am b/testsuites/psxtests/Makefile.am<br>
> index 59c9f2085b..7d1c0a783c 100755<br>
> --- a/testsuites/psxtests/Makefile.am<br>
> +++ b/testsuites/psxtests/Makefile.am<br>
> @@ -694,6 +694,13 @@ psxmutexattr01_CPPFLAGS = $(AM_CPPFLAGS) $(TEST_FLAGS_psxmutexattr01) \<br>
> $(support_includes) -I$(top_srcdir)/include<br>
> endif<br>
><br>
> +if TEST_psxndbm01<br>
> +psx_tests += psxndbm01<br>
> +psxndbm01_SOURCES = psxndbm01/init.c<br>
> +psxndbm01_CPPFLAGS = $(AM_CPPFLAGS) $(TEST_FLAGS_psxndbm01) \<br>
> + $(support_includes)<br>
> +endif<br>
> +<br>
> if TEST_psxobj01<br>
> psx_tests += psxobj01<br>
> psx_screens += psxobj01/psxobj01.scn<br>
> diff --git a/testsuites/psxtests/<a href="http://configure.ac" rel="noreferrer" target="_blank">configure.ac</a> b/testsuites/psxtests/<a href="http://configure.ac" rel="noreferrer" target="_blank">configure.ac</a><br>
> index 85559e4aa5..07d7ccaf55 100644<br>
> --- a/testsuites/psxtests/<a href="http://configure.ac" rel="noreferrer" target="_blank">configure.ac</a><br>
> +++ b/testsuites/psxtests/<a href="http://configure.ac" rel="noreferrer" target="_blank">configure.ac</a><br>
> @@ -110,6 +110,7 @@ RTEMS_TEST_CHECK([psxmsgq02])<br>
> RTEMS_TEST_CHECK([psxmsgq03])<br>
> RTEMS_TEST_CHECK([psxmsgq04])<br>
> RTEMS_TEST_CHECK([psxmutexattr01])<br>
> +RTEMS_TEST_CHECK([psxndbm01])<br>
> RTEMS_TEST_CHECK([psxobj01])<br>
> RTEMS_TEST_CHECK([psxonce01])<br>
> RTEMS_TEST_CHECK([psxpasswd01])<br>
> diff --git a/testsuites/psxtests/psxndbm01/init.c b/testsuites/psxtests/psxndbm01/init.c<br>
> new file mode 100644<br>
> index 0000000000..b38900361d<br>
> --- /dev/null<br>
> +++ b/testsuites/psxtests/psxndbm01/init.c<br>
> @@ -0,0 +1,260 @@<br>
> +/**<br>
> + * @file<br>
> + * @brief Test suite for ndbm.h methods<br>
> + */<br>
> +<br>
> +/*<br>
> + * SPDX-License-Identifier: BSD-2-Clause<br>
> + *<br>
> + * Copyright (C) 2019 Vaibhav Gupta<br>
> + *<br>
> + * Redistribution and use in source and binary forms, with or without<br>
> + * modification, are permitted provided that the following conditions<br>
> + * are met:<br>
> + * 1. Redistributions of source code must retain the above copyright<br>
> + * notice, this list of conditions and the following disclaimer.<br>
> + * 2. Redistributions in binary form must reproduce the above copyright<br>
> + * notice, this list of conditions and the following disclaimer in the<br>
> + * documentation and/or other materials provided with the distribution.<br>
> + *<br>
> + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"<br>
> + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE<br>
> + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE<br>
> + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE<br>
> + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR<br>
> + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF<br>
> + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS<br>
> + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN<br>
> + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)<br>
> + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE<br>
> + * POSSIBILITY OF SUCH DAMAGE.<br>
> + */<br>
> +<br>
> +#ifdef HAVE_CONFIG_H<br>
> +#include "config.h"<br>
> +#endif<br>
> +<br>
> +/* header files are listed in lexical/lexicographical/alphabetical order */<br>
> +<br>
> +#include <errno.h><br>
> +#include <fcntl.h> /* contains definitions of `open_flags` */<br>
> +#include <limits.h><br>
> +#include <ndbm.h> /* conatains declarations of ndbm methods */<br>
> +#include <stddef.h><br>
> +#include <stdint.h><br>
> +#include <stdio.h><br>
> +#include <sys/stat.h> /* contains definitions of `file_mode` */<br>
> +#include <string.h><br>
> +#include <rtems/test.h><br>
> +#include <tmacros.h><br>
> +<br>
> +const char rtems_test_name[] = "PSXNDBM 01";<br>
> +<br>
> +#define NAME "VARoDeK"<br>
> +#define PHONE_NO "123-321-777-888"<br>
> +#define DB_NAME "phones_test"<br>
> +#define NAME2 "VG"<br>
> +#define PHONE_NO2 "321-123-888-777"<br>
> +<br>
> +/* forward declarations to avoid warnings */<br>
> +rtems_task Init(rtems_task_argument ignored);<br>
> +<br>
> +rtems_task Init(rtems_task_argument ignored)<br>
> +{<br>
> + datum name = { NAME , sizeof( NAME ) };<br>
> + datum put_phone_no = { PHONE_NO, sizeof( PHONE_NO ) };<br>
> + datum get_phone_no, key;<br>
> +<br>
> + datum name2 = { NAME2 , sizeof( NAME2 ) };<br>
> + datum put_phone_no2 = { PHONE_NO2 , sizeof( PHONE_NO2 ) };<br>
> +<br>
> + int i;<br>
> + char *test_strings;<br>
> +<br>
> + DBM *db;<br>
> +<br>
> + TEST_BEGIN();<br>
> +<br>
> +/* A Simple test to check if ndbm methods are call-able */<br>
> +<br>
> +/* Store a simple data<br>
> + * This record (procedure) will be helpful in further tests<br>
> + */<br>
> +<br>
> + puts( "Open Database." );<br>
> + db = dbm_open( DB_NAME , O_RDWR | O_CREAT | O_TRUNC , S_IRWXU );<br>
Remove the extra blank space character before the comma.<br>
<br>
> + rtems_test_assert( db != NULL );<br>
> +<br>
> + puts( "Store Records in Database." );<br>
> + dbm_store( db , name , put_phone_no , DBM_INSERT );<br>
ditto, and more below.<br>
<br>
> +<br>
> + puts( "Fetch Records from Database and check." );<br>
> + get_phone_no = dbm_fetch( db , name );<br>
> + rtems_test_assert( strcmp( (const char*)get_phone_no.dptr , PHONE_NO ) == 0 );<br>
<br>
> +<br>
> + puts( "Close Database." );<br>
> + dbm_close( db );<br>
> +<br>
> +/* dbm_open() */<br>
I would like this to be more clearly about documenting what is<br>
happening, as it looks from casual glance to be commented-out code one<br>
wonders what it does here.<br>
<br>
> +<br>
> + puts( "\nTestcases for `dbm_open()`" );<br>
I would avoid the use of the back-ticks ` characters. Historically,<br>
they can cause problems in *nix systems.<br>
<br>
> +<br>
> +/* The `DB_NAME` is already created, hence `O_RDWR | O_EXCL` should fail. */<br>
> +<br>
> + puts( "Use `O_CREAT | O_EXCL` to open existing file and confirm error." );<br>
> + db = dbm_open( DB_NAME , O_RDWR | O_CREAT | O_EXCL , S_IRWXU );<br>
> + rtems_test_assert( db == NULL );<br>
> + rtems_test_assert( errno == EEXIST );<br>
> +<br>
> +/* Some implementations use 3 characters for a suffix and others use<br>
> + * 4 characters for a suffix, applications should ensure that the maximum<br>
> + * portable pathname length passed to dbm_open() is no greater than<br>
> + * {PATH_MAX}-4 bytes, with the last component of the pathname no greater<br>
> + * than {NAME_MAX}-4 bytes.<br>
> + */<br>
> +<br>
> +/* inside `ndbm.h` ; `#define DBM_SUFFIX ".db"` ;<br>
> + * 2 alphabtes and 1 period, hence 3 characters are used for suffix<br>
typo: alphabets (or alphabetical)<br>
<br>
> + * in this implementation.<br>
> + */<br>
> +<br>
> + puts( "Use path name larger than `{PATH_MAX}-3 bytes.` and confirm error." );<br>
> + test_strings = (char*)malloc( ( PATH_MAX - 2 ) );<br>
the parentheses around PATH_MAX - 2 are redundant<br>
<br>
> + for ( i = 0 ; i < ( PATH_MAX - 3 ) ; i++ ){<br>
space before {.<br>
<a href="https://devel.rtems.org/wiki/Developer/Coding/Conventions#Formatting" rel="noreferrer" target="_blank">https://devel.rtems.org/wiki/Developer/Coding/Conventions#Formatting</a><br>
<br>
> + test_strings[i] = 'r';<br>
> + }<br>
> + test_strings[i] = '\0';<br>
> + db = dbm_open( (const char*)test_strings , O_RDWR | O_CREAT | O_TRUNC , S_IRWXU );<br>
This line is > 80 characters. Please break it apart as per<br>
<a href="https://devel.rtems.org/wiki/Developer/Coding/80_characters_per_line" rel="noreferrer" target="_blank">https://devel.rtems.org/wiki/Developer/Coding/80_characters_per_line</a><br>
<br>
> + rtems_test_assert( db == NULL );<br>
> + rtems_test_assert( errno == ENAMETOOLONG );<br>
> + free( test_strings );<br>
> +<br>
> +/* database opened for write-only access opens the files for read and<br>
> + * write access or it will fail.<br>
> + */<br>
> +<br>
> +/* Implemenation of __hash_open in newlib does not support `O_WRONLY` */<br>
typo: Implementation<br>
<br>
> +<br>
> + puts( "Open file with write access only and confirm error." );<br>
> + db = dbm_open( DB_NAME , O_WRONLY , S_IRWXU );<br>
> + rtems_test_assert( db == NULL );<br>
> + rtems_test_assert( errno == EINVAL );<br>
> +<br>
> +/* dbm_store() */<br>
> +<br>
> + puts( "\nTestcases for `dbm_store()`" );<br>
> + db = dbm_open( DB_NAME , O_RDWR , S_IRWXU );<br>
> + rtems_test_assert( db != NULL );<br>
> +<br>
> + puts( "Insert new record with same key using `DBM_INSERT` mode and confirm error." );<br>
> + rtems_test_assert( dbm_store( db , name , put_phone_no2 , DBM_INSERT ) == 1 );<br>
also too long. fix all lines > 80 characters<br>
<br>
> + get_phone_no = dbm_fetch( db , name );<br>
> + rtems_test_assert( strcmp( (const char*)get_phone_no.dptr , PHONE_NO ) == 0 );<br>
> +<br>
> + puts( "Insert new record with same key using `DBM_REPLACE` mode and confirm changes." );<br>
> + rtems_test_assert( dbm_store( db , name , put_phone_no2 , DBM_REPLACE ) == 0 );<br>
> + get_phone_no = dbm_fetch( db , name );<br>
> + rtems_test_assert( strcmp( (const char*)get_phone_no.dptr , PHONE_NO2 ) == 0 );<br>
> +<br>
> +/* Revert for next tests*/<br>
> +<br>
> + rtems_test_assert( dbm_store( db , name , put_phone_no , DBM_REPLACE ) == 0 );<br>
> +<br>
> + puts( "Store a new record and confirm, total number of records is successful 2." );<br>
> + rtems_test_assert( dbm_store( db , name2 , put_phone_no2 , DBM_INSERT ) == 0 );<br>
> + for(key = dbm_firstkey( db ) , i = 0; key.dptr != NULL; key = dbm_nextkey( db ) , i++ );<br>
add spaces around ( after for:<br>
<br>
> + rtems_test_assert( i == 2);<br>
spacing<br>
<br>
> + dbm_close( db );<br>
> +<br>
> +/* dbm_fetch() */<br>
> +<br>
> + puts( "\nTestcases for `dbm_fetch()`" );<br>
> + db = dbm_open( DB_NAME , O_RDONLY , S_IRWXU );<br>
> + rtems_test_assert( db != NULL );<br>
> +<br>
> + puts( "Fetch existing records and confirm results." );<br>
> + get_phone_no = dbm_fetch( db , name );<br>
> + rtems_test_assert( strcmp( (const char*)get_phone_no.dptr , PHONE_NO ) == 0 );<br>
> + get_phone_no = dbm_fetch( db , name2 );<br>
> + rtems_test_assert( strcmp( (const char*)get_phone_no.dptr , PHONE_NO2 ) == 0 );<br>
> +<br>
> + puts( "Fetch non-existing record and conform error." );<br>
typo: confirm<br>
<br>
> + test_strings = (char*)malloc(6);<br>
> + strcpy( test_strings , "Hello" );<br>
suggest you use strncpy.<br>
<br>
> + key.dptr = test_strings;<br>
> + key.dsize = sizeof( test_strings );<br>
> + get_phone_no = dbm_fetch( db , key );<br>
> + rtems_test_assert( get_phone_no.dptr == NULL );<br>
> + dbm_close( db );<br>
> +<br>
> +/* dbm_delete() */<br>
> +<br>
> + puts( "\nTestcases for `dbm_delete()`" );<br>
> + db = dbm_open( DB_NAME , O_RDWR , S_IRWXU );<br>
> + rtems_test_assert( db != NULL );<br>
> +<br>
> + puts( "Delte non-existing record and confirm error." );<br>
typo: Delete<br>
<br>
> + rtems_test_assert( dbm_delete( db , key ) != 0 );<br>
> + free( test_strings );<br>
> + for(key = dbm_firstkey( db ) , i = 0; key.dptr != NULL; key = dbm_nextkey( db ) , i++ );<br>
> + rtems_test_assert( i == 2);<br>
since you are repeating this logic many times, you might consider<br>
writing a helper function to count the records in the db. It will make<br>
the test easier to read too.</div></blockquote><div>Sure, I must confirm for this from Newlib first. Or else I can make <br></div><div>a user-defined function in a tesuite itself for this purpose.</div><div>.<br></div><div>It will take database name as an argument and count number of</div><div>records.<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div>
> +<br>
> + puts("Delete existing record and confirm, total number of records is successful 1.");<br>
> + rtems_test_assert( dbm_delete( db , name ) == 0 );<br>
> + for(key = dbm_firstkey( db ) , i = 0; key.dptr != NULL; key = dbm_nextkey( db ) , i++ );<br>
> + rtems_test_assert( i == 1);<br>
> +<br>
> + puts("Confirm if correct record is deleted.");<br>
> + get_phone_no = dbm_fetch( db , name );<br>
> + rtems_test_assert( get_phone_no.dptr == NULL );<br>
> +<br>
> +/* record returned by `dbm_firstkey()` should be the only record<br>
> + * left, this should be checked to confirm correct working of<br>
> + * `dbm_firstkey()`.<br>
> + * Check if the data is not corrupted after usage of `dbm_delete()`<br>
> + */<br>
> +<br>
> + puts( "Check if the data is not corrupted after usage of `dbm_delete()`." );<br>
> + get_phone_no = dbm_fetch( db , dbm_firstkey( db ) );<br>
> + rtems_test_assert( strcmp( (const char*)get_phone_no.dptr , PHONE_NO2 ) == 0 );<br>
> +<br>
> +/* Empty the database and then try to use `dbm_firstkey()`, the<br>
> + * dptr pointer should point to NULL.<br>
> + */<br>
> +<br>
> + puts( "Empty records in database and check results of `dbm_firstkey()`." );<br>
> + rtems_test_assert( dbm_delete( db , dbm_firstkey( db ) ) == 0 );<br>
> + key = dbm_firstkey( db );<br>
> + rtems_test_assert( key.dptr == NULL );<br>
> + dbm_close( db );<br>
> +<br>
> +/* `dbm_firstkey()` */<br>
> +<br>
> + puts( "\nTestcases for `dbm_firstkey()`" );<br>
> + puts( "All cases tested while performing above tests." );<br>
> +<br>
> +/* `dbm_nextkey()` */<br>
> +<br>
> + puts( "\nTestcases for `dbm_nextkey()`" );<br>
> + puts( "All cases tested while performing above tests." );<br>
> +<br>
these are not necessary print statements then. you can just make it a<br>
comment somewhere in here that those functions are tested already.<br>
<br>
> + TEST_END();<br>
> + rtems_test_exit(0);<br>
> +}<br>
> +<br>
> +/* NOTICE: the clock driver is explicitly disabled */<br>
> +<br>
> +#define CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER<br>
> +#define CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER<br>
> +<br>
> +#define CONFIGURE_MAXIMUM_TASKS 1<br>
> +<br>
> +#define CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS 6<br>
> +<br>
> +#define CONFIGURE_RTEMS_INIT_TASKS_TABLE<br>
> +<br>
> +#define CONFIGURE_INITIAL_EXTENSIONS RTEMS_TEST_INITIAL_EXTENSION<br>
> +<br>
> +#define CONFIGURE_INIT<br>
> +#include <rtems/confdefs.h><br>
> +/* end of file */<br>
> --<br>
> 2.21.0<br>
><br>
</div></blockquote></div></div>