Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
F
fact_pdf_report
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
fact-depend
fact_pdf_report
Commits
29203d12
Commit
29203d12
authored
Jul 07, 2019
by
dorp
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
fixed tests and added some more config
parent
d6d4d318
Show whitespace changes
Inline
Side-by-side
Showing
6 changed files
with
445 additions
and
72 deletions
+445
-72
.isort.cfg
.isort.cfg
+4
-0
.pylintrc
.pylintrc
+390
-0
code_generation.py
src/latex_code_generation/code_generation.py
+19
-29
test_code_generation.py
src/test/integration/test_code_generation.py
+18
-15
test_latex_code_generation.py
src/test/integration/test_latex_code_generation.py
+0
-12
test_code_generation.py
src/test/unit/test_code_generation.py
+14
-16
No files found.
.isort.cfg
0 → 100644
View file @
29203d12
[settings]
line_length=120
known_first_party=test
multi_line_output=6
.pylintrc
0 → 100644
View file @
29203d12
[MASTER]
# Add files or directories to the blacklist. They should be base names, not
# paths.
ignore=CVS
# Add files or directories matching the regex patterns to the blacklist. The
# regex matches against base names, not paths.
ignore-patterns=test/,src/bin
# Pickle collected data for later comparisons.
persistent=yes
# List of plugins (as comma separated values of python modules names) to load,
# usually to register additional checkers.
load-plugins=pylint.extensions.bad_builtin,pylint.extensions.mccabe
# Use multiple processes to speed up Pylint.
jobs=2
# Allow loading of arbitrary C extensions. Extensions are imported into the
# active Python interpreter and may run arbitrary code.
unsafe-load-any-extension=no
# A comma-separated list of package or module names from where C extensions may
# be loaded. Extensions are loading into the active Python interpreter and may
# run arbitrary code
extension-pkg-whitelist=
# Allow optimization of some AST trees. This will activate a peephole AST
# optimizer, which will apply various small optimizations. For instance, it can
# be used to obtain the result of joining multiple strings with the addition
# operator. Joining a lot of strings can lead to a maximum recursion error in
# Pylint and this flag can prevent that. It has one side effect, the resulting
# AST will be different than the one from reality. This option is deprecated
# and it will be removed in Pylint 2.0.
optimize-ast=no
[MESSAGES CONTROL]
# Only show warnings with the listed confidence levels. Leave empty to show
# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
confidence=
# Disable the message, report, category or checker with the given id(s)
disable=missing-docstring,locally-disabled,logging-format-interpolation
[REPORTS]
# Set the output format. Available formats are text, parseable, colorized, html
output-format=colorized
# Put messages in a separate file for each module / package specified on the
# command line instead of printing them on stdout. Reports (if any) will be
# written in a file name "pylint_global.[txt|html]". This option is deprecated
# and it will be removed in Pylint 2.0.
files-output=no
# Tells whether to display a full report or only the messages
reports=no
# Python expression which should return a note less than 10 (10 is the highest
# note). You have access to the variables errors warning, statement which
# respectively contain the number of errors / warnings messages and the total
# number of statements analyzed. This is used by the global evaluation report
# (RP0004).
evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
# Template used to display messages. This is a python new-style format string
# used to format the message information. See doc for all details
msg-template="{path}:{line}: [{symbol}:{obj}] {msg}"
[VARIABLES]
# Tells whether we should check for unused import in __init__ files.
init-import=no
# A regular expression matching the name of dummy variables (i.e. expectedly
# not used).
dummy-variables-rgx=_$|dummy
# List of additional names supposed to be defined in builtins. Remember that
# you should avoid to define new builtins when possible.
additional-builtins=
# List of strings which can identify a callback function by name. A callback
# name must start or end with one of those strings.
callbacks=cb_,_cb
# List of qualified module names which can have objects that can redefine
# builtins.
redefining-builtins-modules=six.moves,future.builtins
[TYPECHECK]
# Tells whether missing members accessed in mixin class should be ignored. A
# mixin class is detected if its name ends with "mixin" (case insensitive).
ignore-mixin-members=yes
# List of module names for which member attributes should not be checked
# (useful for modules/projects where namespaces are manipulated during runtime
# and thus existing member attributes cannot be deduced by static analysis. It
# supports qualified module names, as well as Unix pattern matching.
ignored-modules=
# List of classes names for which member attributes should not be checked
# (useful for classes with attributes dynamically set). This supports can work
# with qualified names.
ignored-classes=
# List of members which are set dynamically and missed by pylint inference
# system, and so shouldn't trigger E1101 when accessed. Python regular
# expressions are accepted.
generated-members=
# List of decorators that produce context managers, such as
# contextlib.contextmanager. Add to this list to register other decorators that
# produce valid context managers.
contextmanager-decorators=contextlib.contextmanager
[SPELLING]
# Spelling dictionary name. Available dictionaries: none. To make it working
# install python-enchant package.
spelling-dict=
# List of comma separated words that should not be checked.
spelling-ignore-words=
# A path to a file that contains private dictionary; one word per line.
spelling-private-dict-file=
# Tells whether to store unknown words to indicated private dictionary in
# --spelling-private-dict-file option instead of raising a message.
spelling-store-unknown-words=no
[SIMILARITIES]
# Minimum lines number of a similarity.
min-similarity-lines=4
# Ignore comments when computing similarities.
ignore-comments=yes
# Ignore docstrings when computing similarities.
ignore-docstrings=yes
# Ignore imports when computing similarities.
ignore-imports=no
[MISCELLANEOUS]
# List of note tags to take in consideration, separated by a comma.
notes=FIXME,XXX
[LOGGING]
# Logging modules to check that the string format arguments are in logging
# function parameter format
logging-modules=logging
[FORMAT]
# Maximum number of characters on a single line.
max-line-length=200
# Regexp for a line that is allowed to be longer than the limit.
ignore-long-lines=^\s*(# )?<?https?://\S+>?$
# Allow the body of an if to be on the same line as the test if there is no
# else.
single-line-if-stmt=no
# List of optional constructs for which whitespace checking is disabled. `dict-
# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
# `trailing-comma` allows a space between comma and closing bracket: (a, ).
# `empty-line` allows space-only lines.
no-space-check=trailing-comma,dict-separator
# Maximum number of lines in a module
max-module-lines=1000
# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
# tab).
indent-string=' '
# Number of spaces of indent required inside a hanging or continued line.
indent-after-paren=4
# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
expected-line-ending-format=
[BASIC]
# List of builtins function names that should not be used, separated by a comma
bad-functions=map,filter
# Good variable names which should always be accepted, separated by a comma
good-names=i,j,k,ex,Run,_
# Bad variable names which should always be refused, separated by a comma
bad-names=foo,bar,baz,toto,tutu,tata
# Colon-delimited sets of names that determine each other's naming style when
# the name regexes allow several styles.
name-group=
# Include a hint for the correct naming format with invalid-name
include-naming-hint=no
# List of decorators that produce properties, such as abc.abstractproperty. Add
# to this list to register other decorators that produce valid properties.
property-classes=abc.abstractproperty
# Regular expression matching correct method names
method-rgx=[a-z_][a-z0-9_]{2,50}$
# Naming hint for method names
method-name-hint=[a-z_][a-z0-9_]{2,50}$
# Regular expression matching correct attribute names
attr-rgx=[a-z_][a-z0-9_]{1,30}$
# Naming hint for attribute names
attr-name-hint=[a-z_][a-z0-9_]{1,30}$
# Regular expression matching correct class names
class-rgx=[A-Z_][a-zA-Z0-9]+$
# Naming hint for class names
class-name-hint=[A-Z_][a-zA-Z0-9]+$
# Regular expression matching correct module names
module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
# Naming hint for module names
module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
# Regular expression matching correct function names
function-rgx=[a-z_][a-z0-9_]{2,33}$
# Naming hint for function names
function-name-hint=[a-z_][a-z0-9_]{2,33}$
# Regular expression matching correct inline iteration names
inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
# Naming hint for inline iteration names
inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
# Regular expression matching correct argument names
argument-rgx=[a-z_][a-z0-9_]{1,30}$
# Naming hint for argument names
argument-name-hint=[a-z_][a-z0-9_]{1,30}$
# Regular expression matching correct variable names
variable-rgx=[a-z_][a-z0-9_]{1,30}$
# Naming hint for variable names
variable-name-hint=[a-z_][a-z0-9_]{1,30}$
# Regular expression matching correct class attribute names
class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
# Naming hint for class attribute names
class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
# Regular expression matching correct constant names
const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
# Naming hint for constant names
const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
# Regular expression which should only match function or class names that do
# not require a docstring.
no-docstring-rgx=^_
# Minimum line length for functions/classes that require docstrings, shorter
# ones are exempt.
docstring-min-length=-1
[ELIF]
# Maximum number of nested blocks for function / method body
max-nested-blocks=5
[IMPORTS]
# Deprecated modules which should not be used, separated by a comma
deprecated-modules=optparse
# Create a graph of every (i.e. internal and external) dependencies in the
# given file (report RP0402 must not be disabled)
import-graph=
# Create a graph of external dependencies in the given file (report RP0402 must
# not be disabled)
ext-import-graph=
# Create a graph of internal dependencies in the given file (report RP0402 must
# not be disabled)
int-import-graph=
# Force import order to recognize a module as part of the standard
# compatibility libraries.
known-standard-library=
# Force import order to recognize a module as part of a third party library.
known-third-party=enchant
# Analyse import fallback blocks. This can be used to support both Python 2 and
# 3 compatible code, which means that the block might have code that exists
# only in one or another interpreter, leading to false positives when analysed.
analyse-fallback-blocks=no
[DESIGN]
# McCabe complexity cyclomatic threshold
max-complexity=7
# Maximum number of arguments for function / method
max-args=7
# Argument names that match this expression will be ignored. Default to name
# with leading underscore
ignored-argument-names=_.*
# Maximum number of locals for function / method body
max-locals=15
# Maximum number of return / yield for function / method body
max-returns=6
# Maximum number of branch for function / method body
max-branches=12
# Maximum number of statements in function / method body
max-statements=50
# Maximum number of parents for a class (see R0901).
max-parents=7
# Maximum number of attributes for a class (see R0902).
max-attributes=7
# Minimum number of public methods for a class (see R0903).
min-public-methods=0
# Maximum number of public methods for a class (see R0904).
max-public-methods=40
# Maximum number of boolean expressions in a if statement
max-bool-expr=5
[CLASSES]
# List of method names used to declare (i.e. assign) instance attributes.
defining-attr-methods=__init__,__new__,setUp
# List of valid names for the first argument in a class method.
valid-classmethod-first-arg=cls
# List of valid names for the first argument in a metaclass class method.
valid-metaclass-classmethod-first-arg=mcs
# List of member names, which should be excluded from the protected access
# warning.
exclude-protected=_asdict,_fields,_replace,_source,_make
[EXCEPTIONS]
# Exceptions that will emit a warning when being caught. Defaults to
# "Exception"
overgeneral-exceptions=Exception
src/latex_code_generation/code_generation.py
View file @
29203d12
import
logging
import
os
import
shutil
from
pathlib
import
Path
from
tempfile
import
TemporaryDirectory
import
shutil
import
jinja2
import
jinja2
from
common_helper_process
import
execute_shell_command_get_return_code
from
jinja_filters.filter
import
(
nice_unix_time
,
nice_number_filter
,
filter_latex_special_chars
,
count_elements_in_list
,
filter_chars_in_list
,
convert_base64_to_png_filter
,
check_if_list_empty
,
split_hash
,
split_output_lines
,
byte_number_filter
byte_number_filter
,
check_if_list_empty
,
convert_base64_to_png_filter
,
count_elements_in_list
,
filter_chars_in_list
,
filter_latex_special_chars
,
nice_number_filter
,
nice_unix_time
,
split_hash
,
split_output_lines
)
from
rest_import.rest
import
create_request_url
,
request_firmware_data
GENERIC_TEMPLATE
=
'generic.tex'
def
_set_jinja_env
(
templates_to_use
=
'default'
):
def
create_jinja_environment
(
templates_to_use
=
'default'
):
template_directory
=
Path
(
Path
(
__file__
)
.
parent
.
parent
,
'templates'
,
templates_to_use
)
return
jinja2
.
Environment
(
block_start_string
=
'
\
BLOCK{'
,
environment
=
jinja2
.
Environment
(
block_start_string
=
r
'\BLOCK{'
,
block_end_string
=
'}'
,
variable_start_string
=
'
\
VAR{'
,
variable_start_string
=
r
'\VAR{'
,
variable_end_string
=
'}'
,
comment_start_string
=
'
\
#{'
,
comment_start_string
=
r
'\#{'
,
comment_end_string
=
'}'
,
line_statement_prefix
=
'
%%
'
,
line_comment_prefix
=
'
%#
'
,
...
...
@@ -31,9 +30,11 @@ def _set_jinja_env(templates_to_use='default'):
autoescape
=
False
,
loader
=
jinja2
.
FileSystemLoader
(
str
(
template_directory
))
)
_add_filters_to_jinja
(
environment
)
return
environment
def
_
setup_jinja_filters
(
environment
):
def
_
add_filters_to_jinja
(
environment
):
environment
.
filters
[
'number_format'
]
=
byte_number_filter
environment
.
filters
[
'nice_unix_time'
]
=
nice_unix_time
environment
.
filters
[
'nice_number'
]
=
nice_number_filter
...
...
@@ -75,20 +76,10 @@ def _render_analysis_result(analysis, environment, analysis_plugin, tmp_dir):
return
template
.
render
(
selected_analysis
=
analysis
,
tmp_dir
=
tmp_dir
)
def
_create_tex_files
(
analysis_dict
,
jinja_env
):
module_list
=
list
(
analysis_dict
[
'analysis'
]
.
keys
())
module_list
.
append
(
'meta_data'
)
for
module
in
module_list
:
try
:
_render_analysis_result
(
analysis_dict
,
jinja_env
,
module
)
except
Exception
as
e
:
logging
.
error
(
'Could not generate tex file: {} -> {}'
.
format
(
type
(
Exception
),
e
))
def
create_report_filename
(
meta_data
):
main_tex_filename
=
meta_data
[
'device_name'
]
+
"_analysis_report.pdf"
main_tex_filename
=
main_tex_filename
.
replace
(
" "
,
"_"
)
return
main_tex_filename
.
replace
(
"/"
,
"__"
)
main_tex_filename
=
meta_data
[
'device_name'
]
+
'_analysis_report.pdf'
main_tex_filename
=
main_tex_filename
.
replace
(
' '
,
'_'
)
return
main_tex_filename
.
replace
(
'/'
,
'__'
)
def
_copy_fact_image
(
target
):
...
...
@@ -111,16 +102,15 @@ def generate_pdf_report(firmware_uid):
logging
.
warning
(
'No firmware found with UID {}'
.
format
(
firmware_uid
))
return
None
jinja_environment
=
_set_jinja_env
()
_setup_jinja_filters
(
environment
=
jinja_environment
)
environment
=
create_jinja_environment
()
with
TemporaryDirectory
()
as
tmp_dir
:
Path
(
tmp_dir
,
'meta.tex'
)
.
write_text
(
generate_meta_data_code
(
environment
=
jinja_
environment
,
meta_data
=
firmware_meta_data
))
Path
(
tmp_dir
,
'meta.tex'
)
.
write_text
(
generate_meta_data_code
(
environment
=
environment
,
meta_data
=
firmware_meta_data
))
for
filename
,
result_code
in
generate_analysis_codes
(
environment
=
jinja_
environment
,
analysis
=
firmware_analyses
,
tmp_dir
=
tmp_dir
):
for
filename
,
result_code
in
generate_analysis_codes
(
environment
=
environment
,
analysis
=
firmware_analyses
,
tmp_dir
=
tmp_dir
):
Path
(
tmp_dir
,
filename
)
.
write_text
(
result_code
)
Path
(
tmp_dir
,
'main.tex'
)
.
write_text
(
generate_main_code
(
firmware_analyses
,
firmware_meta_data
,
jinja_
environment
))
Path
(
tmp_dir
,
'main.tex'
)
.
write_text
(
generate_main_code
(
firmware_analyses
,
firmware_meta_data
,
environment
))
_copy_fact_image
(
tmp_dir
)
...
...
src/test/
unit/test_new_tests
.py
→
src/test/
integration/test_code_generation
.py
View file @
29203d12
from
pathlib
import
Path
import
pytest
from
jinja2
import
Environment
,
FileSystemLoader
from
latex_code_generation.code_generation
import
_add_filters_to_jinja
,
generate_meta_data_code
from
rest_import.rest
import
request_firmware_data
from
latex_code_generation.code_generation
import
generate_meta_data_code
from
..data.test_dict
import
test_dict
from
rest_import.rest
import
create_request_url
,
request_firmware_data
from
jinja2
import
Environment
,
FileSystemLoader
# pylint: disable=redefined-outer-name
class
MockResponse
:
@staticmethod
def
json
():
return
dict
()
return
{
'firmware'
:
{
'analysis'
:
{},
'meta_data'
:
{}}}
@pytest.fixture
(
scope
=
'function'
)
def
mock_environment
():
env
=
Environment
(
block_start_string
=
"
\
BLOCK{"
,
block_end_string
=
"}"
,
variable_start_string
=
"
\
VAR{"
,
variable_end_string
=
"}"
,
comment_start_string
=
"
\
#{"
,
comment_end_string
=
"}"
,
line_statement_prefix
=
"
%%
"
,
line_comment_prefix
=
"
%#
"
,
block_start_string
=
r'\BLOCK{'
,
block_end_string
=
'}'
,
variable_start_string
=
r'\VAR{'
,
variable_end_string
=
'}'
,
comment_start_string
=
r'\#{'
,
comment_end_string
=
'}'
,
line_statement_prefix
=
'
%%
'
,
line_comment_prefix
=
'
%#
'
,
trim_blocks
=
True
,
autoescape
=
False
,
loader
=
FileSystemLoader
(
str
(
Path
(
Path
(
__file__
)
.
parent
.
parent
.
parent
,
"templates"
,
'default'
))),
loader
=
FileSystemLoader
(
str
(
Path
(
Path
(
__file__
)
.
parent
.
parent
.
parent
,
'templates'
,
'default'
))),
)
_add_filters_to_jinja
(
env
)
return
env
...
...
@@ -39,6 +42,6 @@ def test_anything_mocked(monkeypatch):
assert
anything
def
test_
generate_meta_code
(
mock_environment
):
result
=
generate_meta_data_code
(
mock_environment
,
{}
)
def
test_
latex_code_generation
(
mock_environment
):
result
=
generate_meta_data_code
(
mock_environment
,
test_dict
)
assert
result
src/test/integration/test_latex_code_generation.py
deleted
100644 → 0
View file @
d6d4d318
from
tempfile
import
TemporaryDirectory
from
pathlib
import
Path
from
..data.test_dict
import
test_dict
from
latex_code_generation.code_generation
import
generate_meta_data_code
def
test_latex_code_generation
():
output_dir
=
TemporaryDirectory
()
main_tex_path
=
Path
(
output_dir
.
name
,
'main.tex'
)
generate_meta_data_code
(
test_dict
,
Path
(
output_dir
.
name
))
assert
main_tex_path
.
exists
()
src/test/unit/test_code_generation.py
View file @
29203d12
from
tempfile
import
TemporaryDirectory
from
pathlib
import
Path
from
latex_code_generation.code_generation
import
_set_jinja_env
,
_render_analysis_result
,
_create_tex_files
,
generate_pdf_report
from
latex_code_generation.code_generation
import
_render_analysis_result
,
create_jinja_environment
,
generate_pdf_report
TEST_DATA
=
{
'analysis'
:
{
'file_hashes'
:
{
'ssdeep'
:
'bla'
,
'sha1'
:
'blah'
}},
'meta_data'
:
{
'device_name'
:
'test_device'
}
}
def
test_render_template
():
with
TemporaryDirectory
()
as
tmp_dir
:
test_data
=
{
'meta_data'
:
'123'
,
'analysis'
:
'456'
}
jinja_env
=
_set_jinja_env
(
templates_to_use
=
'test'
)
output
=
_render_analysis_result
(
test_data
,
jinja_env
,
'render_test'
)
assert
output
==
'Test 123 - 456'
jinja_env
=
create_jinja_environment
(
templates_to_use
=
'test'
)
output
=
_render_analysis_result
(
test_data
,
jinja_env
,
'render_test'
,
tmp_dir
)
assert
output
==
'Test - '
def
test_create_tex_files
():
test_data
=
{
'analysis'
:
{
'file_hashes'
:
{
'ssdeep'
:
'bla'
,
'sha1'
:
'blah'
},
'meta_data'
:
dict
()}}
tmp_dir
=
TemporaryDirectory
()
jinja_env
=
_set_jinja_env
(
templates_to_use
=
'default'
)
for
template_name
in
test_data
[
'analysis'
]:
_create_tex_files
(
test_data
,
jinja_env
)
file_path
=
Path
(
tmp_dir
.
name
,
template_name
+
'.tex'
)
assert
file_path
.
exists
()
def
test_main
():
def
test_main
(
monkeypatch
):
monkeypatch
.
setattr
(
'latex_code_generation.code_generation.request_firmware_data'
,
lambda
*
_
:
(
TEST_DATA
[
'analysis'
],
TEST_DATA
[
'meta_data'
]))
monkeypatch
.
setattr
(
'latex_code_generation.code_generation.shutil.move'
,
lambda
*
_
:
None
)
generate_pdf_report
(
firmware_uid
=
'b79ea608e2f0390744642bad472f8d9fd7e4713791857da5d5fcabf70a009e50_29626948'
)
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment