File: step.async_steps.feature

package info (click to toggle)
behave 1.2.6-6
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,160 kB
  • sloc: python: 19,857; makefile: 137; sh: 18
file content (226 lines) | stat: -rw-r--r-- 8,551 bytes parent folder | download | duplicates (3)
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
@not.with_python2=true
Feature: Async-Test Support (async-step, ...)

  As a test writer and step provider
  I want to test async frameworks or protocols (that use asyncio)

  . USE CASES:
  .   * async-step with run-to-complete semantics (like synchronous step)
  .   * async-dispatch-and-collect-results-later:
  .     one or more steps dispatch async-calls (tasks)
  .     and final step(s) that waits until tasks have been completed
  .     (collects the results of the async-calls and verifies them)
  .
  . TERMINOLOGY: async-step
  .  An async-step is either
  .    * an async-function as coroutine using async/await keywords (Python 3.5)
  .    * an async-function tagged with @asyncio.coroutine and using "yield from"
  .
  .  # -- EXAMPLE CASE 1 (since Python 3.5):
  .  async def coroutine1(duration):
  .      await asyncio.sleep(duration)
  .
  .  # -- EXAMPLE CASE 2 (since Python 3.4):
  .  @asyncio.coroutine
  .  def coroutine2(duration):
  .      yield from asyncio.sleep(duration)
  .
  . RATIONALE:
  .   By using async-steps, an additional layer of indirection is avoided.
  .   The async-step can directly interact with other async-functions.


    @use.with_python.version=3.5
    @use.with_python.version=3.6
    Scenario: Use async-step with @async_run_until_complete (async)
      Given a new working directory
      And a file named "features/steps/async_steps35.py" with:
        """
        from behave import step
        from behave.api.async_step import async_run_until_complete
        import asyncio

        @step('an async-step waits {duration:f} seconds')
        @async_run_until_complete
        async def step_async_step_waits_seconds(context, duration):
            await asyncio.sleep(duration)
        """
      And a file named "features/async_run.feature" with:
        """
        Feature:
          Scenario:
            Given an async-step waits 0.2 seconds
        """
      When I run "behave -f plain --show-timings features/async_run.feature"
      Then it should pass with:
        """
        Feature:
           Scenario:
             Given an async-step waits 0.2 seconds ... passed in 0.2
        """


    @use.with_python.version=3.4
    @use.with_python.version=3.5
    @use.with_python.version=3.6
    Scenario: Use async-step with @async_run_until_complete (@coroutine)
      Given a new working directory
      And a file named "features/steps/async_steps34.py" with:
        """
        from behave import step
        from behave.api.async_step import async_run_until_complete
        import asyncio

        @step('an async-step waits {duration:f} seconds')
        @async_run_until_complete
        @asyncio.coroutine
        def step_async_step_waits_seconds2(context, duration):
            yield from asyncio.sleep(duration)
        """
      And a file named "features/async_run.feature" with:
        """
        Feature:
          Scenario:
            Given an async-step waits 0.3 seconds
        """
      When I run "behave -f plain --show-timings features/async_run.feature"
      Then it should pass with:
        """
        Feature:
           Scenario:
             Given an async-step waits 0.3 seconds ... passed in 0.3
        """

    @use.with_python.version=3.5
    @use.with_python.version=3.6
    Scenario: Use @async_run_until_complete(timeout=...) and TIMEOUT occurs (async)
      Given a new working directory
      And a file named "features/steps/async_steps_timeout35.py" with:
        """
        from behave import step
        from behave.api.async_step import async_run_until_complete
        import asyncio

        @step('an async-step waits {duration:f} seconds with timeout')
        @async_run_until_complete(timeout=0.1)  # BAD-TIMEOUT-BY-DESIGN
        async def step_async_step_waits_seconds_with_timeout35(context, duration):
            await asyncio.sleep(duration)
        """
      And a file named "features/async_timeout35.feature" with:
        """
        Feature:
          Scenario:
            Given an async-step waits 1.0 seconds with timeout
        """
      When I run "behave -f plain --show-timings features/async_timeout35.feature"
      Then it should fail with:
        """
        0 steps passed, 1 failed, 0 skipped, 0 undefined
        """
      And the command output should contain:
        """
        Given an async-step waits 1.0 seconds with timeout ... failed in 0.1
        """
      And the command output should contain:
        """
        Assertion Failed: TIMEOUT-OCCURED: timeout=0.1
        """

    @use.with_python.version=3.4
    @use.with_python.version=3.5
    @use.with_python.version=3.6
    Scenario: Use @async_run_until_complete(timeout=...) and TIMEOUT occurs (@coroutine)
      Given a new working directory
      And a file named "features/steps/async_steps_timeout34.py" with:
        """
        from behave import step
        from behave.api.async_step import async_run_until_complete
        import asyncio

        @step('an async-step waits {duration:f} seconds with timeout')
        @async_run_until_complete(timeout=0.2)  # BAD-TIMEOUT-BY-DESIGN
        @asyncio.coroutine
        def step_async_step_waits_seconds_with_timeout34(context, duration):
            yield from asyncio.sleep(duration)
        """
      And a file named "features/async_timeout34.feature" with:
        """
        Feature:
          Scenario:
            Given an async-step waits 1.0 seconds with timeout
        """
      When I run "behave -f plain --show-timings features/async_timeout34.feature"
      Then it should fail with:
        """
        0 steps passed, 1 failed, 0 skipped, 0 undefined
        """
      And the command output should contain:
        """
        Given an async-step waits 1.0 seconds with timeout ... failed in 0.2
        """
      And the command output should contain:
        """
        Assertion Failed: TIMEOUT-OCCURED: timeout=0.2
        """

    @use.with_python.version=3.4
    @use.with_python.version=3.5
    @use.with_python.version=3.6
    Scenario: Use async-dispatch and async-collect concepts
      Given a new working directory
      And a file named "features/steps/async_dispatch_steps.py" with:
        """
        from behave import given, then, step
        from behave.api.async_step import use_or_create_async_context, AsyncContext
        from hamcrest import assert_that, equal_to, empty
        import asyncio

        @asyncio.coroutine
        def async_func(param):
            yield from asyncio.sleep(0.2)
            return str(param).upper()

        @given('I dispatch an async-call with param "{param}"')
        def step_dispatch_async_call(context, param):
            async_context = use_or_create_async_context(context, "async_context1")
            task = async_context.loop.create_task(async_func(param))
            async_context.tasks.append(task)

        @then('the collected result of the async-calls is "{expected}"')
        def step_collected_async_call_result_is(context, expected):
            async_context = context.async_context1
            done, pending = async_context.loop.run_until_complete(
                asyncio.wait(async_context.tasks, loop=async_context.loop))

            parts = [task.result() for task in done]
            joined_result = ", ".join(sorted(parts))
            assert_that(joined_result, equal_to(expected))
            assert_that(pending, empty())
        """
      And a file named "features/async_dispatch.feature" with:
        """
        Feature:
          Scenario:
            Given I dispatch an async-call with param "Alice"
            And   I dispatch an async-call with param "Bob"
            Then the collected result of the async-calls is "ALICE, BOB"
        """
      When I run "behave -f plain --show-timings features/async_dispatch.feature"
      Then it should pass with:
        """
        3 steps passed, 0 failed, 0 skipped, 0 undefined
        """
      And the command output should contain:
        """
        Given I dispatch an async-call with param "Alice" ... passed in 0.00
        """
      And the command output should contain:
        """
        And I dispatch an async-call with param "Bob" ... passed in 0.00
        """
      And the command output should contain:
        """
        Then the collected result of the async-calls is "ALICE, BOB" ... passed in 0.2
        """
      But note that "the async-collect step waits 0.2 seconds for both async-tasks to finish"
      And note that "the async-dispatch steps do not wait at all"