torture: Add assert macros for ssh return codes

This allows us to print errors from ssh sessions.

Signed-off-by: Andreas Schneider <asn@cryptomilk.org>

tests/CMakeLists.txt

@@ -35,7 +35,8 @@ add_library(${TORTURE_LIBRARY}
                 cmdline.c
                 torture.c
                 torture_key.c
-                torture_pki.c)
+                torture_pki.c
+                torture_cmocka.c)
 target_link_libraries(${TORTURE_LIBRARY} ${TORTURE_LINK_LIBRARIES})
 
 if (ARGP_LIBRARY)

tests/torture.h

@@ -40,6 +40,8 @@
 
 #include <cmocka.h>
 
+#include "torture_cmocka.h"
+
 #ifndef assert_return_code
 /* hack for older versions of cmocka */
 #define assert_return_code(code, errno) \

tests/torture_cmocka.c

@@ -0,0 +1,100 @@
+/*
+ * torture.c - torture library for testing libssh
+ *
+ * This file is part of the SSH Library
+ *
+ * Copyright (c) 2018      by Andreas Schneider <asn@cryptomilk.org>
+ *
+ * The SSH Library is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or (at your
+ * option) any later version.
+ *
+ * The SSH Library is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with the SSH Library; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+ * MA 02111-1307, USA.
+ */
+
+#include "config.h"
+
+#include "torture.h"
+
+void _assert_ssh_return_code(ssh_session session,
+                             int rc,
+                             const char * const file,
+                             const int line)
+{
+    char ssh_error[1024] = {0};
+
+    if (session != NULL) {
+        snprintf(ssh_error,
+                 sizeof(ssh_error),
+                 "ERROR: Invalid return code - %s",
+                 ssh_get_error(session));
+    } else {
+        snprintf(ssh_error,
+                 sizeof(ssh_error),
+                 "ERROR: Invalid return code");
+    }
+
+    _assert_true(rc == SSH_OK,
+                 ssh_error,
+                 file,
+                 line);
+}
+
+void _assert_ssh_return_code_equal(ssh_session session,
+                                   int rc,
+                                   int expected_rc,
+                                   const char * const file,
+                                   const int line)
+{
+    char ssh_error[1024] = {0};
+
+    if (session != NULL) {
+        snprintf(ssh_error,
+                 sizeof(ssh_error),
+                 "ERROR: Invalid return code - %s",
+                 ssh_get_error(session));
+    } else {
+        snprintf(ssh_error,
+                 sizeof(ssh_error),
+                 "ERROR: Invalid return code");
+    }
+
+    _assert_true((rc == expected_rc),
+                 ssh_error,
+                 file,
+                 line);
+}
+
+void _assert_ssh_return_code_not_equal(ssh_session session,
+                                       int rc,
+                                       int unexpected_rc,
+                                       const char * const file,
+                                       const int line)
+{
+    char ssh_error[1024] = {0};
+
+    if (session != NULL) {
+        snprintf(ssh_error,
+                 sizeof(ssh_error),
+                 "ERROR: Invalid return code - %s",
+                 ssh_get_error(session));
+    } else {
+        snprintf(ssh_error,
+                 sizeof(ssh_error),
+                 "ERROR: Invalid return code");
+    }
+
+    _assert_true((rc != unexpected_rc),
+                 ssh_error,
+                 file,
+                 line);
+}

tests/torture_cmocka.h

@@ -0,0 +1,55 @@
+/*
+ * torture.c - torture library for testing libssh
+ *
+ * This file is part of the SSH Library
+ *
+ * Copyright (c) 2018      by Andreas Schneider <asn@cryptomilk.org>
+ *
+ * The SSH Library is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or (at your
+ * option) any later version.
+ *
+ * The SSH Library is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with the SSH Library; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+ * MA 02111-1307, USA.
+ */
+
+#ifndef _TORTURE_CMOCKA_H
+#define _TORTURE_CMOCKA_H
+
+#include "libssh/session.h"
+
+void _assert_ssh_return_code(ssh_session session,
+                             int rc,
+                             const char * const file,
+                             const int line);
+
+#define assert_ssh_return_code(session, rc) \
+    _assert_ssh_return_code((session), (rc), __FILE__, __LINE__)
+
+void _assert_ssh_return_code_equal(ssh_session session,
+                                   int rc,
+                                   int expected_rc,
+                                   const char * const file,
+                                   const int line);
+
+#define assert_ssh_return_code_equal(session, rc, expected_rc) \
+    _assert_ssh_return_code_equal((session), (rc), (expected_rc), __FILE__, __LINE__)
+
+void _assert_ssh_return_code_not_equal(ssh_session session,
+                                       int rc,
+                                       int expected_rc,
+                                       const char * const file,
+                                       const int line);
+
+#define assert_ssh_return_code_not_equal(session, rc, unexpected_rc) \
+    _assert_ssh_return_code_not_equal((session), (rc), (unexpected_rc), __FILE__, __LINE__)
+
+#endif /* _TORTURE_CMOCKA_H */