library requires gem chef-vault but cookbook does not specify it

[kevin-j-smith]

Cookbook version

[Version of the cookbook where you are encountering the issue] Using chef-vault (4.0.0)

Chef-client version

[Version of chef-client in your environment] Test Kitchen version 1.25.0

Platform Details

[Operating system distribution and release version. Cloud provider if running in the cloud] OEL 6.10

Scenario:

[What you are trying to achieve and you can't?]

       Compiling Cookbooks...

       ================================================================================
       Recipe Compile Error in /tmp/kitchen/cache/cookbooks/chef-vault/libraries/helpers.rb
       ================================================================================

       LoadError
       ---------
       cannot load such file -- chef-vault

       Cookbook Trace:
       ---------------
         /tmp/kitchen/cache/cookbooks/chef-vault/libraries/helpers.rb:22:in `<top (required)>'

       Relevant File Content:
       ----------------------
       /tmp/kitchen/cache/cookbooks/chef-vault/libraries/helpers.rb:

        15:  #
        16:  # Unless required by applicable law or agreed to in writing, software
        17:  # distributed under the License is distributed on an "AS IS" BASIS,
        18:  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        19:  # See the License for the specific language governing permissions and
        20:  # limitations under the License.
        21:  
        22>> require 'chef-vault'
        23:  
        24:  module ChefVaultCookbook
        25:    # Helper method which provides a Recipe/Resource DSL for wrapping
        26:    # creation of {ChefVault::Item}.
        27:    # @note
        28:    # Falls back to normal data bag item loading if the item is not
        29:    # actually a Chef Vault item. This is controlled via
        30:    # +node['chef-vault']['databag_fallback']+.
        31:    # @example

       Platform:
       ---------
       x86_64-linux

Steps to Reproduce:

[If you are filing an issue what are the things we need to do in order to repro your problem? How are you using this cookbook or any resources it includes?] depend on chef-vault causes this issue during kitchen run

Expected Result:

[What are you expecting to happen as the consequence of above reproduction steps?] When I put gem chef-vault within my metadata.rb file this issue does not reproduce. This cookbook should reference the gem so that it can be found within the dependency tree.

Actual Result:

[What actually happens after the reproduction steps? Include the error output or a link to a gist if possible.] :(

[welcomebot]

Hey There It looks like this is the first issue you've filed against the chef-cookbooks project. I'm here to offer you a bit of extra help to make sure we can quickly get back to you. Make sure you've filled out all the fields in our issue template. Make sure you've provided us with the version of chef-client you're running, your operating system and the version of the cookbook. If you're not using the most up to date version of the cookbook then please make sure to update first. Lots of things change between versions even if you're issue isn't listed in the changelog. Finally please give us a detailed description of the issue you're having. The more we know about what you're trying to do, what actually happens, and how you can reproduce the problem, the better.

If you're looking for more immediate troubleshooting help make sure to check out #general on the Chef Community Slack. There's plenty of folks there willing to lend a helping hand. Thanks for the first issue. We hope we can get back to you soon with a solution.

[jblaine]

You didn't specify what version of Chef you're running. See CHANGELOG.md quoted below. I suspect you're running an old unsupported version of chef-client.

4.0.0 (2020-01-02)
This cookkbook now requires Chef Infra Client 13.4+, which ships with the chef-vault gem out of the box. Since the gem is included out of the box we now skip the gem installation via the cookbook.

[yonasstephen]

Got the same error because I'm running this on Chef Infra 12.x.x. Probably worth a mention in the README. CHANGELOG is often overlooked especially for first time users