RDBC-790 Fixed pip install, adjusted the process startup, fixed bugs

Author: poissoncorp

.gitignore

@@ -2,7 +2,7 @@
 /test.py
 /dist
 /ravendb-embedded.egg-info
-/ravendb_embedded/ravendb_server
+/ravendb_embedded/target
 *.pyc
 *.log
 *.raven-topology

MANIFEST.in

@@ -1,2 +1,2 @@
-include ravendb_embedded/ravendb_server/server.zip
+graft ravendb_embedded/target/nuget
 include README.rst

ravendb_embedded/embedded_server.py

@@ -60,7 +60,7 @@ def start_server(self, options_param: ServerOptions = None) -> None:
 
         start_server = Lazy(lambda: self._run_server(options))
 
-        if self.server_task and self.server_task != start_server:
+        if self.server_task and self.server_task.created and self.server_task != start_server:
             raise RuntimeError("The server was already started")
 
         self.server_task = start_server
@@ -106,9 +106,9 @@ def get_document_store_from_options(self, options: DatabaseOptions) -> DocumentS
     def _try_create_database(self, options: DatabaseOptions, store: DocumentStore) -> None:
         try:
             store.maintenance.server.send(CreateDatabaseOperation(options.database_record))
-        except RuntimeError as e:
+        except Exception as e:
             # Expected behavior when the database already exists
-            if "Already exists" in e.args[0]:  # todo: test
+            if "conflict" in e.args[0]:  # todo: change exc type when python client will implement conflict handling
                 self._log_debug(f"{options.database_record.database_name} already exists.")
             else:
                 raise e
@@ -289,10 +289,11 @@ def close(self):
         self._shutdown_server_process(process)
 
         for key, value in self.document_stores.items():
-            if value.is_value_created():
+            if value.created:
                 value.get_value().close()
 
         self.document_stores.clear()
+        self.server_task = None
 
 
 class Lazy(Generic[_T]):

ravendb_embedded/options.py

@@ -15,7 +15,7 @@ class DatabaseOptions:
     def __init__(self, database_record: DatabaseRecord):
         self.database_record = database_record
         self.skip_creating_database: Optional[bool] = False
-        self.conventions: Optional[DocumentConventions] = None
+        self.conventions: DocumentConventions = DocumentConventions()
 
     @classmethod
     def from_database_name(cls, database_name: str) -> DatabaseOptions:
@@ -38,8 +38,8 @@ class ServerOptions:
 
     def __init__(self):
         self.framework_version: str = "7.0.15+"
-        self.logs_path: str = self.BASE_DIRECTORY + "RavenDB/Logs"
-        self.data_directory: str = self.BASE_DIRECTORY + "RavenDB"
+        self.logs_path: str = self.BASE_DIRECTORY + "/RavenDB/Logs"
+        self.data_directory: str = self.BASE_DIRECTORY + "/RavenDB"
         self.provider: ProvideRavenDBServer = ExtractFromPkgResourceServerProvider()
         self.target_server_location: str = self.DEFAULT_SERVER_LOCATION
         self.dot_net_path: str = "dotnet"

ravendb_embedded/provide.py

@@ -18,7 +18,7 @@ def __init__(self, server_files: str):
         self.server_files = server_files
 
     def provide(self, target_directory: str) -> None:  # todo: test
-        shutil.copytree(self.server_files, target_directory)
+        shutil.copytree(self.server_files, target_directory, dirs_exist_ok=True)
 
 
 class CopyServerFromNugetProvider(CopyServerProvider):
@@ -31,7 +31,7 @@ def provide(self, target_directory: str) -> None:
         if not os.path.exists("target"):
             raise RuntimeError(
                 f"Unable to find 'target' directory in the current working directory ({os.path.abspath('.')}). "
-                f"Please make sure you execute the test in the root project directory with the pom.xml file."
+                f"Please make sure you execute the test in the ravendb_embedded directory with the provide.py file."
             )
 
         super().provide(target_directory)

ravendb_embedded/raven_server_runner.py

@@ -89,17 +89,16 @@ def run(options: ServerOptions) -> subprocess.Popen:
         else:
             options.server_url = options.server_url or "http://127.0.0.1:0"
 
-        command_line_args.extend(
-            [f"--ServerUrl={options.server_url}", CommandLineArgumentEscaper.escape_single_arg(server_dll_path)]
-        )
-
-        if options.framework_version:
-            framework_version = RuntimeFrameworkVersionMatcher.match(options)
-            command_line_args[:0] = ["--fx-version", framework_version]
+        command_line_args.extend([f"--ServerUrl={options.server_url}"])
 
         command_line_args[:0] = options.command_line_args
+        command_line_args.insert(0, server_dll_path)
+        command_line_args.insert(0, options.dot_net_path)
 
