vppinfra: improve test coverage

Bonus corner-case bugfix in bitmap.h, found during the exercise.
Issue dates from 2001 or thereabouts. Please review this specific
change carefully.

lcov_post: filter system include directories and generated files in
build-root

Type: improvement

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: Iaa0b63e9dc571dfe3d992197ac49ba4d93403c61

extras/lcov/lcov_post

@@ -6,4 +6,7 @@ cd build-root
 rm -rf html
 mkdir html
 lcov --no-checksum --directory . --capture --output-file out.info
-genhtml out.info -o html
+lcov --remove out.info \
+       "/usr/include/*" "*/build-root/*" "/opt/*" "/usr/lib/*" \
+       -o filtered.info
+genhtml filtered.info -o html

src/plugins/unittest/CMakeLists.txt

@@ -15,6 +15,7 @@ add_vpp_plugin(unittest
   SOURCES
   bier_test.c
   bihash_test.c
+  bitmap_test.c
   crypto/aes_cbc.c
   crypto/aes_ctr.c
   crypto/aes_gcm.c

src/plugins/unittest/bitmap_test.c

@@ -0,0 +1,76 @@
+/*
+ * Copyright (c) 2020 Cisco and/or its affiliates.
+ * 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 <vlib/vlib.h>
+#include <vppinfra/bitmap.h>
+
+static clib_error_t *
+test_bitmap_command_fn (vlib_main_t * vm,
+			unformat_input_t * input, vlib_cli_command_t * cmd)
+{
+  u64 *bm = 0;
+  u64 *bm2 = 0;
+  u64 *dup;
+  uword junk;
+
+  bm = clib_bitmap_set_multiple (bm, 2, ~0ULL, BITS (uword));
+
+  junk = clib_bitmap_next_clear (bm, 3);
+  junk = clib_bitmap_next_clear (bm, 65);
+
+  bm2 = clib_bitmap_set_multiple (bm2, 0, ~0ULL, BITS (uword));
+  _vec_len (bm2) = 1;
+  junk = clib_bitmap_next_clear (bm2, 0);
+
+
+  bm = clib_bitmap_set_multiple (bm, 2, ~0ULL, BITS (uword) - 3);
+  junk = clib_bitmap_get_multiple (bm, 2, BITS (uword));
+  junk = clib_bitmap_first_set (bm);
+  junk = 1 << 3;
+  bm = clib_bitmap_xori (bm, junk);
+  bm = clib_bitmap_andi (bm, junk);
+  bm = clib_bitmap_xori_notrim (bm, junk);
+  bm = clib_bitmap_andi_notrim (bm, junk);
+
+  bm = clib_bitmap_set_multiple (bm, 2, ~0ULL, BITS (uword) - 3);
+  bm2 = clib_bitmap_set_multiple (bm2, 2, ~0ULL, BITS (uword) - 3);
+
+  dup = clib_bitmap_dup_and (bm, bm2);
+  vec_free (dup);
+  dup = clib_bitmap_dup_andnot (bm, bm2);
+  vec_free (dup);
+  vec_free (bm);
+  vec_free (bm2);
+
+  return 0;
+}
+
+
+
+/* *INDENT-OFF* */
+VLIB_CLI_COMMAND (test_bihash_command, static) =
+{
+  .path = "test bitmap",
+  .short_help = "Coverage test for bitmap.h",
+  .function = test_bitmap_command_fn,
+};
+/* *INDENT-ON* */
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */

src/vppinfra/bitmap.h

@@ -730,7 +730,7 @@ clib_bitmap_next_clear (uword * ai, uword i)
 	}
 
       /* no clear bit left in bitmap, return bit just beyond bitmap */
-      return (i0 + 1) * BITS (ai[0]);
+      return (i0 * BITS (ai[0])) + 1;
     }
   return i;
 }

test/test_bihash.py

@@ -61,5 +61,11 @@ class TestBihash(VppTestCase):
             self.logger.critical(error)
             self.assertNotIn('failed', error)
 
+        error = self.vapi.cli("test bihash nitems 10 nbuckets 1 ncycles 3" +
+                              "search 2 careful 1 verbose 2 non-random-keys")
+        if error:
+            self.logger.critical(error)
+            self.assertNotIn('failed', error)
+
 if __name__ == '__main__':
     unittest.main(testRunner=VppTestRunner)

test/test_vppinfra.py

@@ -0,0 +1,40 @@
+#!/usr/bin/env python3
+
+import unittest
+
+from framework import VppTestCase, VppTestRunner, running_extended_tests
+from framework import running_gcov_tests
+
+
+class TestVppinfra(VppTestCase):
+    """ Vppinfra Unit Test Cases """
+    worker_config = "workers 1"
+
+    @classmethod
+    def setUpClass(cls):
+        super(TestVppinfra, cls).setUpClass()
+
+    @classmethod
+    def tearDownClass(cls):
+        super(TestVppinfra, cls).tearDownClass()
+
+    def setUp(self):
+        super(TestVppinfra, self).setUp()
+
+    def tearDown(self):
+        super(TestVppinfra, self).tearDown()
+
+    def test_bitmap_unittest(self):
+        """ Bitmap Code Coverage Test """
+        cmds = ["test bitmap"]
+
+        for cmd in cmds:
+            r = self.vapi.cli_return_response(cmd)
+            if r.retval != 0:
+                if hasattr(r, 'reply'):
+                    self.logger.info(cmd + " FAIL reply " + r.reply)
+                else:
+                    self.logger.info(cmd + " FAIL retval " + str(r.retval))
+
+if __name__ == '__main__':
+    unittest.main(testRunner=VppTestRunner)