chore: update test workflow to run all tests in one job

fix: handle cases where format is None in BrewInfo
refactor: change 'serial' marker to 'destructive' and update tests to use it
feat: add destructive tests and related scripts
feat: add BrewFile install error handling and before/after command execution
feat: implement json info cache and helper methods

Author: rcmdnk

.github/workflows/test.yml

@@ -138,23 +138,13 @@ jobs:
           github_token: "${{github.token}}"
           pre-commit: "${{ env.IS_MAIN }}"
           tmate: "${{ env.DEBUG }}"
-  test-serial:
+  test-destructive:
     strategy:
       fail-fast: false
       matrix:
         python-version: ['3.9']
         test-path:
-          - 'tests/test_serial.py::test_init'
-          - 'tests/test_serial.py::test_install_clean[default]'
-          - 'tests/test_serial.py::test_install_clean[on-request]'
-          - 'tests/test_serial.py::test_install_clean[top-packages]'
-          - 'tests/test_serial.py::test_clean_non_request'
-          - 'tests/test_serial.py::test_vscode_cursor'
-          - 'tests/test_serial.py::test_update'
-          - 'tests/test_serial.py::test_dry_run'
-          - 'tests/test_serial.py::test_brew_command'
-          - 'tests/test_serial.py::test_format_options'
-          - 'tests/test_serial.py::test_cask_args'
+          - 'tests/test_destructive.py'
     runs-on: macos-latest
     steps:
       - name: Set pseudo git user
@@ -173,7 +163,7 @@ jobs:
           pytest-separate-benchmark: 0
           coverage: 0
           pytest-cov-path: ""
-          pytest-opt: "-n0 -m serial"
+          pytest-opt: "-n0 -m destructive"
           coverage-push: 0
           github_token: ""
           pre-commit: 0

bin/brew-file

@@ -953,8 +953,7 @@ class BrewInfo:
         output_prefix = ''
         output = ''
 
-        # commands for each format
-        # if self.helper.opt["form"] in ["file", "none"]:
+        # comd base
         cmd_before = 'before '
         cmd_after = 'after '
         cmd_cask_args = 'cask_args '
@@ -969,7 +968,9 @@ class BrewInfo:
         cmd_cursor = 'cursor '
         cmd_main = 'main '
         cmd_file = 'file '
-        if self.helper.opt['form'] in ['brewdler', 'bundle']:
+        if self.helper.opt['form'] in ['file', None]:
+            pass
+        elif self.helper.opt['form'] in ['brewdler', 'bundle']:
             cmd_before = '#before '
             cmd_after = '#after '
             cmd_cask_args = '#cask_args '
@@ -1011,6 +1012,9 @@ fi
             cmd_cursor = 'cursor --install-extension '
             cmd_main = '#main '
             cmd_file = '#file '
+        else:
+            msg = f'Invalid format: "{self.helper.opt["form"]}".\nUse "file", "brewdler", "bundle", "command" or "cmd".'
+            raise ValueError(msg)
 
         # sort
         self.sort()

pyproject.toml

@@ -25,9 +25,9 @@ build-backend = "hatchling.build"
 
 [tool.pytest.ini_options]
 markers = [
-    "serial: tests only for serial run.",
+    "destructive: tests only for destructive run.",
 ]
-addopts = "-n auto -m 'not serial'"
+addopts = "-n auto -m 'not destructive'"
 testpaths = ["tests",]
 
 [tool.ruff]

src/brew_file/brew_info.py

@@ -400,8 +400,7 @@ def write(self) -> None:
         output_prefix = ''
         output = ''
 
-        # commands for each format
-        # if self.helper.opt["form"] in ["file", "none"]:
+        # comd base
         cmd_before = 'before '
         cmd_after = 'after '
         cmd_cask_args = 'cask_args '
@@ -416,7 +415,9 @@ def write(self) -> None:
         cmd_cursor = 'cursor '
         cmd_main = 'main '
         cmd_file = 'file '
-        if self.helper.opt['form'] in ['brewdler', 'bundle']:
+        if self.helper.opt['form'] in ['file', None]:
+            pass
+        elif self.helper.opt['form'] in ['brewdler', 'bundle']:
             cmd_before = '#before '
             cmd_after = '#after '
             cmd_cask_args = '#cask_args '
@@ -458,6 +459,9 @@ def write(self) -> None:
             cmd_cursor = 'cursor --install-extension '
             cmd_main = '#main '
             cmd_file = '#file '
+        else:
+            msg = f'Invalid format: "{self.helper.opt["form"]}".\nUse "file", "brewdler", "bundle", "command" or "cmd".'
+            raise ValueError(msg)
 
         # sort
         self.sort()

tests/conftest.py

