Cookbook breaks in Chef < 13 because of apt cookbook dependency

thisisjaid commented 6 years ago

Expected Behavior

Cookbook should run on Chef version 12 and lower.

Current Behavior

Compiling Cookbooks...

================================================================================
Recipe Compile Error in /var/chef/cache/cookbooks/altmetric-sensu/recipes/client.rb
================================================================================

NoMethodError
-------------
No resource or method named `apt_preference' for `Chef::Recipe "_linux"'

Cookbook Trace:
---------------
  /var/chef/cache/cookbooks/sensu/recipes/_linux.rb:35:in `from_file'
  /var/chef/cache/cookbooks/sensu/recipes/default.rb:34:in `from_file'
  /var/chef/cache/cookbooks/altmetric-sensu/recipes/client.rb:10:in `from_file'

Relevant File Content:
----------------------
/var/chef/cache/cookbooks/sensu/recipes/_linux.rb:

 28:      key node['sensu']['apt_key_url']
 29:      distribution node["sensu"]["apt_repo_codename"] || node["lsb"]["codename"]
 30:      components node["sensu"]["use_unstable_repo"] ? ["unstable"] : ["main"]
 31:      action :add
 32:      only_if { node["sensu"]["add_repo"] }
 33:    end
 34:  
 35>>   apt_preference "sensu" do
 36:      pin "version #{node['sensu']['version']}"
 37:      pin_priority "700"
 38:    end
 39:  
 40:    package_options = '--force-yes -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confnew"'
 41:  
 42:    package "sensu" do
 43:      version node["sensu"]["version"]
 44:      options package_options

System Info:
------------
chef_version=12.21.31

Possible Solution

Problematic because Chef doesn't support multiple version constraints, but ideally apt dependency needs to be pinned to < 7.0 where they have removed the apt_preference method completely and became Chef 13.3 exclusive.

Steps to Reproduce (for bugs)

Run the sensu default recipe on any Chef install < 13.3

Context

Breaks cookbook functionality completely.

Your Environment

System Info:
------------
chef_version=12.21.31
platform=ubuntu
platform_version=16.04
ruby=ruby 2.3.5p376 (2017-09-14 revision 59905) [x86_64-linux]
program_name=chef-client worker: ppid=23768;start=15:29:56;
executable=/opt/chef/bin/chef-client

tas50 commented 6 years ago

Chef 12 is officially end of life at this point since Chef 14 shipped. You're going to see a large part of the Chef ecosystem begin to drop support for Chef 12. If you still want to continue to use it you'll need to pin apt on your own. It's pretty easy to do this either in your environment or in a wrapper cookbook, but that's really outside the scope of this cookbook. Pinning here would just break users of currently supported Chef releases who wanted to pull down the latest cookbooks.

thisisjaid commented 6 years ago

That's fair enough, but the Readme should be in any case updated to reflect that this cookbook doesn't support Chef 12 anymore and is Chef 13+. We've pinned the apt cookbook for now and we're in the process of moving to 14 anyway, but this was still a pretty sudden break.

anherrera commented 6 years ago

Updating your metadata.rb to reflect this dependency would be a start. The master branch still says chef_version '>= 12.14'.

Also, despite pinning an older version of this cookbook (4.0.6), presumably before you dropped support for Chef 12, I still ran into this issue. It only worked when I manually pinned all of my dependencies to known good versions.

If you're saying that NO versions of this cookbook work on Chef 12 any more, that's one thing, but if older versions are still supposed to work on 12 and they're not that's still an issue. Suddenly breaking and then telling people to pin their apt cookbook manually is pretty crappy. You should be responsible for pinning the right versions of your dependencies in your metadata.rb for each cookbook version. And >= is not good enough.