DAFixity is a simple file fixity checker designed to work with the Data Accessioner tool. It parses the report generated by Data Accessioner, creates a list of accessioned files and their checksums, then validates those checksums against the accessioned files on disk. It produces a detailed log, as well as a CSV report.
Source: https://github.com/digitalpowrr/dafixity
The latest release zip distribution file can be downloaded at https://github.com/digitalpowrr/dafixity/releases/latest.
Unzip the distribution zip file in the location of your choice. All dependencies are included within the package.
Open a Windows command prompt terminal and run dafixity.exe in the install folder.
C:\Users\someuser> cd <DAFIXITY_DIRECTORY>
C:\Users\someuser\<DAFIXITY_DIRECTORY> .\dafixity.exe -r \path\to\da\report -d \path\to\top\of\accession\tree
Open a terminal application (Terminal in Mac), then run the following commands:
cd <DAFIXITY_DIRECTORY>
java -jar ./dafixity -r /path/to/da/report -d /path/to/top/of/accession/tree
Where <DAFIXITY_DIRECTORY> is the folder where you installed dafixity.
usage: dafixity [options]
-r,--report <REPORT> Path to Data Accessioner report file
-d,--directory <DIRECTORY> Parent directory for accession tree in the
report
-h,--help This help message
The logs are written to logs/dafixity-<YYYYMMDDHHmmss>.log; the
report is written to logs/dafixity-report-<YYYYMMDDHHmmss>.csv,
where YYYYMMDDHHmmss is the date-time stamp of the beginning of
the run.
/var/tmp/dafixity-1.2$ ./dafixity -r /var/tmp/dafixity-sample.xml -d /var/tmp/dafixity-sample
Running dafixity, version 1.2
Report file is '/var/tmp/dafixity-sample.xml'
Parent accession directory path is '/var/tmp/dafixity-sample'
Parsing report to get the list of files and their checksums
Starting fixity check at 2024-05-31 16:09:21.591 CST
Ending fixity check at 2024-05-31 16:09:21.614 CST
Fixity check run time: 00:00:00.021
The log contains the detailed output of the run, including overall run time, run times for each file, and the status of each file found.
OK: checksums match Generated file checksum matches the checksum in the report
File xxx not found or not readable. Skipping. File in the report was not found on disk, or is not readable.
MISMATCH: checksums do not match Generated file checksum does not match the checksum in the report. The next line will show the expected checksum, and the generated checksum.
The log file is written to logs/dafixity.log.
2024-05-31 16:09:21,585 INFO - Running dafixity, version 1.2
2024-05-31 16:09:21,586 INFO - Report file is '/var/tmp/dafixity-sample.xml'
2024-05-31 16:09:21,586 INFO - Parent accession directory path is '/var/tmp/dafixity-sample'
2024-05-31 16:09:21,586 INFO - Parsing report to get the list of files and their checksums
2024-05-31 16:09:21,593 INFO - Starting fixity check at 2024-05-31 16:09:21.591 CST
2024-05-31 16:09:21,595 INFO - Checking file '/var/tmp/dafixity-sample/test-collection/folder1/folder1a/sample1a.jpg'
2024-05-31 16:09:21,604 INFO - '/var/tmp/dafixity-sample/test-collection/folder1/folder1a/sample1a.jpg': OK: checksums match
2024-05-31 16:09:21,606 INFO - '/var/tmp/dafixity-sample/test-collection/folder1/folder1a/sample1a.jpg': check runtime: 00:00:00.009
2024-05-31 16:09:21,607 INFO - Checking file '/var/tmp/dafixity-sample/test-collection/folder1/folder1a/sample1a.pdf'
2024-05-31 16:09:21,607 INFO - '/var/tmp/dafixity-sample/test-collection/folder1/folder1a/sample1a.pdf': OK: checksums match
2024-05-31 16:09:21,607 INFO - '/var/tmp/dafixity-sample/test-collection/folder1/folder1a/sample1a.pdf': check runtime: 00:00:00.000
2024-05-31 16:09:21,607 INFO - Checking file '/var/tmp/dafixity-sample/test-collection/folder1/folder1b/sample1b.odt'
2024-05-31 16:09:21,608 INFO - '/var/tmp/dafixity-sample/test-collection/folder1/folder1b/sample1b.odt': OK: checksums match
2024-05-31 16:09:21,608 INFO - '/var/tmp/dafixity-sample/test-collection/folder1/folder1b/sample1b.odt': check runtime: 00:00:00.001
2024-05-31 16:09:21,608 INFO - Checking file '/var/tmp/dafixity-sample/test-collection/folder2/sample2.wpd'
2024-05-31 16:09:21,611 INFO - '/var/tmp/dafixity-sample/test-collection/folder2/sample2.wpd': OK: checksums match
2024-05-31 16:09:21,612 INFO - '/var/tmp/dafixity-sample/test-collection/folder2/sample2.wpd': check runtime: 00:00:00.003
2024-05-31 16:09:21,612 INFO - Checking file '/var/tmp/dafixity-sample/test-collection/folder2/folder2a/sample2a'
2024-05-31 16:09:21,613 INFO - '/var/tmp/dafixity-sample/test-collection/folder2/folder2a/sample2a': OK: checksums match
2024-05-31 16:09:21,613 INFO - '/var/tmp/dafixity-sample/test-collection/folder2/folder2a/sample2a': check runtime: 00:00:00.001
2024-05-31 16:09:21,613 INFO - Checking file '/var/tmp/dafixity-sample/test-collection/folder3/folder3a/folder3ai/random3ai'
2024-05-31 16:09:21,613 INFO - '/var/tmp/dafixity-sample/test-collection/folder3/folder3a/folder3ai/random3ai': OK: checksums match
2024-05-31 16:09:21,613 INFO - '/var/tmp/dafixity-sample/test-collection/folder3/folder3a/folder3ai/random3ai': check runtime: 00:00:00.000
2024-05-31 16:09:21,613 INFO - Checking file '/var/tmp/dafixity-sample/test-collection/folder4-deleted/deleted-sample4.m4v'
2024-05-31 16:09:21,614 WARN - File '/var/tmp/dafixity-sample/test-collection/folder4-deleted/deleted-sample4.m4v' not found or not readable. Skipping.
2024-05-31 16:09:21,614 INFO - Checking file '/var/tmp/dafixity-sample/test-collection/folder5-changed/folder5a-changed/changed-sample5a.txt'
2024-05-31 16:09:21,614 WARN - '/var/tmp/dafixity-sample/test-collection/folder5-changed/folder5a-changed/changed-sample5a.txt': MISMATCH: checksums do not match
2024-05-31 16:09:21,614 WARN - '/var/tmp/dafixity-sample/test-collection/folder5-changed/folder5a-changed/changed-sample5a.txt': expected d61e884cdf73257617e7947defe8eb09, got 87c7ce7d1ee1ba0f79eea89e27ffbe53
2024-05-31 16:09:21,614 INFO - '/var/tmp/dafixity-sample/test-collection/folder5-changed/folder5a-changed/changed-sample5a.txt': check runtime: 00:00:00.000
2024-05-31 16:09:21,614 INFO - Ending fixity check at 2024-05-31 16:09:21.614 CST
2024-05-31 16:09:21,614 INFO - Fixity check run time: 00:00:00.021The report output contains five columns, separated by semicolons. The columns are:
- Date and time file was checked
- Accession ID
- Full path to file on disk
- Check status:
- true: checksums match
- false: checksums don't match
- FNF: file not found
- Run time to check the file (in format HH:MM:SS.sss)
The report file is written to logs/dafixity-report.csv.
2024-05-31 16:09:21.593 CST;dafixity-sample;/var/tmp/dafixity-sample/test-collection/folder1/folder1a/sample1a.jpg;true;00:00:00.009
2024-05-31 16:09:21.607 CST;dafixity-sample;/var/tmp/dafixity-sample/test-collection/folder1/folder1a/sample1a.pdf;true;00:00:00.000
2024-05-31 16:09:21.607 CST;dafixity-sample;/var/tmp/dafixity-sample/test-collection/folder1/folder1b/sample1b.odt;true;00:00:00.001
2024-05-31 16:09:21.608 CST;dafixity-sample;/var/tmp/dafixity-sample/test-collection/folder2/sample2.wpd;true;00:00:00.003
2024-05-31 16:09:21.612 CST;dafixity-sample;/var/tmp/dafixity-sample/test-collection/folder2/folder2a/sample2a;true;00:00:00.001
2024-05-31 16:09:21.613 CST;dafixity-sample;/var/tmp/dafixity-sample/test-collection/folder3/folder3a/folder3ai/random3ai;true;00:00:00.000
2024-05-31 16:09:21.613 CST;dafixity-sample;/var/tmp/dafixity-sample/test-collection/folder4-deleted/deleted-sample4.m4v;FNF;
2024-05-31 16:09:21.614 CST;dafixity-sample;/var/tmp/dafixity-sample/test-collection/folder5-changed/folder5a-changed/changed-sample5a.txt;false;00:00:00.000- A recent version of Java (>= 11)
- Maven (>= 3.9)
DAFixity is built using Maven. To build, clone the repository:
git clone https://github.com/digitalpowrr/dafixity.git
Then execute the following command in the top-level directory:
mvn clean package
A distributable zip file will be built and placed in the target/
subdirectory, with the name dafixity-<version>-dist.zip.
For testing purposes, you may run the created executable jar in
the target/ folder directly:
dafixity-<version>.jar
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request
Copyright © 2024 by Digital POWRR.
Copyright © 2017 by Scott Prater.
DAFixity 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.
DAFixity 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 http://www.gnu.org/licenses/.