Skip to content

Dev lead id,status are optional for engagments #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Dev lead id,status are optional for engagments #53

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6dbacb0
add support related_fields to 3 methods:
SecurityEdge2 Jul 13, 2021
2728169
dev lead_id, status are optional for engagments
Aug 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 20 additions & 59 deletions defectdojo_api/defectdojo_apiv2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ def get_user(self, user_id):
return self._request('GET', 'users/' + str(user_id) + '/')

###### Engagements API #######
def list_engagements(self, status=None, product_id=None, name_contains=None, name=None, limit=20, offset=0):
def list_engagements(self, status=None, product_id=None, name_contains=None, name=None, limit=20, offset=0, related_fields=False):
"""Retrieves all the engagements.

:param product_in: List of product ids (1,2).
Expand Down Expand Up @@ -128,6 +128,9 @@ def list_engagements(self, status=None, product_id=None, name_contains=None, nam
if name:
params['name'] = name

if related_fields:
params['related_fields'] = 'true'

return self._request('GET', 'engagements/', params)

def get_engagement(self, engagement_id):
Expand All @@ -138,7 +141,7 @@ def get_engagement(self, engagement_id):
"""
return self._request('GET', 'engagements/' + str(engagement_id) + '/')

def create_engagement(self, name, product_id, lead_id, status, target_start, target_end, active='True',
def create_engagement(self, name, product_id, target_start, target_end, active='True', lead_id=None, status=None,
pen_test='False', check_list='False', threat_model='False', risk_path="",test_strategy="", progress="",
done_testing='False', engagement_type="CI/CD", build_id=None, commit_hash=None, branch_tag=None, build_server=None,
source_code_management_server=None, source_code_management_uri=None, orchestration_engine=None, description=None, deduplication_on_engagement=True):
Expand Down Expand Up @@ -312,25 +315,7 @@ def set_engagement(self, id, product_id=None, lead_id=None, name=None, status=No
return self._request('PATCH', 'engagements/' + str(id) + '/', data=data)

###### Product API #######
def set_product_metadata(self, product_id, name=None, value=None):
"""Add a custom field to a product.

:param product_id: Product ID.
:param meta_data: name/value array.

"""
data = {
'product': product_id,
'name': name,
'value': value
}
headers = {
'product_id': '{}'.format(product_id)
}

return self._request('POST', 'metadata/', data=data, custom_headers=headers)

def list_products(self, name=None, name_contains=None, limit=200, offset=0):
def list_products(self, name=None, name_contains=None, limit=200, offset=0, related_fields=False):

"""Retrieves all the products.

Expand All @@ -354,6 +339,9 @@ def list_products(self, name=None, name_contains=None, limit=200, offset=0):
if name_contains:
params['name__icontains'] = name_contains

if related_fields:
params['related_fields'] = 'true'

return self._request('GET', 'products/', params)

def get_product(self, product_id):
Expand Down Expand Up @@ -456,20 +444,14 @@ def get_test(self, test_id):
"""
return self._request('GET', 'tests/' + str(test_id) + '/')

def create_test(self, engagement_id, test_type, environment, target_start,
target_end, percent_complete=None, lead=None, title=None,
version=None, description=None):
def create_test(self, engagement_id, test_type, environment, target_start, target_end, percent_complete=None):
"""Creates a product with the given properties.

:param engagement_id: Engagement id.
:param test_type: Test type key id.
:param target_start: Test start date.
:param target_end: Test end date.
:param percent_complete: Percentage until test completion.
:param lead: Test lead id
:param title: Test title/name
:param version: Test version
:param description: Test description

"""

Expand All @@ -482,34 +464,17 @@ def create_test(self, engagement_id, test_type, environment, target_start,
'percent_complete': percent_complete
}

if lead:
data['lead'] = lead

if title:
data['title'] = title

if version:
data['version'] = version

if description:
data['description'] = description

return self._request('POST', 'tests/', data=data)

def set_test(self, test_id, engagement_id=None, test_type=None,
environment=None, target_start=None, target_end=None,
percent_complete=None, title=None, version=None, description=None):
def set_test(self, test_id, engagement_id=None, test_type=None, environment=None,
target_start=None, target_end=None, percent_complete=None):
"""Creates a product with the given properties.

:param engagement_id: Engagement id.
:param test_type: Test type key id.
:param target_start: Test start date.
:param target_end: Test end date.
:param percent_complete: Percentage until test completion.
:param title: Test title/name
:param version: Test version
:param description: Test description


"""

Expand Down Expand Up @@ -537,22 +502,13 @@ def set_test(self, test_id, engagement_id=None, test_type=None,

if percent_complete:
data['percent_complete'] = percent_complete

if title:
data['title'] = title

if version:
data['version'] = version

if description:
data['description'] = description

return self._request('PUT', 'tests/' + str(test_id) + '/', data=data)

###### Findings API #######
def list_findings(self, active=None, duplicate=None, mitigated=None, severity=None, verified=None, severity_lt=None,
severity_gt=None, severity_contains=None, title_contains=None, url_contains=None, date_lt=None,
date_gt=None, date=None, product_id_in=None, engagement_id_in=None, test_id_in=None, build=None, limit=20, offset=0):
date_gt=None, date=None, product_id_in=None, engagement_id_in=None, test_id_in=None, build=None, limit=20, offset=0, related_fields=False):

"""Returns filtered list of findings.

Expand Down Expand Up @@ -636,6 +592,9 @@ def list_findings(self, active=None, duplicate=None, mitigated=None, severity=No
if build:
params['build_id__contains'] = build

if related_fields:
params['related_fields'] = 'true'

return self._request('GET', 'findings/', params)

def get_finding(self, finding_id):
Expand Down Expand Up @@ -794,6 +753,7 @@ def build_details(self, engagement_id, json):
)

##### Upload API #####

def upload_scan(self, engagement_id, scan_type, file, active, verified, close_old_findings, skip_duplicates, scan_date, tags=None, build=None, version=None, branch_tag=None, commit_hash=None, minimum_severity="Info", auto_group_by=None):
"""Uploads and processes a scan file.

Expand Down Expand Up @@ -847,6 +807,7 @@ def upload_scan(self, engagement_id, scan_type, file, active, verified, close_ol
)

##### Re-upload API #####

def reupload_scan(self, test_id, scan_type, file, active, scan_date, tags=None, build=None, version=None, branch_tag=None, commit_hash=None, minimum_severity="Info", auto_group_by=None):
"""Re-uploads and processes a scan file.

Expand All @@ -871,7 +832,7 @@ def reupload_scan(self, test_id, scan_type, file, active, scan_date, tags=None,
'version': ('', version),
'branch_tag': ('', branch_tag),
'commit_hash': ('', commit_hash),
'minimum_severity': ('', minimum_severity),
'minimum_severity': ('', minimum_severity),
# 'push_to_jira': ('', True)
}

Expand Down Expand Up @@ -1198,7 +1159,7 @@ def list_jira_issues(self, finding_id=None, jira_key=None, limit=100, offset=0):
Retrieves JIRA issues assigned to findings

:param finding_id: Search for a specific finding ID
:param jira_key: Search a specific JIRA key
:param jira_key: Search a specific JIRA key
:param limit: Number of records to return.
:param offset: The initial index from which to return the result
"""
Expand Down