Step 3. Introduction of output module mediator and more clean up #123

These files are missing unit tests:
 + plaso/output/elastic.py + plaso/output/helper.py + plaso/output/mysql_4n6.py + plaso/output/rawpy.py + plaso/output/sqlite_4n6.py + plaso/output/test_lib.py

[Joachim Metz, 2015-04-04 14:10:37]

Code updated.

[onager, 2015-04-07 11:56:29]

Few comments

https://codereview.appspot.com/224140043/diff/20001/plaso/frontend/analysis_f...
File plaso/frontend/analysis_frontend.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/frontend/analysis_f...
plaso/frontend/analysis_frontend.py:41: def GetFormatertMediator(self):
Formatter - and everywhere else

https://codereview.appspot.com/224140043/diff/20001/plaso/lib/event.py
File plaso/lib/event.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/lib/event.py#newcode30
plaso/lib/event.py:30: """Return an Unicode string representation of the
report."""
I prefer "a Unicode representation":
https://books.google.com/ngrams/graph?content=a+unicode%2Can+unicode&year_sta...

https://codereview.appspot.com/224140043/diff/20001/plaso/output/dynamic.py
File plaso/output/dynamic.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/output/dynamic.py#n...
plaso/output/dynamic.py:86: def _FormatField(self, field):
This method is confusing - it just does a string replace. Perhaps rename to
"CleanField()" or "RemoveDelimiters()" or change the docstring to reflect what
it's supposed to do: "Prepares a field value string for writing to the file"?

https://codereview.appspot.com/224140043/diff/20001/plaso/output/dynamic.py#n...
plaso/output/dynamic.py:256: def ParseZone(self, _):
This doesn't parse anything - the naming in this class is very strange -
FormatBlah() and ParseBlah() both seem to extract and prepare a string for
output.

https://codereview.appspot.com/224140043/diff/20001/plaso/output/helper.py
File plaso/output/helper.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/output/helper.py#ne...
plaso/output/helper.py:1: # -*- coding: utf-8 -*-
Why does this file still exist? Shouldn't this one remaning method get moved to
the mediator, or some specific output module?

https://codereview.appspot.com/224140043/diff/20001/plaso/output/interface.py
File plaso/output/interface.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/output/interface.py...
plaso/output/interface.py:44: raise ValueError(u'Unused keyword arguments.')
Please report the kwargs that are unused

https://codereview.appspot.com/224140043/diff/20001/plaso/output/l2t_csv.py
File plaso/output/l2t_csv.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/output/l2t_csv.py#n...
plaso/output/l2t_csv.py:15: class
L2tCsvOutputModule(interface.FileOutputModule):
L2TCSV

https://codereview.appspot.com/224140043/diff/20001/plaso/output/manager.py
File plaso/output/manager.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/output/manager.py#n...
plaso/output/manager.py:80: name: The name of the output.
output module

https://codereview.appspot.com/224140043/diff/20001/plaso/output/manager.py#n...
plaso/output/manager.py:84: The corresponding output (instance of OutputModule).
An instance of the corresponding output class...

https://codereview.appspot.com/224140043/diff/20001/plaso/output/manager.py#n...
plaso/output/manager.py:88: KeyError: if there is no output object found with
the
If the name is not a string, which error gets raised?

https://codereview.appspot.com/224140043/diff/20001/plaso/output/mediator.py
File plaso/output/mediator.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/output/mediator.py#...
plaso/output/mediator.py:122: u'Unable to find event formatter data type is
missing from event '
I don't think this is the right error to raise here - it's the event itself that
is broken. There's also no need to repeat that a formatter hasn't bee found if
we are going to use this error class.

https://codereview.appspot.com/224140043/diff/20001/plaso/output/mysql_4n6.py
File plaso/output/mysql_4n6.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/output/mysql_4n6.py...
plaso/output/mysql_4n6.py:24: """Class defining the MySQL database output module
for 4n6time."""
MySQL

