feat: add pre-commit hooks and run comprehensive tests always

dguido · claude · dguido · commit ce63043a42cb · 2025-08-21T18:47:56.000-04:00
- Remove label requirement for comprehensive tests (only 3 min runtime) - Add pre-commit configuration with ruff and basic checks - Fix all formatting issues found by pre-commit - Update development setup docs to include pre-commit installation - Prevents CI failures from formatting issues 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -1,48 +1,48 @@
---- 
-body: 
-  - 
-    attributes: 
+---
+body:
+  -
+    attributes:
       value: |
           Please check the issues tab to avoid duplicates.
           Thanks for taking the time to fill out this bug report!
     type: markdown
-  - 
-    attributes: 
+  -
+    attributes:
       label: "Describe the issue:"
     id: what-happened
     type: textarea
-    validations: 
+    validations:
       required: true
-  - 
-    attributes: 
+  -
+    attributes:
       description: "It can be a github repo, etherscan link, or code snippet."
       label: "Code example to reproduce the issue:"
       placeholder: "`contract A {}`\n"
     id: reproduce
     type: textarea
-    validations: 
+    validations:
       required: true
-  - 
-    attributes: 
+  -
+    attributes:
       description: |
-          What version of solc-select are you running? 
+          What version of solc-select are you running?
           Run `solc-select--version`
       label: "Version:"
     id: version
     type: textarea
-    validations: 
+    validations:
       required: true
-  - 
-    attributes: 
+  -
+    attributes:
       description: |
-          Please copy and paste any relevant log output. This 
+          Please copy and paste any relevant log output. This
           will be automatically formatted into code, so no need for backticks.
       render: shell
       label: "Relevant log output:"
     id: logs
     type: textarea
 description: "File a bug report"
-labels: 
+labels:
   - bug-candidate
 name: "Bug Report"
 title: "[Bug-Candidate]: "
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -5,7 +5,7 @@ updates:
     directory: /
     schedule:
       interval: daily
-  
+
   - package-ecosystem: pip
     directory: /
     schedule:
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -47,11 +47,9 @@ jobs:
         # Run pytest with appropriate platform markers
         # Skip slow tests (upgrade test) and version_boundaries tests in CI
         python -m pytest tests/ -v --tb=short -k "not version_boundaries" -m "not slow"
-  
+
   comprehensive-tests:
     name: Comprehensive Tests (Python ${{ matrix.python }} on ${{ matrix.os }})
-    # Only run on schedule or when labeled 'full-tests'
-    if: github.event_name == 'schedule' || contains(github.event.pull_request.labels.*.name, 'full-tests')
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
diff --git a/.github/workflows/pip-audit.yml b/.github/workflows/pip-audit.yml
@@ -38,4 +38,3 @@ jobs:
         uses: pypa/gh-action-pip-audit@v1.1.0
         with:
           virtual-environment: /tmp/pip-audit-env
-
diff --git a/.gitignore b/.gitignore
@@ -8,4 +8,4 @@ global-version
 build/
 dist/
 *.egg
-*.egg-info/
+*.egg-info/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,24 @@
+# Pre-commit hooks for code quality
+# See https://pre-commit.com for more information
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version should match the version in pyproject.toml
+    rev: v0.8.4
+    hooks:
+      # Run the linter
+      - id: ruff
+        args: ["--fix"]
+      # Run the formatter
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+        args: ["--maxkb=1000"]
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: debug-statements
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,15 +1,15 @@
-# Contributing to solc-select 
+# Contributing to solc-select
 
-Hi! Welcome to solc-select. 
+Hi! Welcome to solc-select.
 
