ServiceNowUpdateIncident

This script is used to wrap the generic update-record command in ServiceNow. You can add fields that you want to update the record with as script arguments or in the code and work with the records easily.

python · ServiceNow

Details

ID	`ServiceNowUpdateIncident`
Language	python
From Version	5.0.0
Docker Image	`demisto/python3:3.12.13.10116658`
Tags	servicenow servicenow v2

README

Wraps the generic update-record command in ServiceNow. Fields can be added that update the record with as script arguments or in the code and work with the records easily.

Script Data

Name	Description
Script Type	python
Tags	servicenow

Dependencies

This script uses the following commands and scripts.

servicenow-query-table
servicenow-update-record

Inputs

Argument Name	Description
severity	The severity of the incident.
assignee	The assignee name of the incident. For example, “John Smith”.
description	The description of the incident.
assigned_group	The assigned group name of the incident. For example, “Incident Management Group”.
id	The incident ID to update.
number	The incident number to update.
query	The query to use.

Outputs

Path	Description	Type
ServiceNow.Incident.ID	The ID of the incident.	string
ServiceNow.Incident.Number	The number of the incident.	string

Source

ServiceNowUpdateIncident.py ServiceNowUpdateIncident_test.py ServiceNowUpdateIncident.yml

Download History Raw

from CommonServerPython import *


def test_get_incident(mocker):
    """
    Given:
     - an incident data from service now command

    When:
     - executing get_incident function

    Then:
     - make sure the incident result key is being retrieved
    """
    from ServiceNowUpdateIncident import get_incident

    mocker.patch.object(demisto, "executeCommand")
    mocker.patch.object(demisto, "get", return_value={"result": "test"})

    result = get_incident("query")
    assert result == "test"


def test_get_incident_id(mocker):
    """
    Given:
     - an incident sys-id

    When:
     - executing get_incident_id function

    Then:
     - make sure that the incident sys ID is retrieved.
    """
    from ServiceNowUpdateIncident import get_incident_id

    mocker.patch.object(demisto, "executeCommand")
    mocker.patch.object(demisto, "get", return_value={"result": [{"sys_id": "123"}]})
    incident_sys_id = get_incident_id("123")
    assert incident_sys_id == "123"


def test_get_user(mocker):
    """
    Given:
     - an incident data from service now command

    When:
     - executing get_user function

    Then:
     - make sure the incident result key is being retrieved
    """
    from ServiceNowUpdateIncident import get_user

    mocker.patch.object(demisto, "executeCommand")
    mocker.patch.object(demisto, "get", return_value={"result": "test"})

    user = get_user("query")
    assert user == "test"


def test_get_user_id(mocker):
    """
    Given:
     - an incident sys-id

    When:
     - executing get_user_id function

    Then:
     - make sure that the incident sys ID is retrieved.
    """
    from ServiceNowUpdateIncident import get_user_id

    mocker.patch.object(demisto, "executeCommand")
    mocker.patch.object(demisto, "get", return_value={"result": [{"sys_id": "123"}]})
    incident_sys_id = get_user_id("user1 user2")
    assert incident_sys_id == "123"


def test_get_group(mocker):
    """
    Given:
     - an incident data from service now command

    When:
     - executing get_user function

    Then:
     - make sure the incident result key is being retrieved
    """
    from ServiceNowUpdateIncident import get_group

    mocker.patch.object(demisto, "executeCommand")
    mocker.patch.object(demisto, "get", return_value={"result": "test"})

    user = get_group("query")
    assert user == "test"


def test_get_group_id(mocker):
    """
    Given:
     - an incident sys-id

    When:
     - executing get_user_id function

    Then:
     - make sure that the incident sys ID is retrieved.
    """
    from ServiceNowUpdateIncident import get_group_id

    mocker.patch.object(demisto, "executeCommand")
    mocker.patch.object(demisto, "get", return_value={"result": [{"sys_id": "123"}]})
    incident_sys_id = get_group_id("user1 user2")
    assert incident_sys_id == "123"


def test_main_flow_success(mocker):
    """
    Given:
     - result of the 'servicenow-update-record' executed command.

    When:
     - running the main flow

    Then:
     - make sure the main flow gets executed without errors.
    """
    from ServiceNowUpdateIncident import main

    args_mock = {"number": "INC0021211", "query": "description=hello"}
    mocked_command_data = {"result": {"number": "INC0021211", "sys_id": "123"}}
    mocker.patch.object(demisto, "executeCommand")
    mocker.patch("ServiceNowUpdateIncident.get_incident_id", return_value="123")
    mocker.patch.object(demisto, "args", return_value=args_mock)
    mocker.patch.object(demisto, "get", return_value=mocked_command_data)

    result = mocker.patch("demistomock.results")

    main()

    assert result.call_args.args[0] == {
        "Type": 1,
        "Contents": {"result": {"number": "INC0021211", "sys_id": "123"}},
        "ContentsFormat": "json",
        "ReadableContentsFormat": "markdown",
        "HumanReadable": "Incident with ID 123 successfully updated",
        "EntryContext": {"ServiceNow.Incident(val.ID===obj.ID)": {"ID": "123"}},
    }