BaseIntegration

[Enter a comprehensive, yet concise, description of what the integration does, what use cases it is designed for, etc.].

Utilities · Starter Pack

Details

IDBaseIntegration
ProviderOpen Source
CategoryUtilities
From Version5.0.0
Docker Imagedemisto/python3:3.12.8.3296088
Supported ModulesAgentix XSIAM

README

[Enter a comprehensive, yet concise, description of what the integration does, what use cases it is designed for, etc.]
This integration was integrated and tested with version v1.0.0 of BaseIntegration

Configure Starter Base Integration - Name the integration as it will appear in the XSOAR UI in Cortex

Parameter Description Required
Your server URL   True
API Key The API Key to use for connection True
Trust any certificate (not secure)   False
Use system proxy settings   False

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

baseintegration-dummy


[Enter a description of the command, including any important information users need to know, for example required permissions.]

Base Command

baseintegration-dummy

Input

Argument Name Description Required
dummy [Enter a description of the argument, including any important information users need to know, for example, default values.]. Required

Context Output

Path Type Description
BaseIntegration.Output String [Enter a description of the data returned in this output.]

Configuration parameters

  • url — Your server URL (required)
  • credentials — (required)
  • insecure — Trust any certificate (not secure)
  • proxy — Use system proxy settings

Commands (1)

  • baseintegration-dummy

    [Enter a description of the command, including any important information users need to know, for example required permissions.].

"""Base Integration for Cortex XSOAR - Unit Tests file

Pytest Unit Tests: all funcion names must start with "test_"

More details: https://xsoar.pan.dev/docs/integrations/unit-testing

MAKE SURE YOU REVIEW/REPLACE ALL THE COMMENTS MARKED AS "TODO"

You must add at least a Unit Test function for every XSOAR command
you are implementing with your integration
"""

import json


def util_load_json(path):
    with open(path, encoding="utf-8") as f:
        return json.loads(f.read())


# TODO: REMOVE the following dummy unit test function
def test_baseintegration_dummy():
    """Tests helloworld-say-hello command function.

    Checks the output of the command function with the expected output.

    No mock is needed here because the say_hello_command does not call
    any external API.
    """
    from BaseIntegration import Client, baseintegration_dummy_command

    client = Client(base_url="some_mock_url", verify=False)
    args = {"dummy": "this is a dummy response"}
    response = baseintegration_dummy_command(client, args)

    mock_response = util_load_json("test_data/baseintegration-dummy.json")

    assert response.outputs == mock_response


# TODO: ADD HERE unit tests for every command