-
Notifications
You must be signed in to change notification settings - Fork 3
/
aws_energy_labeler_cli.py
201 lines (180 loc) · 9.31 KB
/
aws_energy_labeler_cli.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# File: aws_energy_labeler_cli.py
#
# Copyright 2022 Theodoor Scholte, Costas Tyfoxylos, Jenda Brands
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
#
"""
Main code for aws_energy_labeler_cli.
.. _Google Python Style Guide:
http://google.github.io/styleguide/pyguide.html
"""
import datetime
import json
import logging
from art import text2art
from terminaltables import AsciiTable
from awsenergylabelerlib import DataExporter, DEFAULT_SECURITY_HUB_FRAMEWORKS
from awsenergylabelerlib._version import __version__ as lib_version
from awsenergylabelercli._version import __version__ as cli_version
from awsenergylabelercli import (calculate_file_hash,
get_account_reporting_data,
get_arguments,
get_zone_reporting_data,
setup_logging)
from awsenergylabelercli.entities import MetadataEntry, Metadata
__author__ = '''Costas Tyfoxylos <ctyfoxylos@schubergphilis.com>'''
__docformat__ = '''google'''
__date__ = '''11-11-2021'''
__copyright__ = '''Copyright 2022, Costas Tyfoxylos'''
__credits__ = ["Theodoor Scholte", "Costas Tyfoxylos", "Jenda Brands"]
__license__ = '''MIT'''
__maintainer__ = '''Costas Tyfoxylos'''
__email__ = '''<ctyfoxylos@schubergphilis.com>'''
__status__ = '''Development''' # "Prototype", "Development", "Production".
# This is the main prefix used for logging
LOGGER_BASENAME = '''aws_energy_labeler_cli'''
LOGGER = logging.getLogger(LOGGER_BASENAME)
LOGGER.addHandler(logging.NullHandler())
def create_execution_metadata(args):
"""Creates the execution metadata.
Args:
args: The arguments provided by argparse as set by the user.
Returns:
The calculated metadata.
"""
metadata = Metadata()
metadata.add_entry(MetadataEntry(title='Default Account Thresholds Overwritten:',
value=bool(args.account_thresholds),
is_report_entry=True))
if args.account_thresholds:
metadata.add_entry(MetadataEntry(title='Account Thresholds Provided:',
value=args.account_thresholds,
is_report_entry=False))
metadata.add_entry(MetadataEntry(title='Default Zone Thresholds Overwritten:',
value=bool(args.zone_thresholds),
is_report_entry=True))
if args.zone_thresholds:
metadata.add_entry(MetadataEntry(title='Zone Thresholds Provided:',
value=args.zone_thresholds,
is_report_entry=False))
metadata.add_entry(MetadataEntry(title='Default Security Hub Query Filter Overwritten:',
value=bool(args.security_hub_query_filter),
is_report_entry=True))
if args.security_hub_query_filter:
metadata.add_entry(MetadataEntry(title='Security Hub Query Filter Provided:',
value=args.security_hub_query_filter,
is_report_entry=False))
if set(args.frameworks) != set(DEFAULT_SECURITY_HUB_FRAMEWORKS):
metadata.add_entry(MetadataEntry(title='Default Frameworks Overwritten:',
value=True,
is_report_entry=True))
metadata.add_entry(MetadataEntry(title='Frameworks Provided:',
value=args.frameworks,
is_report_entry=False))
metadata.add_entry(MetadataEntry(title='Library Version:',
value=lib_version,
is_report_entry=True))
metadata.add_entry(MetadataEntry(title='Cli Version:',
value=cli_version,
is_report_entry=True))
return metadata
def _get_reporting_arguments(args):
start_run_time = datetime.datetime.now()
execution_metadata = create_execution_metadata(args)
method_arguments = {'region': args.region,
'frameworks': args.frameworks,
'allowed_regions': args.allowed_regions,
'denied_regions': args.denied_regions,
'report_closed_findings_days': args.report_closed_findings_days,
'report_suppressed_findings': args.report_suppressed_findings,
'account_thresholds': args.account_thresholds,
'export_all_data_flag': args.export_all,
'security_hub_query_filter': args.security_hub_query_filter,
'log_level': args.log_level,
'metadata': execution_metadata,
'disable_spinner': args.disable_spinner}
if args.single_account_id:
get_reporting_data = get_account_reporting_data
method_arguments.update({'account_id': args.single_account_id})
else:
zone_type = 'organizations_zone' if args.organizations_zone_name else 'audit_zone'
zone_name = args.organizations_zone_name or args.audit_zone_name
get_reporting_data = get_zone_reporting_data
method_arguments.update({'zone_name': zone_name,
'allowed_account_ids': args.allowed_account_ids,
'denied_account_ids': args.denied_account_ids,
'zone_type': zone_type,
'zone_thresholds': args.zone_thresholds})
report_data, exporter_arguments = get_reporting_data(**method_arguments)
execution_metadata = exporter_arguments.get('metadata')
report_data.extend(execution_metadata.report_table)
end_run_time = datetime.datetime.now()
execution_metadata.add_entry(MetadataEntry(title='Date and time of end of execution:',
value=str(end_run_time),
is_report_entry=True))
execution_metadata.add_entry(MetadataEntry(title='Duration of run:',
value=str(end_run_time - start_run_time),
is_report_entry=True))
execution_metadata.add_entry(MetadataEntry(title='Hash:',
value=calculate_file_hash(
json.dumps(execution_metadata.data).encode('utf-8')),
is_report_entry=False))
exporter_arguments.update({'metadata': execution_metadata.data})
return report_data, exporter_arguments
def report(report_data, to_json=False):
"""Report to table or json."""
if to_json:
data = {key.replace(':', '').replace(' ', '_').lower(): value for key, value in dict(report_data).items()}
print(json.dumps(data, indent=2))
return None
table_data = [['Energy label report']]
table_data.extend(report_data)
table = AsciiTable(table_data)
print(table.table)
return None
def main():
"""Main method."""
args = get_arguments()
setup_logging(args.log_level, args.logger_config)
logging.getLogger('botocore').setLevel(logging.ERROR)
for entity in ['account', 'zone']:
if getattr(args, f'{entity}_thresholds'):
LOGGER.warning(f'{entity.capitalize()} thresholds have been overwritten, '
f'configuration will be reported on the output.')
if not args.frameworks:
LOGGER.info('No frameworks have been provided for filtering.')
try:
if not args.disable_banner:
print(text2art("AWS Energy Labeler"))
report_data, exporter_arguments = _get_reporting_arguments(args)
if args.export_path:
LOGGER.info(f'Trying to export data to the requested path : {args.export_path}')
exporter = DataExporter(**exporter_arguments)
exporter.export(args.export_path)
report(report_data, args.to_json)
status_code = 0
except Exception as msg: # pylint: disable=broad-except
LOGGER.error(msg)
status_code = 1
return status_code
if __name__ == '__main__':
raise SystemExit(main())