# vim: ts=4:sw=4:expandtab # BleachBit # Copyright (C) 2008-2024 Andrew Ziem # https://www.bleachbit.org # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . """ Test case for module CLI """ from bleachbit.CLI import ( args_to_operations, args_to_operations_list, cleaners_list, preview_or_clean) from bleachbit.General import run_external from bleachbit import FileUtilities from tests import common import copy import os import sys import tempfile class CLITestCase(common.BleachbitTestCase): """Test case for module CLI""" def setUp(self): super(CLITestCase, self).setUp() def _test_preview(self, args, redirect_stdout=True, env=None): """Helper to test preview""" # Use devnull because in some cases the buffer will be too large, # and the other alternative, the screen, is not desirable. with open(os.devnull, 'w') as stdout: if not redirect_stdout: stdout = None output = run_external(args, stdout=stdout, env=env) self.assertEqual(output[0], 0, "Return code = %d, stderr='%s'" % (output[0], output[2])) pos = output[2].find('Traceback (most recent call last)') if pos > -1: print("Saw the following error when using args '%s':\n %s" % (args, output[2])) self.assertEqual(pos, -1) def test_args_to_operations_list(self): """Unit test for args_to_operations_list()""" # --preset import bleachbit.Options bleachbit.Options.init_configuration() o = args_to_operations_list(True, False) self.assertEqual(o, []) bleachbit.Options.options.set_tree('system', 'tmp', True) o = args_to_operations_list(True, False) self.assertEqual(o, ['system.tmp']) # --all-but-warning o = args_to_operations_list(False, True) self.assertIsInstance(o, list) self.assertTrue('google_chrome.cache' in o) self.assertTrue('system.tmp' in o) self.assertTrue('system.clipboard' in o) self.assertFalse('system.free_disk_space' in o) self.assertFalse('system.memory' in o) def test_args_to_operations(self): """Unit test for args_to_operations()""" # test explicit cleaners (without --preset or --all-but-warning) tests = ( (['adobe_reader.*'], {'adobe_reader': ['cache', 'mru', 'tmp']}), (['adobe_reader.mru'], {'adobe_reader': ['mru']})) for test in tests: o = args_to_operations(test[0], False, False) self.assertIsInstance(o, dict) self.assertEqual(o, test[1]) def test_cleaners_list(self): """Unit test for cleaners_list()""" for cleaner in cleaners_list(): self.assertIsString(cleaner) @common.skipIfWindows def test_encoding(self): """Unit test for encoding""" filename = self.write_file( '/tmp/bleachbit-test-cli-encoding-\xe4\xf6\xfc~') # not assertExists because it doesn't cope with invalid encodings self.assertTrue(os.path.exists(filename)) env = copy.deepcopy(os.environ) env['LANG'] = 'en_US' # not UTF-8 args = [sys.executable, '-m', 'bleachbit.CLI', '-p', 'system.tmp'] # If Python pipes stdout to file or devnull, the test may give # a false negative. It must print stdout to terminal. self._test_preview(args, redirect_stdout=False, env=env) os.remove(filename) self.assertNotExists(filename) def test_invalid_locale(self): """Unit test for invalid locales""" old_lang = common.get_env('LANG') common.put_env('LANG', 'blahfoo') # tests are run from the parent directory args = [sys.executable, '-m', 'bleachbit.CLI', '--version'] output = run_external(args) self.assertNotEqual(output[1].find('Copyright'), -1, str(output)) common.put_env('LANG', old_lang) def test_preview(self): """Unit test for --preview option""" env = copy.deepcopy(os.environ) # the language and encoding affect the test results env['LANG'] = 'en_US.UTF-8' env['PYTHONIOENCODING'] = 'utf-8:backslashreplace' args_list = [] module = 'bleachbit.CLI' big_args = [sys.executable, '-m', module, '--preview', ] # The full list can take a long time and generally does not improve the testing, # so test a subset. full_cleaners_list = list(cleaners_list()) system_cleaners = [ c for c in full_cleaners_list if c.startswith('system.')] non_system_cleaners = [ c for c in full_cleaners_list if not c.startswith('system.')] import random sample_cleaners = random.sample(non_system_cleaners, 5) for cleaner in (system_cleaners + sample_cleaners): args_list.append( [sys.executable, '-m', module, '--preview', cleaner]) big_args.append(cleaner) args_list.append(big_args) for args in args_list: self._test_preview(args, env=env) def test_delete(self): """Unit test for --delete option""" prefixes = [ 'bleachbit-test-cli-delete', '\x8b\x8b-bad-encoding' ] for i in range(len(prefixes)): filename = self.mkstemp(prefix=prefixes[i]) if 'nt' == os.name: filename = os.path.normcase(filename) # replace delete function for testing save_delete = FileUtilities.delete deleted_paths = [] crash = [False] def dummy_delete(path, shred=False): try: self.assertExists(path) except: crash[0] = True deleted_paths.append(os.path.normcase(path)) FileUtilities.delete = dummy_delete FileUtilities.delete(filename) self.assertExists(filename) operations = args_to_operations(['system.tmp'], False, False) preview_or_clean(operations, True, quiet=True) FileUtilities.delete = save_delete self.assertIn(filename, deleted_paths, "%s not found deleted" % filename) os.remove(filename) self.assertNotExists(filename) self.assertFalse(crash[0]) def test_shred(self): """Unit test for --shred""" suffixes = ['', '.', '.txt'] dirs = ['.', None] for dir_ in dirs: for suffix in suffixes: (fd, filename) = tempfile.mkstemp( prefix='bleachbit-test-cli-shred', suffix=suffix, dir=dir_) os.close(fd) if '.' == dir_: filename = os.path.basename(filename) # not assertExists because something strange happens on Windows self.assertTrue(os.path.exists(filename)) args = [sys.executable, '-m', 'bleachbit.CLI', '--shred', filename] output = run_external(args) self.assertEqual(output[0], 0) self.assertNotExists(filename) @common.skipUnlessWindows def test_gui_exit(self): """Unit test for --gui --exit, only for Windows""" args = (sys.executable, '-m', 'bleachbit.CLI', '--gui', '--exit') (rc, _stdout, stderr) = run_external(args) self.assertNotIn('no such option', stderr) self.assertNotIn('Usage: CLI.py', stderr) self.assertEqual(rc, 0) # Is the application still running? opened_windows_titles = common.get_opened_windows_titles() self.assertFalse('BleachBit' in opened_windows_titles)