Skip to content

Refactor plugin specs to reduce boiler plate #697

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

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Refactor plugin specs to reduce boiler plate #697

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d75c132
Move plugin specs to their own directory
ekohl Aug 6, 2021
3acaaf4
Introduce a shared example for plugin testing
ekohl Aug 6, 2021
cfb5b8a
Add a describe_plugin helper
ekohl Aug 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 0 additions & 37 deletions spec/classes/foreman_proxy__plugin__abrt_spec.rb
View file
Open in desktop

This file was deleted.

20 changes: 0 additions & 20 deletions spec/classes/foreman_proxy__plugin__acd_spec.rb
View file
Open in desktop

This file was deleted.

125 changes: 0 additions & 125 deletions spec/classes/foreman_proxy__plugin__ansible_spec.rb
View file
Open in desktop

This file was deleted.

55 changes: 0 additions & 55 deletions spec/classes/foreman_proxy__plugin__chef__spec.rb
View file
Open in desktop

This file was deleted.

38 changes: 0 additions & 38 deletions spec/classes/foreman_proxy__plugin__container_gateway_spec.rb
View file
Open in desktop

This file was deleted.

21 changes: 21 additions & 0 deletions spec/classes/plugin/abrt_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
require 'spec_helper'

describe_plugin 'foreman_proxy::plugin::abrt' do
describe 'with default settings' do
include_examples 'a plugin with a settings file', 'abrt' do
let(:expected_config) { /:enabled: https/ }
Copy link
Member

@ehelms ehelms Aug 6, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally I like the examples tactic here as it simplifies the boilerplate. I think it can take some experience to unwind include_examples sometimes. I would probably prefer if each spec declared this in the same way with my preference being https://github.com/theforeman/puppet-foreman_proxy/pull/697/files#diff-622e312bc4439aacb45352c217bcd7880af426efd40e1e8f6dc27501eab16769R8-R14 because it makes it clear its a yaml file and declares it -- less mental overhead when reading through these or as developers copy/paste for new plugins.

Copy link
Member Author

@ekohl ekohl Aug 6, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For what it's worth, I kept the change minimal here. The old example was also this regex. I'm not opposed to an explicit long form everywhere, at least for default settings. For the case where we disable it and only want to ensure it's :enabled: false I think the regex form is still better.

end
end

describe 'with faf_ssl_* set' do
let :params do {
:faf_server_ssl_cert => '/faf_cert.pem',
:faf_server_ssl_key => '/faf_key.pem',
} end

include_examples 'a plugin with a settings file', 'abrt' do
# TODO: this is weaker than it was
let(:expected_config) { %r{:server_ssl_(cert|key): /faf_\1\.pem} }
end
end
end
9 changes: 9 additions & 0 deletions spec/classes/plugin/acd_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
require 'spec_helper'

describe_plugin 'foreman_proxy::plugin::acd' do
describe 'with default settings' do
include_examples 'a plugin with a settings file', 'acd' do
let(:expected_config) { "---\n:enabled: https\n" }
end
end
end
Loading