Files
zoneminder/tests/zm_comms.cpp
Isaac ConnorandClaude Opus 5 a0626ed66f test: own the SockAddr that newSockAddr returns
Both "newSockAddr from resolved addr" sections called
zm::SockAddr::newSockAddr and dropped the pointer. It hands ownership to the
caller -- Socket deletes the ones it holds in its destructor -- so each run
leaked one: 48 bytes for the AF_INET case and 240 for the AF_UNIX one, the
288 bytes in 2 allocations AddressSanitizer has been reporting on every run
of the suite.

Held in a unique_ptr rather than deleted at the end of the section, because a
failing REQUIRE throws and would walk straight past a delete there.

With this the whole suite is clean under AddressSanitizer for the first time:
12171 assertions in 133 cases with no report of any kind, and the [notCI]
socket cases pass under it too, 66 assertions in 5 cases. Normal build
unchanged at 12171 assertions.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015Y6FieTwEXuLhhR4e2yiax
2026-09-07 11:24:16 -04:00

405 lines
12 KiB
C++

/*
* This file is part of the ZoneMinder Project. See AUTHORS file for Copyright information
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version.
*
* This program 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 General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "zm_catch2.h"
#include <memory>
#include "zm_comms.h"
#include <array>
#include <cstdlib>
#include <arpa/inet.h>
#include <netinet/in.h>
#include <sys/socket.h>
#include <unistd.h>
namespace {
// InetSocket::bind() resolves with AF_UNSPEC, so the socket that actually got
// bound may be AF_INET6. sockaddr_storage is the only buffer guaranteed to be
// big enough for either, and the port sits at a different offset in each.
int getBoundPort(int sd) {
sockaddr_storage addr = {};
socklen_t addr_len = sizeof(addr);
REQUIRE(::getsockname(sd, reinterpret_cast<sockaddr *>(&addr), &addr_len) == 0);
int port = 0;
if (addr.ss_family == AF_INET) {
port = ntohs(reinterpret_cast<const sockaddr_in *>(&addr)->sin_port);
} else if (addr.ss_family == AF_INET6) {
port = ntohs(reinterpret_cast<const sockaddr_in6 *>(&addr)->sin6_port);
} else {
FAIL("unexpected address family " << addr.ss_family);
}
REQUIRE(port > 0);
return port;
}
// mkstemp is what reserves the name, so the template has to be the socket path
// itself. Reserving zm.unittest.XXXXXX and then appending .sock would hand back
// a name nothing had claimed, which two concurrent runs could still collide on.
std::string makeUnixSocketPath() {
char path_template[] = "/tmp/zm.unittest.XXXXXX.sock";
const int fd = ::mkstemps(path_template, 5);
REQUIRE(fd >= 0);
REQUIRE(::close(fd) == 0);
// bind() needs the path free, and this process holds the only claim on it.
REQUIRE(::unlink(path_template) == 0);
return std::string(path_template);
}
// A port nothing is listening on. Binding then closing leaves the number
// unused, which is far safer than hardcoding one and hoping the host agrees.
int getUnusedPort() {
const int sd = ::socket(AF_INET, SOCK_STREAM, 0);
REQUIRE(sd >= 0);
sockaddr_in addr = {};
addr.sin_family = AF_INET;
addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
addr.sin_port = 0;
REQUIRE(::bind(sd, reinterpret_cast<sockaddr *>(&addr), sizeof(addr)) == 0);
const int port = getBoundPort(sd);
REQUIRE(::close(sd) == 0);
return port;
}
} // namespace
TEST_CASE("ZM::Pipe basics") {
zm::Pipe pipe;
SECTION("setBlocking on non-opened") {
REQUIRE(pipe.setBlocking(true) == false);
REQUIRE(pipe.setBlocking(false) == false);
}
REQUIRE(pipe.open() == true);
REQUIRE(pipe.isOpen() == true);
REQUIRE(pipe.isClosed() == false);
REQUIRE(pipe.getReadDesc() != -1);
REQUIRE(pipe.getWriteDesc() != -1);
SECTION("double open") {
REQUIRE(pipe.open() == true); // is this expected?
}
SECTION("close") {
REQUIRE(pipe.close() == true);
REQUIRE(pipe.isOpen() == false);
REQUIRE(pipe.isClosed() == true);
REQUIRE(pipe.getReadDesc() == -1);
REQUIRE(pipe.getWriteDesc() == -1);
SECTION("double close") {
REQUIRE(pipe.close() == true);
}
SECTION("setBlocking on closed") {
REQUIRE(pipe.setBlocking(true) == false);
REQUIRE(pipe.setBlocking(false) == false);
}
}
SECTION("setBlocking") {
REQUIRE(pipe.setBlocking(true) == true);
REQUIRE(pipe.setBlocking(false) == true);
}
}
TEST_CASE("ZM::Pipe read/write") {
zm::Pipe pipe;
std::array<char, 3> msg = {'a', 'b', 'c'};
std::array<char, msg.size()> rcv{};
SECTION("read/write on non-opened pipe") {
REQUIRE(pipe.write(msg.data(), msg.size()) == -1);
REQUIRE(pipe.read(rcv.data(), rcv.size()) == -1);
}
SECTION("read/write on opened pipe") {
REQUIRE(pipe.open() == true);
REQUIRE(pipe.write(msg.data(), msg.size()) == msg.size());
REQUIRE(pipe.read(rcv.data(), rcv.size()) == msg.size());
REQUIRE(rcv == msg);
}
SECTION("read/write on closed pipe") {
REQUIRE(pipe.open() == true);
REQUIRE(pipe.close() == true);
REQUIRE(pipe.write(msg.data(), msg.size()) == -1);
REQUIRE(pipe.read(rcv.data(), rcv.size()) == -1);
}
}
TEST_CASE("ZM::SockAddrInet") {
zm::SockAddrInet addr;
REQUIRE(addr.getAddrSize() == sizeof(sockaddr_in));
SECTION("resolve") {
addr.resolve(80, "");
REQUIRE(addr.getDomain() == AF_INET);
SECTION("newSockAddr from resolved addr") {
// newSockAddr hands ownership to the caller; Socket deletes the ones it
// holds in its destructor. Held in a unique_ptr rather than deleted at
// the end of the section because a failing REQUIRE throws past it.
std::unique_ptr<zm::SockAddr> addr2(zm::SockAddr::newSockAddr(&addr));
REQUIRE(addr2->getDomain() == AF_INET);
REQUIRE(addr2->getAddrSize() == sizeof(sockaddr_in));
}
}
}
TEST_CASE("ZM::SockAddrUnix") {
zm::SockAddrUnix addr;
REQUIRE(addr.getAddrSize() == sizeof(sockaddr_un));
SECTION("resovle") {
addr.resolve("/", "");
REQUIRE(addr.getDomain() == AF_UNIX);
SECTION("newSockAddr from resolved addr") {
// newSockAddr hands ownership to the caller; Socket deletes the ones it
// holds in its destructor. Held in a unique_ptr rather than deleted at
// the end of the section because a failing REQUIRE throws past it.
std::unique_ptr<zm::SockAddr> addr2(zm::SockAddr::newSockAddr(&addr));
REQUIRE(addr2->getDomain() == AF_UNIX);
REQUIRE(addr2->getAddrSize() == sizeof(sockaddr_un));
}
}
}
TEST_CASE("ZM::UdpInetSocket basics") {
zm::UdpInetSocket socket;
REQUIRE(socket.isClosed() == true);
REQUIRE(socket.isOpen() == false);
REQUIRE(socket.isConnected() == false);
REQUIRE(socket.isDisconnected() == false);
SECTION("bind with host and port") {
REQUIRE(socket.bind(nullptr, "0") == true);
REQUIRE(socket.isOpen() == true);
REQUIRE(socket.isDisconnected() == true);
REQUIRE(socket.isClosed() == false);
REQUIRE(socket.isConnected() == false);
SECTION("close") {
REQUIRE(socket.close() == true);
REQUIRE(socket.isClosed() == true);
REQUIRE(socket.isOpen() == false);
REQUIRE(socket.isConnected() == false);
REQUIRE(socket.isDisconnected() == false);
}
}
SECTION("bind with port") {
REQUIRE(socket.bind("0") == true);
}
SECTION("bind with host and port number") {
REQUIRE(socket.bind(nullptr, 0) == true);
}
SECTION("bind with port number") {
REQUIRE(socket.bind(0) == true);
}
}
TEST_CASE("ZM::UdpInetSocket send/recv") {
zm::UdpInetSocket srv_socket;
zm::UdpInetSocket client_socket;
std::array<char, 3> msg = {'a', 'b', 'c'};
std::array<char, msg.size()> rcv{};
SECTION("send/recv on unbound socket") {
REQUIRE(client_socket.send(msg.data(), msg.size()) == -1);
REQUIRE(srv_socket.recv(rcv.data(), rcv.size()) == -1);
}
SECTION("send/recv") {
REQUIRE(srv_socket.bind("127.0.0.1", "0") == true);
REQUIRE(srv_socket.isOpen() == true);
const int port = getBoundPort(srv_socket.getReadDesc());
const std::string port_str = std::to_string(port);
REQUIRE(client_socket.connect("127.0.0.1", port_str.c_str()) == true);
REQUIRE(client_socket.isConnected() == true);
REQUIRE(client_socket.send(msg.data(), msg.size()) == msg.size());
REQUIRE(srv_socket.recv(rcv.data(), rcv.size()) == msg.size());
REQUIRE(rcv == msg);
}
}
TEST_CASE("ZM::UdpUnixSocket basics") {
const std::string sock_path = makeUnixSocketPath();
zm::UdpUnixSocket socket;
REQUIRE(socket.isClosed() == true);
REQUIRE(socket.isOpen() == false);
REQUIRE(socket.isConnected() == false);
REQUIRE(socket.isDisconnected() == false);
SECTION("bind") {
REQUIRE(socket.bind(sock_path.c_str()) == true);
REQUIRE(socket.isOpen() == true);
REQUIRE(socket.isDisconnected() == true);
REQUIRE(socket.isClosed() == false);
REQUIRE(socket.isConnected() == false);
SECTION("close") {
REQUIRE(socket.close() == true);
REQUIRE(socket.isClosed() == true);
REQUIRE(socket.isOpen() == false);
REQUIRE(socket.isConnected() == false);
REQUIRE(socket.isDisconnected() == false);
}
}
SECTION("connect to unbound socket") {
REQUIRE(socket.connect(sock_path.c_str()) == false);
}
}
TEST_CASE("ZM::UdpUnixSocket send/recv") {
const std::string sock_path = makeUnixSocketPath();
zm::UdpUnixSocket srv_socket;
zm::UdpUnixSocket client_socket;
SECTION("send/recv byte buffer") {
std::array<char, 3> msg = {'a', 'b', 'c'};
std::array<char, msg.size()> rcv{};
SECTION("on unbound socket") {
REQUIRE(client_socket.send(msg.data(), msg.size()) == -1);
REQUIRE(srv_socket.recv(rcv.data(), rcv.size()) == -1);
}
SECTION("on bound socket") {
REQUIRE(srv_socket.bind(sock_path.c_str()) == true);
REQUIRE(srv_socket.isOpen() == true);
REQUIRE(client_socket.connect(sock_path.c_str()) == true);
REQUIRE(client_socket.isConnected() == true);
REQUIRE(client_socket.send(msg.data(), msg.size()) == msg.size());
REQUIRE(srv_socket.recv(rcv.data(), rcv.size()) == msg.size());
REQUIRE(rcv == msg);
}
}
SECTION("send/recv string") {
std::string msg = "abc";
std::string rcv;
rcv.reserve(msg.length());
REQUIRE(srv_socket.bind(sock_path.c_str()) == true);
REQUIRE(srv_socket.isOpen() == true);
REQUIRE(client_socket.connect(sock_path.c_str()) == true);
REQUIRE(client_socket.isConnected() == true);
REQUIRE(client_socket.send(msg) == static_cast<ssize_t>(msg.size()));
REQUIRE(srv_socket.recv(rcv) == static_cast<ssize_t>(msg.size()));
REQUIRE(rcv == msg);
}
}
TEST_CASE("ZM::TcpInetClient basics") {
zm::TcpInetClient client;
REQUIRE(client.isClosed() == true);
REQUIRE(client.isOpen() == false);
REQUIRE(client.isConnected() == false);
REQUIRE(client.isDisconnected() == false);
REQUIRE(client.connect("127.0.0.1", getUnusedPort()) == false);
REQUIRE(client.isClosed() == true);
REQUIRE(client.isOpen() == false);
REQUIRE(client.isConnected() == false);
REQUIRE(client.isDisconnected() == false);
}
TEST_CASE("ZM::TcpInetServer basics", "[notCI]") {
zm::TcpInetServer server;
REQUIRE(server.isClosed() == true);
REQUIRE(server.isOpen() == false);
REQUIRE(server.isConnected() == false);
REQUIRE(server.isDisconnected() == false);
REQUIRE(server.bind(0) == true);
REQUIRE(server.isOpen() == true);
REQUIRE(server.isClosed() == false);
REQUIRE(server.isConnected() == false);
REQUIRE(server.isDisconnected() == true);
REQUIRE(server.isListening() == false);
REQUIRE(server.listen() == true);
REQUIRE(server.isListening() == true);
SECTION("close") {
REQUIRE(server.close() == true);
REQUIRE(server.isClosed() == true);
REQUIRE(server.isOpen() == false);
REQUIRE(server.isConnected() == false);
REQUIRE(server.isDisconnected() == false);
}
}
TEST_CASE("ZM::TcpInetClient/Server send/recv", "[notCI]") {
zm::TcpInetServer server;
zm::TcpInetClient client;
std::array<char, 3> msg = {'a', 'b', 'c'};
std::array<char, msg.size()> rcv{};
SECTION("send/recv on unbound socket") {
REQUIRE(client.send(msg.data(), msg.size()) == -1);
REQUIRE(server.recv(rcv.data(), rcv.size()) == -1);
}
SECTION("send/recv") {
REQUIRE(server.bind(0) == true);
REQUIRE(server.isOpen() == true);
const int port = getBoundPort(server.getReadDesc());
REQUIRE(server.listen() == true);
REQUIRE(client.connect("127.0.0.1", port) == true);
REQUIRE(client.isConnected() == true);
REQUIRE(server.accept() == true);
REQUIRE(client.send(msg.data(), msg.size()) == msg.size());
REQUIRE(server.recv(rcv.data(), rcv.size()) == msg.size());
REQUIRE(rcv == msg);
}
}