working with homebrew tap that requires audit and style exceptions, ie. homebrew-freecad

[ipatch]

Output of brew config

HOMEBREW_VERSION: 4.2.9-63-g6a9c9c0
ORIGIN: https://github.com/Homebrew/brew
HEAD: 6a9c9c00a028cf0bcf7da5a9e5b28c861a981ebd
Last commit: 2 weeks ago
Core tap HEAD: 7436c1a58599bbd644eb6134dc5b84c8542676f5
Core tap last commit: 24 hours ago
Core tap JSON: 21 Feb 17:55 UTC
Core cask tap JSON: 21 Feb 17:55 UTC
HOMEBREW_PREFIX: /Users/ipatch/homebrew
HOMEBREW_REPOSITORY: /Users/ipatch/homebrew
HOMEBREW_CELLAR: /Users/ipatch/homebrew/Cellar
HOMEBREW_CASK_OPTS: []
HOMEBREW_DEVELOPER: set
HOMEBREW_EDITOR: nvim
HOMEBREW_MAKE_JOBS: 8
HOMEBREW_NO_ANALYTICS: set
HOMEBREW_NO_AUTO_UPDATE: set
HOMEBREW_NO_GITHUB_API: set
HOMEBREW_NO_INSTALL_CLEANUP: set
HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK: set
HOMEBREW_SORBET_RUNTIME: set
HOMEBREW_TEMP: /Users/ipatch/tmp
Homebrew Ruby: 3.1.4 => /Users/ipatch/homebrew/Library/Homebrew/vendor/portable-ruby/3.1.4/bin/ruby
CPU: octa-core 64-bit arm_firestorm_icestorm
Clang: 14.0.0 build 1400
Git: 2.37.1 => /Library/Developer/CommandLineTools/usr/bin/git
Curl: 7.79.1 => /usr/bin/curl
macOS: 12.6-arm64
CLT: 14.2.0.0.1.1668646533
Xcode: N/A
Rosetta 2: false

Output of brew doctor

Please note that these warnings are just used to help the Homebrew maintainers
with debugging if you file an issue. If everything you use Homebrew for is
working fine: please don't worry or file an issue; just ignore this. Thanks!

Warning: You have unlinked kegs in your Cellar.
Leaving kegs unlinked can lead to build-trouble and cause formulae that depend on
those kegs to fail to run properly once built. Run `brew link` on these:
  qt

Warning: Your Homebrew's prefix is not /opt/homebrew.

Many of Homebrew's bottles (binary packages) can only be used with the default prefix.
Consider uninstalling Homebrew and reinstalling into the default prefix.
It is expected behaviour that some formulae will fail to build in this unsupported configuration.
It is expected behaviour that Homebrew will be buggy and slow.
Do not create any issues about this on Homebrew's GitHub repositories.
Do not create any issues even if you think this message is unrelated.
Any opened issues will be immediately closed without response.
Do not ask for help from Homebrew or its maintainers on social media.
You may ask for help in Homebrew's discussions but are unlikely to receive a response.
Try to figure out the problem yourself and submit a fix as a pull request.
We will review it but may or may not accept it.


Warning: Some taps are not on the default git origin branch and may not receive
updates. If this is a surprise to you, check out the default branch with:
  git -C $(brew --repo freecad/freecad) checkout master

Warning: Some installed formulae are missing dependencies.
You should `brew install` the missing dependencies:
  brew install hdf5

Run `brew missing` for more details.

Description of issue

i've been drafting a new freecad formula file,

FreeCAD/homebrew-freecad#488

however test-bot will fail with the below rubocop offenses,

https://github.com/FreeCAD/homebrew-freecad/actions/runs/8194098878/job/22409364649#step:14:20

 /opt/homebrew/Library/Taps/freecad/homebrew-freecad/Formula/[email protected]_py310.rb:148:32: C: [Correctable] FormulaAudit/PythonVersions: References to [email protected] should match the specified python dependency ([email protected])
      ENV.remove "PATH", Formula["[email protected]"].opt_prefix/"bin"
                                 ^^^^^^^^^^^^^
  /opt/homebrew/Library/Taps/freecad/homebrew-freecad/Formula/[email protected]_py310.rb:149:32: C: [Correctable] FormulaAudit/PythonVersions: References to [email protected] should match the specified python dependency ([email protected])
      ENV.remove "PATH", Formula["[email protected]"].opt_prefix/"libexec/bin"
                                 ^^^^^^^^^^^^^
  /opt/homebrew/Library/Taps/freecad/homebrew-freecad/Formula/[email protected]_py310.rb:150:43: C: [Correctable] FormulaAudit/PythonVersions: References to [email protected] should match the specified python dependency ([email protected])
      ENV.remove "PKG_CONFIG_PATH", Formula["[email protected]"].opt_prefix/"lib/pkgconfig"
                                            ^^^^^^^^^^^^^
  
  27 files inspected, 3 offenses detected, 3 offenses autocorrectable
  Error: FormulaAudit/PythonVersions: References to `[email protected]` should match the specified python dependency (`[email protected]`)
  Error: FormulaAudit/PythonVersions: References to `[email protected]` should match the specified python dependency (`[email protected]`)
  Error: FormulaAudit/PythonVersions: References to `[email protected]` should match the specified python dependency (`[email protected]`)
==> brew readall --aliases --os=all --arch=all freecad/freecad
==> brew audit --except=installed --tap=freecad/freecad
Error: 1 failed step!
brew style freecad/freecad
Error: Process completed with exit code 1.

currently the [email protected] installation is sneaking into the homebrew setup even though the formula does not directly use [email protected] and is setup to specifically use [email protected].

so i added some statements to the formula to remove the references to [email protected] but then running,

brew style freecad/freecad

will throw the rubocop offenses.

spent a little time searching the upstream homebrew/brew repo looking through source code and possibly seeing if i could either add a style or audit exception but my attempt failed when creating the below file,

https://github.com/FreeCAD/homebrew-freecad/blob/master/audit_exceptions/python_versions_allowlist.json

thus begging the question is there a way to print a list of all style and audit exceptions?

the best i could come up with is navigating the homebrew/brew source code on github (which i find less than ideal)

[cho-m]

currently the [email protected] installation is sneaking into the homebrew setup even though the formula does not directly use [email protected] and is setup to specifically use [email protected].

That would be due to dependency trees, like cython.

---

What is the exact issue you are getting with [email protected] in environment?

In CMake, Python usually means using of one of FindPythonInterp , FindPython, or FindPython3. Each of these has an easy override option, i.e. PYTHON_EXECUTABLE, Python_EXECUTABLE, and Python3_EXECUTABLE respectively.

Also, for latter 2, there is https://cmake.org/cmake/help/latest/policy/CMP0094.html#policy:CMP0094. The default behavior in CMake is to pick newest Python version but the new policy means the first version can automatically be used.

[ipatch]

That would be due to dependency trees, like cython.

how did you determine cython was the dependency that was pulling in [email protected]? can you provide an exact command you used?

[cho-m]

I was already familiar with cython in this case. Otherwise, could make use of brew deps --tree to view dependency trees.

Anyway, it is going to be difficult to dodge [email protected] as a dependency.

Have you taken a look at CMake options?