Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

RSS

kitchen-test-helper (2) Versions 1.0.0

Suite of chef/kitchen testing tools

Berkshelf/Librarian
Policyfile
Knife
cookbook 'kitchen-test-helper', '= 1.0.0'
cookbook 'kitchen-test-helper', '= 1.0.0', :supermarket
knife cookbook site install kitchen-test-helper
knife cookbook site download kitchen-test-helper
README
Dependencies
Changelog
Quality -%

kitchen-test-helper

This cookbook provides a suite of tools to assist with testing chef cookbooks when using test-kitchen and serverspec.

Build Status: Build Status

Node Attributes Dump

Including this cookbook will create a .json file with the contents of all of the current node's attributes. The contents of the variables can then be used within your serverspec tests.

How to use

Include in Berksfile: ```ruby source 'https://supermarket.chef.io'

metadata

group :integration do cookbook 'kitchen-test-helper' end ```

Add kitchen-test-helper to the top of the run list in the .kitchen.yml configuration:

```ruby

driver: name: vagrant

provisioner: name: chef_zero

platforms: - name: centos-6.6

suites: - name: default run_list: - recipe[kitchen-test-helper] - recipe[<<<<>>>>>] ```

Use the following spec_helper.rb file when attempting to use node attributes within serverspec tests. It will correctly configure the backend for either windows or linux systems, as well as set the $node variable with the contents of the dumped node.json file. ```ruby require 'serverspec' require 'pathname' require 'json'

if ENV['OS'] == 'Windows_NT' set :backend, :cmd # On Windows, set the target host's OS explicitely set :os, :family => 'windows' $node = ::JSON.parse(File.read('c:\windows\temp\serverspec\node.json')) else set :backend, :exec $node = ::JSON.parse(File.read('/tmp/serverspec/node.json')) end

set :path, '/sbin:/usr/local/sbin:$PATH' unless os[:family] == 'windows' ```

How to use the node's variables in serverspec tests: ```ruby describe file("#{$node['python']['prefix_dir']}/bin/python2.7") do it { should exist } end

describe file("#{$node['nginx']['dir']}/www") do it { should exist } it { should be_directory } it { should be_mode 755 } it { should be_owned_by "#{$node['nginx']['user']}" } it { should be_grouped_into "#{$node['nginx']['group']}" } end ```

Databag Faker

Some cookbooks require databags to be created in order for the cookbook to correctly be ran.

This recipe will build a databag, place it in the correct local databag location, and allow future cookbooks to use the created databags as if they had been read from a chef server.

To use this recipe, include it in your kitchen.yml run_list, before any other recipes:

---
driver:
  name: vagrant

provisioner:
  name: chef_zero

platforms:
  - name: centos-6.6

suites:
  - name: default
    run_list:
      - recipe['kitchen-test-helper']
      - recipe[<<<<>>>>>]
Creating Faked Databags

To add a databag, add fake_databags to the attributes in your kitchen.yml following the example below. This will create a databag item named tuser.json and will put it in the users databag.

---
driver:
  name: vagrant

provisioner:
  name: chef_zero

platforms:
  - name: centos-6.6

suites:
  - name: default
    run_list:
      - recipe['kitchen-test-helper']
      - recipe[<<<<>>>>>]
    attributes:
        fake_databags:
          - data_bag: 'users'
            content:
                id: 'tuser'
                user.first_name: 'test'
                user.last_name: 'user'
                user.email: 'test_user@test.com'

The resulting databag (users/tuser) would look like this: Json { "id": "tuser", "user.first_name": "test", "user.last_name": "user", "user.email": "test_user@test.com" }

Creating Faked Databags with Secure Content

Some recipes require an SSH key, or other secure information that we do not want committed to github.

Following the same example as above, we will add a data_bag item to the fake_databags array, but this time we will include a key that has an environment variable setting it's value.

First we need to export the environment variable: Bash export ENV_VARIABLE_NAME="{{VARIABLE CONTENT}}"

Example: Bash export TEST_GIT_SSH_KEY="FakeKeyValueFakeKeyValue"

suites:
  - name: default
    run_list:
      - recipe['kitchen-test-helper']
      - recipe[<<<<>>>>>]
    attributes:
      fake_databags:
        - data_bag: 'git-credentials'
          content:
            id: 'test'
            key: "<%= ENV['TEST_GIT_SSH_KEY'] %>"
            user.name: 'TestUser'
            user.email: 'testuser@gmail.com'

The resulting databag (git-credentials/test) would look like this: Json { "id": "test", "key": "FakeKeyValueFakeKeyValue", "user.name": "TestUser", "user.email": "testuser@gmail.com" }

Multiple Databags

To create multiple databags within the same 'kitchen.yml', follow this example: This will create a databag named test.json within the git-credentials folder, as well as a databag named test2.json within the aws-credentials folder.

suites:
  - name: default
    run_list:
      - recipe['kitchen-test-helper']
      - recipe[<<<<>>>>>]
    attributes:
      fake_databags:
        - data_bag: 'git-credentials'
          content:
              id: 'test'
              key: "FakeKeyValueFakeKeyValue"
              user.name: 'TestUser'
              user.email: 'testuser@gmail.com'
        - data_bag: 'aws-credentials'
          content:
              id: 'test2'
              key: "FakeKeyValueFakeKeyValue"
              user.name: 'TestUser2'
              user.email: 'testuser2@gmail.com’

The resulting databags would look like this:

git-credentials/test
{
    "id": "test",
    "key": "FakeKeyValueFakeKeyValue",
    "user.name": "TestUser",
    "user.email": "testuser@gmail.com"
}
aws-credentials/test2
{
    "id": "test2",
    "key": "FakeKeyValueFakeKeyValue",
    "user.name": "TestUser2",
    "user.email": "testuser2@gmail.com"
}

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

kitchen-test-helper CHANGELOG

This file is used to list changes made in each version of the gdp-base-linux cookbook.

1.0.0

kbvincent - Initial Release of kitchen-test-helper cookbook.

No quality metric results found