ZenServerProcess API changes (#719)

This refactor aims to improve the `ZenServerProcess` classes by making them useful for managing child zenserver instances in more scenarios than just automated tests. This involves changing some functions to not talk about "test directory" and instead use "data directory" etc

As a consequence of the API changes, some tests have changed accordingly.

The code includes som reference to the "hub" mode but there is not yet any other code using this mode, it's just included in this PR to simplify future merges.

1 files changed, 30 insertions, 5 deletions

diff --git a/src/zenutil/include/zenutil/zenserverprocess.h b/src/zenutil/include/zenutil/zenserverprocess.h
index 0da63285b..d0402640b 100644
--- a/src/zenutil/include/zenutil/zenserverprocess.h
+++ b/src/zenutil/include/zenutil/zenserverprocess.h
@@ -34,8 +34,10 @@ public:
 
 	void Initialize(std::filesystem::path ProgramBaseDir);
 	void InitializeForTest(std::filesystem::path ProgramBaseDir, std::filesystem::path TestBaseDir, std::string_view ServerClass = "");
+	void InitializeForHub(std::filesystem::path ProgramBaseDir, std::filesystem::path TestBaseDir, std::string_view ServerClass = "");
 
 	std::filesystem::path	CreateNewTestDir();
+	std::filesystem::path	CreateChildDir(std::string_view ChildName);
 	std::filesystem::path	ProgramBaseDir() const { return m_ProgramBaseDir; }
 	std::filesystem::path	GetTestRootDir(std::string_view Path);
 	inline bool				IsInitialized() const { return m_IsInitialized; }
@@ -43,11 +45,18 @@ public:
 	inline std::string_view GetServerClass() const { return m_ServerClass; }
 	inline uint16_t			GetNewPortNumber() { return m_NextPortNumber.fetch_add(1); }
 
+	// The defaults will work for a single root process only. For hierarchical
+	// setups (e.g., hub managing storage servers), we need to be able to
+	// allocate distinct child IDs and ports to avoid overlap/conflicts.
+	static void SetBaseChildId(int InitialValue);
+	void		SetNextPortNumber(uint16_t NewValue) { m_NextPortNumber = NewValue; }
+
 private:
 	std::filesystem::path m_ProgramBaseDir;
-	std::filesystem::path m_TestBaseDir;
+	std::filesystem::path m_ChildProcessBaseDir;
 	bool				  m_IsInitialized  = false;
 	bool				  m_IsTestInstance = false;
+	bool				  m_IsHubInstance  = false;
 	std::string			  m_ServerClass;
 	std::atomic_uint16_t  m_NextPortNumber{20000};
 };
@@ -60,10 +69,19 @@ private:
 	Especially useful for automated testing but can also be used for
 	management tools.
 
+	This is also used by zenserver in hub mode, for managing storage
+	server instances.
+
   */
 struct ZenServerInstance
 {
-	ZenServerInstance(ZenServerEnvironment& TestEnvironment);
+	enum class ServerMode
+	{
+		kStorageServer,	 // default
+		kHubServer,
+	};
+
+	ZenServerInstance(ZenServerEnvironment& TestEnvironment, ServerMode Mode = ServerMode::kStorageServer);
 	~ZenServerInstance();
 
 	int				   Shutdown();
@@ -72,6 +90,7 @@ struct ZenServerInstance
 	[[nodiscard]] bool WaitUntilReady(int Timeout);
 	[[nodiscard]] bool WaitUntilExited(int Timeout, std::error_code& OutEc);
 	void			   EnableTermination() { m_Terminate = true; }
+	void			   EnableShutdownOnDestroy() { m_ShutdownOnDestroy = true; }
 	void			   DisableShutdownOnDestroy() { m_ShutdownOnDestroy = false; }
 	void			   Detach();
 	inline int		   GetPid() const { return m_Process.Pid(); }
@@ -81,7 +100,11 @@ struct ZenServerInstance
 	bool			   Terminate();
 	std::string		   GetLogOutput() const;
 
-	void SetTestDir(std::filesystem::path TestDir);
+	inline ServerMode GetServerMode() const { return m_ServerMode; }
+
+	inline void SetServerExecutablePath(std::filesystem::path ExecutablePath) { m_ServerExecutablePath = ExecutablePath; }
+
+	void SetDataDir(std::filesystem::path TestDir);
 
 	inline void SpawnServer(std::string_view AdditionalServerArgs = std::string_view())
 	{
@@ -117,11 +140,13 @@ private:
 	std::unique_ptr<NamedEvent> m_ShutdownEvent;
 	bool						m_Terminate			= false;
 	bool						m_ShutdownOnDestroy = true;
-	std::filesystem::path		m_TestDir;
-	uint16_t					m_BasePort = 0;
+	std::filesystem::path		m_DataDir;
+	uint16_t					m_BasePort	 = 0;
+	ServerMode					m_ServerMode = ServerMode::kStorageServer;
 	std::optional<int>			m_OwnerPid;
 	std::string					m_Name;
 	std::filesystem::path		m_OutputCapturePath;
+	std::filesystem::path		m_ServerExecutablePath;
 
 	void CreateShutdownEvent(int BasePort);
 	void SpawnServer(int BasePort, std::string_view AdditionalServerArgs, int WaitTimeoutMs);