[svn-r23350] I cleaned up some code and added comments for my previous checkin of the DESY project.

Tested on koala.

5 files changed, 95 insertions, 32 deletions

diff --git a/test/plugin.c b/test/plugin.c
index 4385916..debc38b 100644
--- a/test/plugin.c
+++ b/test/plugin.c
@@ -188,7 +188,7 @@ int	points_deflate[DSET_DIM1][DSET_DIM2],
 /*-------------------------------------------------------------------------
  * Function:	test_filter_internal
  *
- * Purpose:	Tests 
+ * Purpose:	Tests writing entire data and partial data with filters  
  *
  * Return:	Success:	0
  *		Failure:	-1
@@ -417,6 +417,8 @@ test_filter_internal(hid_t fid, const char *name, hid_t dcpl, hsize_t *dset_size
 
     PASSED();
 
+    /* Save the data written to the file for later comparison when the file 
+     * is reopened for read test */
     for(i=0; i<size[0]; i++) {
         for(j=0; j<size[1]; j++) {
             if(!HDstrcmp(name, DSET_DEFLATE_NAME)) {
@@ -450,13 +452,14 @@ error:
 /*-------------------------------------------------------------------------
  * Function:	test_filters
  *
- * Purpose:	Tests dataset filter.
+ * Purpose:	Tests creating datasets and writing data with dynamically
+ *              loaded filters
  *
  * Return:	Success:	0
  *		Failure:	-1
  *
- * Programmer:	Robb Matzke
- *              Wednesday, April 15, 1998
+ * Programmer:	Raymond Lu
+ *              14 March 2013
  *
  *-------------------------------------------------------------------------
  */
@@ -501,8 +504,10 @@ test_filters(hid_t file, hid_t fapl)
     if(H5Pset_filter (dc, H5Z_FILTER_DYNLIB1, H5Z_FLAG_MANDATORY, 1, &compress_level) < 0) goto error;
 
     if(test_filter_internal(file,DSET_DYNLIB1_NAME,dc,&deflate_size) < 0) goto error;
+
     /* Clean up objects used for this test */
     if(H5Pclose (dc) < 0) goto error;
+
     /* Unregister the dynamic filter DYNLIB1 for testing purpose. The next time when this test is run for 
      * the new file format, the library's H5PL code has to search in the table of loaded plugin libraries
      * for this filter. */
@@ -519,9 +524,11 @@ test_filters(hid_t file, hid_t fapl)
     if(H5Pset_filter (dc, H5Z_FILTER_DYNLIB2, H5Z_FLAG_MANDATORY, 1, &compress_level) < 0) goto error;
 
     if(test_filter_internal(file,DSET_DYNLIB2_NAME,dc,&deflate_size) < 0) goto error;
+
     /* Clean up objects used for this test */
     if(H5Pclose (dc) < 0) goto error;
-    /* Unregister the dynamic filter BOGUS for testing purpose. The next time when this test is run for 
+
+    /* Unregister the dynamic filter DYNLIB2 for testing purpose. The next time when this test is run for 
      * the new file format, the library's H5PL code has to search in the table of loaded plugin libraries
      * for this filter. */
     if(H5Zunregister(H5Z_FILTER_DYNLIB2) < 0) goto error;
@@ -537,8 +544,10 @@ test_filters(hid_t file, hid_t fapl)
     if(H5Pset_filter (dc, H5Z_FILTER_BZIP2, H5Z_FLAG_MANDATORY, 1, &compress_level) < 0) goto error;
 
     if(test_filter_internal(file,DSET_BZIP2_NAME,dc,&deflate_size) < 0) goto error;
+
     /* Clean up objects used for this test */
     if(H5Pclose (dc) < 0) goto error;
+
     /* Unregister the dynamic filter BOGUS for testing purpose. The next time when this test is run for 
      * the new file format, the library's H5PL code has to search in the table of loaded plugin libraries
      * for this filter. */
@@ -554,13 +563,13 @@ error:
 /*-------------------------------------------------------------------------
  * Function:	test_read_data
  *
- * Purpose:	Tests dataset filter.
+ * Purpose:	Tests reading data and compares values
  *
  * Return:	Success:	0
  *		Failure:	-1
  *
- * Programmer:	Robb Matzke
- *              Wednesday, April 15, 1998
+ * Programmer:	Raymond Lu
+ *              14 March 2013
  *
  *-------------------------------------------------------------------------
  */
@@ -601,13 +610,13 @@ error:
 /*-------------------------------------------------------------------------
  * Function:	test_read_with_filters
  *
- * Purpose:	Tests dataset filter.
+ * Purpose:	Tests reading dataset created with dynamically loaded filters
  *
  * Return:	Success:	0
  *		Failure:	-1
  *
- * Programmer:	Robb Matzke
- *              Wednesday, April 15, 1998
+ * Programmer:	Raymond Lu
+ *              14 March 2013
  *
  *-------------------------------------------------------------------------
  */
@@ -693,14 +702,14 @@ error:
 /*-------------------------------------------------------------------------
  * Function:	main
  *
- * Purpose:	Tests the dataset interface (H5D)
+ * Purpose:	Tests the plugin module (H5PL)
  *
  * Return:	Success:	exit(0)
  *
  *		Failure:	exit(1)
  *
- * Programmer:	Robb Matzke
- *		Tuesday, December  9, 1997
+ * Programmer:	Raymond Lu
+ *		14 March 2013
  *
  *-------------------------------------------------------------------------
  */
@@ -715,15 +724,6 @@ main(void)
     size_t rdcc_nbytes;
     double rdcc_w0;
     int	nerrors = 0;
-    const char *envval;
-
-    /* Don't run this test using certain file drivers */
-    envval = HDgetenv("HDF5_DRIVER");
-    if(envval == NULL)
-        envval = "nomatch";
-
-    /* Set the random # seed */
-    HDsrandom((unsigned)HDtime(NULL));
 
     /* Testing setup */
     h5_reset();
@@ -762,14 +762,7 @@ main(void)
         if((file = H5Fcreate(filename, H5F_ACC_TRUNC, H5P_DEFAULT, my_fapl)) < 0)
             TEST_ERROR 
 
-        /* Cause the library to emit initial messages */
-        if((grp = H5Gcreate2(file, "emit diagnostics", H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) < 0)
-            TEST_ERROR 
-        if(H5Oset_comment(grp, "Causes diagnostic messages to be emitted") < 0)
-            TEST_ERROR 
-        if(H5Gclose(grp) < 0)
-            TEST_ERROR 
-
+        /* Test dynamically loaded filters */
         nerrors += (test_filters(file, my_fapl) < 0		? 1 : 0);
 
         if(H5Fclose(file) < 0)
@@ -790,6 +783,7 @@ main(void)
     if((file = H5Fopen(filename, H5F_ACC_RDONLY, fapl)) < 0)
         TEST_ERROR 
 
+    /* Read the data with filters */
     nerrors += (test_read_with_filters(file, fapl) < 0		? 1 : 0);
 
     if(H5Fclose(file) < 0)
diff --git a/test/plugin_lib/Makefile.in b/test/plugin_lib/Makefile.in
index aecb36e..83d350c 100644
--- a/test/plugin_lib/Makefile.in
+++ b/test/plugin_lib/Makefile.in
@@ -1,3 +1,22 @@
+# Copyright by The HDF Group.
+# Copyright by the Board of Trustees of the University of Illinois.
+# All rights reserved.
+#
+# This file is part of HDF5.  The full HDF5 copyright notice, including
+# terms governing use, modification, and redistribution, is contained in
+# the files COPYING and Copyright.html.  COPYING can be found at the root
+# of the source code distribution tree; Copyright.html can be found at the
+# root level of an installed copy of the electronic HDF5 document set and
+# is linked from the top-level documents page.  It can also be found at
+# http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have
+# access to either file, you may request a copy from help@hdfgroup.org.
+#
+# HDF5 Library Test Makefile(.in)
+#
+# This Makefile.in is NOT generated by automake.  Since we want to build 
+# shared libraries for testing, automake can't create shared libraries when
+# configure asks to build static library.
+#
 CFLAGS = -fPIC -g
 CC = @CC@
 SRCDIR = @srcdir@
diff --git a/test/plugin_lib/dynlib1.c b/test/plugin_lib/dynlib1.c
index 619fe66..4b57ddb 100644
--- a/test/plugin_lib/dynlib1.c
+++ b/test/plugin_lib/dynlib1.c
@@ -1,3 +1,24 @@
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ * Copyright by The HDF Group.                                               *
+ * Copyright by the Board of Trustees of the University of Illinois.         *
+ * All rights reserved.                                                      *
+ *                                                                           *
+ * This file is part of HDF5.  The full HDF5 copyright notice, including     *
+ * terms governing use, modification, and redistribution, is contained in    *
+ * the files COPYING and Copyright.html.  COPYING can be found at the root   *
+ * of the source code distribution tree; Copyright.html can be found at the  *
+ * root level of an installed copy of the electronic HDF5 document set and   *
+ * is linked from the top-level documents page.  It can also be found at     *
+ * http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
+ * access to either file, you may request a copy from help@hdfgroup.org.     *
+ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+
+/*
+ * Programmer:	Raymond Lu
+ *		13 February 2013
+ *
+ * Purpose:	Tests the plugin module (H5PL)
+ */
 #include "dynlib1.h"
 
 /* This message derives from H5Z */
diff --git a/test/plugin_lib/dynlib1.h b/test/plugin_lib/dynlib1.h
index f255ee4..5d68780 100644
--- a/test/plugin_lib/dynlib1.h
+++ b/test/plugin_lib/dynlib1.h
@@ -1,9 +1,35 @@
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ * Copyright by The HDF Group.                                               *
+ * Copyright by the Board of Trustees of the University of Illinois.         *
+ * All rights reserved.                                                      *
+ *                                                                           *
+ * This file is part of HDF5.  The full HDF5 copyright notice, including     *
+ * terms governing use, modification, and redistribution, is contained in    *
+ * the files COPYING and Copyright.html.  COPYING can be found at the root   *
+ * of the source code distribution tree; Copyright.html can be found at the  *
+ * root level of an installed copy of the electronic HDF5 document set and   *
+ * is linked from the top-level documents page.  It can also be found at     *
+ * http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
+ * access to either file, you may request a copy from help@hdfgroup.org.     *
+ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+
+/*
+ * Programmer:	Raymond Lu
+ *		13 February 2013
+ *
+ * Purpose:	Tests the plugin module (H5PL)
+ */
 #include <stdlib.h>
 #include <stdio.h>
 #include <hdf5.h>
 
 #define FILTER_DYNLIB1_VERS 1
 
+const H5PL_type_t   H5PL_get_plugin_type(void);
+const int           H5PL_get_plugin_version(void);
+const char*         H5PL_get_plugin_name(void);
+const H5Z_class2_t* H5PL_get_plugin_info(void);
+
 /* Local prototypes for filter functions */
 static size_t H5Z_filter_dynlib1(unsigned int flags, size_t cd_nelmts,
     const unsigned int *cd_values, size_t nbytes, size_t *buf_size, void **buf);
diff --git a/test/test_plugin.sh.in b/test/test_plugin.sh.in
index a1287a5..a881198 100644
--- a/test/test_plugin.sh.in
+++ b/test/test_plugin.sh.in
@@ -13,7 +13,10 @@
 # http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have
 # access to either file, you may request a copy from help@hdfgroup.org.
 #
-# Tests for test_error and err_compat 
+# This script file first envokes the Makefile in plugin_lib to build dynamic
+# plugin libraries.  Then it moves the libraries to some locations and points
+# HDF5_PLUGIN_PATH to these locations.  In the end, it runs plugin.c test.
+# 
 
 srcdir=@srcdir@
 TOP_BUILDDIR=@top_builddir@