refactor, third part

Author: s-m-e

.gitignore

@@ -83,6 +83,7 @@ celerybeat-schedule
 # virtualenv
 venv/
 ENV/
+env*/
 
 # Spyder project settings
 .spyderproject

CHANGES.rst

@@ -4,7 +4,11 @@ Changes
 0.0.2 (2019-XX-XX)
 ------------------
 
-* FIX: Implementation of truncate did rely on the assumption that the current working directory of the file system process would not change. This was risky.
+* FEATURE: New flag ``-j`` for JSON-formatted log output
+* FEATURE: New field ``command`` allowed in XML configuration files for filtering for command strings with regular expressions
+* FEATURE: All fields in ``include`` and ``exclude`` tags, e.g. ``extension`` or ``uid``, become optional / implicit and can be omitted.
+* FEATURE: (UNTESTED) Mac OS X support. Test framework still relies on Linux.
+* FIX: Several implementations of FUSE calls such as truncate did rely on the assumption that the current working directory of the file system process would not change. This was risky. LoggedFS-python does also NOT change the current working directory anymore on its own.
 * Code cleanup
 
 0.0.1 (2019-04-11)

README.rst

@@ -64,7 +64,7 @@ CAVEATS
   UTIME_OMIT WILL NOT BE HONORED. THERE WAS A `PULL REQUEST`_ TO FIX THIS,
   WHICH HAS BEEN REJECTED. ALTERNATIVE APPROACHES ARE BEING RESEARCHED.
 * THE FILESYSTEM IS CURRENTLY **ONLY** BEING DEVELOPED FOR AND TESTED ON **LINUX**.
-  ANYONE INTERESTED IN ADDING MAC OS X AND/OR BSD SUPPORT?
+  ANYONE INTERESTED IN CONFIRMING MAC OS X AND/OR ADDING BSD SUPPORT?
 
 .. _CUSTOM BUG-FIXED VERSION OF FUSEPY: https://github.com/s-m-e/fusepy
 .. _PULL REQUEST: https://github.com/fusepy/fusepy/pull/79
@@ -88,7 +88,7 @@ From GitHub:
 **Supports Python 3.{4,5,6,7}.**
 
 **Supports Linux.**
-Support for MAC OS X and BSD requires a minor change only, but has yet not been added: Access to the system log is currently being achieved through ``logging.handlers.SysLogHandler(address = '/dev/log')``, a Linux-only solution.
+Support for MAC OS X is implemented but has yet not been tested.
 
 .. _Python Package Index: https://pypi.org/
 
@@ -112,9 +112,7 @@ To stop recording, just unmount as usual:
 Configuration
 =============
 
-LoggedFS-python can use an XML configuration file if you want it to log
-operations only for certain files, for certain users, or for certain operations.
-The format is fully compatible with LoggedFS' original format.
+LoggedFS-python can use an XML configuration file if you want it to log operations only for certain files, for certain users, or for certain operations. LoggedFS-python is fully compatible with configuration files in LoggedFS' original format. Yet it can also handle additional fields (e.g. the ``command`` field).
 
 Here is a sample configuration file :
 
@@ -124,12 +122,12 @@ Here is a sample configuration file :
 
 	<loggedFS logEnabled="true" printProcessName="true">
 		<includes>
-			<include extension=".*" uid="*" action=".*" retname=".*"/>
+			<include extension=".*" uid="*" action=".*" retname=".*" command=".*"/>
 		</includes>
 		<excludes>
-			<exclude extension=".*\.bak$" uid="*" action=".*" retname="SUCCESS"/>
-			<exclude extension=".*" uid="1000" action=".*" retname="FAILURE"/>
-			<exclude extension=".*" uid="*" action="getattr" retname=".*"/>
+			<exclude extension=".*\.bak$" uid="*" action=".*" retname="SUCCESS" command=".*"/>
+			<exclude extension=".*" uid="1000" action=".*" retname="FAILURE" command=".*"/>
+			<exclude extension=".*" uid="*" action="getattr" retname=".*" command=".*"/>
 		</excludes>
 	</loggedFS>
 

makefile

@@ -85,6 +85,9 @@ destroy_parentfs:
 	python3 -c 'import tests; tests.lib.quick_cli_destroy_parentfs()'
 destroy_childfs:
 	python3 -c 'import tests; tests.lib.quick_cli_destroy_childfs()'
+destroy_force:
+	-sudo fusermount -u tests/test_mount/test_child
+	-sudo umount tests/test_mount
 
 test:
 	make test_posix

src/loggedfs/cli.py

@@ -62,15 +62,19 @@
 	)
 @click.option(
 	'-l',
-	# type = click.File(mode = 'a'),
 	type = click.Path(file_okay = True, dir_okay = False, resolve_path = True),
 	help = ('Use the "log-file" to write logs to.')
 	)
+@click.option(
+	'-j', '--json',
+	is_flag = True,
+	help = 'Format output as JSON instead of traditional loggedfs format.'
+	)
 @click.argument(
 	'directory',
 	type = click.Path(exists = True, file_okay = False, dir_okay = True, resolve_path = True)
 	)
-def cli_entry(f, p, c, s, l, directory):
+def cli_entry(f, p, c, s, l, json, directory):
 	"""LoggedFS-python is a transparent fuse-filesystem which allows to log
 	every operations that happens in the backend filesystem. Logs can be written
 	to syslog, to a file, or to the standard output. LoggedFS comes with an XML
@@ -82,7 +86,7 @@ def cli_entry(f, p, c, s, l, directory):
 
 	loggedfs_factory(
 		directory,
-		**__process_config__(c, l, s, f, p)
+		**__process_config__(c, l, s, f, p, json)
 		)
 
 
@@ -91,7 +95,8 @@ def __process_config__(
 	log_file,
 	log_syslog_off,
 	fuse_foreground_bool,
-	fuse_allowother_bool
+	fuse_allowother_bool,
+	log_json
 	):
 
 	if config_fh is not None:
@@ -105,13 +110,14 @@ def __process_config__(
 	config_dict = parse_filters(config_xml_str)
 
 	return {
-		'log_includes': config_dict['includes'],
-		'log_excludes': config_dict['excludes'],
+		'log_includes': config_dict['log_includes'],
+		'log_excludes': config_dict['log_excludes'],
+		'log_enabled': config_dict['log_enabled'],
+		'log_printprocessname': config_dict['log_printprocessname'],
 		'log_file': log_file,
 		'log_syslog': not log_syslog_off,
 		'log_configmsg': 'LoggedFS-python using configuration file %s' % config_file,
-		'log_enabled': config_dict['@logEnabled'],
-		'log_printprocessname': config_dict['@printProcessName'],
+		'log_json': log_json,
 		'fuse_foreground_bool': fuse_foreground_bool,
 		'fuse_allowother_bool': fuse_allowother_bool
 		}