Infra
/
lemur
5
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

improving the documentation and method naming

This commit is contained in:
Hossein Shafagh 2020-03-17 16:55:36 -07:00
parent 9de89ec96a
commit ecca003ab4
2 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
lemur/certificates/service.py
View File

@ -102,12 +102,13 @@ def get_all_certs():
return Certificate.query.all() return Certificate.query.all()
def get_all_pending_cleaning(source): def get_all_pending_cleaning_expired(source):
""" """
Retrieves all certificates that are available for cleaning. Retrieves all certificates that are available for cleaning. These are certificates which are expired and are not
attached to any endpoints.
:param source: :param source: the source to search for certificates
:return: :return: the pending certificates
""" """
return ( return (
Certificate.query.filter(Certificate.sources.any(id=source.id)) Certificate.query.filter(Certificate.sources.any(id=source.id))
@ -117,14 +118,14 @@ def get_all_pending_cleaning(source):
) )
def get_all_pending_cleaning_about_to_expire_certs(source, days_to_expire): def get_all_pending_cleaning_expiring_in_days(source, days_to_expire):
""" """
Retrieves all certificates that are available for cleaning: not attached to endpoint, Retrieves all certificates that are available for cleaning, not attached to endpoint,
and within X days from expiration. and within X days from expiration.
:param days_to_expire: :param days_to_expire: defines how many days till the certificate is expired
:param source: :param source: the source to search for certificates
:return: :return: the pending certificates
""" """
expiration_window = arrow.now().shift(days=+days_to_expire).format("YYYY-MM-DD") expiration_window = arrow.now().shift(days=+days_to_expire).format("YYYY-MM-DD")
return ( return (
@ -135,13 +136,13 @@ def get_all_pending_cleaning_about_to_expire_certs(source, days_to_expire):
) )
def get_all_pending_cleaning_not_in_use_certs(source, days_since_issuance): def get_all_pending_cleaning_issued_since_days(source, days_since_issuance):
""" """
Retrieves all certificates that are available for cleaning: not attached to endpoint, and X days since issuance. Retrieves all certificates that are available for cleaning: not attached to endpoint, and X days since issuance.
:param days_since_issuance: :param days_since_issuance: defines how many days since the certificate is issued
:param source: :param source: the source to search for certificates
:return: :return: the pending certificates
""" """
not_in_use_window = arrow.now().shift(days=-days_since_issuance).format("YYYY-MM-DD") not_in_use_window = arrow.now().shift(days=-days_since_issuance).format("YYYY-MM-DD")
return ( return (

6
lemur/sources/cli.py
View File

@ -153,7 +153,7 @@ def clean(source_strings, commit):
print("[+] Staring to clean source: {label}!\n".format(label=source.label)) print("[+] Staring to clean source: {label}!\n".format(label=source.label))
cleaned = 0 cleaned = 0
certificates = certificate_service.get_all_pending_cleaning(source) certificates = certificate_service.get_all_pending_cleaning_expired(source)
for certificate in certificates: for certificate in certificates:
status = FAILURE_METRIC_STATUS status = FAILURE_METRIC_STATUS
if commit: if commit:
@ -215,7 +215,7 @@ def clean_unused_and_expiring_within_days(source_strings, days_to_expire, commit
print("[+] Staring to clean source: {label}!\n".format(label=source.label)) print("[+] Staring to clean source: {label}!\n".format(label=source.label))
cleaned = 0 cleaned = 0
certificates = certificate_service.get_all_pending_cleaning_about_to_expire_certs(source, days_to_expire) certificates = certificate_service.get_all_pending_cleaning_expiring_in_days(source, days_to_expire)
for certificate in certificates: for certificate in certificates:
status = FAILURE_METRIC_STATUS status = FAILURE_METRIC_STATUS
if commit: if commit:
@ -277,7 +277,7 @@ def clean_unused_and_issued_since_days(source_strings, days_since_issuance, comm
print("[+] Staring to clean source: {label}!\n".format(label=source.label)) print("[+] Staring to clean source: {label}!\n".format(label=source.label))
cleaned = 0 cleaned = 0
certificates = certificate_service.get_all_pending_cleaning_not_in_use_certs(source, days_since_issuance) certificates = certificate_service.get_all_pending_cleaning_issued_since_days(source, days_since_issuance)
for certificate in certificates: for certificate in certificates:
status = FAILURE_METRIC_STATUS status = FAILURE_METRIC_STATUS
if commit: if commit: