This repository has been archived by the owner on Apr 8, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathREADME.dev
103 lines (65 loc) · 2.71 KB
/
README.dev
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
tagfs - tag file system
developer readme
1) Roadmap
2) Logging
3) Profiling
4) Tracing
5) Distribution
5.1) tar Distribution
6) Tests
7) Code Coverage
8) End-To-End Tests
---------------------------------------------------------------------
Roadmap
The upcomming tagfs features are listed in the 'backlog' file. The file is
best viewed using emacs org-mode.
---------------------------------------------------------------------
Logging
You can enable logging by setting a debug environment variable before you
launch tagfs:
$ export DEBUG=1
tagfs will log to the console and the file /tmp/tagfs.log
---------------------------------------------------------------------
Profiling
You can enable profiling by setting a profile environment variable before you
launch tagfs:
$ export PROFILE=1
After unmounting your tagfs file system a profile file will be written. The
profile file will be written to the current directory. The profile file will
be named 'tagfs.profile'.
---------------------------------------------------------------------
Tracing
Tracing is done via the log output. There is a utility script to analyze the
log files. To analyze a log file execute the following
$ util/trace_logfiles.py /tmp/tagfs.log
The tracing script will output some statistics.
---------------------------------------------------------------------
tar Distribution
The tagfs project contains scripts for creating source distribution packages.
To create a tar distribution package you execute the following:
$ make distsnapshot
The make call will create an archive within the target directory. The created
tar file is used for tagfs source distribution.
---------------------------------------------------------------------
Tests
You can execute the test cases via the setup.py script in the project's root
directory.
$ python setup.py test
---------------------------------------------------------------------
Code Coverage
The tagfs unit tests can be executed with code coverage measurement enabled.
setup.py will measure the code coverage if the coverage lib is installed.
The coverage lib is available here: http://nedbatchelder.com/code/coverage
If you're a debian user you can try:
$ apt-get install python-coverage
The code coverage will be written below the reports directory after executing
the test cases:
$ python setup.py test
---------------------------------------------------------------------
End-To-End Tests
tagfs contains some end-to-end tests. The end-to-end tests first mount an
items directory and afterwards execute a shell script which can assert certain
conditions in the mounted tagfs.
The end-to-end tests can be run via the setup.py:
$ python setup.py e2e_test
The end-to-end tests are located below the test/e2e directory.