build debug and release versions simultaneously

Author: N-Coder

.gitignore

@@ -1,3 +1,6 @@
+*.zip
+*.tar.gz
+*.whl
 *.svg
 cmake_build/
 wheelhouse/

hatch_build.py

@@ -63,9 +63,8 @@ def tag(self):
             plat = sysconfig.get_platform()
         return "py3-none-%s" % plat.replace("-", "_").replace(".", "_")
 
-    @cached_property
-    def cmake_build_dir(self):
-        p = Path(self.directory) / "cmake_build"
+    def cmake_build_dir(self, config):
+        p = Path(self.directory) / f"cmake_build_{config}"
         p.mkdir(parents=True, exist_ok=True)
         return p
 
@@ -82,10 +81,10 @@ def cmake_install_dir(self):
     def ogdf_src_dir(self):
         return Path(self.root) / "ogdf"
 
-    def run(self, *args):
+    def run(self, *args, dir):
         args = list(map(str, args))
         with group("Running", *args):
-            return subprocess.run(args, capture_output=False, check=True, cwd=self.cmake_build_dir)
+            return subprocess.run(args, capture_output=False, check=True, cwd=dir)
 
     def dump_files(self, dir):
         with group("Index of", dir):
@@ -112,30 +111,43 @@ def initialize(self, version, build_data):
             del self.build_config.target_config["shared-data"]
 
         with group("Config"):
+            pprint({
+                "root": self.root,
+                "directory": self.directory,
+                "ogdf_src_dir": self.ogdf_src_dir,
+                "cmake_install_dir": self.cmake_install_dir,
+                "cmake_build_dir debug": self.cmake_build_dir("debug"),
+                "cmake_build_dir release": self.cmake_build_dir("release"),
+            })
             pprint(build_data)
             pprint(self.build_config.__dict__)
 
         flags = [
-            "-DCMAKE_CONFIGURATION_TYPES=Debug;Release",
-            "-DCMAKE_CROSS_CONFIGS=all", "-DCMAKE_DEFAULT_CONFIGS=all",
             "-DBUILD_SHARED_LIBS=ON",
             "-DCMAKE_INSTALL_PREFIX=%s" % self.cmake_install_dir,
             "-DOGDF_WARNING_ERRORS=OFF",
             "-DCMAKE_BUILD_RPATH=$ORIGIN;@loader_path", "-DCMAKE_INSTALL_RPATH=$ORIGIN;@loader_path",
             "-DMACOSX_RPATH=TRUE",
-            "-DOGDF_USE_ASSERT_EXCEPTIONS=ON",  # "-DOGDF_USE_ASSERT_EXCEPTIONS_WITH=ON_LIBUNWIND",
             "-DOGDF_MEMORY_MANAGER=POOL_TS",  # "-DOGDF_MEMORY_MANAGER=MALLOC_TS", "-DOGDF_LEAK_CHECK=ON",
         ]
-        if not is_windows() and not is_macos():  # XCode and VS are multi-config by default
-            flags.append("-G Ninja Multi-Config")
-        self.run("cmake", self.ogdf_src_dir, *flags)
+
+        release_dir = self.cmake_build_dir("release")
+        self.run("cmake", self.ogdf_src_dir, "-DCMAKE_BUILD_TYPE=Release", *flags, dir=release_dir)
+        self.run("cmake", "--build", ".", "--parallel", str(multiprocessing.cpu_count()), dir=release_dir)
+        self.run("cmake", "--install", ".", dir=release_dir)
+
+        if not is_windows():
+            flags.extend([
+                "-DOGDF_USE_ASSERT_EXCEPTIONS=ON",  # "-DOGDF_USE_ASSERT_EXCEPTIONS_WITH=ON_LIBUNWIND",
+            ])
+        debug_dir = self.cmake_build_dir("debug")
+        self.run("cmake", self.ogdf_src_dir, "-DCMAKE_BUILD_TYPE=Debug", *flags, dir=debug_dir)
+        self.run("cmake", "--build", ".", "--parallel", str(multiprocessing.cpu_count()), dir=debug_dir)
+        self.run("cmake", "--install", ".", dir=debug_dir)
 
         # import IPython
         # IPython.embed()
 
