(#759) Add reference spec tests for sensu_check JSON provider #765
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jeffmccune
force-pushed
the
759_provider_spec_tests
branch
3 times, most recently
from
333cd55 to
1479c9f
Compare
Without this patch there are no spec tests for the sensu_check JSON provider. This is problem because a reference is needed to specify the expected behavior of all providers. This patch implements a pattern of stubbing out the filesystem. All reads and writes in the provider itself are routed through the `read_file` and `write_json_object` methods. The RSpec tests then use rspec-mocks to stub out the reads and set expectations on the output. This reference may be applied to any provider using the `flush` method. The setter methods in the provider for each property are expected to update state in an instance variable, conventionally named @property_flush but named @conf in the sensu_check provider. The flush method is responsible for writing out @property_flush (@conf), which we intercept and set expectations on the data provided. N.B. There is a bug with Rspec where the expected and actual values of multi-line strings will not have a nice diff output if the two strings disagree on the presence of the trailing newline. See https://github.com/rspec/rspec-support/issues/70 for more information. Because of this issue in combination with the use of IO#puts in the write_output class method, care should be taken with the examples to make sure the expected and actual values agree on the trailing newline. In this patch, the fixture data for the expected output is chomp()'ed to match the string passed to write_output(). Resolves sensu#759
jeffmccune
force-pushed
the
759_provider_spec_tests
branch
from
1479c9f to
6fb1efd
Compare
|
Released in v2.28.0 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Without this patch there are no spec tests for the sensu_check JSON provider.
This is problem because a reference is needed to specify the expected behavior
of all providers.
This patch implements a pattern of stubbing out the filesystem. All reads and
writes in the provider itself are routed through the
read_fileandwrite_json_objectmethods. The RSpec tests then use rspec-mocks to stub outthe reads and set expectations on the output.
This reference may be applied to any provider using the
flushmethod. Thesetter methods in the provider for each property are expected to update state
in an instance variable, conventionally named @property_flush but named @conf
in the sensu_check provider. The flush method is responsible for writing out
@property_flush (@conf), which we intercept and set expectations on the data
provided.
Resolves #759