Testing windows

- self.arch to use lowercase as we expect cibuildwheel to pass amd64 while platform.machine() returns AMD64 on windows
- Added Windows and amd64 as supported (list check)
- Added archive suffix and archive format to support ZIP archive
- Custom rename of arch in filename as openZIM uses x86_64
- Copying dll from bin/ folder (tree is different) and .lib file (not sure if needed)
- Cleaning dll/lib as well
- Setting to the exact nightly date we have it for (not targetting lastest nightly as it requires addtional ZIP handling TBD)
- forcing cibuildwheel to only do windows py312 on amd64 for tests speed
- forcing those wheels on windows branch

Author: rgaudin

.github/workflows/test.yml

@@ -2,7 +2,7 @@ name: test
 on: [push]
 
 env:
-  LIBZIM_DL_VERSION: "9.1.0"
+  LIBZIM_DL_VERSION: "2024-08-27"
   MACOSX_DEPLOYMENT_TARGET: "12.0"
 
 jobs:

.github/workflows/wheels.yml

@@ -5,9 +5,10 @@ on:
   push:
     branches:
       - main
+      - windows
 
 env:
-  LIBZIM_DL_VERSION: "9.1.0"
+  LIBZIM_DL_VERSION: "2024-08-27"
   MACOSX_DEPLOYMENT_TARGET: "12.0"
   CIBW_ENVIRONMENT_PASS_LINUX: "LIBZIM_DL_VERSION"
   CIBW_BUILD_VERBOSITY: "3"

pyproject.toml

@@ -11,7 +11,7 @@ testpaths = ["tests"]
 pythonpath = ["."]
 
 [tool.cibuildwheel]
-build = "*"
+build = "cp312-win_amd64"
 # disabling windows until hhttps://github.com/kiwix/kiwix-build/issues/466
 # disabling PyPy due to 2 failing tests
 skip = "pp* *-win*"

setup.py

@@ -46,6 +46,7 @@ class Config:
         "Darwin": ["x86_64", "arm64"],
         "Linux": ["x86_64", "aarch64"],
         "Linux-musl": ["x86_64", "aarch64"],
+        "Windows": ["amd64"],
     }
 
     base_dir: pathlib.Path = Path(__file__).parent
@@ -101,7 +102,7 @@ def arch(self) -> str:
         # we extract the cross-compile arch from it
         return (
             os.getenv("_PYTHON_HOST_PLATFORM", "").rsplit("-", 1)[-1]
-            or sysplatform.machine()
+            or sysplatform.machine().lower()
         )
 
     def check_platform(self):
@@ -121,8 +122,19 @@ def libzim_fname(self):
         return {
             "Darwin": f"libzim.{self.libzim_major}.dylib",
             "Linux": f"libzim.so.{self.libzim_major}",
+            "Windows": f"zim-{self.libzim_major}.dll",
         }[self.platform]
 
+    @property
+    def archive_suffix(self):
+        if self.platform == "Windows":
+            return ".zip"
+        return ".tar.gz"
+
+    @property
+    def archive_format(self):
+        return {".zip": "zip", ".tar.gz": "gztar"}.get(self.archive_suffix)
+
     @property
     def is_musl(self) -> bool:
         """whether running on a musl system (Alpine)"""
@@ -145,7 +157,13 @@ def get_download_filename(self, arch: Optional[str] = None) -> str:
         """filename to download to get binary libzim for platform/arch"""
         arch = arch or self.arch
 
-        lzplatform = {"Darwin": "macos", "Linux": "linux"}.get(self.platform)
+        # believe this is incorrect naming at openZIM ; will open ticket
+        if self.platform == "Windows" and arch == "amd64":
+            arch = "x86_64"
+
+        lzplatform = {"Darwin": "macos", "Linux": "linux", "Windows": "win"}.get(
+            self.platform
+        )
 
         variant = ""
         if self.platform == "Linux":
@@ -157,7 +175,7 @@ def get_download_filename(self, arch: Optional[str] = None) -> str:
             version_suffix = f"-{self.libzim_dl_version}"
 
         return pathlib.Path(
-            f"libzim_{lzplatform}-{arch}{variant}{version_suffix}.tar.gz"
+            f"libzim_{lzplatform}-{arch}{variant}{version_suffix}{self.archive_suffix}"
         ).name
 
     def download_to_dest(self):
@@ -227,15 +245,16 @@ def _download_and_extract(self, filename: str) -> pathlib.Path:
 
         print("> extracting archive")
         # extract into current folder (all files are inside an in-tar folder)
-        shutil.unpack_archive(fpath, self.base_dir, "gztar")
+        shutil.unpack_archive(fpath, self.base_dir, self.archive_format)
 
         # nightly have different download name and extracted folder name as it
         # uses a redirect
+        # TODO: FIX for zip
         if self.is_latest_nightly:
             tar = tarfile.open(fpath)
             folder = pathlib.Path(pathlib.Path(tar.firstmember.name).parts[0])
         else:
-            folder = fpath.with_name(fpath.name.replace(".tar.gz", ""))
+            folder = fpath.with_name(fpath.name.replace(self.archive_suffix, ""))
 
         return folder
 
@@ -254,6 +273,14 @@ def _install_from(self, folder: pathlib.Path):
         for fpath in folder.joinpath("lib").rglob("libzim.*"):
             print(f"{fpath} -> {libzim_dir / fpath.name}")
             os.replace(fpath, libzim_dir / fpath.name)
+        # windows has different folder and name
+        for fpath in folder.joinpath("bin").rglob("zim-*.dll"):
+            print(f"{fpath} -> {libzim_dir / fpath.name}")
+            os.replace(fpath, libzim_dir / fpath.name)
+        # windows again, not sure its required at all
+        for fpath in folder.joinpath("lib").rglob("zim.lib"):
+            print(f"{fpath} -> {libzim_dir / fpath.name}")
+            os.replace(fpath, libzim_dir / fpath.name)
 
         # remove temp folder
         shutil.rmtree(folder, ignore_errors=True)
@@ -284,7 +311,7 @@ def cleanup(self):
         # we downloaded libzim, so we must remove it
         if self.download_libzim:
             print("removing downloaded libraries")
-            for fpath in self.dylib_file.parent.glob("*.[dylib|so]*"):
+            for fpath in self.dylib_file.parent.glob("*.[dylib|so|dll|lib]*"):
                 print(">", fpath)
                 fpath.unlink(missing_ok=True)
             if self.header_file.parent.exists():
@@ -490,11 +517,9 @@ class DownloadLibzim(Command):
 
     user_options = []
 
-    def initialize_options(self):
-        ...
+    def initialize_options(self): ...
 
-    def finalize_options(self):
-        ...
+    def finalize_options(self): ...
 
     def run(self):
         config.download_to_dest()
@@ -503,11 +528,9 @@ def run(self):
 class LibzimClean(Command):
     user_options = []
 
-    def initialize_options(self):
-        ...
+    def initialize_options(self): ...
 
-    def finalize_options(self):
-        ...
+    def finalize_options(self): ...
 
     def run(self):
         config.cleanup()