-## Bug Reports and Feature Suggestions 
+## Bug Reports and Feature Suggestions
 
 Bug reports and feature suggestions can be submitted to our issue tracker. For bug reports, attaching the contract that caused the bug will help us in debugging and resolving the issue quickly. If you find a security vulnerability, do not open an issue; email opensource@trailofbits.com instead.
 
 ## Questions
 Questions can be submitted to the issue tracker, but you may get a faster response if you ask in our [chat room](https://slack.empirehacking.nyc/) (in the #ethereum channel).
 
-## Code 
+## Code
 solc-select uses the pull request contribution model. Please make an account on Github, fork this repo, and submit code contributions via pull request. For more documentation, look [here](https://guides.github.com/activities/forking/).
 
 Some pull request guidelines:
@@ -31,7 +31,8 @@ git clone https://github.com/crytic/solc-select.git
 cd solc-select
 uv venv
 source .venv/bin/activate  # On Windows: .venv\Scripts\activate
-uv pip install -e .
+uv pip install -e ".[dev]"
+pre-commit install  # Set up automatic linting on commit
 ```
 
 #### Using pip
@@ -41,7 +42,8 @@ git clone https://github.com/crytic/solc-select.git
 cd solc-select
 python3 -m venv venv
 source venv/bin/activate  # On Windows: venv\Scripts\activate
-pip install -e .
+pip install -e ".[dev]"
+pre-commit install  # Set up automatic linting on commit
 ```
 
 #### Using make
diff --git a/ISSUE_DRAFT.md b/ISSUE_DRAFT.md
@@ -128,4 +128,4 @@ The solution should be tested on:
 
 - [Solidity Official Binaries Repository](https://binaries.soliditylang.org/)
 - [macOS Universal Binary Support (v0.8.24+)](https://github.com/ethereum/solidity/issues/12291#issuecomment-2223328961)
-- [solc-js npm package](https://www.npmjs.com/package/solc) - JavaScript/WASM version
+- [solc-js npm package](https://www.npmjs.com/package/solc) - JavaScript/WASM version
diff --git a/LICENSE b/LICENSE
@@ -658,4 +658,4 @@ specific requirements.
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU AGPL, see
-<https://www.gnu.org/licenses/>.
+<https://www.gnu.org/licenses/>.
diff --git a/Makefile b/Makefile
@@ -1,3 +1,3 @@
-dev: 
+dev:
 	python3 -m venv env && source ./env/bin/activate
 	python3 -m pip install -e .
diff --git a/pyproject.toml b/pyproject.toml
@@ -50,6 +50,8 @@ dev = [
     "ruff>=0.1.0",
     "mypy>=1.0.0",
     "types-setuptools",
+    # Development tools
+    "pre-commit>=3.5.0",
 ]
 
 [project.scripts]
@@ -109,6 +111,6 @@ addopts = [
 markers = [
     "slow: marks tests as slow (deselect with '-m \"not slow\"')",
     "linux: marks tests to run only on Linux",
-    "macos: marks tests to run only on macOS", 
+    "macos: marks tests to run only on macOS",
     "windows: marks tests to run only on Windows",
 ]
diff --git a/scripts/solidity_tests/solc080_fail_compile.sol b/scripts/solidity_tests/solc080_fail_compile.sol
@@ -4,4 +4,4 @@ contract solc080 {
     function good() public returns (uint256){
         return uint(-1);
     }
-}
+}
diff --git a/scripts/solidity_tests/solc080_success.sol b/scripts/solidity_tests/solc080_success.sol
@@ -5,4 +5,4 @@ contract solc080 {
     function good() public pure returns (uint256){
         return type(uint).max;
     }
-}
+}
diff --git a/scripts/solidity_tests/solc080_success_warning.sol b/scripts/solidity_tests/solc080_success_warning.sol
@@ -4,4 +4,4 @@ contract solc080 {
     function good() public returns (uint256){
         return type(uint).max;
     }
-}
+}
diff --git a/scripts/test_macos.sh b/scripts/test_macos.sh
@@ -31,4 +31,4 @@ if [[ $use_version != *"Invalid version '$latest_release' is the latest availabl
   echo "OS X FAILED: version too high"
   exit 255
 fi
-echo "OS X SUCCESS: version too high"
+echo "OS X SUCCESS: version too high"
diff --git a/scripts/test_solc.sh b/scripts/test_solc.sh
@@ -110,4 +110,4 @@ if [[ $execute != *"'0.8.1' must be installed prior to use"* ]]; then
 fi
 echo "SUCCESS: use - no install"
 
-solc-select install 0.8.1 &> /dev/null
+solc-select install 0.8.1 &> /dev/null
diff --git a/scripts/test_solc_upgrade.sh b/scripts/test_solc_upgrade.sh
@@ -26,4 +26,4 @@ if [ "$all_old_versions" != "$all_new_versions" ]; then
   exit 255
 fi
 
-echo "Upgrade successful"
+echo "Upgrade successful"
diff --git a/tests/README.md b/tests/README.md
@@ -35,7 +35,7 @@ pytest -m "not (linux or macos or windows)"
 # Run Linux-specific tests (only works on Linux)
 pytest -m linux
 
-# Run macOS-specific tests (only works on macOS)  
+# Run macOS-specific tests (only works on macOS)
 pytest -m macos
 
 # Run Windows-specific tests (only works on Windows)
@@ -77,4 +77,4 @@ The tests maintain the exact same:
 - Command execution patterns
 - Error message checking
 - Version installation behavior
-- Platform-specific constraints
+- Platform-specific constraints
diff --git a/tests/test_compiler_versions.py b/tests/test_compiler_versions.py
@@ -35,9 +35,9 @@ def test_solc_045(self, run_command, test_contracts_dir, backup_current_version)
         # Test expected compilation failure
         result = run_command(f"solc {test_contracts_dir}/solc045_fail_compile.sol", check=False)
         assert result.returncode != 0
-        assert "Error: Expected token Semicolon got 'Function'" in result.stdout, (
-            f"solc045_fail_compile did not fail as expected. Output: {result.stdout}"
-        )
+        assert (
+            "Error: Expected token Semicolon got 'Function'" in result.stdout
+        ), f"solc045_fail_compile did not fail as expected. Output: {result.stdout}"
 
     def test_solc_050(self, run_command, test_contracts_dir, backup_current_version):
         """Test Solidity 0.5.0 compilation behavior."""
@@ -83,9 +83,9 @@ def test_solc_070(self, run_command, test_contracts_dir, backup_current_version)
         # Test deprecated 'now' keyword
         result = run_command(f"solc {test_contracts_dir}/solc070_fail_compile.sol", check=False)
         assert result.returncode != 0
-        assert '"now" has been deprecated.' in result.stdout, (
-            f"solc070_fail_compile did not show deprecation warning. Output: {result.stdout}"
-        )
+        assert (
+            '"now" has been deprecated.' in result.stdout
+        ), f"solc070_fail_compile did not show deprecation warning. Output: {result.stdout}"
 
         # Test successful compilation
         result = run_command(f"solc {test_contracts_dir}/solc070_success.sol", check=False)
@@ -106,16 +106,16 @@ def test_solc_080(self, run_command, test_contracts_dir, backup_current_version)
         result = run_command(f"solc {test_contracts_dir}/solc080_success_warning.sol", check=False)
         # Should succeed but with warning
         assert result.returncode == 0
-        assert "Warning: Function state mutability can be restricted to pure" in result.stdout, (
-            f"solc080_success_warning did not show expected warning. Output: {result.stdout}"
-        )
+        assert (
+            "Warning: Function state mutability can be restricted to pure" in result.stdout
+        ), f"solc080_success_warning did not show expected warning. Output: {result.stdout}"
 
         # Test expected compilation failure
         result = run_command(f"solc {test_contracts_dir}/solc080_fail_compile.sol", check=False)
         assert result.returncode != 0
-        assert "Error: Explicit type conversion not allowed" in result.stdout, (
-            f"solc080_fail_compile did not fail as expected. Output: {result.stdout}"
-        )
+        assert (
+            "Error: Explicit type conversion not allowed" in result.stdout
+        ), f"solc080_fail_compile did not fail as expected. Output: {result.stdout}"
 
 
 class TestVersionSwitching:
@@ -150,9 +150,9 @@ def test_always_install_flag(self, run_command, solc_select_path, backup_current
         # Use with --always-install should install and switch
         result = run_command("solc-select use 0.8.9 --always-install", check=False)
         assert result.returncode == 0
-        assert "Switched global version to 0.8.9" in result.stdout, (
-            f"Failed to switch with --always-install. Output: {result.stdout}"
-        )
+        assert (
+            "Switched global version to 0.8.9" in result.stdout
+        ), f"Failed to switch with --always-install. Output: {result.stdout}"
 
     def test_use_without_install(self, run_command, solc_select_path, backup_current_version):
         """Test that 'use' fails when version is not installed."""
@@ -184,9 +184,9 @@ def test_use_without_install(self, run_command, solc_select_path, backup_current
         # Use without install should fail
         result = run_command("solc-select use 0.8.1", check=False)
         assert result.returncode != 0
-        assert "'0.8.1' must be installed prior to use" in result.stdout, (
-            f"Did not fail as expected when version not installed. Output: {result.stdout}"
-        )
+        assert (
+            "'0.8.1' must be installed prior to use" in result.stdout
+        ), f"Did not fail as expected when version not installed. Output: {result.stdout}"
 
         # Clean up: install 0.8.1 for other tests
         run_command("solc-select install 0.8.1", check=False)
diff --git a/tests/test_platform_specific.py b/tests/test_platform_specific.py
diff --git a/tests/test_upgrade.py b/tests/test_upgrade.py

-Original file line number
+Diff line change
         uses: pypa/[email protected]
         with:
           virtual-environment: /tmp/pip-audit-env
+-