test: update-python-resources formula

Author: Justintime50

homebrew_releaser/formula.py

@@ -271,33 +271,23 @@ def _generate_class_name(repo_name: str) -> str:
 
     @staticmethod
     def update_python_resources(formula_path: str, formula_name: str) -> None:
-        """Runs brew update-python-resources on the formula to add Python resources.
-
-        Args:
-            formula_path: The path to the formula file
-            formula_name: The name of the formula
-        """
+        """Runs brew update-python-resources on the formula to add Python resources."""
         logger = woodchips.get(LOGGER_NAME)
 
         brew_path = shutil.which('brew')
         if not brew_path:
             raise SystemExit("brew not found in PATH")
 
         try:
-            logger.info(f'Running brew update-python-resources for {formula_name}...')
-            output = subprocess.check_output(  # nosec B603
+            logger.info(f'Running brew update-python-resources for {formula_path}...')
+            subprocess.check_output(  # nosec B603
                 [brew_path, 'update-python-resources', formula_path],
                 stderr=subprocess.STDOUT,
                 text=True,
                 timeout=TIMEOUT,
             )
-            logger.info(f'Successfully updated Python resources for {formula_name}')
-            logger.debug(f'brew update-python-resources output:\n{output}')
+            logger.info(f'Successfully updated Python resources for {formula_path}')
         except subprocess.TimeoutExpired as e:
             raise SystemExit from e
         except subprocess.CalledProcessError as e:
-            raise SystemExit(
-                "Failed to update Python resources: %s\nCommand output: %s\nCommand error: %s", e, e.stdout, e.stderr
-            ) from e
-        except Exception as e:
             raise SystemExit(f'An error occurred while updating Python resources: {e}') from e

test/formulas/homebrew_releaser.rb

@@ -0,0 +1,57 @@
+# typed: true
+# frozen_string_literal: true
+
+# This file was generated by Homebrew Releaser. DO NOT EDIT.
+class HomebrewReleaser < Formula
+  include Language::Python::Virtualenv
+
+  desc "Release scripts, binaries, and executables to github"
+  homepage "https://github.com/Justintime50/homebrew-releaser"
+  url "https://github.com/justintime50/homebrew-releaser/archive/refs/tags/v1.0.0.tar.gz"
+  sha256 "0000000000000000000000000000000000000000000000000000000000000000"
+  license "MIT"
+
+  resource "certifi" do
+    url "https://files.pythonhosted.org/packages/e8/9e/c05b3920a3b7d20d3d3310465f50348e5b3694f4f88c6daf736eef3024c4/certifi-2025.4.26.tar.gz"
+    sha256 "0a816057ea3cdefcef70270d2c515e4506bbc954f417fa5ade2021213bb8f0c6"
+  end
+
+  resource "charset-normalizer" do
+    url "https://files.pythonhosted.org/packages/e4/33/89c2ced2b67d1c2a61c19c6751aa8902d46ce3dacb23600a283619f5a12d/charset_normalizer-3.4.2.tar.gz"
+    sha256 "5baececa9ecba31eff645232d59845c07aa030f0c81ee70184a90d35099a0e63"
+  end
+
+  resource "chevron" do
+    url "https://files.pythonhosted.org/packages/15/1f/ca74b65b19798895d63a6e92874162f44233467c9e7c1ed8afd19016ebe9/chevron-0.14.0.tar.gz"
+    sha256 "87613aafdf6d77b6a90ff073165a61ae5086e21ad49057aa0e53681601800ebf"
+  end
+
+  resource "idna" do
+    url "https://files.pythonhosted.org/packages/f1/70/7703c29685631f5a7590aa73f1f1d3fa9a380e654b86af429e0934a32f7d/idna-3.10.tar.gz"
+    sha256 "12f65c9b470abda6dc35cf8e63cc574b1c52b11df2c86030af0ac09b01b13ea9"
+  end
+
+  resource "pretty-tables" do
+    url "https://files.pythonhosted.org/packages/f7/d6/327794663b3c94127da65714639d66029b7acf152bc63a2fe7976c068614/pretty-tables-2.0.3.tar.gz"
+    sha256 "b98d5973c6677a4bda26e43322797764ef4c4333cc6c188be19a365e6d4c3a99"
+  end
+
+  resource "requests" do
+    url "https://files.pythonhosted.org/packages/63/70/2bf7780ad2d390a8d301ad0b550f1581eadbd9a20f896afe06353c2a2913/requests-2.32.3.tar.gz"
+    sha256 "55365417734eb18255590a9ff9eb97e9e1da868d4ccd6402399eaf68af20a760"
+  end
+
+  resource "urllib3" do
+    url "https://files.pythonhosted.org/packages/8a/78/16493d9c386d8e60e442a35feac5e00f0913c0f4b7c217c11e8ec2ff53e0/urllib3-2.4.0.tar.gz"
+    sha256 "414bc6535b787febd7567804cc015fee39daab8ad86268f1310a9250697de466"
+  end
+
+  resource "woodchips" do
+    url "https://files.pythonhosted.org/packages/a2/b7/81330431738c0a92cb0e716512b132c184058eef6d9d8ff0bc75b5ca21fb/woodchips-1.0.0.tar.gz"
+    sha256 "1837186797c933507ee4a822b17f7fec61db55ed6045c73b9d0350564984705c"
+  end
+
+  def install
+    virtualenv_install_with_resources
+  end
+end

test/unit/test_formula.py

@@ -10,8 +10,7 @@
 from homebrew_releaser.formula import Formula
 
 
-formula_path = 'test/formulas'
-
+FORMULA_PATH = 'test/formulas'
 USERNAME = 'Justintime50'
 VERSION = '0.1.0'
 CHECKSUM = '0' * 64  # `brew audit` wants a 64 character number here, this would be true with real data
@@ -42,7 +41,7 @@
 '''
 
 
-def _record_formula(formula_path: str, formula_name: str, formula_data: str):
+def _record_formula(formula_path: str, formula_name: str, formula_data: str, skip_assertions: bool = False):
     """Read from an existing formula file or create a new formula file if it's not present.
 
     Tests using this function will generate a formula into a file (similar to how
@@ -56,8 +55,9 @@ def _record_formula(formula_path: str, formula_name: str, formula_data: str):
     full_formula_filename = os.path.join(formula_path, formula_name)
 
     if os.path.isfile(full_formula_filename):
-        with open(full_formula_filename, 'r') as formula_file:
-            assert formula_data == formula_file.read()
+        if skip_assertions is False:
+            with open(full_formula_filename, 'r') as formula_file:
+                assert formula_data == formula_file.read()
     else:
         os.makedirs(formula_path, exist_ok=True)
         with open(full_formula_filename, 'w') as formula_file:
@@ -104,7 +104,7 @@ def test_generate_formula():
         test=TEST,
     )
 
-    _record_formula(formula_path, formula_filename, formula)
+    _record_formula(FORMULA_PATH, formula_filename, formula)
 
     # The following assertions are explicitly listed as the "gold standard" for generic formula generation
     assert (
@@ -174,7 +174,7 @@ def test_generate_formula_no_article_description():
         test=None,
     )
 
-    _record_formula(formula_path, formula_filename, formula)
+    _record_formula(FORMULA_PATH, formula_filename, formula)
 
     assert 'desc "Release scripts, binaries, and executables to github"' in formula
 
@@ -215,7 +215,7 @@ def test_generate_formula_formula_name_starts_description():
         test=None,
     )
 
-    _record_formula(formula_path, formula_filename, formula)
+    _record_formula(FORMULA_PATH, formula_filename, formula)
 
     assert 'desc "Is a tool"' in formula
 
@@ -254,7 +254,7 @@ def test_generate_formula_no_depends_on():
         test=TEST,
     )
 
-    _record_formula(formula_path, formula_filename, formula)
+    _record_formula(FORMULA_PATH, formula_filename, formula)
 
     assert 'depends_on' not in formula
 
@@ -293,7 +293,7 @@ def test_generate_formula_no_test():
         test=None,
     )
 
-    _record_formula(formula_path, formula_filename, formula)
+    _record_formula(FORMULA_PATH, formula_filename, formula)
 
     assert 'test do' not in formula
 
@@ -334,7 +334,7 @@ def test_generate_formula_multiline_fields():
         test=MULTILINE_TEST,
     )
 
-    _record_formula(formula_path, formula_filename, formula)
+    _record_formula(FORMULA_PATH, formula_filename, formula)
 
     assert (
         '''
@@ -436,7 +436,7 @@ def test_generate_formula_complete_matrix():
         test=TEST,
     )
 
