tests: Rename test0* functions as internal_test*.

The internal_* prefix is reserved for internal functions
such as these tests.

TODO

@@ -514,8 +514,3 @@ necessarily care about ongoing data integrity while writing, as long
 as data is reliably written out when g.sync or g.close return.  Also
 in libguestfs we effectively control the whole stack, so we can ensure
 write barriers happen when we want.
-
-Tidy up test0 functions
------------------------
-
-test0_* functions should be called internal_test_*

generator/generator_actions.ml

@@ -55,22 +55,22 @@ let test_all_optargs = [
 
 let test_all_rets = [
   (* except for RErr, which is tested thoroughly elsewhere *)
-  "test0rint",         RInt "valout";
-  "test0rint64",       RInt64 "valout";
-  "test0rbool",        RBool "valout";
-  "test0rconststring", RConstString "valout";
-  "test0rconstoptstring", RConstOptString "valout";
-  "test0rstring",      RString "valout";
-  "test0rstringlist",  RStringList "valout";
-  "test0rstruct",      RStruct ("valout", "lvm_pv");
-  "test0rstructlist",  RStructList ("valout", "lvm_pv");
-  "test0rhashtable",   RHashtable "valout";
-  "test0rbufferout",   RBufferOut "valout";
+  "internal_test_rint",         RInt "valout";
+  "internal_test_rint64",       RInt64 "valout";
+  "internal_test_rbool",        RBool "valout";
+  "internal_test_rconststring", RConstString "valout";
+  "internal_test_rconstoptstring", RConstOptString "valout";
+  "internal_test_rstring",      RString "valout";
+  "internal_test_rstringlist",  RStringList "valout";
+  "internal_test_rstruct",      RStruct ("valout", "lvm_pv");
+  "internal_test_rstructlist",  RStructList ("valout", "lvm_pv");
+  "internal_test_rhashtable",   RHashtable "valout";
+  "internal_test_rbufferout",   RBufferOut "valout";
 ]
 
 let test_functions = [
   { defaults with
-    name = "test0";
+    name = "internal_test";
     style = RErr, test_all_args, test_all_optargs;
     in_fish = false; in_docs = false; cancellable = true;
     shortdesc = "internal test function - do not use";

generator/generator_bindtests.ml

@@ -58,16 +58,16 @@ print_strings (char *const *argv)
   printf (\"]\\n\");
 }
 
-/* The test0 function prints its parameters to stdout. */
+/* The internal_test function prints its parameters to stdout. */
 ";
 
-  let test0, tests =
+  let test, tests =
     match test_functions with
     | [] -> assert false
-    | test0 :: tests -> test0, tests in
+    | test :: tests -> test, tests in
 
   let () =
-    let { name = name; style = (ret, args, optargs as style) } = test0 in
+    let { name = name; style = (ret, args, optargs as style) } = test in
     generate_prototype ~extern:false ~semicolon:false ~newline:true
       ~handle:"g" ~prefix:"guestfs__" ~optarg_proto:Argv name style;
     pr "{\n";
@@ -95,7 +95,7 @@ print_strings (char *const *argv)
     ) args;
     let check_optarg n printf_args =
       pr "  printf (\"%s: \");\n" n;
-      pr "  if (optargs->bitmask & GUESTFS_TEST0_%s_BITMASK) {\n"
+      pr "  if (optargs->bitmask & GUESTFS_INTERNAL_TEST_%s_BITMASK) {\n"
         (String.uppercase n);
       pr "    printf(%s);\n" printf_args;
       pr "  } else {\n";
@@ -551,7 +551,7 @@ var o;
 
     let mkoptargs = function
     | Some optargs ->
-      "o = new Guestfs.Test0({" ^
+      "o = new Guestfs.InternalTest({" ^
       (
         String.concat ", " (
           List.map (
@@ -597,60 +597,73 @@ var o;
  * ensure there is parity in testing bindings across all languages.
  *)
 and generate_lang_bindtests call =
-  call "test0" [CallString "abc"; CallOptString (Some "def");
+  call "internal_test"
+    [CallString "abc"; CallOptString (Some "def");
      CallStringList []; CallBool false;
      CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
      CallBuffer "abc\000abc"]
     (Some [CallOBool ("obool", true); CallOInt ("oint", 1)]);
-  call "test0" [CallString "abc"; CallOptString None;
+  call "internal_test"
+    [CallString "abc"; CallOptString None;
      CallStringList []; CallBool false;
      CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
      CallBuffer "abc\000abc"]
     (Some [CallOInt64 ("oint64", 1L);
            CallOString ("ostring", "string")]);
-  call "test0" [CallString ""; CallOptString (Some "def");
+  call "internal_test"
+    [CallString ""; CallOptString (Some "def");
      CallStringList []; CallBool false;
      CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
      CallBuffer "abc\000abc"]
     (Some [CallOBool ("obool", false)]);
-  call "test0" [CallString ""; CallOptString (Some "");
+  call "internal_test"
+    [CallString ""; CallOptString (Some "");
      CallStringList []; CallBool false;
      CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
      CallBuffer "abc\000abc"]
     (Some []);
-  call "test0" [CallString "abc"; CallOptString (Some "def");
+  call "internal_test"
+    [CallString "abc"; CallOptString (Some "def");
      CallStringList ["1"]; CallBool false;
      CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
      CallBuffer "abc\000abc"] None;
-  call "test0" [CallString "abc"; CallOptString (Some "def");
+  call "internal_test"
+    [CallString "abc"; CallOptString (Some "def");
      CallStringList ["1"; "2"]; CallBool false;
      CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
      CallBuffer "abc\000abc"] None;
-  call "test0" [CallString "abc"; CallOptString (Some "def");
+  call "internal_test"
+    [CallString "abc"; CallOptString (Some "def");
      CallStringList ["1"]; CallBool true;
      CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
      CallBuffer "abc\000abc"] None;
-  call "test0" [CallString "abc"; CallOptString (Some "def");
+  call "internal_test"
+    [CallString "abc"; CallOptString (Some "def");
      CallStringList ["1"]; CallBool false;
      CallInt (-1); CallInt64 (-1L); CallString "123"; CallString "456";
      CallBuffer "abc\000abc"] None;
-  call "test0" [CallString "abc"; CallOptString (Some "def");
+  call "internal_test"
+    [CallString "abc"; CallOptString (Some "def");
      CallStringList ["1"]; CallBool false;
      CallInt (-2); CallInt64 (-2L); CallString "123";CallString "456";
      CallBuffer "abc\000abc"] None;
-  call "test0" [CallString "abc"; CallOptString (Some "def");
+  call "internal_test"
+    [CallString "abc"; CallOptString (Some "def");
      CallStringList ["1"]; CallBool false;
      CallInt 1; CallInt64 1L; CallString "123"; CallString "456";
      CallBuffer "abc\000abc"] None;
-  call "test0" [CallString "abc"; CallOptString (Some "def");
+  call "internal_test"
+    [CallString "abc"; CallOptString (Some "def");
      CallStringList ["1"]; CallBool false;
      CallInt 2; CallInt64 2L; CallString "123"; CallString "456";
      CallBuffer "abc\000abc"] None;
-  call "test0" [CallString "abc"; CallOptString (Some "def");
+  call "internal_test"
+    [CallString "abc"; CallOptString (Some "def");
      CallStringList ["1"]; CallBool false;
      CallInt 4095; CallInt64 4095L; CallString "123"; CallString "456";
      CallBuffer "abc\000abc"] None;
-  call "test0" [CallString "abc"; CallOptString (Some "def");
+  call "internal_test"
+    [CallString "abc"; CallOptString (Some "def");
      CallStringList ["1"]; CallBool false;
      CallInt 0; CallInt64 0L; CallString ""; CallString "";
      CallBuffer "abc\000abc"] None;

generator/generator_c.ml

@@ -551,11 +551,12 @@ extern GUESTFS_DLL_PUBLIC void *guestfs_next_private (guestfs_h *g, const char *
   List.iter (
     fun { name = shortname; style = (ret, args, optargs as style);
           deprecated_by = deprecated_by } ->
-      let test0 =
-        String.length shortname >= 5 && String.sub shortname 0 5 = "test0" in
+      let test =
+        String.length shortname >= 13 &&
+          String.sub shortname 0 13 = "internal_test" in
       let debug =
         String.length shortname >= 5 && String.sub shortname 0 5 = "debug" in
-      if deprecated_by = None && not test0 && not debug then
+      if deprecated_by = None && not test && not debug then
         pr "#define LIBGUESTFS_HAVE_%s 1\n" (String.uppercase shortname);
 
       if optargs <> [] then (
@@ -787,7 +788,8 @@ trace_send_line (guestfs_h *g)
           let errcode =
             match errcode_of_ret ret with
             | `CannotReturnError ->
-                if shortname = "test0rconstoptstring" then (* XXX hack *)
+                (* XXX hack *)
+                if shortname = "internal_test_rconstoptstring" then
                   `ErrorIsNULL
                 else
                   failwithf

gobject/Makefile.am

@@ -41,6 +41,9 @@ EXTRA_DIST = \
 CLEANFILES = \
 	guestfs-gobject*.c *.o *.lo
 
+# Remove old test0 API files.
+CLEANFILES += src/optargs-test0.c include/guestfs-gobject/optargs-test0.h
+
 libname = libguestfs-gobject-1.0.la
 
 lib_LTLIBRARIES = $(libname)

gobject/Makefile.inc

@@ -38,7 +38,7 @@ guestfs_gobject_headers= \
   include/guestfs-gobject/struct-isoinfo.h \
   include/guestfs-gobject/struct-mdstat.h \
   include/guestfs-gobject/struct-btrfssubvolume.h \
-  include/guestfs-gobject/optargs-test0.h \
+  include/guestfs-gobject/optargs-internal_test.h \
   include/guestfs-gobject/optargs-add_drive_opts.h \
   include/guestfs-gobject/optargs-add_domain.h \
   include/guestfs-gobject/optargs-inspect_get_icon.h \
@@ -82,7 +82,7 @@ guestfs_gobject_sources= \
   src/struct-isoinfo.c \
   src/struct-mdstat.c \
   src/struct-btrfssubvolume.c \
-  src/optargs-test0.c \
+  src/optargs-internal_test.c \
   src/optargs-add_drive_opts.c \
   src/optargs-add_domain.c \
   src/optargs-inspect_get_icon.c \

gobject/bindtests-manual.js

@@ -47,64 +47,64 @@ var g = new Guestfs.Session();
 var v;
 var eq;
 
-v = g.test0rint('1');
-v == 1 || eq_fail('test0rint', v);
-check_error('test0rinterr');
+v = g.internal_test_rint('1');
+v == 1 || eq_fail('internal_test_rint', v);
+check_error('internal_test_rinterr');
 
-v = g.test0rint64('1');
-v == 1 || eq_fail('test0rint64', v);
-check_error('test0rint64err');
+v = g.internal_test_rint64('1');
+v == 1 || eq_fail('internal_test_rint64', v);
+check_error('internal_test_rint64err');
 
-v = g.test0rbool('true');
-v == 1 || eq_fail('test0rbool', v);
-check_error('test0rboolerr');
+v = g.internal_test_rbool('true');
+v == 1 || eq_fail('internal_test_rbool', v);
+check_error('internal_test_rboolerr');
 
-v = g.test0rconststring('1');
-v == 'static string' || eq_fail('test0rconststring', v);
-check_error('test0rconststringerr');
+v = g.internal_test_rconststring('1');
+v == 'static string' || eq_fail('internal_test_rconststring', v);
+check_error('internal_test_rconststringerr');
 
-v = g.test0rconstoptstring('1');
-v == 'static string' || eq_fail('test0rconstoptstring', v);
-//check_error('test0rconstoptstringerr');
+v = g.internal_test_rconstoptstring('1');
+v == 'static string' || eq_fail('internal_test_rconstoptstring', v);
+//check_error('internal_test_rconstoptstringerr');
 
-v = g.test0rstring('string');
-v == 'string' || eq_fail('test0rstring', v);
-check_error('test0rstringerr');
+v = g.internal_test_rstring('string');
+v == 'string' || eq_fail('internal_test_rstring', v);
+check_error('internal_test_rstringerr');
 
-v = g.test0rstringlist('5');
+v = g.internal_test_rstringlist('5');
 eq = v.length == 5;
 for (var i = 0; eq && i < 5; i++) {
   if (v[i] != i) eq = false;
 }
-eq || eq_fail('test0rstringlist', v.join(' '));
-check_error('test0rstringlisterr');
+eq || eq_fail('internal_test_rstringlist', v.join(' '));
+check_error('internal_test_rstringlisterr');
 
-v = g.test0rstruct('1');
-v.pv_size == 0 || eq_fail('test0rstruct', v);
-check_error('test0rstructerr');
+v = g.internal_test_rstruct('1');
+v.pv_size == 0 || eq_fail('internal_test_rstruct', v);
+check_error('internal_test_rstructerr');
 
-v = g.test0rstructlist('5');
+v = g.internal_test_rstructlist('5');
 eq = v.length == 5;
 for (var i = 0; eq && i < 5; i++) {
   if (v[i].pv_size != i) eq = false;
 }
-eq || eq_fail('test0rstructlist', v);
-check_error('test0rstructlisterr');
+eq || eq_fail('internal_test_rstructlist', v);
+check_error('internal_test_rstructlisterr');
 
-v = g.test0rhashtable('5');
+v = g.internal_test_rhashtable('5');
 eq = true;
 for (var i = 0; eq && i < 5; i++) {
   if (v[i] != i) eq = false;
 }
-eq || eq_fail('test0rhashtable', v);
-check_error('test0rhashtableerr');
+eq || eq_fail('internal_test_rhashtable', v);
+check_error('internal_test_rhashtableerr');
 
-v = g.test0rbufferout("01234");
+v = g.internal_test_rbufferout("01234");
 eq = v.length == 5;
 for (var i = 0; i < v.length; i++) {
   if (v[i] != 48 + i) eq = false; // 48 = ascii '0'
 }
-eq || eq_fail('test0rbufferout', v);
-check_error('test0rbufferouterr');
+eq || eq_fail('internal_test_rbufferout', v);
+check_error('internal_test_rbufferouterr');
 
 fail ? 1 : 0;

gobject/tests-misc.js

@@ -58,7 +58,7 @@ if (!progress_detected) {
 g.close();
 var threw = false;
 try {
-  var v = g.test0rconstoptstring('1');
+  var v = g.internal_test_rconstoptstring('1');
 } catch (error) {
   threw = true;
   if (!error.message.match(/closed/)) {

perl/t/006-pod-coverage.t

@@ -26,6 +26,5 @@ all_pod_coverage_ok ({
         qr/^debug.*/,
         qr/^is_busy$/,
         qr/^internal.*/,
-        qr/^test0.*/,
         ]
 });

po/POTFILES

@@ -145,6 +145,7 @@ gobject/src/optargs-copy_file_to_file.c
 gobject/src/optargs-e2fsck.c
 gobject/src/optargs-fstrim.c
 gobject/src/optargs-inspect_get_icon.c
+gobject/src/optargs-internal_test.c
 gobject/src/optargs-md_create.c
 gobject/src/optargs-mkfs_btrfs.c
 gobject/src/optargs-mkfs_opts.c
@@ -154,7 +155,6 @@ gobject/src/optargs-ntfsclone_out.c
 gobject/src/optargs-ntfsfix.c
 gobject/src/optargs-ntfsresize_opts.c
 gobject/src/optargs-set_e2attrs.c
-gobject/src/optargs-test0.c
 gobject/src/optargs-tune2fs.c
 gobject/src/optargs-umount_local.c
 gobject/src/session.c

src/api-support/update-from-tarballs.sh

@@ -59,6 +59,7 @@ for t in $tarballs; do
             grep -v '_args$' |
             grep -v '^guestfs_free_' |
             grep -v '^guestfs_test0' |
+            grep -v '^guestfs_internal_test' |
             grep -v '^guestfs_message_error$' |
             grep -v '^guestfs_message_header$' > $v
     fi