Repository navigation
Read .overcommit.yml as UTF-8 in the hook template - #910
Merged
Merged
Conversation
The hook template reads .overcommit.yml with File.read and no encoding, so the string takes Encoding.default_external. Under a non-UTF-8 locale (for example LANG=C, as used by some GUI git clients) that is US-ASCII, and matching the gemfile regex against a file containing any non-ASCII character, even in a comment, raises "invalid byte sequence in US-ASCII" and every git hook fails. Pass encoding: 'UTF-8' in all hook copies, which the template directory spec requires to be identical, and add a spec that runs a hook with LC_ALL=C against a non-ASCII .overcommit.yml.
Run the installed pre-commit hook in an initialized temporary repository with an explicit US-ASCII external encoding. Require a successful exit and output from the configured AuthorName check so unrelated startup failures and disabled hooks cannot satisfy the regression test.
Owner
|
Thanks! |
sds
added a commit
that referenced
this pull request
Nov 5, 2026
Windows CI has been disabled since #836. Restore the full test matrix on Windows for every supported Ruby (2.6–4.0), alongside Linux, and remove the Windows and AppVeyor exclusions from the specs. Give the slower Windows jobs 30 minutes to complete the integration suite while retaining the 15-minute Linux limit. Both platforms now run the same 1,679 examples; no examples are removed or newly skipped. The restored matrix exposed two production failures: - Reading merge state with `File.open(...).read` leaves handles open until garbage collection, preventing Windows from deleting `MERGE_MODE`. Use `File.read` so the handles close immediately. Also close readers and temporary files in the Gerrit specs, and retain commit-message fixtures until each example finishes, to prevent Windows finalizer errors. - Parent-command detection depends on WMIC, which is unavailable on current Windows runners. Query `Win32_Process` through PowerShell's `Get-CimInstance`, preserving the `nil` fallback when the command cannot launch or the parent has exited. Use Ruby's native symlink APIs on Windows instead of invoking `mklink` and parsing `dir` output. This supports directory links, raises on creation failures, and lets the restored specs exercise real symlinks with `core.symlinks=true`. Ten additional examples cover files, directories, missing targets, spaces, and creation errors. Repair the parallelism regression spec: its previous built-in hook ignored the configured sleep command. An ad hoc serial hook now actually sleeps and writes a marker; the spec requires a successful commit and verifies the marker. Allow 30 seconds for Git and interpreter startup on slower Windows runners instead of the flaky five-second deadline. Two additional examples cover unavailable Windows process information. Validation: - Local Ruby 3.4.7: full suite with 1,679 examples and zero failures; the strengthened parallelism example and all 52 commit-message context examples also pass independently. - [Tests](https://github.com/sds/overcommit/actions/runs/41940143707): all 16 Linux/Windows jobs pass, each with 1,679 examples, zero failures, and zero pending examples. All Windows logs are free of tempfile finalizer errors. - [Lint](https://github.com/sds/overcommit/actions/runs/41940143568), coverage finalization, and all 16 Coveralls statuses pass. All 34 PR checks are green on `03e86dc5`. Refs #836 and #910.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #868.
Every hook in
template-dir/hooksstarts by reading.overcommit.ymlto look for agemfile:setting:File.readwithout an encoding usesEncoding.default_external. Under a non-UTF-8 locale such asLANG=Cthat is US-ASCII, so if.overcommit.ymlcontains any non-ASCII character (even in a comment) the match raisesArgumentError: invalid byte sequence in US-ASCIIbefore Overcommit loads, and every git hook fails.This passes
encoding: 'UTF-8'in all 10 hook copies (the template directory spec requires them to be byte-identical).The regression spec in
spec/integration/template_dir_spec.rbinitializes a temporary repository using the hook templates and writes a.overcommit.ymlcontaining a non-ASCII comment. It runs the installedpre-commithook withLC_ALL=C LANG=Cand-E US-ASCII, then checks for a successful exit and output from the configuredAuthorNamecheck. This verifies that the hook actually runs instead of passing on an unrelated startup failure or an early exit. The encoding is set explicitly because the CI runners use a UTF-8 locale by default.Initial validation of the original spec on the fork:
template_dir_spec.rb:31,expected "…/template-dir/hooks/pre-commit:30:in '<main>': invalid byte s…" not to include "invalid byte sequence".1667 examples, 0 failures), and Lint passes.The original fix commit is the squashed form of the fix branch; a separate follow-up commit strengthens the regression test. I left
CHANGELOG.mdalone since it looks like it is written when a version is cut.Follow-up validation: Tests passes on all eight Ruby versions (2.6–4.0), and Lint passes. The strengthened spec also passes locally on Ruby 2.6 and fails both without the encoding fix and with hook execution disabled. The full local suite has four macOS timestamp precision failures, all reproduced on the original PR commit.