-    _record_formula(formula_path, formula_filename, formula)
+    _record_formula(FORMULA_PATH, formula_filename, formula)
 
     assert formula.count('url') == 5
     assert formula.count('sha256') == 5
@@ -498,7 +498,7 @@ def test_generate_formula_darwin_matrix():
         test=None,
     )
 
-    _record_formula(formula_path, formula_filename, formula)
+    _record_formula(FORMULA_PATH, formula_filename, formula)
 
     assert 'on_macos' in formula
     assert 'on_intel' in formula
@@ -558,7 +558,7 @@ def test_generate_formula_linux_matrix():
         test=None,
     )
 
-    _record_formula(formula_path, formula_filename, formula)
+    _record_formula(FORMULA_PATH, formula_filename, formula)
 
     assert 'on_macos' not in formula
     assert 'on_intel' in formula
@@ -619,7 +619,7 @@ def test_one_of_each_matrix():
         test=None,
     )
 
-    _record_formula(formula_path, formula_filename, formula)
+    _record_formula(FORMULA_PATH, formula_filename, formula)
 
     assert 'on_macos' in formula
     assert 'on_intel' in formula
@@ -666,7 +666,7 @@ def test_generate_formula_string_false_configs():
         test=None,
     )
 
-    _record_formula(formula_path, formula_filename, formula)
+    _record_formula(FORMULA_PATH, formula_filename, formula)
 
     assert 'on_macos' not in formula
     assert 'on_intel' not in formula
