Add update_python_resources parameter to build python resources

Author: akopdev

README.md

@@ -136,6 +136,10 @@ jobs:
           # Logs debugging info to console.
           # Default is shown - boolean
           debug: false
+          
+          # Run 'brew update-python-resources' on the formula to add Python resources.
+          # Default is shown - boolean
+          update_python_resources: false
 ```
 
 ## Development

action.yml

@@ -67,6 +67,9 @@ inputs:
   debug:
     description: "Logs debugging info to console."
     required: false
+  update_python_resources:
+    description: "Run 'brew update-python-resources' on the formula to add Python resources."
+    required: false
 runs:
   using: "docker"
   image: "Dockerfile"
@@ -91,3 +94,4 @@ runs:
     - ${{ inputs.update_readme_table }}
     - ${{ inputs.skip_commit }}
     - ${{ inputs.debug }}
+    - ${{ inputs.update_python_resources }}

homebrew_releaser/_version.py

@@ -1 +1 @@
-__version__ = '2.0.3'
+__version__ = '2.1.0'

homebrew_releaser/app.py

@@ -21,6 +21,7 @@
     TARGET_DARWIN_ARM64,
     TARGET_LINUX_AMD64,
     TARGET_LINUX_ARM64,
+    UPDATE_PYTHON_RESOURCES,
     VERSION,
 )
 from homebrew_releaser.formula import Formula
@@ -162,7 +163,14 @@ def run_github_action():
             version_no_v if VERSION else None,
         )
 
-        Utils.write_file(os.path.join(HOMEBREW_TAP, FORMULA_FOLDER, f'{repository["name"]}.rb'), template, 'w')
+        formula_path = os.path.join(HOMEBREW_TAP, FORMULA_FOLDER, f'{repository["name"]}.rb')
+        Utils.write_file(formula_path, template, 'w')
+
+        if UPDATE_PYTHON_RESOURCES:
+            logger.info('Attempting to update Python resources in the formula...')
+            Formula.update_python_resources(formula_path, repository["name"])
+        else:
+            logger.debug('Skipping update to Python resources.')
 
         if UPDATE_README_TABLE:
             logger.info('Attempting to update the README\'s project table...')

homebrew_releaser/constants.py

@@ -49,3 +49,10 @@
 TARGET_LINUX_ARM64 = (
     os.getenv('INPUT_TARGET_LINUX_ARM64', False) if os.getenv('INPUT_TARGET_LINUX_ARM64') != 'false' else False
 )  # Must check for string `false` since GitHub Actions passes the bool as a string
+
+# Python resources
+UPDATE_PYTHON_RESOURCES = (
+    os.getenv("INPUT_UPDATE_PYTHON_RESOURCES", False)
+    if os.getenv("INPUT_UPDATE_PYTHON_RESOURCES") != "false"
+    else False
+)

homebrew_releaser/formula.py

@@ -1,4 +1,6 @@
 import re
+import shutil
+import subprocess  # nosec B404
 import textwrap
 from typing import (
     Any,
@@ -265,3 +267,37 @@ def _generate_class_name(repo_name: str) -> str:
                 repo_name.title(),
             ),
         )
+
+    @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
+        """
+        logger = woodchips.get(LOGGER_NAME)
+
+        brew_path = shutil.which('brew')
+        if not brew_path:
+            logger.error("brew not found in PATH")
+            return
+
+        try:
+            logger.info(f'Running brew update-python-resources for {formula_name}...')
+            result = subprocess.run(  # nosec B603
+                [brew_path, 'update-python-resources', formula_path],
+                capture_output=True,
+                text=True,
+                check=True,
+                shell=False,  # Skip shell code to make it more secure
+            )
+
+            logger.info(f'Successfully updated Python resources for {formula_name}')
+            logger.debug(f'brew update-python-resources output: {result.stdout}')
+        except subprocess.CalledProcessError as e:
+            logger.error(
+                "Failed to update Python resources: %s\nCommand output: %s\nCommand error: %s", e, e.stdout, e.stderr
+            )
+        except Exception as e:
+            logger.error(f'An error occurred while updating Python resources: {e}')

test/unit/test_app.py

@@ -137,6 +137,53 @@ def test_run_github_action_update_readme(
     mock_update_readme.assert_called_once()
 
 
+@patch('homebrew_releaser.app.HOMEBREW_TAP', '123')
+@patch('homebrew_releaser.app.UPDATE_PYTHON_RESOURCES', True)
+@patch('homebrew_releaser.checksum.Checksum.upload_checksum_file')
+@patch('woodchips.get')
+@patch('homebrew_releaser.git.Git.setup')
+@patch('homebrew_releaser.git.Git.add')
+@patch('homebrew_releaser.git.Git.commit')
+@patch('homebrew_releaser.git.Git.push')
+@patch('homebrew_releaser.utils.Utils.write_file')
+@patch('homebrew_releaser.formula.Formula.generate_formula_data')
+@patch('homebrew_releaser.checksum.Checksum.get_checksum', return_value=('123', 'mock-repo'))
+@patch('homebrew_releaser.app.App.download_archive')
+@patch('homebrew_releaser.utils.Utils.make_github_get_request')
+@patch('homebrew_releaser.app.App.check_required_env_variables')
+@patch('homebrew_releaser.formula.Formula.update_python_resources')
+def test_run_github_action_update_python_resources(
+    mock_update_python_resources,
+    mock_check_env_variables,
+    mock_make_github_get_request,
+    mock_download_archive,
+    mock_get_checksum,
+    mock_generate_formula,
+    mock_write_file,
+    mock_push_formula,
+    mock_commit_formula,
+    mock_add_formula,
+    mock_setup_git,
+    mock_logger,
+    mock_upload_checksum_file,
+):
+    App.run_github_action()
+
+    # TODO: Assert these `called_with` eventually
+    mock_logger.assert_called()
+    mock_check_env_variables.assert_called_once()
+    assert mock_make_github_get_request.call_count == 2
+    mock_download_archive.call_count == 2
+    mock_get_checksum.call_count == 2
+    mock_generate_formula.assert_called_once()
+    mock_write_file.call_count == 2
+    mock_setup_git.assert_called_once()
+    mock_add_formula.assert_called_once()
+    mock_commit_formula.assert_called_once()
+    mock_push_formula.assert_called_once()
+    mock_update_python_resources.assert_called_once()
+
+
 @patch('homebrew_releaser.app.HOMEBREW_TAP', '123')
 @patch('homebrew_releaser.app.TARGET_DARWIN_AMD64', True)
 @patch('homebrew_releaser.app.TARGET_DARWIN_ARM64', True)

test/unit/test_formula.py

@@ -1,5 +1,6 @@
 import inspect
 import os
+import shutil
 from unittest.mock import patch
 
 import pytest
@@ -880,3 +881,22 @@ def test_generate_class_name(repo_name, expected_class_name):
     class_name = Formula._generate_class_name(repo_name)
 
     assert class_name == expected_class_name
+
+
+@patch('woodchips.get')
+@patch('subprocess.run', side_effect=Exception('Test error'))
+def test_update_python_resources_error(mock_subprocess_run, mock_logger):
+    formula_path = '/path/to/formula.rb'
+    formula_name = 'test-formula'
+
+    Formula.update_python_resources(formula_path, formula_name)
+
+    brew_path = shutil.which('brew')
+    mock_subprocess_run.assert_called_once_with(
+        [brew_path, 'update-python-resources', formula_path],
+        capture_output=True,
+        text=True,
+        check=True,
+        shell=False,
+    )
+    mock_logger.assert_called()