def test_get_inputs():
from demisto_sdk.commands.generate_docs.generate_playbook_doc import get_inputs
playbook = get_yaml(TEST_PLAYBOOK_PATH)
inputs, errors = get_inputs(playbook)
expected_query = '(type:ip or type:file or type:Domain or type:URL) -tags:pending_review ' \
'and (tags:approved_black or tags:approved_white or tags:approved_watchlist)'
expected_inputs = [{
'Name': 'InputA',
'Description': '',
'Default Value': 'File.Name',
'Required': 'Optional'
}, {
'Name': 'InputB',
'Description': 'This is input b',
'Default Value': '*****@*****.**',
'Required': 'Required'
}, {
'Name': 'Indicator Query',
'Description':
'Indicators matching the indicator query will be used as playbook input',
'Default Value': expected_query,
'Required': 'Optional'
}]
assert inputs == expected_inputs
assert errors[
0] == 'Error! You are missing description in playbook input InputA'
def test_get_script_inputs():
from demisto_sdk.commands.generate_docs.generate_script_doc import \
get_inputs
script = get_yaml(TEST_SCRIPT_PATH)
inputs, errors = get_inputs(script)
expected_inputs = [{'Argument Name': 'InputA', 'Description': ''},
{'Argument Name': 'InputB', 'Description': 'This is input b'}]
assert inputs == expected_inputs
assert errors[0] == 'Error! You are missing description in script input InputA'
def test_get_inputs():
from demisto_sdk.commands.generate_docs.generate_playbook_doc import get_inputs
playbook = get_yaml(TEST_PLAYBOOK_PATH)
inputs, errors = get_inputs(playbook)
expected_inputs = [{
'Name': 'InputA',
'Description': '',
'Default Value': 'Name',
'Source': 'File',
'Required': 'Optional'
}, {
'Name': 'InputB',
'Description': 'This is input b',
'Default Value': '*****@*****.**',
'Source': '',
'Required': 'Required'
}]
assert inputs == expected_inputs
assert errors[
0] == 'Error! You are missing description in playbook input InputA'
