task to check if puppet resources have a spec described

[h0tw1r3]

Anyone interested in this?
Request for comment / improvements / toss it out?

Example:

$ pdk bundle exec rake spec_described[90]
pdk (INFO): Using Ruby 3.2.2
pdk (INFO): Using Puppet 8.4.0
===> rake: spec_described
Spec described coverage: 92.9%
  * 4 defines: 100.0%
  * 21 classes: 95.2%
    missing:
    - puppetdb::something
    unknown:
    - something in spec/classes/whoknows_spec.rb
  * 1 type_alias: 0.0%
    missing:
    - Puppetdb::Ttl
  * 2 functions: 100.0%

[codecov]

Codecov Report

Attention: Patch coverage is 16.66667% with 20 lines in your changes missing coverage. Please review.

Project coverage is 40.85%. Comparing base (e3b7546) to head (d49de85).
Report is 72 commits behind head on main.

Files with missing lines	Patch %	Lines
lib/puppetlabs_spec_helper/rake_tasks.rb	16.66%	20 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #439      +/-   ##
==========================================
- Coverage   41.71%   40.85%   -0.86%     
==========================================
  Files          10       10              
  Lines         676      700      +24     
==========================================
+ Hits          282      286       +4     
- Misses        394      414      +20     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[ekohl]

I like the idea, but I don't want to test my private classes (like $module::params). Sadly you can only declare a class as private using puppet-strings so that may be hard with your existing code.

Overall puppet-strings can already parse and extract the various types, which is probably better than using regular expressions. Any thoughts on using puppet-strings to generate a list of all resources?

[h0tw1r3]

Overall puppet-strings can already parse and extract the various types, which is probably better than using regular expressions. Any thoughts on using puppet-strings to generate a list of all resources?

Thanks for the feedback. I'll check it out, cheers!

[gavindidrichsen]

Hi @h0tw1r3. We all like this on devx, so kicked off a discussion #442

[bastelfreak]

I like this and share the same opinion as @ekohl . I think this would be a helpful addition to puppetlabs_spec_helper.