RDBC-790 Custom providers tests

Author: poissoncorp

ravendb_embedded/provide.py

@@ -17,7 +17,7 @@ class CopyServerProvider(ProvideRavenDBServer):
     def __init__(self, server_files: str):
         self.server_files = server_files
 
-    def provide(self, target_directory: str) -> None:  # todo: test
+    def provide(self, target_directory: str) -> None:
         shutil.copytree(self.server_files, target_directory, dirs_exist_ok=True)
 
 
@@ -55,7 +55,7 @@ def unzip(source: Union[str, bytes], out: str) -> None:
 
 class ExtractFromPkgResourceServerProvider(ProvideRavenDBServer):
     def provide(self, target_directory):
-        resource_name = "/ravendb_server.zip"
+        resource_name = "ravendb_server.zip"
 
         # Get binary data from the resource
         resource_data = pkgutil.get_data(self.__class__.__module__, resource_name)
@@ -87,7 +87,7 @@ def __init__(self, server_location: str):
 
         # Alternatively, it might be a directory - look for Raven.Server.exe inside
         if os.path.isdir(file_server_location) and os.path.exists(
-            os.path.join(file_server_location, "Raven.Server.exe")
+            os.path.join(file_server_location, self.SERVER_DLL_FILENAME)
         ):
             self.inner_provider = CopyServerProvider(server_location)
             return

ravendb_embedded/raven_server_runner.py

@@ -28,9 +28,22 @@ def run(options: ServerOptions) -> subprocess.Popen:
         if not options.logs_path.strip():
             raise ValueError("logs_path cannot be None or whitespace")
 
-        server_dll_path = os.path.join(options.target_server_location, "Raven.Server.dll")
-        if not os.path.exists(server_dll_path):
-            raise RavenException("Server file was not found: " + server_dll_path)
+        server_paths = [
+            "Raven.Server.dll",
+            "Server/Raven.Server.dll",
+            "contentFiles/any/any/RavenDBServer/Raven.Server.dll",
+        ]
+
+        server_dll_path = None
+
+        for path in server_paths:
+            full_path = os.path.join(options.target_server_location, path)
+            if os.path.exists(full_path):
+                server_dll_path = full_path
+                break
+
+        if server_dll_path is None:
+            raise RavenException("Server file was not found in any of the expected locations.")
 
         if not options.dot_net_path.strip():
             raise ValueError("dot_net_path cannot be None or whitespace")

setup.py

@@ -65,6 +65,7 @@ def run(self):
 
 # Setup configuration
 setup(
+    python_requires='>=3.8',
     cmdclass={"install": CustomInstall, "develop": CustomDevelop, "sdist": CustomSDist},
     name="ravendb-embedded",
     packages=["ravendb-embedded"],

tests/dir_utils.py

@@ -0,0 +1,13 @@
+import shutil
+import tempfile
+from typing import ContextManager
+
+
+class DirUtils:
+    @staticmethod
+    def temporary_dir() -> ContextManager[str]:
+        temp_dir = tempfile.mkdtemp()
+        try:
+            yield temp_dir
+        finally:
+            shutil.rmtree(temp_dir)

tests/test_custom_provider.py

@@ -0,0 +1,48 @@
+import tempfile
+from pathlib import Path
+from unittest import TestCase
+
+from ravendb_embedded.embedded_server import EmbeddedServer
+from ravendb_embedded.options import ServerOptions, DatabaseOptions
+from ravendb_embedded.provide import CopyServerFromNugetProvider
+from tests import Person
+
+
+class TestCustomProvider(TestCase):
+    @staticmethod
+    def configure_server_options(temp_dir: str, server_options: ServerOptions) -> ServerOptions:
+        server_options.target_server_location = str(Path(temp_dir, "RavenDBServer"))
+        server_options.data_directory = str(Path(temp_dir, "RavenDB"))
+        server_options.logs_path = str(Path(temp_dir, "Logs"))
+        server_options.command_line_args = ["--Features.Availability=Experimental"]
+        return server_options
+
+    def test_can_use_zip_as_external_server_source(self):
+        with tempfile.TemporaryDirectory() as temp_dir:
+            with EmbeddedServer() as embedded:
+                server_options = ServerOptions()
+                server_options = self.configure_server_options(temp_dir, server_options)
+                server_options.with_external_server("target/ravendb-server.zip")
+                embedded.start_server(server_options)
+
+                database_options = DatabaseOptions.from_database_name("Test")
+
+                with embedded.get_document_store_from_options(database_options) as store:
+                    with store.open_session() as session:
+                        loaded_person = session.load("no-such-person", Person)
+                        self.assertIsNone(loaded_person)
+
+    def test_can_use_directory_as_external_server_source(self):
+        with tempfile.TemporaryDirectory() as temp_directory:
+            with EmbeddedServer() as embedded:
+                server_options = ServerOptions()
+                server_options = self.configure_server_options(temp_directory, server_options)
+                server_options.with_external_server(CopyServerFromNugetProvider.SERVER_FILES)
+                embedded.start_server(server_options)
+
+                database_options = DatabaseOptions.from_database_name("Test")
+
+                with embedded.get_document_store_from_options(database_options) as store:
+                    with store.open_session() as session:
+                        loaded_person = session.load("no-such-person", Person)
+                        self.assertIsNone(loaded_person)