-        self.run("cmake", "--build", ".")
-        self.run("cmake", "--install", ".")
-
         self.dump_files(self.directory)
         self.dump_files(self.root)
 
@@ -158,5 +170,6 @@ def clean(self, versions):
         the [`clean`](../cli/reference.md#hatch-clean) command.
         """
         import shutil
-        shutil.rmtree(self.cmake_build_dir)
-        shutil.rmtree(self.cmake_install_dir)
+        shutil.rmtree(self.cmake_build_dir("release"), ignore_errors=True)
+        shutil.rmtree(self.cmake_build_dir("debug"), ignore_errors=True)
+        shutil.rmtree(self.cmake_install_dir, ignore_errors=True)

ogdf

@@ -62,16 +62,26 @@ def diff_dict_keys(a, b):
 
 
 def check_diff(tag, actual, expected, ign_a="", ign_e="", exp_a=[], win=False):
+    """
+    :param tag: tag for logging
+    :param actual: {filename: size} dict of actually found files
+    :param expected: {filename: size} dict of expected files
+    :param ign_a: regex for ignoring superfluous files that are in actual but not in expected
+    :param ign_e: regex for ignoring missing files that are in expected but not in actual
+    :param exp_a: list of additional file names that need to be present in actual, independent of expected
+    :param win: on windows, we ignore file sizes
+    """
     global issues
     print("\tChecking", tag)
-    if win:
-        actual, expected = diff_dict_keys(actual, expected)
-    else:
-        actual, expected = diff_dicts(actual, expected)
     for e in exp_a:
         if e not in actual:
             print("\tMissing file %s in %s!" % (e, tag))
             issues += 1
+
+    if win:  # ignore file sizes on windows
+        actual, expected = diff_dict_keys(actual, expected)
+    else:
+        actual, expected = diff_dicts(actual, expected)
     sup = {k: v for k, v in actual.items() if not re.fullmatch(ign_a, k) and k not in exp_a}
     mis = {k: v for k, v in expected.items() if not re.fullmatch(ign_e, k)}
     if sup or mis:
@@ -91,7 +101,7 @@ def ignore(*ps):
 ]
 
 
-def check_wheel(wheelp, ogdfp, name, tag):
+def check_wheel(wheelp, ogdfp, name, tag, config):
     name_esc = ignore(name)
     headers, others = {}, {}
     for k, v in ogdfp["include/"].items():
@@ -100,7 +110,8 @@ def check_wheel(wheelp, ogdfp, name, tag):
         else:
             others[k] = v
 
-    # _cur is the install location for the current platform (UNIX), _oth for the other (Windows)
+    # _cur is the install location for the current target platform (default UNIX), _oth for the other (Windows)
+    # only one of them will actually contain files, depending on the target platform
     incl_cur, incl_oth = wheelp[name + ".data/data/include/"], wheelp["ogdf_wheel/install/include/"]
     exam_cur, exam_oth = wheelp[name + ".data/data/share/doc/libogdf/examples/"], wheelp["ogdf_wheel/install/share/doc/libogdf/examples/"]
     check = check_diff
@@ -109,7 +120,11 @@ def check_wheel(wheelp, ogdfp, name, tag):
         exam_cur, exam_oth = exam_oth, exam_cur
         check = partial(check_diff, win=True)
 
-    check("wheel includes [cur]", incl_cur, headers, exp_a=["ogdf/basic/internal/config_autogen.h"])
+    if config:
+        check("wheel includes [cur]", incl_cur, headers, exp_a=[f"ogdf-{config}/ogdf/basic/internal/config_autogen.h"])
+    else:
+        check("wheel includes [cur]", incl_cur, headers,
+              exp_a=["ogdf-debug/ogdf/basic/internal/config_autogen.h", "ogdf-release/ogdf/basic/internal/config_autogen.h"])
     check("wheel includes [oth]", incl_oth, {})
     check("wheel examples [cur]", exam_cur, ogdfp["doc/examples/"], ign_e=IGNORE_GIT + "|.*\\.dox")
     check("wheel examples [oth]", exam_oth, {})
@@ -121,21 +136,32 @@ def check_wheel(wheelp, ogdfp, name, tag):
            'ogdf/lib/minisat/doc/ReleaseNotes-2.2.0.txt': 3418,
            'ogdf/geometric/README.md': 321})
 
-    ign_meta = f"{name_esc}\\.dist-info/(METADATA|RECORD|WHEEL)|{name_esc}\\.data/data/lib/cmake/.*\.cmake"
+    def expand_suffix(*paths, pre=""):
+        ret = []
+        if config != "release":
+            ret.extend(pre + p.replace("{suffix}", "-debug") for p in paths)
+        if config != "debug":
+            ret.extend(pre + p.replace("{suffix}", "") for p in paths)
+        return ret
+
+    ign_meta = f"{name_esc}\\.dist-info/(METADATA|RECORD|WHEEL)|{name_esc}\\.data/data/(lib/cmake|share/ogdf)/.*\\.cmake"
     exp_lic = [name + ".dist-info/licenses/" + f for f in LICENSES] + ['ogdf_wheel/__init__.py']
     if "win" in tag:
         check("wheel install [win]", wheelp["ogdf_wheel/install/"], {},
-              ign_a="lib/cmake/.*\.cmake|lib/(COIN|OGDF)\.lib",
-              exp_a=["bin/OGDF.dll"])
+              ign_a="lib/cmake/.*\\.cmake|lib/(COIN|OGDF)" + ('(-debug)' if config != 'release' else '')
+                    + ('' if config else '?') + "\\.lib",
+              exp_a=expand_suffix("bin/OGDF{suffix}.dll"))
         check("wheel rest [win]", wheelp[""], {}, ign_a=ign_meta, exp_a=exp_lic)
     elif "macos" in tag:
         check("wheel rest [macos]", wheelp[""], {},
               ign_a=ign_meta,
-              exp_a=[name + ".data/data/lib/libOGDF.dylib", name + ".data/data/lib/libCOIN.dylib", *exp_lic])
+              exp_a=expand_suffix("libOGDF{suffix}.dylib", "libCOIN{suffix}.dylib", pre=name + ".data/data/lib/")
+                    + exp_lic)
     else:
         check("wheel rest [linux]", wheelp[""], {},
-              ign_a=ign_meta,
-              exp_a=[name + ".data/data/lib/libOGDF.so", name + ".data/data/lib/libCOIN.so", *exp_lic])
+              ign_a=ign_meta+f"|{name}.data/data/lib(64)?/lib.*\\.so\\.[0-9]+\\.[0-9]+",
+              exp_a=expand_suffix("libOGDF{suffix}.so", "libCOIN{suffix}.so", pre=name + ".data/data/lib/")
+                    + exp_lic)
 
 
 def check_sdist(sdistp, ogdff):
@@ -162,7 +188,8 @@ def dump_data(dumpdir, files, partitions, name):
     @click.option('--dist', type=click.Path(exists=True, file_okay=False), default=Path("dist"))
     @click.option('--ogdf', type=click.Path(exists=True, file_okay=False), default=Path("ogdf"))
     @click.option('--dump', type=click.Path(file_okay=False))
-    def main(dist, ogdf, dump):
+    @click.option('--config', default="")
+    def main(dist, ogdf, dump, config):
         dist = Path(dist)
         ogdf = Path(ogdf)
         dump = Path(dump) if dump else dump
@@ -194,7 +221,7 @@ def main(dist, ogdf, dump):
                 name + ".data/data/include/", name + ".data/data/share/doc/libogdf/examples/",
                 "ogdf_wheel/install/include/", "ogdf_wheel/install/share/doc/libogdf/examples/", "ogdf_wheel/install/"])
             if dump: dump_data(dump, wheelf, wheelp, "wheel-%s" % wheel.name)
-            check_wheel(wheelp, ogdfp, name, wheel.stem)
+            check_wheel(wheelp, ogdfp, name, wheel.stem, config)
 
         if issues:
             print("There were %s issue(s)!" % issues)