@@ -1,39 +1,62 @@
 from __future__ import annotations
 
+import getpass
 import os
+import warnings
 from pathlib import Path
 from typing import TYPE_CHECKING
 
 import pytest
 from filelock import FileLock
 
-from .brew_file import BrewFile, BrewHelper
+from .brew_file import BrewFile, BrewHelper, BrewInfo, is_mac
 
 if TYPE_CHECKING:
     from _pytest.config import Config
     from _pytest.nodes import Item
 
 
-def _running_under_xdist(config: Config) -> bool:
+def _parallel_test(config: Config) -> bool:
     return getattr(config, 'workerinput', None) is not None
 
 
+@pytest.hookimpl(trylast=True)  # To run after marker filtering
 def pytest_collection_modifyitems(config: Config, items: Item) -> None:
-    if not _running_under_xdist(config):
-        return
-
     remaining = []
-    deselected = []
+    destructive = []
 
     for item in items:
-        if 'serial' in item.keywords:
-            deselected.append(item)
+        if 'destructive' in item.keywords:
+            destructive.append(item)
         else:
             remaining.append(item)
 
-    if deselected:
-        config.hook.pytest_deselected(items=deselected)
-        items[:] = remaining
+    if destructive:
+        config.destructive_clean = True
+        if _parallel_test(config):
+            config.hook.pytest_deselected(items=destructive)
+            items[:] = remaining
+            warnings.warn(
+                'Destructive tests are skipped in parallel mode.', stacklevel=2
+            )
+        elif getpass.getuser() not in ['lume', 'runner']:
+            response = input(
+                '\n\n\033[33mThere are destructive tests.\nTHIS MAY DELETE ALL OF YOUR HOMEBREW PACKAGES.\nDo you actually want to run them on current environment?\033[0m [y/N]: '
+            )
+            if response.lower() != 'y':
+                config.hook.pytest_deselected(items=destructive)
+                items[:] = remaining
+                warnings.warn('Destructive tests are skipped.', stacklevel=2)
+            else:
+                response = input(
+                    'Do you want to clean up the environment before each destructive test? [y/N]: '
+                )
+                if response.lower() != 'y':
+                    config.destructive_clean = False
+                    warnings.warn(
+                        'Do not run cleanup before destructive tests. Some tests may fail.',
+                        stacklevel=2,
+                    )
 
 
 @pytest.fixture(scope='session', autouse=True)
@@ -43,7 +66,7 @@ def check_brew(tmp_path_factory: pytest.TempPathFactory) -> None:
     with FileLock(root_tmp_dir / 'brew.lock'):
         bf = BrewFile({})
         if not (Path(bf.opt['cache']) / 'api/formula.jws.json').exists():
-            # pseudo code to download api json
+            # run search to download api json
             helper.proc('brew search python')
     for env in os.environ:
         if env.startswith('HOMEBREW_BREWFILE'):
@@ -52,17 +75,6 @@ def check_brew(tmp_path_factory: pytest.TempPathFactory) -> None:
     os.environ['HOMEBREW_AUTO_UPDATE_SECS'] = '100000'
 
 
-@pytest.fixture(scope='session', autouse=False)
-def tap(tmp_path_factory: pytest.TempPathFactory) -> list[str]:
-    taps = ['rcmdnk/rcmdnkpac', 'rcmdnk/rcmdnkcask']
-    root_tmp_dir = tmp_path_factory.getbasetemp().parent
-    with FileLock(root_tmp_dir / 'tap.lock'):
-        helper = BrewHelper()
-        helper.proc(f'brew tap {taps[0]}')
-        helper.proc(f'brew tap {taps[1]}')
-    return taps
-
-
 @pytest.fixture(scope='session', autouse=False)
 def python(tmp_path_factory: pytest.TempPathFactory) -> str:
     python_formula = '[email protected]'
@@ -81,4 +93,13 @@ def bf_cmd() -> str:
 
 @pytest.fixture
 def helper() -> BrewHelper:
-    return BrewHelper()
+    # BrewHelper with default options
+    return BrewFile({}).helper
+
+
+@pytest.fixture
+def brew_info() -> BrewInfo:
+    file = 'BrewfileTest' if is_mac() else 'BrewfileTestLinux'
+    # BrewInfo with default options and input file
+    bf = BrewFile({'input': Path(__file__).parent / 'files' / file})
+    return bf.brewinfo

tests/scripts/destructive_test.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+if pytest --help | grep -q -- '-n numprocesses';then
+  pytest -s -vvv -n0 -p no:cacheprovider -o "markers=destructive" -c /dev/null tests/test_destructive.py
+else
+  pytest -s -vvv -p no:cacheprovider -o "markers=destructive" -c /dev/null tests/test_destructive.py
+fi