mirror of
https://github.com/eclipse/paho.mqtt.cpp.git
synced 2025-05-09 03:11:23 +08:00
Moved ssl_options unit tests to Catch2
This commit is contained in:
fpagliughi
parent
98da500fb5
commit
4a5de0db4f
@ -6,9 +6,9 @@ else()
|
||||
set(_PAHO_MQTT_C_LIB_NAME paho-mqtt3a)
|
||||
endif()
|
||||
# add suffix when using static Paho MQTT C library variant
|
||||
if(PAHO_BUILD_STATIC)
|
||||
set(_PAHO_MQTT_C_LIB_NAME ${_PAHO_MQTT_C_LIB_NAME}-static)
|
||||
endif()
|
||||
#if(PAHO_BUILD_STATIC)
|
||||
# set(_PAHO_MQTT_C_LIB_NAME ${_PAHO_MQTT_C_LIB_NAME}-static)
|
||||
#endif()
|
||||
|
||||
find_library(PAHO_MQTT_C_LIBRARIES NAMES ${_PAHO_MQTT_C_LIB_NAME})
|
||||
unset(_PAHO_MQTT_C_LIB_NAME)
|
||||
|
||||
@ -74,8 +74,7 @@ class ssl_options
|
||||
|
||||
/** The connect options has special access */
|
||||
friend class connect_options;
|
||||
friend class connect_options_test;
|
||||
friend class ssl_options_test;
|
||||
//friend class connect_options_test;
|
||||
|
||||
/**
|
||||
* Gets a pointer to the C-language NUL-terminated strings for the
|
||||
@ -144,6 +143,12 @@ public:
|
||||
* @return A reference to this object.
|
||||
*/
|
||||
ssl_options& operator=(ssl_options&& opt);
|
||||
/**
|
||||
* Expose the underlying C struct for the unit tests.
|
||||
*/
|
||||
#if defined(UNIT_TESTS)
|
||||
const MQTTAsync_SSLOptions& c_struct() const { return opts_; }
|
||||
#endif
|
||||
/**
|
||||
* Returns the file containing the public digital certificates trusted by
|
||||
* the client.
|
||||
|
||||
@ -1,318 +0,0 @@
|
||||
// ssl_options_test.h
|
||||
// Unit tests for the ssl_options class in the Paho MQTT C++ library.
|
||||
|
||||
/*******************************************************************************
|
||||
* Copyright (c) 2016 Frank Pagliughi <fpagliughi@mindspring.com>
|
||||
*
|
||||
* All rights reserved. This program and the accompanying materials
|
||||
* are made available under the terms of the Eclipse Public License v1.0
|
||||
* and Eclipse Distribution License v1.0 which accompany this distribution.
|
||||
*
|
||||
* The Eclipse Public License is available at
|
||||
* http://www.eclipse.org/legal/epl-v10.html
|
||||
* and the Eclipse Distribution License is available at
|
||||
* http://www.eclipse.org/org/documents/edl-v10.php.
|
||||
*
|
||||
* Contributors:
|
||||
* Frank Pagliughi - initial implementation and documentation
|
||||
* Guilherme M. Ferreira - add more test cases
|
||||
*******************************************************************************/
|
||||
|
||||
#ifndef __mqtt_ssl_options_test_h
|
||||
#define __mqtt_ssl_options_test_h
|
||||
|
||||
#include <cppunit/ui/text/TestRunner.h>
|
||||
#include <cppunit/extensions/HelperMacros.h>
|
||||
|
||||
#include "mqtt/ssl_options.h"
|
||||
|
||||
namespace mqtt {
|
||||
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
class ssl_options_test : public CppUnit::TestFixture
|
||||
{
|
||||
CPPUNIT_TEST_SUITE( ssl_options_test );
|
||||
|
||||
CPPUNIT_TEST( test_dflt_constructor );
|
||||
CPPUNIT_TEST( test_user_constructor );
|
||||
CPPUNIT_TEST( test_copy_constructor );
|
||||
CPPUNIT_TEST( test_move_constructor );
|
||||
CPPUNIT_TEST( test_copy_assignment );
|
||||
CPPUNIT_TEST( test_move_assignment );
|
||||
CPPUNIT_TEST( test_set_user );
|
||||
CPPUNIT_TEST( test_set_empty_strings );
|
||||
|
||||
CPPUNIT_TEST_SUITE_END();
|
||||
|
||||
// C struct signature/eyecatcher
|
||||
const char* CSIG = "MQTS";
|
||||
const size_t CSIG_LEN = std::strlen(CSIG);
|
||||
|
||||
const bool DFLT_SERVER_CERT = true;
|
||||
|
||||
const std::string EMPTY_STR;
|
||||
const std::string TRUST_STORE { "trust store" };
|
||||
const std::string KEY_STORE { "key store" };
|
||||
const std::string PRIVATE_KEY { "private key" };
|
||||
const std::string PRIVATE_KEY_PASSWORD { "private key password" };
|
||||
const std::string ENABLED_CIPHER_SUITES { "cipher suite" };
|
||||
const bool SERVER_CERT { false };
|
||||
|
||||
mqtt::ssl_options orgOpts;
|
||||
|
||||
public:
|
||||
void setUp() {
|
||||
orgOpts = mqtt::ssl_options{
|
||||
TRUST_STORE,
|
||||
KEY_STORE,
|
||||
PRIVATE_KEY,
|
||||
PRIVATE_KEY_PASSWORD,
|
||||
ENABLED_CIPHER_SUITES,
|
||||
SERVER_CERT};
|
||||
}
|
||||
void tearDown() {}
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Test the default constructor
|
||||
// ----------------------------------------------------------------------
|
||||
|
||||
void test_dflt_constructor() {
|
||||
mqtt::ssl_options opts;
|
||||
|
||||
CPPUNIT_ASSERT_EQUAL(EMPTY_STR, opts.get_trust_store());
|
||||
CPPUNIT_ASSERT_EQUAL(EMPTY_STR, opts.get_key_store());
|
||||
CPPUNIT_ASSERT_EQUAL(EMPTY_STR, opts.get_private_key());
|
||||
CPPUNIT_ASSERT_EQUAL(EMPTY_STR, opts.get_private_key_password());
|
||||
CPPUNIT_ASSERT_EQUAL(DFLT_SERVER_CERT, opts.get_enable_server_cert_auth());
|
||||
|
||||
// Make sure the empty string represents a nullptr for C library
|
||||
const MQTTAsync_SSLOptions& c_struct = opts.opts_;
|
||||
|
||||
CPPUNIT_ASSERT(!memcmp(&c_struct.struct_id, CSIG, CSIG_LEN));
|
||||
CPPUNIT_ASSERT(c_struct.trustStore == nullptr);
|
||||
CPPUNIT_ASSERT(c_struct.keyStore == nullptr);
|
||||
CPPUNIT_ASSERT(c_struct.privateKey == nullptr);
|
||||
CPPUNIT_ASSERT(c_struct.privateKeyPassword == nullptr);
|
||||
CPPUNIT_ASSERT(c_struct.enabledCipherSuites == nullptr);
|
||||
CPPUNIT_ASSERT_EQUAL(DFLT_SERVER_CERT, c_struct.enableServerCertAuth != 0);
|
||||
}
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Test the constructor that takes user arguments
|
||||
// ----------------------------------------------------------------------
|
||||
|
||||
void test_user_constructor() {
|
||||
mqtt::ssl_options opts { TRUST_STORE, KEY_STORE, PRIVATE_KEY,
|
||||
PRIVATE_KEY_PASSWORD, ENABLED_CIPHER_SUITES, SERVER_CERT };
|
||||
|
||||
CPPUNIT_ASSERT_EQUAL(TRUST_STORE, opts.get_trust_store());
|
||||
CPPUNIT_ASSERT_EQUAL(KEY_STORE, opts.get_key_store());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY, opts.get_private_key());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY_PASSWORD, opts.get_private_key_password());
|
||||
CPPUNIT_ASSERT_EQUAL(ENABLED_CIPHER_SUITES, opts.get_enabled_cipher_suites());
|
||||
CPPUNIT_ASSERT_EQUAL(SERVER_CERT, opts.get_enable_server_cert_auth());
|
||||
|
||||
// Check the underlying C struct
|
||||
const MQTTAsync_SSLOptions& c_struct = opts.opts_;
|
||||
|
||||
CPPUNIT_ASSERT(!memcmp(&c_struct.struct_id, CSIG, CSIG_LEN));
|
||||
CPPUNIT_ASSERT(!strcmp(c_struct.trustStore, TRUST_STORE.c_str()));
|
||||
CPPUNIT_ASSERT(!strcmp(c_struct.keyStore, KEY_STORE.c_str()));
|
||||
CPPUNIT_ASSERT(!strcmp(c_struct.privateKey, PRIVATE_KEY.c_str()));
|
||||
CPPUNIT_ASSERT(!strcmp(c_struct.privateKeyPassword, PRIVATE_KEY_PASSWORD.c_str()));
|
||||
CPPUNIT_ASSERT(!strcmp(c_struct.enabledCipherSuites, ENABLED_CIPHER_SUITES.c_str()));
|
||||
CPPUNIT_ASSERT_EQUAL(SERVER_CERT, c_struct.enableServerCertAuth != 0);
|
||||
}
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Test the copy constructor
|
||||
// ----------------------------------------------------------------------
|
||||
|
||||
void test_copy_constructor() {
|
||||
mqtt::ssl_options opts{orgOpts};
|
||||
|
||||
CPPUNIT_ASSERT_EQUAL(TRUST_STORE, opts.get_trust_store());
|
||||
CPPUNIT_ASSERT_EQUAL(KEY_STORE, opts.get_key_store());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY, opts.get_private_key());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY_PASSWORD, opts.get_private_key_password());
|
||||
CPPUNIT_ASSERT_EQUAL(ENABLED_CIPHER_SUITES, opts.get_enabled_cipher_suites());
|
||||
CPPUNIT_ASSERT_EQUAL(SERVER_CERT, opts.get_enable_server_cert_auth());
|
||||
|
||||
// Check the underlying C struct
|
||||
const MQTTAsync_SSLOptions& c_struct = opts.opts_;
|
||||
|
||||
CPPUNIT_ASSERT(!memcmp(&c_struct.struct_id, CSIG, CSIG_LEN));
|
||||
CPPUNIT_ASSERT(!strcmp(c_struct.trustStore, TRUST_STORE.c_str()));
|
||||
CPPUNIT_ASSERT(!strcmp(c_struct.keyStore, KEY_STORE.c_str()));
|
||||
CPPUNIT_ASSERT(!strcmp(c_struct.privateKey, PRIVATE_KEY.c_str()));
|
||||
CPPUNIT_ASSERT(!strcmp(c_struct.privateKeyPassword, PRIVATE_KEY_PASSWORD.c_str()));
|
||||
CPPUNIT_ASSERT(!strcmp(c_struct.enabledCipherSuites, ENABLED_CIPHER_SUITES.c_str()));
|
||||
CPPUNIT_ASSERT_EQUAL(SERVER_CERT, c_struct.enableServerCertAuth != 0);
|
||||
|
||||
// Make sure it's a true copy, not linked to the original
|
||||
orgOpts.set_trust_store(EMPTY_STR);
|
||||
orgOpts.set_key_store(EMPTY_STR);
|
||||
orgOpts.set_private_key(EMPTY_STR);
|
||||
orgOpts.set_private_key_password(EMPTY_STR);
|
||||
orgOpts.set_enabled_cipher_suites(EMPTY_STR);
|
||||
orgOpts.set_enable_server_cert_auth(!SERVER_CERT);
|
||||
|
||||
CPPUNIT_ASSERT_EQUAL(TRUST_STORE, opts.get_trust_store());
|
||||
CPPUNIT_ASSERT_EQUAL(KEY_STORE, opts.get_key_store());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY, opts.get_private_key());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY_PASSWORD, opts.get_private_key_password());
|
||||
CPPUNIT_ASSERT_EQUAL(ENABLED_CIPHER_SUITES, opts.get_enabled_cipher_suites());
|
||||
CPPUNIT_ASSERT_EQUAL(SERVER_CERT, opts.get_enable_server_cert_auth());
|
||||
}
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Test the move constructor
|
||||
// ----------------------------------------------------------------------
|
||||
|
||||
void test_move_constructor() {
|
||||
mqtt::ssl_options opts(std::move(orgOpts));
|
||||
|
||||
CPPUNIT_ASSERT_EQUAL(TRUST_STORE, opts.get_trust_store());
|
||||
CPPUNIT_ASSERT_EQUAL(KEY_STORE, opts.get_key_store());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY, opts.get_private_key());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY_PASSWORD, opts.get_private_key_password());
|
||||
CPPUNIT_ASSERT_EQUAL(ENABLED_CIPHER_SUITES, opts.get_enabled_cipher_suites());
|
||||
CPPUNIT_ASSERT_EQUAL(SERVER_CERT, opts.get_enable_server_cert_auth());
|
||||
|
||||
// Check that the original was moved
|
||||
CPPUNIT_ASSERT_EQUAL(EMPTY_STR, orgOpts.get_trust_store());
|
||||
CPPUNIT_ASSERT_EQUAL(EMPTY_STR, orgOpts.get_key_store());
|
||||
CPPUNIT_ASSERT_EQUAL(EMPTY_STR, orgOpts.get_private_key());
|
||||
CPPUNIT_ASSERT_EQUAL(EMPTY_STR, orgOpts.get_private_key_password());
|
||||
CPPUNIT_ASSERT_EQUAL(EMPTY_STR, orgOpts.get_enabled_cipher_suites());
|
||||
}
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Test the copy assignment operator=(const&)
|
||||
// ----------------------------------------------------------------------
|
||||
|
||||
void test_copy_assignment() {
|
||||
mqtt::ssl_options opts;
|
||||
|
||||
opts = orgOpts;
|
||||
|
||||
CPPUNIT_ASSERT_EQUAL(TRUST_STORE, opts.get_trust_store());
|
||||
CPPUNIT_ASSERT_EQUAL(KEY_STORE, opts.get_key_store());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY, opts.get_private_key());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY_PASSWORD, opts.get_private_key_password());
|
||||
CPPUNIT_ASSERT_EQUAL(ENABLED_CIPHER_SUITES, opts.get_enabled_cipher_suites());
|
||||
CPPUNIT_ASSERT_EQUAL(SERVER_CERT, opts.get_enable_server_cert_auth());
|
||||
|
||||
// Make sure it's a true copy, not linked to the original
|
||||
orgOpts.set_trust_store("");
|
||||
orgOpts.set_key_store("");
|
||||
orgOpts.set_private_key("");
|
||||
orgOpts.set_private_key_password("");
|
||||
orgOpts.set_enabled_cipher_suites("");
|
||||
orgOpts.set_enable_server_cert_auth(!SERVER_CERT);
|
||||
|
||||
CPPUNIT_ASSERT_EQUAL(TRUST_STORE, opts.get_trust_store());
|
||||
CPPUNIT_ASSERT_EQUAL(KEY_STORE, opts.get_key_store());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY, opts.get_private_key());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY_PASSWORD, opts.get_private_key_password());
|
||||
CPPUNIT_ASSERT_EQUAL(ENABLED_CIPHER_SUITES, opts.get_enabled_cipher_suites());
|
||||
CPPUNIT_ASSERT_EQUAL(SERVER_CERT, opts.get_enable_server_cert_auth());
|
||||
|
||||
// Self assignment should cause no harm
|
||||
opts = opts;
|
||||
|
||||
CPPUNIT_ASSERT_EQUAL(TRUST_STORE, opts.get_trust_store());
|
||||
CPPUNIT_ASSERT_EQUAL(KEY_STORE, opts.get_key_store());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY, opts.get_private_key());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY_PASSWORD, opts.get_private_key_password());
|
||||
CPPUNIT_ASSERT_EQUAL(ENABLED_CIPHER_SUITES, opts.get_enabled_cipher_suites());
|
||||
CPPUNIT_ASSERT_EQUAL(SERVER_CERT, opts.get_enable_server_cert_auth());
|
||||
}
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Test the move assignment, operator=(&&)
|
||||
// ----------------------------------------------------------------------
|
||||
|
||||
void test_move_assignment() {
|
||||
mqtt::ssl_options opts;
|
||||
|
||||
opts = std::move(orgOpts);
|
||||
|
||||
CPPUNIT_ASSERT_EQUAL(TRUST_STORE, opts.get_trust_store());
|
||||
CPPUNIT_ASSERT_EQUAL(KEY_STORE, opts.get_key_store());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY, opts.get_private_key());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY_PASSWORD, opts.get_private_key_password());
|
||||
CPPUNIT_ASSERT_EQUAL(ENABLED_CIPHER_SUITES, opts.get_enabled_cipher_suites());
|
||||
CPPUNIT_ASSERT_EQUAL(SERVER_CERT, opts.get_enable_server_cert_auth());
|
||||
|
||||
// Check that the original was moved
|
||||
CPPUNIT_ASSERT_EQUAL(EMPTY_STR, orgOpts.get_trust_store());
|
||||
CPPUNIT_ASSERT_EQUAL(EMPTY_STR, orgOpts.get_key_store());
|
||||
CPPUNIT_ASSERT_EQUAL(EMPTY_STR, orgOpts.get_private_key());
|
||||
CPPUNIT_ASSERT_EQUAL(EMPTY_STR, orgOpts.get_private_key_password());
|
||||
CPPUNIT_ASSERT_EQUAL(EMPTY_STR, orgOpts.get_enabled_cipher_suites());
|
||||
|
||||
// Self assignment should cause no harm
|
||||
// (clang++ is smart enough to warn about this)
|
||||
#if !defined(__clang__)
|
||||
opts = std::move(opts);
|
||||
CPPUNIT_ASSERT_EQUAL(TRUST_STORE, opts.get_trust_store());
|
||||
CPPUNIT_ASSERT_EQUAL(KEY_STORE, opts.get_key_store());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY, opts.get_private_key());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY_PASSWORD, opts.get_private_key_password());
|
||||
CPPUNIT_ASSERT_EQUAL(ENABLED_CIPHER_SUITES, opts.get_enabled_cipher_suites());
|
||||
CPPUNIT_ASSERT_EQUAL(SERVER_CERT, opts.get_enable_server_cert_auth());
|
||||
#endif
|
||||
}
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Test set/get of the user and password.
|
||||
// ----------------------------------------------------------------------
|
||||
|
||||
void test_set_user() {
|
||||
mqtt::ssl_options opts;
|
||||
|
||||
opts.set_trust_store(TRUST_STORE);
|
||||
opts.set_key_store(KEY_STORE);
|
||||
opts.set_private_key(PRIVATE_KEY);
|
||||
opts.set_private_key_password(PRIVATE_KEY_PASSWORD);
|
||||
opts.set_enabled_cipher_suites(ENABLED_CIPHER_SUITES);
|
||||
opts.set_enable_server_cert_auth(SERVER_CERT);
|
||||
|
||||
CPPUNIT_ASSERT_EQUAL(TRUST_STORE, opts.get_trust_store());
|
||||
CPPUNIT_ASSERT_EQUAL(KEY_STORE, opts.get_key_store());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY, opts.get_private_key());
|
||||
CPPUNIT_ASSERT_EQUAL(PRIVATE_KEY_PASSWORD, opts.get_private_key_password());
|
||||
CPPUNIT_ASSERT_EQUAL(ENABLED_CIPHER_SUITES, opts.get_enabled_cipher_suites());
|
||||
CPPUNIT_ASSERT_EQUAL(SERVER_CERT, opts.get_enable_server_cert_auth());
|
||||
}
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Test if empty strings gives nullptr opts
|
||||
// ----------------------------------------------------------------------
|
||||
|
||||
void test_set_empty_strings() {
|
||||
orgOpts.set_trust_store(EMPTY_STR);
|
||||
orgOpts.set_key_store(EMPTY_STR);
|
||||
orgOpts.set_private_key(EMPTY_STR);
|
||||
orgOpts.set_private_key_password(EMPTY_STR);
|
||||
orgOpts.set_enabled_cipher_suites(EMPTY_STR);
|
||||
|
||||
// Make sure the empty string represents a nullptr for C library
|
||||
const MQTTAsync_SSLOptions& c_struct = orgOpts.opts_;
|
||||
|
||||
CPPUNIT_ASSERT(!memcmp(&c_struct.struct_id, CSIG, CSIG_LEN));
|
||||
CPPUNIT_ASSERT(c_struct.trustStore == nullptr);
|
||||
CPPUNIT_ASSERT(c_struct.keyStore == nullptr);
|
||||
CPPUNIT_ASSERT(c_struct.privateKey == nullptr);
|
||||
CPPUNIT_ASSERT(c_struct.privateKeyPassword == nullptr);
|
||||
CPPUNIT_ASSERT(c_struct.enabledCipherSuites == nullptr);
|
||||
}
|
||||
};
|
||||
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
} // end namespace mqtt
|
||||
|
||||
#endif // __mqtt_ssl_options_test_h
|
||||
|
||||
@ -20,7 +20,6 @@
|
||||
#include "async_client_test.h"
|
||||
#include "async_client_v3_test.h"
|
||||
#include "client_test.h"
|
||||
#include "ssl_options_test.h"
|
||||
#include "disconnect_options_test.h"
|
||||
#include "response_options_test.h"
|
||||
#include "delivery_response_options_test.h"
|
||||
@ -33,10 +32,6 @@ using namespace CppUnit;
|
||||
|
||||
int main(int argc, char* argv[])
|
||||
{
|
||||
#if defined(OPENSSL)
|
||||
CPPUNIT_TEST_SUITE_REGISTRATION( mqtt::ssl_options_test );
|
||||
#endif
|
||||
|
||||
CPPUNIT_TEST_SUITE_REGISTRATION( mqtt::disconnect_options_test );
|
||||
CPPUNIT_TEST_SUITE_REGISTRATION( mqtt::response_options_test );
|
||||
|
||||
|
||||
@ -40,6 +40,10 @@ add_executable(unit_tests unit_tests.cpp
|
||||
test_will_options.cpp
|
||||
)
|
||||
|
||||
if(PAHO_WITH_SSL)
|
||||
target_sources(unit_tests PUBLIC test_ssl_options.cpp)
|
||||
endif()
|
||||
|
||||
# --- Link for executables ---
|
||||
|
||||
message(STATUS "Using library for unit tests: ${PAHO_CPP_LIB}")
|
||||
|
||||
328
test/unit/test_ssl_options.cpp
Normal file
328
test/unit/test_ssl_options.cpp
Normal file
@ -0,0 +1,328 @@
|
||||
// test_ssl_options.cpp
|
||||
//
|
||||
// Unit tests for the ssl_options class in the Paho MQTT C++ library.
|
||||
//
|
||||
|
||||
/*******************************************************************************
|
||||
* Copyright (c) 2016-2020 Frank Pagliughi <fpagliughi@mindspring.com>
|
||||
*
|
||||
* All rights reserved. This program and the accompanying materials
|
||||
* are made available under the terms of the Eclipse Public License v1.0
|
||||
* and Eclipse Distribution License v1.0 which accompany this distribution.
|
||||
*
|
||||
* The Eclipse Public License is available at
|
||||
* http://www.eclipse.org/legal/epl-v10.html
|
||||
* and the Eclipse Distribution License is available at
|
||||
* http://www.eclipse.org/org/documents/edl-v10.php.
|
||||
*
|
||||
* Contributors:
|
||||
* Frank Pagliughi - initial implementation and documentation
|
||||
* Guilherme M. Ferreira - add more test cases
|
||||
*******************************************************************************/
|
||||
|
||||
#define UNIT_TESTS
|
||||
|
||||
#include "catch2/catch.hpp"
|
||||
#include "mqtt/ssl_options.h"
|
||||
|
||||
using namespace std::chrono;
|
||||
using namespace mqtt;
|
||||
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// C struct signature/eyecatcher
|
||||
static const char* CSIG = "MQTS";
|
||||
static const size_t CSIG_LEN = std::strlen(CSIG);
|
||||
|
||||
static const bool DFLT_SERVER_CERT = true;
|
||||
|
||||
static const std::string EMPTY_STR;
|
||||
static const std::string TRUST_STORE { "trust store" };
|
||||
static const std::string KEY_STORE { "key store" };
|
||||
static const std::string PRIVATE_KEY { "private key" };
|
||||
static const std::string PRIVATE_KEY_PASSWORD { "private key password" };
|
||||
static const std::string ENABLED_CIPHER_SUITES { "cipher suite" };
|
||||
static const bool SERVER_CERT { false };
|
||||
|
||||
static mqtt::ssl_options orgOpts {
|
||||
TRUST_STORE,
|
||||
KEY_STORE,
|
||||
PRIVATE_KEY,
|
||||
PRIVATE_KEY_PASSWORD,
|
||||
ENABLED_CIPHER_SUITES,
|
||||
SERVER_CERT
|
||||
};
|
||||
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Test the default constructor
|
||||
// ----------------------------------------------------------------------
|
||||
|
||||
TEST_CASE("ssl_options dflt constructor", "[options]")
|
||||
{
|
||||
mqtt::ssl_options opts;
|
||||
|
||||
REQUIRE(EMPTY_STR == opts.get_trust_store());
|
||||
REQUIRE(EMPTY_STR == opts.get_key_store());
|
||||
REQUIRE(EMPTY_STR == opts.get_private_key());
|
||||
REQUIRE(EMPTY_STR == opts.get_private_key_password());
|
||||
REQUIRE(DFLT_SERVER_CERT == opts.get_enable_server_cert_auth());
|
||||
|
||||
// Make sure the empty string represents a nullptr for C library
|
||||
const auto& c_struct = opts.c_struct();
|
||||
|
||||
REQUIRE(!memcmp(&c_struct.struct_id, CSIG, CSIG_LEN));
|
||||
REQUIRE(c_struct.trustStore == nullptr);
|
||||
REQUIRE(c_struct.keyStore == nullptr);
|
||||
REQUIRE(c_struct.privateKey == nullptr);
|
||||
REQUIRE(c_struct.privateKeyPassword == nullptr);
|
||||
REQUIRE(c_struct.enabledCipherSuites == nullptr);
|
||||
//REQUIRE(DFLT_SERVER_CERT == c_struct.enableServerCertAuth != 0);
|
||||
}
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Test the constructor that takes user arguments
|
||||
// ----------------------------------------------------------------------
|
||||
|
||||
TEST_CASE("ssl_options user constructor", "[options]")
|
||||
{
|
||||
mqtt::ssl_options opts { TRUST_STORE, KEY_STORE, PRIVATE_KEY,
|
||||
PRIVATE_KEY_PASSWORD, ENABLED_CIPHER_SUITES, SERVER_CERT };
|
||||
|
||||
REQUIRE(TRUST_STORE == opts.get_trust_store());
|
||||
REQUIRE(KEY_STORE == opts.get_key_store());
|
||||
REQUIRE(PRIVATE_KEY == opts.get_private_key());
|
||||
REQUIRE(PRIVATE_KEY_PASSWORD == opts.get_private_key_password());
|
||||
REQUIRE(ENABLED_CIPHER_SUITES == opts.get_enabled_cipher_suites());
|
||||
REQUIRE(SERVER_CERT == opts.get_enable_server_cert_auth());
|
||||
|
||||
// Check the underlying C struct
|
||||
const auto& c_struct = opts.c_struct();
|
||||
|
||||
REQUIRE(!memcmp(&c_struct.struct_id, CSIG, CSIG_LEN));
|
||||
REQUIRE(!strcmp(c_struct.trustStore, TRUST_STORE.c_str()));
|
||||
REQUIRE(!strcmp(c_struct.keyStore, KEY_STORE.c_str()));
|
||||
REQUIRE(!strcmp(c_struct.privateKey, PRIVATE_KEY.c_str()));
|
||||
REQUIRE(!strcmp(c_struct.privateKeyPassword, PRIVATE_KEY_PASSWORD.c_str()));
|
||||
REQUIRE(!strcmp(c_struct.enabledCipherSuites, ENABLED_CIPHER_SUITES.c_str()));
|
||||
//REQUIRE(SERVER_CERT == c_struct.enableServerCertAuth != 0);
|
||||
}
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Test the copy constructor
|
||||
// ----------------------------------------------------------------------
|
||||
|
||||
TEST_CASE("ssl_options copy constructor", "[options]")
|
||||
{
|
||||
mqtt::ssl_options opts{orgOpts};
|
||||
|
||||
REQUIRE(TRUST_STORE == opts.get_trust_store());
|
||||
REQUIRE(KEY_STORE == opts.get_key_store());
|
||||
REQUIRE(PRIVATE_KEY == opts.get_private_key());
|
||||
REQUIRE(PRIVATE_KEY_PASSWORD == opts.get_private_key_password());
|
||||
REQUIRE(ENABLED_CIPHER_SUITES == opts.get_enabled_cipher_suites());
|
||||
REQUIRE(SERVER_CERT == opts.get_enable_server_cert_auth());
|
||||
|
||||
// Check the underlying C struct
|
||||
const auto& c_struct = opts.c_struct();
|
||||
|
||||
REQUIRE(!memcmp(&c_struct.struct_id, CSIG, CSIG_LEN));
|
||||
REQUIRE(!strcmp(c_struct.trustStore, TRUST_STORE.c_str()));
|
||||
REQUIRE(!strcmp(c_struct.keyStore, KEY_STORE.c_str()));
|
||||
REQUIRE(!strcmp(c_struct.privateKey, PRIVATE_KEY.c_str()));
|
||||
REQUIRE(!strcmp(c_struct.privateKeyPassword, PRIVATE_KEY_PASSWORD.c_str()));
|
||||
REQUIRE(!strcmp(c_struct.enabledCipherSuites, ENABLED_CIPHER_SUITES.c_str()));
|
||||
//REQUIRE(SERVER_CERT == c_struct.enableServerCertAuth != 0);
|
||||
|
||||
// Make sure it's a true copy, not linked to the original
|
||||
orgOpts.set_trust_store(EMPTY_STR);
|
||||
orgOpts.set_key_store(EMPTY_STR);
|
||||
orgOpts.set_private_key(EMPTY_STR);
|
||||
orgOpts.set_private_key_password(EMPTY_STR);
|
||||
orgOpts.set_enabled_cipher_suites(EMPTY_STR);
|
||||
orgOpts.set_enable_server_cert_auth(!SERVER_CERT);
|
||||
|
||||
REQUIRE(TRUST_STORE == opts.get_trust_store());
|
||||
REQUIRE(KEY_STORE == opts.get_key_store());
|
||||
REQUIRE(PRIVATE_KEY == opts.get_private_key());
|
||||
REQUIRE(PRIVATE_KEY_PASSWORD == opts.get_private_key_password());
|
||||
REQUIRE(ENABLED_CIPHER_SUITES == opts.get_enabled_cipher_suites());
|
||||
REQUIRE(SERVER_CERT == opts.get_enable_server_cert_auth());
|
||||
}
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Test the move constructor
|
||||
// ----------------------------------------------------------------------
|
||||
|
||||
TEST_CASE("ssl_options move constructor", "[options]")
|
||||
{
|
||||
mqtt::ssl_options orgOpts {
|
||||
TRUST_STORE,
|
||||
KEY_STORE,
|
||||
PRIVATE_KEY,
|
||||
PRIVATE_KEY_PASSWORD,
|
||||
ENABLED_CIPHER_SUITES,
|
||||
SERVER_CERT
|
||||
};
|
||||
|
||||
mqtt::ssl_options opts(std::move(orgOpts));
|
||||
|
||||
REQUIRE(TRUST_STORE == opts.get_trust_store());
|
||||
REQUIRE(KEY_STORE == opts.get_key_store());
|
||||
REQUIRE(PRIVATE_KEY == opts.get_private_key());
|
||||
REQUIRE(PRIVATE_KEY_PASSWORD == opts.get_private_key_password());
|
||||
REQUIRE(ENABLED_CIPHER_SUITES == opts.get_enabled_cipher_suites());
|
||||
REQUIRE(SERVER_CERT == opts.get_enable_server_cert_auth());
|
||||
|
||||
// Check that the original was moved
|
||||
REQUIRE(EMPTY_STR == orgOpts.get_trust_store());
|
||||
REQUIRE(EMPTY_STR == orgOpts.get_key_store());
|
||||
REQUIRE(EMPTY_STR == orgOpts.get_private_key());
|
||||
REQUIRE(EMPTY_STR == orgOpts.get_private_key_password());
|
||||
REQUIRE(EMPTY_STR == orgOpts.get_enabled_cipher_suites());
|
||||
}
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Test the copy assignment operator=(const&)
|
||||
// ----------------------------------------------------------------------
|
||||
|
||||
TEST_CASE("ssl_options copy assignment", "[options]")
|
||||
{
|
||||
mqtt::ssl_options orgOpts {
|
||||
TRUST_STORE,
|
||||
KEY_STORE,
|
||||
PRIVATE_KEY,
|
||||
PRIVATE_KEY_PASSWORD,
|
||||
ENABLED_CIPHER_SUITES,
|
||||
SERVER_CERT
|
||||
};
|
||||
|
||||
mqtt::ssl_options opts;
|
||||
|
||||
opts = orgOpts;
|
||||
|
||||
REQUIRE(TRUST_STORE == opts.get_trust_store());
|
||||
REQUIRE(KEY_STORE == opts.get_key_store());
|
||||
REQUIRE(PRIVATE_KEY == opts.get_private_key());
|
||||
REQUIRE(PRIVATE_KEY_PASSWORD == opts.get_private_key_password());
|
||||
REQUIRE(ENABLED_CIPHER_SUITES == opts.get_enabled_cipher_suites());
|
||||
REQUIRE(SERVER_CERT == opts.get_enable_server_cert_auth());
|
||||
|
||||
// Make sure it's a true copy, not linked to the original
|
||||
orgOpts.set_trust_store("");
|
||||
orgOpts.set_key_store("");
|
||||
orgOpts.set_private_key("");
|
||||
orgOpts.set_private_key_password("");
|
||||
orgOpts.set_enabled_cipher_suites("");
|
||||
orgOpts.set_enable_server_cert_auth(!SERVER_CERT);
|
||||
|
||||
REQUIRE(TRUST_STORE == opts.get_trust_store());
|
||||
REQUIRE(KEY_STORE == opts.get_key_store());
|
||||
REQUIRE(PRIVATE_KEY == opts.get_private_key());
|
||||
REQUIRE(PRIVATE_KEY_PASSWORD == opts.get_private_key_password());
|
||||
REQUIRE(ENABLED_CIPHER_SUITES == opts.get_enabled_cipher_suites());
|
||||
REQUIRE(SERVER_CERT == opts.get_enable_server_cert_auth());
|
||||
|
||||
// Self assignment should cause no harm
|
||||
opts = opts;
|
||||
|
||||
REQUIRE(TRUST_STORE == opts.get_trust_store());
|
||||
REQUIRE(KEY_STORE == opts.get_key_store());
|
||||
REQUIRE(PRIVATE_KEY == opts.get_private_key());
|
||||
REQUIRE(PRIVATE_KEY_PASSWORD == opts.get_private_key_password());
|
||||
REQUIRE(ENABLED_CIPHER_SUITES == opts.get_enabled_cipher_suites());
|
||||
REQUIRE(SERVER_CERT == opts.get_enable_server_cert_auth());
|
||||
}
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Test the move assignment, operator=(&&)
|
||||
// ----------------------------------------------------------------------
|
||||
|
||||
TEST_CASE("ssl_options move assignment", "[options]")
|
||||
{
|
||||
mqtt::ssl_options orgOpts {
|
||||
TRUST_STORE,
|
||||
KEY_STORE,
|
||||
PRIVATE_KEY,
|
||||
PRIVATE_KEY_PASSWORD,
|
||||
ENABLED_CIPHER_SUITES,
|
||||
SERVER_CERT
|
||||
};
|
||||
|
||||
mqtt::ssl_options opts;
|
||||
|
||||
opts = std::move(orgOpts);
|
||||
|
||||
REQUIRE(TRUST_STORE == opts.get_trust_store());
|
||||
REQUIRE(KEY_STORE == opts.get_key_store());
|
||||
REQUIRE(PRIVATE_KEY == opts.get_private_key());
|
||||
REQUIRE(PRIVATE_KEY_PASSWORD == opts.get_private_key_password());
|
||||
REQUIRE(ENABLED_CIPHER_SUITES == opts.get_enabled_cipher_suites());
|
||||
REQUIRE(SERVER_CERT == opts.get_enable_server_cert_auth());
|
||||
|
||||
// Check that the original was moved
|
||||
REQUIRE(EMPTY_STR == orgOpts.get_trust_store());
|
||||
REQUIRE(EMPTY_STR == orgOpts.get_key_store());
|
||||
REQUIRE(EMPTY_STR == orgOpts.get_private_key());
|
||||
REQUIRE(EMPTY_STR == orgOpts.get_private_key_password());
|
||||
REQUIRE(EMPTY_STR == orgOpts.get_enabled_cipher_suites());
|
||||
|
||||
// Self assignment should cause no harm
|
||||
// (clang++ is smart enough to warn about this)
|
||||
#if !defined(__clang__)
|
||||
opts = std::move(opts);
|
||||
REQUIRE(TRUST_STORE == opts.get_trust_store());
|
||||
REQUIRE(KEY_STORE == opts.get_key_store());
|
||||
REQUIRE(PRIVATE_KEY == opts.get_private_key());
|
||||
REQUIRE(PRIVATE_KEY_PASSWORD == opts.get_private_key_password());
|
||||
REQUIRE(ENABLED_CIPHER_SUITES == opts.get_enabled_cipher_suites());
|
||||
REQUIRE(SERVER_CERT == opts.get_enable_server_cert_auth());
|
||||
#endif
|
||||
}
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Test set/get of the user and password.
|
||||
// ----------------------------------------------------------------------
|
||||
|
||||
TEST_CASE("ssl_options set user", "[options]")
|
||||
{
|
||||
mqtt::ssl_options opts;
|
||||
|
||||
opts.set_trust_store(TRUST_STORE);
|
||||
opts.set_key_store(KEY_STORE);
|
||||
opts.set_private_key(PRIVATE_KEY);
|
||||
opts.set_private_key_password(PRIVATE_KEY_PASSWORD);
|
||||
opts.set_enabled_cipher_suites(ENABLED_CIPHER_SUITES);
|
||||
opts.set_enable_server_cert_auth(SERVER_CERT);
|
||||
|
||||
REQUIRE(TRUST_STORE == opts.get_trust_store());
|
||||
REQUIRE(KEY_STORE == opts.get_key_store());
|
||||
REQUIRE(PRIVATE_KEY == opts.get_private_key());
|
||||
REQUIRE(PRIVATE_KEY_PASSWORD == opts.get_private_key_password());
|
||||
REQUIRE(ENABLED_CIPHER_SUITES == opts.get_enabled_cipher_suites());
|
||||
REQUIRE(SERVER_CERT == opts.get_enable_server_cert_auth());
|
||||
}
|
||||
|
||||
// ----------------------------------------------------------------------
|
||||
// Test if empty strings gives nullptr opts
|
||||
// ----------------------------------------------------------------------
|
||||
|
||||
TEST_CASE("ssl_options set empty strings", "[options]")
|
||||
{
|
||||
orgOpts.set_trust_store(EMPTY_STR);
|
||||
orgOpts.set_key_store(EMPTY_STR);
|
||||
orgOpts.set_private_key(EMPTY_STR);
|
||||
orgOpts.set_private_key_password(EMPTY_STR);
|
||||
orgOpts.set_enabled_cipher_suites(EMPTY_STR);
|
||||
|
||||
// Make sure the empty string represents a nullptr for C library
|
||||
const auto& c_struct = orgOpts.c_struct();
|
||||
|
||||
REQUIRE(!memcmp(&c_struct.struct_id, CSIG, CSIG_LEN));
|
||||
REQUIRE(c_struct.trustStore == nullptr);
|
||||
REQUIRE(c_struct.keyStore == nullptr);
|
||||
REQUIRE(c_struct.privateKey == nullptr);
|
||||
REQUIRE(c_struct.privateKeyPassword == nullptr);
|
||||
REQUIRE(c_struct.enabledCipherSuites == nullptr);
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user