New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Don't stacktrace when calling unsupported plan functions through BoltSpec #2692

Closed

lucywyman opened this issue Mar 4, 2021 · 0 comments

Assignees

Labels

Bug

Contributor

lucywyman commented Mar 4, 2021 •

edited

Describe the Bug

How do we want to handle unsupported plan functions in BoltSpec, like parallelize? Require they be mocked?

For run_task_with just have an 'allow' and basically require that that be set, so that the return value is mocked. Either a limited mock, or something that's not too unwieldy (since run_task_with return objects can be pretty large)

For parallelize, when 'round_robin' gets called define in the mock_executor to run things in order. If it's easier to run through actual round_robin we can probably do that since tasks shouldn't be delayed.

Part of this should be verifying that there aren't any other executor functions that need to be defined or handled in the mock executor.

It would be good to see if we can automate scanning the executor and verifying that anything is either marked private or defined in the mock executor, but if that breaks tests or takes more than half a day to implement it isn't a strict requirement for this ticket.

The text was updated successfully, but these errors were encountered:

lucywyman added the Bug label

lucywyman added this to 📝 To Do in Bolt Kanban via automation

beechtom self-assigned this

beechtom moved this from 📝 To Do to ⚡️ Doing in Bolt Kanban

beechtom added a commit to beechtom/bolt that referenced this issue


          (puppetlabsGH-2692) Add test for BoltSpec mock executor method defini…

6710d0b

…tions

This adds a test that checks that all public methods on the
`Bolt::Executor` class are defined on the
`BoltSpec::Plans::MockExecutor` class. This is to ensure that if tests
run with BoltSpec invoke any methods on the executor that it will not
result in an "undefined method" error.

!no-release-note

beechtom added a commit to beechtom/bolt that referenced this issue


          (puppetlabsGH-2692) Support 'run_task_with' in BoltSpec

c2c0646

This adds support for testing plans that use the `run_task_with()` plan
function to BoltSpec. When BoltSpec runs a plan with this function, it
will execute a separate task run for each target. Users making
assertions about tasks run with `run_task_with()` should make an
assertion about each individual target that the task runs against, or an
assertion about the number of times that the task is run. This includes
an example in the 'Testing plans' documentation that details how to test
these types of plans.

!feature