https://codereview.appspot.com/224140043/diff/20001/plaso/output/test_lib.py
File plaso/output/test_lib.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/output/test_lib.py#...
plaso/output/test_lib.py:18: """Retrieves an output mediator.
Creates?

https://codereview.appspot.com/224140043/diff/20001/plaso/output/timesketch_o...
File plaso/output/timesketch_out.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/output/timesketch_o...
plaso/output/timesketch_out.py:27: class
TimesketchOutput(interface.OutputModule):
TimesketchOutputModule

https://codereview.appspot.com/224140043/diff/20001/plaso/output/timesketch_o...
plaso/output/timesketch_out.py:93: # Try to get the hostname from the
pre-processing object.
Remove comment

[Joachim Metz, 2015-04-07 20:19:16]

https://codereview.appspot.com/224140043/diff/20001/plaso/frontend/analysis_f...
File plaso/frontend/analysis_frontend.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/frontend/analysis_f...
plaso/frontend/analysis_frontend.py:41: def GetFormatertMediator(self):
On 2015/04/07 11:56:28, onager wrote:
> Formatter - and everywhere else

Done.

https://codereview.appspot.com/224140043/diff/20001/plaso/lib/event.py
File plaso/lib/event.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/lib/event.py#newcode30
plaso/lib/event.py:30: """Return an Unicode string representation of the
report."""
On 2015/04/07 11:56:28, onager wrote:
> I prefer "a Unicode representation":
>
https://books.google.com/ngrams/graph?content=a+unicode%2Can+unicode&year_sta...

backed by numbers ;) SGTM

https://codereview.appspot.com/224140043/diff/20001/plaso/output/dynamic.py
File plaso/output/dynamic.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/output/dynamic.py#n...
plaso/output/dynamic.py:86: def _FormatField(self, field):
On 2015/04/07 11:56:28, onager wrote:
> This method is confusing - it just does a string replace. Perhaps rename to
> "CleanField()" or "RemoveDelimiters()" or change the docstring to reflect what
> it's supposed to do: "Prepares a field value string for writing to the file"?

Done.

https://codereview.appspot.com/224140043/diff/20001/plaso/output/dynamic.py#n...
plaso/output/dynamic.py:256: def ParseZone(self, _):
On 2015/04/07 11:56:29, onager wrote:
> This doesn't parse anything - the naming in this class is very strange -
> FormatBlah() and ParseBlah() both seem to extract and prepare a string for
> output. 

Yeah I was thinking the same with parse, I'll change them all to format.

https://codereview.appspot.com/224140043/diff/20001/plaso/output/helper.py
File plaso/output/helper.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/output/helper.py#ne...
plaso/output/helper.py:1: # -*- coding: utf-8 -*-
On 2015/04/07 11:56:29, onager wrote:
> Why does this file still exist? Shouldn't this one remaning method get moved
to
> the mediator, or some specific output module?

Yes, I was planning to that in a next step to lighten the number of changes per
CL.

https://codereview.appspot.com/224140043/diff/20001/plaso/output/interface.py
File plaso/output/interface.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/output/interface.py...
plaso/output/interface.py:44: raise ValueError(u'Unused keyword arguments.')
On 2015/04/07 11:56:29, onager wrote:
> Please report the kwargs that are unused

Done.

https://codereview.appspot.com/224140043/diff/20001/plaso/output/l2t_csv.py
File plaso/output/l2t_csv.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/output/l2t_csv.py#n...
plaso/output/l2t_csv.py:15: class
L2tCsvOutputModule(interface.FileOutputModule):
On 2015/04/07 11:56:29, onager wrote:
> L2TCSV

Done.

https://codereview.appspot.com/224140043/diff/20001/plaso/output/manager.py
File plaso/output/manager.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/output/manager.py#n...
plaso/output/manager.py:80: name: The name of the output.
On 2015/04/07 11:56:29, onager wrote:
> output module

Done.

https://codereview.appspot.com/224140043/diff/20001/plaso/output/manager.py#n...
plaso/output/manager.py:84: The corresponding output (instance of OutputModule).
On 2015/04/07 11:56:29, onager wrote:
> An instance of the corresponding output class...

Done.

https://codereview.appspot.com/224140043/diff/20001/plaso/output/manager.py#n...
plaso/output/manager.py:88: KeyError: if there is no output object found with
the
On 2015/04/07 11:56:29, onager wrote:
> If the name is not a string, which error gets raised?

Done.

https://codereview.appspot.com/224140043/diff/20001/plaso/output/mediator.py
File plaso/output/mediator.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/output/mediator.py#...
plaso/output/mediator.py:122: u'Unable to find event formatter data type is
missing from event '
On 2015/04/07 11:56:29, onager wrote:
> I don't think this is the right error to raise here - it's the event itself
that
> is broken. There's also no need to repeat that a formatter hasn't bee found if
> we are going to use this error class.

Ok let chat about this, to determine what could be a better approach.

https://codereview.appspot.com/224140043/diff/20001/plaso/output/mysql_4n6.py
File plaso/output/mysql_4n6.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/output/mysql_4n6.py...
plaso/output/mysql_4n6.py:24: """Class defining the MySQL database output module
for 4n6time."""
On 2015/04/07 11:56:29, onager wrote:
> MySQL

Done.

https://codereview.appspot.com/224140043/diff/20001/plaso/output/test_lib.py
File plaso/output/test_lib.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/output/test_lib.py#...
plaso/output/test_lib.py:18: """Retrieves an output mediator.
On 2015/04/07 11:56:29, onager wrote:
> Creates?

Done.

https://codereview.appspot.com/224140043/diff/20001/plaso/output/timesketch_o...
File plaso/output/timesketch_out.py (right):

https://codereview.appspot.com/224140043/diff/20001/plaso/output/timesketch_o...
plaso/output/timesketch_out.py:27: class
TimesketchOutput(interface.OutputModule):
On 2015/04/07 11:56:29, onager wrote:
> TimesketchOutputModule

Done.

https://codereview.appspot.com/224140043/diff/20001/plaso/output/timesketch_o...
plaso/output/timesketch_out.py:93: # Try to get the hostname from the
pre-processing object.
On 2015/04/07 11:56:29, onager wrote:
> Remove comment 

Done.

[Joachim Metz, 2015-04-07 20:25:18]

Code updated.

[onager, 2015-04-08 10:54:45]

On 2015/04/07 20:25:18, Joachim Metz wrote:
> Code updated.

LGTM - as discussed, there are a few more changes to be made down the line...

[Joachim Metz, 2015-04-08 16:20:16]

Code Submitted.