[CPP-31]Disk Usage benchmark. (#13)

* [CPP-31]Disk Usage benchmark.

* Respond to review requests.

* Respond to review requests.

Author: john-michaelburke

.github/workflows/main.yml

@@ -211,6 +211,12 @@ jobs:
           bash ./.github/ci-build.sh
           echo "RELEASE_ARCHIVE=$(cat release-archive.filename)" >>$GITHUB_ENV
           echo "BENCH_ARCHIVE=$(cat bench.filename)" >>$GITHUB_ENV
+      - name: ${{ runner.os }} Installer Size Benchmark.
+        env:
+          OS_NAME: ${{ runner.os }}
+        shell: bash
+        run: |
+          cargo make disk-usage-bench
       - uses: actions/upload-artifact@v2
         with:
           name: ${{ runner.os }}-artifacts

Makefile.toml

@@ -202,3 +202,9 @@ conda run -n $CONDA_ENV python console_backend/benches/benchmarks.py
 
 [tasks.benches]
 dependencies = ["bench-rust", "bench-rust-validate"]
+
+[tasks.disk-usage-bench]
+script_runner = "@shell"
+script = '''
+conda run -n $CONDA_ENV python utils/disk_usage_benchmarks.py
+'''

poetry.lock

@@ -18,6 +18,7 @@ disable=bad-continuation,
         too-many-nested-blocks,
         fixme,
         ungrouped-imports,
+        duplicate-code,
 
 [FORMAT]
 max-line-length=120

pylintrc

@@ -22,7 +22,7 @@ def create_nuitka_script():
     for root, _, files in os.walk(f"{CONDA_DIR}/{SITEPACK_DIR}PySide2/Qt", topdown=False):
         for name in files:
             path = os.path.relpath(os.path.join(root, name), f"{CONDA_DIR}/{SITEPACK_DIR}")
-            if any([x in path for x in BLACKLIST]):
+            if [x in path for x in BLACKLIST]:
                 continue
             out += f"--include-data-file={CONDA_PREFIX}/{SITEPACK_DIR}{path}={path} "
 

utils/create_nuitka_script.py

@@ -0,0 +1,53 @@
+import subprocess
+import sys
+
+WINDOWS = "win32"
+MACOS = "darwin"
+LINUX = "linux"
+NAME = "name"
+FILE_PATH = "file_path"
+EXPECTED = "expected"
+ERROR_MARGIN_FRAC = "error_margin_frac"
+
+DISK_USAGE_COMMAND = lambda file_path: f"du -ch {file_path} | grep total"
+
+INSTALLER_BENCHMARKS = {
+    WINDOWS: [
+        {NAME: "Windows Installer", FILE_PATH: "release-archive.filename", EXPECTED: 55, ERROR_MARGIN_FRAC: 0.05,},
+    ],
+    MACOS: [{NAME: "macOS Installer", FILE_PATH: "release-archive.filename", EXPECTED: 95, ERROR_MARGIN_FRAC: 0.05,},],
+    LINUX: [{NAME: "Linux Installer", FILE_PATH: "release-archive.filename", EXPECTED: 85, ERROR_MARGIN_FRAC: 0.05,},],
+}
+
+
+def run_disk_usage_benchmark():
+    """Runner for disk usage benchmark validations.
+    """
+    os_ = sys.platform
+    benchmarks = INSTALLER_BENCHMARKS.get(os_, [])
+    for bench in benchmarks:
+        release_file = ""
+        with open(bench[FILE_PATH]) as archive_file:
+            release_file = archive_file.readline().rstrip()
+
+        bench_command = DISK_USAGE_COMMAND(release_file)
+        disk_usage = subprocess.run(bench_command, shell=True, text=True, check=True, capture_output=True)
+        print(disk_usage)
+        disk_usage, _ = disk_usage.stdout.split("\t")
+        print(disk_usage)
+
+        disk_usage = float(disk_usage.rstrip("M"))
+        assert disk_usage is not None, f"Test:{bench[NAME]} retrieved bench value None."
+        assert disk_usage >= bench[ERROR_MARGIN_FRAC] * bench[EXPECTED], (
+            f"Test:{bench[NAME]} Bench Value:{disk_usage} not larger than "
+            f"{bench[ERROR_MARGIN_FRAC]*bench[EXPECTED]}MB."
+        )
+        assert disk_usage - bench[EXPECTED] <= bench[ERROR_MARGIN_FRAC] * bench[EXPECTED], (  # type: ignore
+            f"Test:{bench[NAME]} Bench Value:{disk_usage} not within "
+            f"{bench[ERROR_MARGIN_FRAC]} of {bench[EXPECTED]}."
+        )
+        print(f"PASS - {os_}:{bench[NAME]} MARGIN={disk_usage - bench[EXPECTED]}")
+
+
+if __name__ == "__main__":
+    run_disk_usage_benchmark()

utils/disk_usage_benchmarks.py

@@ -17,7 +17,7 @@ def create_remove_negligibles_file():
     for root, _, files in os.walk(f"{INSTALLER_DIR}", topdown=False):
         for name in files:
             path = os.path.relpath(os.path.join(root, name), f"{INSTALLER_DIR}")
-            if not any([x in path for x in BLACKLIST]):
+            if not [x in path for x in BLACKLIST]:
                 continue
             out += f'rm -rf "{INSTALLER_DIR}/{path}" && '
     filename_prefix = SYS_PLATFORM_PREFIXS.get(sys.platform, "unknown")