Skip to content

Commit

Permalink
#588: Update Report Output for Easier Parsing (#619)
Browse files Browse the repository at this point in the history 
* Return report result as object instead of list for easier parsing

* Update typing
  • Loading branch information
@jpdakran
jpdakran committed Sep 22, 2022
1 parent 7266a85 commit 9475112
Show file tree
Hide file tree
Showing 2 changed files with 106 additions and 96 deletions.
7 changes: 4 additions & 3 deletions detect_secrets/audit/report.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ def generate_report(
baseline_file: str,
class_to_print: SecretClassToPrint = None,
line_getter_factory: Callable[[str], 'LineGetter'] = open_file,
) -> List[Dict[str, Any]]:
) -> Dict[str, List[Dict[str, Any]]]:

secrets: Dict[Tuple[str, str], Any] = {}
for filename, secret in get_baseline_from_file(baseline_file):
Expand Down Expand Up @@ -63,8 +63,9 @@ def generate_report(
],
'category': verified_result.name,
}

return list(secrets.values())
return {
'results': list(secrets.values()),
}


def get_prioritized_verified_result(
Expand Down
195 changes: 102 additions & 93 deletions tests/audit/report_test.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,109 +26,118 @@
'class_to_print, expected_real, expected_false, expected_output',
[
(
None, 3, 1, [
{
'category': 'VERIFIED_TRUE',
'lines': {
1: 'url = {}'.format(url_format.format(first_secret)),
3: 'link = {}'.format(url_format.format(first_secret)),
None, 3, 1,
{
'results': [
{
'category': 'VERIFIED_TRUE',
'lines': {
1: 'url = {}'.format(url_format.format(first_secret)),
3: 'link = {}'.format(url_format.format(first_secret)),
},
'secrets': first_secret,
'types': [
BasicAuthDetector.secret_type,
],
},
'secrets': first_secret,
'types': [
BasicAuthDetector.secret_type,
],
},
{
'category': 'UNVERIFIED',
'lines': {
2: 'example = {}'.format(url_format.format(random_secret)),
{
'category': 'UNVERIFIED',
'lines': {
2: 'example = {}'.format(url_format.format(random_secret)),
},
'secrets': random_secret,
'types': [
BasicAuthDetector.secret_type,
],
},
'secrets': random_secret,
'types': [
BasicAuthDetector.secret_type,
],
},
{
'category': 'VERIFIED_TRUE',
'lines': {
1: 'url = {}'.format(url_format.format(second_secret)),
{
'category': 'VERIFIED_TRUE',
'lines': {
1: 'url = {}'.format(url_format.format(second_secret)),
},
'secrets': second_secret,
'types': [
BasicAuthDetector.secret_type,
JwtTokenDetector.secret_type,
],
},
'secrets': second_secret,
'types': [
BasicAuthDetector.secret_type,
JwtTokenDetector.secret_type,
],
},
{
'category': 'VERIFIED_FALSE',
'lines': {
2: 'example = {}'.format(url_format.format(random_secret)),
{
'category': 'VERIFIED_FALSE',
'lines': {
2: 'example = {}'.format(url_format.format(random_secret)),
},
'secrets': random_secret,
'types': [
BasicAuthDetector.secret_type,
],
},
'secrets': random_secret,
'types': [
BasicAuthDetector.secret_type,
],
},
],
],
},
),
(
SecretClassToPrint.REAL_SECRET, 3, 0, [
{
'category': 'VERIFIED_TRUE',
'lines': {
1: 'url = {}'.format(url_format.format(first_secret)),
3: 'link = {}'.format(url_format.format(first_secret)),
SecretClassToPrint.REAL_SECRET, 3, 0,
{
'results': [
{
'category': 'VERIFIED_TRUE',
'lines': {
1: 'url = {}'.format(url_format.format(first_secret)),
3: 'link = {}'.format(url_format.format(first_secret)),
},
'secrets': first_secret,
'types': [
BasicAuthDetector.secret_type,
],
},
'secrets': first_secret,
'types': [
BasicAuthDetector.secret_type,
],
},
{
'category': 'UNVERIFIED',
'lines': {
2: 'example = {}'.format(url_format.format(random_secret)),
{
'category': 'UNVERIFIED',
'lines': {
2: 'example = {}'.format(url_format.format(random_secret)),
},
'secrets': random_secret,
'types': [
BasicAuthDetector.secret_type,
],
},
'secrets': random_secret,
'types': [
BasicAuthDetector.secret_type,
],
},
{
'category': 'VERIFIED_TRUE',
'lines': {
1: 'url = {}'.format(url_format.format(second_secret)),
{
'category': 'VERIFIED_TRUE',
'lines': {
1: 'url = {}'.format(url_format.format(second_secret)),
},
'secrets': second_secret,
'types': [
JwtTokenDetector.secret_type,
],
},
'secrets': second_secret,
'types': [
JwtTokenDetector.secret_type,
],
},
],
],
},
),
(
SecretClassToPrint.FALSE_POSITIVE, 0, 2, [
{
'category': 'VERIFIED_FALSE',
'lines': {
1: 'url = {}'.format(url_format.format(second_secret)),
SecretClassToPrint.FALSE_POSITIVE, 0, 2,
{
'results': [
{
'category': 'VERIFIED_FALSE',
'lines': {
1: 'url = {}'.format(url_format.format(second_secret)),
},
'secrets': second_secret,
'types': [
BasicAuthDetector.secret_type,
],
},
'secrets': second_secret,
'types': [
BasicAuthDetector.secret_type,
],
},
{
'category': 'VERIFIED_FALSE',
'lines': {
2: 'example = {}'.format(url_format.format(random_secret)),
{
'category': 'VERIFIED_FALSE',
'lines': {
2: 'example = {}'.format(url_format.format(random_secret)),
},
'secrets': random_secret,
'types': [
BasicAuthDetector.secret_type,
],
},
'secrets': random_secret,
'types': [
BasicAuthDetector.secret_type,
],
},
],
],
},
),
],
)
Expand All @@ -143,9 +152,9 @@ def test_generate_report(
real, false = count_results(output)
assert real == expected_real
assert false == expected_false
for expected in expected_output:
for expected in expected_output['results']:
found = False
for item in output:
for item in output['results']:
if expected['secrets'] == item['secrets'] and expected['category'] == item['category']:
for key in expected.keys():
assert item[key] == expected[key]
Expand All @@ -156,7 +165,7 @@ def test_generate_report(
def count_results(data):
real_secrets = 0
false_secrets = 0
for secret in data:
for secret in data['results']:
if SecretClassToPrint.from_class(VerifiedResult[secret['category']]) == SecretClassToPrint.REAL_SECRET: # noqa: E501
real_secrets += 1
else:
Expand Down

0 comments on commit 9475112

Please sign in to comment.