mstoeck3/autopsy-flatpak
1
0
Fork 0
mirror of https://github.com/overcuriousity/autopsy-flatpak.git synced 2025-07-06 21:00:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Text edits

Browse Source
This commit is contained in:
U-BASIS\dsmyda 2019-08-14 10:54:18 -04:00
parent 9670f05d82
commit fe05d7cc74
2 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/doxygen-dev/main.dox
View File

@ -1,10 +1,10 @@
/*! \mainpage Autopsy Dev's Guide /*! \mainpage Autopsy Developer's Guide
Overview Overview
----- -----
This is the Dev's Guide for the <a href="http://www.sleuthkit.org/autopsy/">open source Autopsy platform</a>. Autopsy allows you to examine a hard drive or mobile device and recover evidence from it. This guide should help you with using Autopsy. There is a seperate <a href="http://www.sleuthkit.org/autopsy/docs/api-docs/"> developer's guide</a> for writing Autopsy modules. This is the Developer's Guide for the <a href="http://www.sleuthkit.org/autopsy/">open source Autopsy platform</a>. Autopsy allows you to examine a hard drive or mobile device and recover evidence from it. This guide should help you with using Autopsy. There is a seperate <a href="http://www.sleuthkit.org/autopsy/docs/api-docs/"> developer's guide</a> for writing Autopsy modules.
Topics Topics
------- -------

12
docs/doxygen-dev/regression_testing.dox
View File

@ -3,25 +3,23 @@
\section intro_regression Introduction \section intro_regression Introduction
The autopsy/test folder contains scripts that are necessary to run the regression test. Developers that are interested in running regression tests should run autopsy/test/script/regression.py. This guide will familiarize you with regression.py and walk you through a simple example at the end. The autopsy/test folder contains scripts that are necessary to run the regression test. Developers that are interested in running regression tests should run autopsy/test/script/regression.py. This guide will familiarize you with regression.py and walk you through a simple example at the end.
If you’ve never heard of regression testing, see <a href="https://en.wikipedia.org/wiki/Regression_testing">Regression Testing</a>.
From a bird’s eye view, regression.py will: From a bird’s eye view, regression.py will:
- Run ingest on an image by starting up Autopsy and controlling the UI - Run ingest on an image by starting up Autopsy and controlling the UI
- Generate a HTML report once ingest is complete - Generate a HTML report once ingest is complete
- Dump the case database and perform diffs on the gold standards. HTML reports are also diffed. - \ref dump "Dump" the case database and perform \ref diff "diffs" on the \ref gold_standard "gold standards". HTML reports are also \ref diff "diffed".
Don’t worry if the terminology of the last bullet confuses you. The \ref terminology section will help get you up to speed. What’s important is that regression.py will enable you to isolate changes that you may have caused while developing and adding features. What’s important is that regression.py will enable you to isolate changes that you may have caused while developing and adding features.
Regression.py is also responsible for producing and saving gold standards for you. This allows your gold standards to evolve as your source code changes. In the following sections, we will learn how to accomplish this and what regression.py will need to know in order to run smoothly. Regression.py is also responsible for producing and saving gold standards for you. This allows your gold standards to evolve as your source code changes. In the following sections, we will learn how to accomplish this and what regression.py will need to know in order to run smoothly.
\section general General \section general General
Regression.py will use the most recent Autopsy and Sleuthkit builds as a launching point. To ensure that your latest changes are included, you will need to make sure you build. Regression.py will use the most recent Autopsy and Sleuthkit builds as a launching point. To ensure that your latest changes are included, you will need to make sure you build.
\section terminology Terminology \section terminology Terminology
Before we jump in, let's start off by defining some common terminology. Before we jump in, let's start off by defining some common terminology.
- Dump - \anchor dump Dump
- A dump refers to writing all case database INSERT statements to file. The case database is what Autopsy uses to persist its analysis. Items that are time or execution order dependent are obfuscated so that only meaningful changes are captured. - A dump refers to writing all case database INSERT statements to file. The case database is what Autopsy uses to persist its analysis. Items that are time or execution order dependent are obfuscated so that only meaningful changes are captured.
- Gold standard - \anchor gold_standard Gold standard
- A gold standard is simply a dump that we designate to be the base expectation for any given ingest run. Some changes may add to this base (potentially positive) and some may modify or remove from this base (potentially negative). HTML reports will also be saved as gold standards. - A gold standard is simply a dump that we designate to be the base expectation for any given ingest run. Some changes may add to this base (potentially positive) and some may modify or remove from this base (potentially negative). HTML reports will also be saved as gold standards.
- Diff - \anchor diff Diff
- A diff is the result of running the <a href="http://man7.org/linux/man-pages/man1/diff.1.html">diff</a> command against a new dump and a corresponding gold standard. If there are any regressions, they will hopefully be captured in these files. - A diff is the result of running the <a href="http://man7.org/linux/man-pages/man1/diff.1.html">diff</a> command against a new dump and a corresponding gold standard. If there are any regressions, they will hopefully be captured in these files.
\section param_desc Parameter Descriptions \section param_desc Parameter Descriptions