-        command_line_args[:0] = [options.dot_net_path]
+        if options.framework_version:
+            framework_version = RuntimeFrameworkVersionMatcher.match(options)
+            command_line_args.insert(1, framework_version)
+            command_line_args.insert(1, "--fx-version")
 
         process_builder = subprocess.Popen(command_line_args, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
         process = process_builder

ravendb_embedded/runtime_framework_version_matcher.py

@@ -55,42 +55,37 @@ def get_framework_versions(options: ServerOptions):
             raise RuntimeError("Dotnet path is not provided.")
 
         process_command = [options.dot_net_path, "--info"]
-        process = None
+        runtimes = []
 
         try:
-            process = subprocess.Popen(process_command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
-
-            inside_runtimes = False
-            runtime_lines = []
-
-            for line in process.stdout:
-                line = line.strip()
-
-                if line.startswith(".NET runtimes installed:") or line.startswith(".NET Core runtimes installed:"):
-                    inside_runtimes = True
-                    continue
-
-                if inside_runtimes and line.startswith("Microsoft.NETCore.App"):
-                    runtime_lines.append(line)
-
-            runtimes = []
-            for runtime_line in runtime_lines:
-                values = runtime_line.split(" ")
-                if len(values) < 2:
-                    raise RuntimeError(
-                        f"Invalid runtime line. Expected 'Microsoft.NETCore.App x.x.x', but was '{runtime_line}'"
-                    )
-
-                runtimes.append(RuntimeFrameworkVersion(values[1]))
-
-            return runtimes
+            with subprocess.Popen(
+                process_command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True
+            ) as process:
+                inside_runtimes = False
+                runtime_lines = []
+
+                for line in process.stdout:
+                    line = line.strip()
+                    if line.startswith(".NET runtimes installed:") or line.startswith(".NET Core runtimes installed:"):
+                        inside_runtimes = True
+                        continue
+                    if inside_runtimes and line.startswith("Microsoft.NETCore.App"):
+                        runtime_lines.append(line)
+
+                for runtime_line in runtime_lines:
+                    values = runtime_line.split(" ")
+                    if len(values) < 2:
+                        raise RuntimeError(
+                            f"Invalid runtime line. Expected 'Microsoft.NETCore.App x.x.x', but was '{runtime_line}'"
+                        )
+                    runtimes.append(RuntimeFrameworkVersion(values[1]))
 
         except Exception as e:
             raise RuntimeError("Unable to execute dotnet to retrieve list of installed runtimes") from e
-
         finally:
             if process:
                 process.kill()
+        return runtimes
 
 
 class RuntimeFrameworkVersion:

setup.py

@@ -1,14 +1,18 @@
-from setuptools import setup, find_packages, find_namespace_packages
+import zipfile
+
+from setuptools import setup
 from setuptools.command.install import install
 from setuptools.command.develop import develop
 import os
 import urllib.request
+
+from setuptools.command.sdist import sdist
 from tqdm import tqdm
 
 # Modify the RavenDB version and download URL accordingly
-RAVENDB_VERSION = "6.0.0"
+RAVENDB_VERSION = "6.0.2"
 RAVENDB_DOWNLOAD_URL = f"https://www.nuget.org/api/v2/package/RavenDB.Embedded/{RAVENDB_VERSION}"
-RAVENDB_DOWNLOAD_FOLDER = "ravendb_embedded/ravendb_server"
+RAVENDB_DOWNLOAD_FOLDER = "ravendb_embedded/target/nuget"
 RAVENDB_FULL_DOWNLOAD_PATH = os.path.join(RAVENDB_DOWNLOAD_FOLDER, "server.zip")
 
 
@@ -17,11 +21,11 @@ def download_ravendb_with_progress():
     os.makedirs(RAVENDB_DOWNLOAD_FOLDER, exist_ok=True)
 
     response = urllib.request.urlopen(RAVENDB_DOWNLOAD_URL)
-    total_size = int(response.headers.get('content-length', 0))
+    total_size = int(response.headers.get("content-length", 0))
     block_size = 1024  # Adjust the block size as needed
-    progress_bar = tqdm(total=total_size, unit='B', unit_scale=True)
+    progress_bar = tqdm(total=total_size, unit="B", unit_scale=True)
 
-    with open(RAVENDB_FULL_DOWNLOAD_PATH, 'wb') as file, progress_bar:
+    with open(RAVENDB_FULL_DOWNLOAD_PATH, "wb") as file, progress_bar:
         while True:
             buffer = response.read(block_size)
             if not buffer:
@@ -30,6 +34,13 @@ def download_ravendb_with_progress():
             file.write(buffer)
             progress_bar.update(len(buffer))
 
+    # Unzip the downloaded file
+    with zipfile.ZipFile(RAVENDB_FULL_DOWNLOAD_PATH, "r") as zip_ref:
+        zip_ref.extractall(RAVENDB_DOWNLOAD_FOLDER)
+
+    # Remove the server.zip file
+    os.remove(RAVENDB_FULL_DOWNLOAD_PATH)
+
 
 # Custom installation command to download RavenDB before installation
 class CustomInstall(install):
@@ -45,13 +56,20 @@ def run(self):
         super().run()
 
 
+# Custom source distribution command to ensure server.zip is included
+class CustomSDist(sdist):
+    def run(self):
+        download_ravendb_with_progress()
+        super().run()
+
+
 # Setup configuration
 setup(
-    cmdclass={"install": CustomInstall, "develop": CustomDevelop},
+    cmdclass={"install": CustomInstall, "develop": CustomDevelop, "sdist": CustomSDist},
     name="ravendb-embedded",
     packages=["ravendb-embedded"],
     package_dir={"ravendb-embedded": "ravendb_embedded"},
-    package_data={"ravendb-embedded.data" : ["ravendb_embedded/server.zip"]},
+    package_data={"ravendb-embedded.data": ["ravendb_embedded/target/nuget/*"]},
     include_package_data=True,
     long_description=open("README.rst").read(),
     version=RAVENDB_VERSION,