dotflow/tests/core/test_action.py at 00b0100de0166b1efed8e41567cecff6b7ad1501 · avarga1/dotflow · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
"""Test context of actions"""

import logging
import unittest

from pytest import fixture  # type: ignore

from dotflow.core.action import Action
from dotflow.core.context import Context
from dotflow.core.task import Task
from dotflow.core.types.status import TypeStatus
from tests.mocks import (
    action_step,
    simple_step,
    simple_step_with_fail,
    simple_step_with_initial_context,
    simple_step_with_params,
    simple_step_with_previous_context,
)


class TestClassActions(unittest.TestCase):
    @fixture(autouse=True)
    def inject_fixtures(self, caplog):
        self._caplog = caplog
        self.task = Task(task_id=1, step=action_step)

    def test_instantiating_action_class(self):
        number_of_retries = 1

        inside = Action(simple_step, task=self.task)
        decorated_function = inside(task=self.task)

        self.assertEqual(inside.retry, number_of_retries)
        self.assertEqual(inside.func, simple_step)
        self.assertIsInstance(decorated_function, Context)

    def test_instantiating_action_class_with_retry(self):
        number_of_retries = 5

        inside = Action(simple_step, task=self.task, retry=number_of_retries)
        decorated_function = inside(task=self.task)

        self.assertEqual(inside.retry, number_of_retries)
        self.assertEqual(inside.func, simple_step)
        self.assertIsInstance(decorated_function, Context)

    def test_instantiating_action_class_with_fail_retry(self):
        error_message = "Fail!"
        number_of_retries = 5

        inside = Action(simple_step_with_fail, retry=number_of_retries)

        with self._caplog.at_level(logging.ERROR):
            try:
                inside()
            except Exception as error:
                self.assertEqual(error.args[0], error_message)

            self.assertEqual(len(self._caplog.records), number_of_retries)

            for record in self._caplog.records:
                self.assertEqual(record.message, error_message)

    def test_sets_retry_status_before_retrying(self):
        calls = {"count": 0}
        statuses = []

        def flaky_step():
            calls["count"] += 1
            if calls["count"] == 1:
                raise Exception("Fail once")
            statuses.append(self.task.status)
            return "ok"

        inside = Action(flaky_step, retry=2, retry_delay=0)
        inside(task=self.task)

        self.assertEqual(len(statuses), 1)
        self.assertEqual(statuses[0], TypeStatus.RETRY)

    def test_retry_exception_does_not_chain_to_itself(self):
        def always_fail():
            raise ValueError("fail")

        inside = Action(always_fail, retry=2, retry_delay=0)

        try:
            inside()
        except ValueError as error:
            self.assertIsNot(
                error.__cause__,
                error,
                "Exception must not be its own __cause__ (circular chain)",
            )

    def test_backoff_does_not_mutate_retry_delay(self):
        def always_fail():
            raise RuntimeError("fail")

        inside = Action(always_fail, retry=3, retry_delay=1, backoff=True)

        with unittest.mock.patch("dotflow.core.action.sleep"):  # noqa: SIM117
            with self.assertRaises(RuntimeError):
                inside()

        self.assertEqual(inside.retry_delay, 1)

    def test_action_class_with_previous_context(self):
        inside = Action(simple_step_with_previous_context, task=self.task)

        with self._caplog.at_level(logging.DEBUG):
            inside(task=self.task)
            self.assertEqual(self._caplog.records[0].message, "None")

    def test_set_params_previous_context(self):
        inside = Action(simple_step_with_previous_context)
        inside._set_params()

        self.assertListEqual(inside.params, ["previous_context"])

    def test_set_params_initial_context(self):
        inside = Action(simple_step_with_initial_context)
        inside._set_params()

        self.assertListEqual(inside.params, ["initial_context"])

    def test_get_context_with_initial_context(self):
        input_value = {"initial_context": "bar"}

        inside = Action(simple_step_with_initial_context)
        inside.params = ["initial_context"]
        result = inside._get_context(kwargs=input_value)

        self.assertIsInstance(result["initial_context"], Context)
        self.assertEqual(result["initial_context"].storage, "bar")

    def test_get_context_with_previous_context(self):
        input_value = {"previous_context": "foo"}

        inside = Action(simple_step_with_previous_context)
        inside.params = ["previous_context"]
        result = inside._get_context(kwargs=input_value)

        self.assertIsInstance(result["previous_context"], Context)
        self.assertEqual(result["previous_context"].storage, "foo")

    def test_get_context_without_content(self):
        expected_value = {}

        inside = Action(simple_step)
        result = inside._get_context(kwargs=expected_value)

        self.assertEqual(result, expected_value)

    def test_get_context_without_context_params(self):
        mock_values = {"foo": True, "bar": True}

        inside = Action(simple_step_with_params)
        result = inside._get_context(kwargs=mock_values)

        self.assertEqual(result, {})