From 4b41d26e1beb1dec2a902a75aee51748ebedfdd5 Mon Sep 17 00:00:00 2001
From: Ryan Curtin <ryan@ratml.org>
Date: Thu, 6 Apr 2017 11:54:05 -0400
Subject: [PATCH] Add tests for some Python binding components.

---
 src/mlpack/tests/CMakeLists.txt          |   1 +
 src/mlpack/tests/python_binding_test.cpp | 107 +++++++++++++++++++++++
 2 files changed, 108 insertions(+)
 create mode 100644 src/mlpack/tests/python_binding_test.cpp

diff --git a/src/mlpack/tests/CMakeLists.txt b/src/mlpack/tests/CMakeLists.txt
index f27109e78d..77b00f1ae0 100644
--- a/src/mlpack/tests/CMakeLists.txt
+++ b/src/mlpack/tests/CMakeLists.txt
@@ -67,6 +67,7 @@ add_executable(mlpack_test
   octree_test.cpp
   pca_test.cpp
   perceptron_test.cpp
+  python_binding_test.cpp
   qdafn_test.cpp
   quic_svd_test.cpp
   radical_test.cpp
diff --git a/src/mlpack/tests/python_binding_test.cpp b/src/mlpack/tests/python_binding_test.cpp
new file mode 100644
index 0000000000..ebb878243e
--- /dev/null
+++ b/src/mlpack/tests/python_binding_test.cpp
@@ -0,0 +1,107 @@
+/**
+ * @file python_binding_test.cpp
+ * @author Ryan Curtin
+ *
+ * Test the components of the Python bindings.
+ *
+ * mlpack is free software; you may redistribute it and/or modify it under the
+ * terms of the 3-clause BSD license.  You should have received a copy of the
+ * 3-clause BSD license along with mlpack.  If not, see
+ * http://www.opensource.org/licenses/BSD-3-Clause for more information.
+ */
+#include <mlpack/core.hpp>
+#include <mlpack/bindings/python/py_option.hpp>
+
+#include <boost/test/unit_test.hpp>
+#include "test_tools.hpp"
+
+namespace mlpack {
+namespace bindings {
+namespace python {
+
+std::string programName; // Needed for linking.
+
+} // namespace python
+} // namespace bindings
+} // namespace mlpack
+
+using namespace mlpack;
+using namespace mlpack::bindings;
+using namespace mlpack::bindings::python;
+
+BOOST_AUTO_TEST_SUITE(PythonBindingsTest);
+
+/**
+ * Ensure that we can construct a PyOption object, and that it will add itself
+ * to the CLI instance.
+ */
+BOOST_AUTO_TEST_CASE(PyOptionTest)
+{
+  programName = "test";
+  PyOption<double> po1(0.0, "test", "test2", "t", "double", false, true, false);
+
+  // Now check that it's in CLI.
+  CLI::RestoreSettings(programName);
+  BOOST_REQUIRE_GT(CLI::Parameters().count("test"), 0);
+  BOOST_REQUIRE_GT(CLI::Aliases().count('t'), 0);
+  BOOST_REQUIRE_EQUAL(CLI::Parameters()["test"].desc, "test2");
+  BOOST_REQUIRE_EQUAL(CLI::Parameters()["test"].name, "test");
+  BOOST_REQUIRE_EQUAL(CLI::Parameters()["test"].alias, 't');
+  BOOST_REQUIRE_EQUAL(CLI::Parameters()["test"].noTranspose, false);
+  BOOST_REQUIRE_EQUAL(CLI::Parameters()["test"].required, false);
+  BOOST_REQUIRE_EQUAL(CLI::Parameters()["test"].input, true);
+  BOOST_REQUIRE_EQUAL(CLI::Parameters()["test"].cppType, "double");
+
+  PyOption<arma::mat> po2(arma::mat(), "mat", "mat2", "m", "arma::mat", true,
+      true, true);
+
+  // Now check that it's in CLI.
+  CLI::RestoreSettings(programName);
+  BOOST_REQUIRE_GT(CLI::Parameters().count("mat"), 0);
+  BOOST_REQUIRE_GT(CLI::Aliases().count('m'), 0);
+  BOOST_REQUIRE_EQUAL(CLI::Parameters()["mat"].desc, "mat2");
+  BOOST_REQUIRE_EQUAL(CLI::Parameters()["mat"].name, "mat");
+  BOOST_REQUIRE_EQUAL(CLI::Parameters()["mat"].alias, 'm');
+  BOOST_REQUIRE_EQUAL(CLI::Parameters()["mat"].noTranspose, true);
+  BOOST_REQUIRE_EQUAL(CLI::Parameters()["mat"].required, true);
+  BOOST_REQUIRE_EQUAL(CLI::Parameters()["mat"].input, true);
+  BOOST_REQUIRE_EQUAL(CLI::Parameters()["mat"].cppType, "arma::mat");
+
+  CLI::ClearSettings();
+}
+
+/**
+ * Make sure GetParam() works.
+ */
+BOOST_AUTO_TEST_CASE(GetParamDoubleTest)
+{
+  util::ParamData d;
+  double x = 5.0;
+  d.value = boost::any(x);
+
+  double* output = NULL;
+  GetParam<double>(d, (void*) NULL, (void*) &output);
+
+  BOOST_REQUIRE_EQUAL(*output, 5.0);
+}
+
+BOOST_AUTO_TEST_CASE(GetParamMatTest)
+{
+  util::ParamData d;
+  arma::mat m(5, 5, arma::fill::ones);
+  d.value = boost::any(m);
+
+  arma::mat* output = NULL;
+  GetParam<arma::mat>(d, (void*) NULL, (void*) &output);
+
+  BOOST_REQUIRE_EQUAL(output->n_rows, 5);
+  BOOST_REQUIRE_EQUAL(output->n_cols, 5);
+  for (size_t i = 0; i < 25; ++i)
+    BOOST_REQUIRE_EQUAL((*output)[i], 1.0);
+}
+
+/**
+ * All of the other functions are implicitly tested simply by compilation.
+ */
+
+BOOST_AUTO_TEST_SUITE_END();