Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bleachbit 4.0.0 (new formula) #56538

Closed
wants to merge 5 commits into from
Closed

bleachbit 4.0.0 (new formula) #56538

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1af4b8a
Add new BleachBit formula.
kdeldycke Jun 19, 2020
90c9e04
Generate launch script.
kdeldycke Jun 19, 2020
414580b
Fix line too long error.
kdeldycke Jun 21, 2020
214c77f
No need to force python home.
kdeldycke Jun 21, 2020
691ad82
Simplify setup stage.
kdeldycke Jun 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions Formula/bleachbit.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
class Bleachbit < Formula
include Language::Python::Virtualenv

desc "Antiforensics and privacy system disk cleaner"
homepage "https://www.bleachbit.org"
url "https://github.com/bleachbit/bleachbit/archive/v4.0.0.tar.gz"
sha256 "5f7813b1ecda32647b1a31564b66f369fbd0d50d67924f256a0d414abc07501b"

depends_on "pygobject3"
depends_on "[email protected]"

def install
virtualenv_install_with_resources
(libexec/"bin").install "bleachbit.py"
(bin/"bleachbit").write_env_script libexec/"bin/bleachbit.py",
:PYTHONPATH => libexec/"lib/python3.8/site-packages"
end

test do
assert_match "BleachBit version ", shell_output("#{bin}/bleachbit --sysinfo")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need a test that exercises the some of the functionality of the app. Version checks or usage checks (foo --version or foo --help) are not sufficient, as explained in the formula cookbook.

In most cases, a good test would involve running a simple test case: run #{bin}/foo input.txt.

  • Then you can check that the output is as expected (with assert_equal or assert_match on the output of shell_output)
  • You can also check that an output file was created, if that is expected: assert_predicate testpath/"output.txt", :exist?

Some advice for specific cases:

  • If the formula is a library, compile and run some simple code that links against it. It could be taken from upstream's documentation / source examples.
  • If the formula is for a GUI program, try to find some function that runs as command-line only, like a format conversion, reading or displaying a config file, etc.
  • If the software cannot function without credentials, a test could be to try to connect with invalid credentials (or without credentials) and confirm that it fails as expected.
  • Same if the software requires a virtual machine, docker instance, etc. to be running.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @SMillerDev for the detailed review! I'll be happy to add more thorough and complete tests once I get BleachBit registered as a proper bleachbit executable into the system. There's lot of opportunity as we can run a couple of cleanup jobs directly by the way of the CLI.

end
end