@@ -707,7 +707,7 @@ def test_generate_formula_empty_fields():
         test=None,
     )
 
-    _record_formula(formula_path, formula_filename, formula)
+    _record_formula(FORMULA_PATH, formula_filename, formula)
 
     assert 'desc "NA"' in formula
     assert 'license' not in formula
@@ -785,7 +785,7 @@ def test_generate_formula_download_strategy():
         custom_require='../formula_imports/mock_download_strategy',
     )
 
-    _record_formula(formula_path, formula_filename, formula)
+    _record_formula(FORMULA_PATH, formula_filename, formula)
 
     assert formula.count(', using: CustomDownloadStrategy') == 5
     assert 'require_relative "../formula_imports/mock_download_strategy"' in formula
@@ -824,7 +824,7 @@ def test_generate_formula_override_version():
         version='9.8.7',
     )
 
-    _record_formula(formula_path, formula_filename, formula)
+    _record_formula(FORMULA_PATH, formula_filename, formula)
 
     assert '9.8.7' in formula
 
@@ -862,9 +862,60 @@ def test_generate_formula_formula_includes():
         formula_includes='include Language::Python::Virtualenv',
     )
 
-    _record_formula(formula_path, formula_filename, formula)
+    _record_formula(FORMULA_PATH, formula_filename, formula)
+
+    assert 'include Language::Python::Virtualenv' in formula
+
+
+def test_generate_formula_update_python_resources():
+    """Tests that we generate the formula content correctly when using the update_python_resources param.
+
+    NOTE: See docstring in `_record_formula` for more details on how recording formulas works.
+
+    NOTE: This test is unique since we call a subprocess to update our formula after we've generated it, will
+    require a different test flow than the others.
+    """
+    formula_filename = 'homebrew_releaser.rb'
+    repo_name = 'homebrew-releaser'
+    mock_tar_url = f'https://github.com/justintime50/{repo_name}/archive/refs/tags/v1.0.0.tar.gz'
+
+    repository = {
+        'description': DESCRIPTION,
+        'license': LICENSE,
+    }
+
+    formula = Formula.generate_formula_data(
+        owner=USERNAME,
+        repo_name=repo_name,
+        repository=repository,
+        checksums=[
+            {
+                f'{repo_name}.tar.gz': {
+                    'checksum': CHECKSUM,
+                    'url': (
+                        f'https://github.com/justintime50/{repo_name}/releases/download/1.0.0/{repo_name}-1.0.0.tar.gz'  # noqa
+                    ),
+                },
+            }
+        ],
+        install='virtualenv_install_with_resources',
+        tar_url=mock_tar_url,
+        formula_includes='include Language::Python::Virtualenv',
+    )
+
+    update_resources = False
+    full_formula_filename = os.path.join(os.getcwd(), FORMULA_PATH, formula_filename)
+    if not os.path.isfile(full_formula_filename):
+        update_resources = True
+    _record_formula(FORMULA_PATH, formula_filename, formula, skip_assertions=True)
+    if update_resources:
+        Formula.update_python_resources(full_formula_filename, repo_name)
+    with open(full_formula_filename, 'r') as formula_file:
+        formula = formula_file.read()
 
     assert 'include Language::Python::Virtualenv' in formula
+    assert 'resource "requests" do' in formula
+    assert 'virtualenv_install_with_resources' in formula
 
 
 @pytest.mark.parametrize(
@@ -885,19 +936,20 @@ def test_generate_class_name(repo_name, expected_class_name):
     assert class_name == expected_class_name
 
 
-@patch('subprocess.check_output', side_effect=Exception('Test error'))
+@patch(
+    'subprocess.check_output',
+    side_effect=subprocess.CalledProcessError(cmd='subprocess.check_output', returncode=1),
+)
 def test_update_python_resources_error(mock_subprocess):
-    formula_path = '/path/to/formula.rb'
+    FORMULA_PATH = '/path/to/formula.rb'
     formula_name = 'test-formula'
 
-    with pytest.raises(SystemExit) as error:
-        Formula.update_python_resources(formula_path, formula_name)
-
-    assert str(error.value) == 'An error occurred while updating Python resources: Test error'
+    with pytest.raises(SystemExit):
+        Formula.update_python_resources(FORMULA_PATH, formula_name)
 
     brew_path = shutil.which('brew')
     mock_subprocess.assert_called_once_with(
-        [brew_path, 'update-python-resources', formula_path],
+        [brew_path, 'update-python-resources', FORMULA_PATH],
         stderr=subprocess.STDOUT,
         text=True,
         timeout=TIMEOUT,

test/unit/test_readme_updater.py

@@ -75,8 +75,8 @@ def test_format_formula_data():
     """
     formulas = ReadmeUpdater.format_formula_data('./test')
 
-    assert len(formulas) == 15
-    assert formulas[0] == {
+    assert len(formulas) == 16
+    assert formulas[1] == {
         'name': 'test-generate-formula',
         'desc': 'Tool to release scripts, binaries, and executables to github',
         'homepage': 'https://github.com/Justintime50/test-generate-formula',