cti-python-stix2/stix2/test/v21/test_course_of_action.py

import datetime as dt

import pytest
import pytz

import stix2
import stix2.exceptions

from .constants import COURSE_OF_ACTION_ID, IDENTITY_ID

EXPECTED = """{
    "type": "course-of-action",
    "spec_version": "2.1",
    "id": "course-of-action--8e2e2d2b-17d4-4cbf-938f-98ee46b3cd3f",
    "created_by_ref": "identity--311b2d2d-f010-4473-83ec-1edf84858f4c",
    "created": "2016-04-06T20:03:48.000Z",
    "modified": "2016-04-06T20:03:48.000Z",
    "name": "Add TCP port 80 Filter Rule to the existing Block UDP 1434 Filter",
    "description": "This is how to add a filter rule to block inbound access to TCP port 80 to the existing UDP 1434 filter ...",
    "action_type": "textual:text/plain",
    "os_execution_envs": [
        "a",
        "b",
        "c"
    ],
    "action_bin": "aGVsbG8gd29ybGQ="
}"""


def test_course_of_action_example():
    coa = stix2.v21.CourseOfAction(
        id=COURSE_OF_ACTION_ID,
        created_by_ref=IDENTITY_ID,
        created="2016-04-06T20:03:48.000Z",
        modified="2016-04-06T20:03:48.000Z",
        name="Add TCP port 80 Filter Rule to the existing Block UDP 1434 Filter",
        description="This is how to add a filter rule to block inbound access to TCP port 80 to the existing UDP 1434 filter ...",
        action_type="textual:text/plain",
        os_execution_envs=["a", "b", "c"],
        action_bin="aGVsbG8gd29ybGQ=",
    )

    assert str(coa) == EXPECTED


@pytest.mark.parametrize(
    "data", [
        EXPECTED,
        {
            "created": "2016-04-06T20:03:48.000Z",
            "created_by_ref": IDENTITY_ID,
            "description": "This is how to add a filter rule to block inbound access to TCP port 80 to the existing UDP 1434 filter ...",
            "id": COURSE_OF_ACTION_ID,
            "modified": "2016-04-06T20:03:48.000Z",
            "name": "Add TCP port 80 Filter Rule to the existing Block UDP 1434 Filter",
            "spec_version": "2.1",
            "type": "course-of-action",
            "action_type": "textual:text/plain",
            "os_execution_envs": ["a", "b", "c"],
            "action_bin": "aGVsbG8gd29ybGQ=",
        },
    ],
)
def test_parse_course_of_action(data):
    coa = stix2.parse(data, version="2.1")

    assert coa.type == 'course-of-action'
    assert coa.spec_version == '2.1'
    assert coa.id == COURSE_OF_ACTION_ID
    assert coa.created == dt.datetime(2016, 4, 6, 20, 3, 48, tzinfo=pytz.utc)
    assert coa.modified == dt.datetime(2016, 4, 6, 20, 3, 48, tzinfo=pytz.utc)
    assert coa.created_by_ref == IDENTITY_ID
    assert coa.description == "This is how to add a filter rule to block inbound access to TCP port 80 to the existing UDP 1434 filter ..."
    assert coa.name == "Add TCP port 80 Filter Rule to the existing Block UDP 1434 Filter"
    assert coa.action_type == "textual:text/plain"
    assert coa.os_execution_envs == ["a", "b", "c"]
    assert coa.action_bin == "aGVsbG8gd29ybGQ="


def test_course_of_action_constraint():
    with pytest.raises(stix2.exceptions.MutuallyExclusivePropertiesError):
        stix2.v21.CourseOfAction(
            name="Add TCP port 80 Filter Rule to the existing Block UDP 1434 Filter",
            action_bin="aGVsbG8gd29ybGQ=",
            action_reference=stix2.v21.ExternalReference(
                source_name="a source",
                description="description of a source",
            ),
        )

# TODO: Add other examples