* **Test plans that use `run_task_with()` plan function in BoltSpec*
  ([puppetlabs#2692](puppetlabs#2692))

  Plans that use the `run_task_with()` plan function can now be tested
  with BoltSpec.

beechtom added a commit to beechtom/bolt that referenced this issue


          (puppetlabsGH-2692) Support 'parallelize' in BoltSpec

11fabdf

This adds support for testing plans that use the `parallelize()` plan
function in BoltSpec. The block passed to the function is evaluated
using each object sequentially instead of in parallel.

!feature

* **Test plans that use `parallelize()` plan function in BoltSpec**
  ([puppetlabs#2692](puppetlabs#2692))

  Plans that use the `parallelize()` plan function can now be tested
  with BoltSpec.

beechtom mentioned this issue

(GH-2692) Support 'run_task_with' and 'parallelize' in BoltSpec #2724

Merged

4 tasks

beechtom added a commit to beechtom/bolt that referenced this issue


          (puppetlabsGH-2692) Add test for BoltSpec mock executor method defini…

bfa6486

…tions

This adds a test that checks that all public methods on the
`Bolt::Executor` class are defined on the
`BoltSpec::Plans::MockExecutor` class. This is to ensure that if tests
run with BoltSpec invoke any methods on the executor that it will not
result in an "undefined method" error.

!no-release-note

beechtom added a commit to beechtom/bolt that referenced this issue


          (puppetlabsGH-2692) Support 'run_task_with' in BoltSpec

88bdd64

This adds support for testing plans that use the `run_task_with()` plan
function to BoltSpec. When BoltSpec runs a plan with this function, it
will execute a separate task run for each target. Users making
assertions about tasks run with `run_task_with()` should make an
assertion about each individual target that the task runs against, or an
assertion about the number of times that the task is run. This includes
an example in the 'Testing plans' documentation that details how to test
these types of plans.

!feature

* **Test plans that use `run_task_with()` plan function in BoltSpec*
  ([puppetlabs#2692](puppetlabs#2692))

  Plans that use the `run_task_with()` plan function can now be tested
  with BoltSpec.

beechtom added a commit to beechtom/bolt that referenced this issue


          (puppetlabsGH-2692) Support 'parallelize' in BoltSpec

f7cd7bf

This adds support for testing plans that use the `parallelize()` plan
function in BoltSpec. The block passed to the function is evaluated
using each object sequentially instead of in parallel.

!feature

* **Test plans that use `parallelize()` plan function in BoltSpec**
  ([puppetlabs#2692](puppetlabs#2692))

  Plans that use the `parallelize()` plan function can now be tested
  with BoltSpec.

beechtom added a commit to beechtom/bolt that referenced this issue


          (puppetlabsGH-2692) Add test for BoltSpec mock executor method defini…

0b1f4c4

…tions

This adds a test that checks that all public methods on the
`Bolt::Executor` class are defined on the
`BoltSpec::Plans::MockExecutor` class. This is to ensure that if tests
run with BoltSpec invoke any methods on the executor that it will not
result in an "undefined method" error.

!no-release-note

beechtom added a commit to beechtom/bolt that referenced this issue


          (puppetlabsGH-2692) Support 'run_task_with' in BoltSpec

323731e

This adds support for testing plans that use the `run_task_with()` plan
function to BoltSpec. When BoltSpec runs a plan with this function, it
will execute a separate task run for each target. Users making
assertions about tasks run with `run_task_with()` should make an
assertion about each individual target that the task runs against, or an
assertion about the number of times that the task is run. This includes
an example in the 'Testing plans' documentation that details how to test
these types of plans.

!feature

* **Test plans that use `run_task_with()` plan function in BoltSpec*
  ([puppetlabs#2692](puppetlabs#2692))

  Plans that use the `run_task_with()` plan function can now be tested
  with BoltSpec.

beechtom added a commit to beechtom/bolt that referenced this issue


          (puppetlabsGH-2692) Support 'parallelize' in BoltSpec

2c806ec

This adds support for testing plans that use the `parallelize()` plan
function in BoltSpec. The block passed to the function is evaluated
using each object sequentially instead of in parallel.

!feature

* **Test plans that use `parallelize()` plan function in BoltSpec**
  ([puppetlabs#2692](puppetlabs#2692))

  Plans that use the `parallelize()` plan function can now be tested
  with BoltSpec.

beechtom added a commit to beechtom/bolt that referenced this issue


          (puppetlabsGH-2692) Add test for BoltSpec mock executor method defini…

c2d3d1b

…tions

This adds a test that checks that all public methods on the
`Bolt::Executor` class are defined on the
`BoltSpec::Plans::MockExecutor` class. This is to ensure that if tests
run with BoltSpec invoke any methods on the executor that it will not
result in an "undefined method" error.

!no-release-note

beechtom added a commit to beechtom/bolt that referenced this issue


          (puppetlabsGH-2692) Support 'run_task_with' in BoltSpec

9e2e09e

This adds support for testing plans that use the `run_task_with()` plan
function to BoltSpec. When BoltSpec runs a plan with this function, it
will execute a separate task run for each target. Users making
assertions about tasks run with `run_task_with()` should make an
assertion about each individual target that the task runs against, or an
assertion about the number of times that the task is run. This includes
an example in the 'Testing plans' documentation that details how to test
these types of plans.

!feature

* **Test plans that use `run_task_with()` plan function in BoltSpec*
  ([puppetlabs#2692](puppetlabs#2692))

  Plans that use the `run_task_with()` plan function can now be tested
  with BoltSpec.

beechtom moved this from ⚡️ Doing to 🚧 Reviewing in Bolt Kanban

beechtom added a commit to beechtom/bolt that referenced this issue


          (puppetlabsGH-2692) Add test for BoltSpec mock executor method defini…

4f134e7

…tions

This adds a test that checks that all public methods on the
`Bolt::Executor` class are defined on the
`BoltSpec::Plans::MockExecutor` class. This is to ensure that if tests
run with BoltSpec invoke any methods on the executor that it will not
result in an "undefined method" error.

!no-release-note

beechtom added a commit to beechtom/bolt that referenced this issue


          (puppetlabsGH-2692) Support 'run_task_with' in BoltSpec

b3e78e8

This adds support for testing plans that use the `run_task_with()` plan
function to BoltSpec. When BoltSpec runs a plan with this function, it
will execute a separate task run for each target. Users making
assertions about tasks run with `run_task_with()` should make an
assertion about each individual target that the task runs against, or an
assertion about the number of times that the task is run. This includes
an example in the 'Testing plans' documentation that details how to test
these types of plans.

!feature

* **Test plans that use `run_task_with()` plan function in BoltSpec*
  ([puppetlabs#2692](puppetlabs#2692))

  Plans that use the `run_task_with()` plan function can now be tested
  with BoltSpec.

lucywyman added a commit that referenced this issue


          Merge pull request #2724 from beechtom/2692/boltspec-functions

6e8981f

(GH-2692) Support 'run_task_with' and 'parallelize' in BoltSpec

lucywyman removed this from 🚧 Reviewing in Bolt Kanban

lucywyman closed this as completed

lucywyman pushed a commit to lucywyman/bolt that referenced this issue


          (puppetlabsGH-2692) Add test for BoltSpec mock executor method defini…

54e7a22

…tions

This adds a test that checks that all public methods on the
`Bolt::Executor` class are defined on the
`BoltSpec::Plans::MockExecutor` class. This is to ensure that if tests
run with BoltSpec invoke any methods on the executor that it will not
result in an "undefined method" error.

!no-release-note

lucywyman pushed a commit to lucywyman/bolt that referenced this issue


          (puppetlabsGH-2692) Support 'run_task_with' in BoltSpec

6fc32a3

This adds support for testing plans that use the `run_task_with()` plan
function to BoltSpec. When BoltSpec runs a plan with this function, it
will execute a separate task run for each target. Users making
assertions about tasks run with `run_task_with()` should make an
assertion about each individual target that the task runs against, or an
assertion about the number of times that the task is run. This includes
an example in the 'Testing plans' documentation that details how to test
these types of plans.

!feature

* **Test plans that use `run_task_with()` plan function in BoltSpec*
  ([puppetlabs#2692](puppetlabs#2692))

  Plans that use the `run_task_with()` plan function can now be tested
  with BoltSpec.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment