Menu

Chef Supermarket

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.

View our collection of guides, documentation, and articles

Cookbooks
Advanced Options

Select Badges

Select Supported Platforms

Select Status

RSS

stow (13) Versions 2.0.0

Installs GNU Stow & provides stow_package resource

Policyfile
Berkshelf
Knife 
cookbook 'stow', '~> 2.0.0', :supermarket
cookbook 'stow', '~> 2.0.0'
knife supermarket install stow
knife supermarket download stow
README
Dependencies
Quality 17%

stow (Chef cookbook)

Cookbook Version
Build Status
Code Climate

Description

A simple chef cookbook to install GNU stow
via package management or source if a package is not available.

Attributes

  • ['stow']['path'] = '/usr/local/stow' path stow command uses for symlinking packages and libraries
  • ['stow']['target'] = nil target directory for stow managed symlinks, defaults to stow path's parent directory if nil
  • ['stow']['version'] = '2.2.0' version of stow to install for source installations
  • ['stow']['src_url'] = 'http://ftp.gnu.org/gnu/stow/stow-2.2.0.tar.gz' URL for latest stow source tarball
  • ['stow']['rpm_url'] = nil # 'http://dl.fedoraproject.org/pub/epel/6/i386/stow-2.2.0-1.el6.noarch.rpm' Default is nil and uses yum, but you can specify an alternative rpm package by URL
  • ['stow']['deb_url'] = nil # 'http://mirrors.kernel.org/ubuntu/pool/universe/s/stow/stow_2.2.0-2_all.deb' Default is nil and uses apt, but you can specify an alternative deb package by URL
  • ['stow']['profile.d']['mode'] = nil Default is nill which will set permissions to the default system level

Usage

Add the recipes to the run_list, it should probably be towards the beginning:

"recipe[stow]"

Configure attributes:

"stow" : {
  "path" : "/opt/local/stow",
  "version" : "2.2.0"
}

Resources Provided

The stow cookbook provides a stow_package resource that can be used as follows:

stow_package 'openssl' do
  name    'openssl'
  version '1.0.2d'
  creates 'bin/openssl' # *Required* relative path to a file your source compiled package creates
  #action :stow # Also available `:destow`, the default action is `:stow`
  #destow_existing true # Defaults to `true` and will destow all out of date packages with prefix "#{name}-+-"
  #current_version '1.0.2c' # Destows `current_version` before `version` is stowed; ignored unless `destow_existing` is `false`
end

NOTE: This cookbook expects you to compile your packages with the following prefix convention:

#{node['stow']['path']}/#{package_name}-+-#{version}/

For the example above, you would compile openssl with the prefix:

--prefix #{node['stow']['path']}/openssl-+-1.0.2d/

If your package / library works with the tar cookbook there's a very easy way to do this, like so:

# Compile your package via the tar cookbook with proper prefix
tar_package "#{tarball_path_or_url}" do
  prefix "#{node['stow']['path']}/#{your_pkg_name}-+-#{your_pkg_version}"
  creates "#{node['stow']['path']}/#{your_pkg_name}-+-#{your_pkg_version}/#{path/to/pkg/file}"
end

# Stow your package
stow_package "#{your_pkg_name}" do
  name    "#{your_pkg_name}"
  version "#{your_pkg_version}"
  creates 'path/to/pkg/file' # Note the relative path vs full path for `tar_package`
end

ChefSpec Matchers

A set of ChefSpec matchers is included, for unit testing with ChefSpec. To illustrate:

# Recipe code
stow_package 'openssl' do
  name    'openssl'
  version '1.0.2d'
  creates 'bin/openssl'
end

# Spec code
it 'should stow openssl version 1.0.2d' do
  expect(chef_run).to stow_package('openssl').with(
    name:    'openssl',
    version: '1.0.2d',
    creates: 'bin/openssl'
  )
  # Stow package wraps the execute resource if you want further validation
  expect(chef_run).to run_execute('stow_openssl-1.0.2d')
end

A matcher for the delete action is also available:

# Recipe code
stow_package 'openssl' do
  action  :destow
  name    'openssl'
  version '1.0.2c'
  creates 'bin/openssl'
end

# Spec code
it 'should destow package openssl 1.0.2c' do
  expect(chef_run).to destow_package('openssl').with(
    action:  :destow,
    name:    'openssl',
    version: '1.0.2c',
    creates: 'bin/openssl'
  )
  # Stow package wraps the execute resource if you want further validation
  expect(chef_run).to run_execute('destow_openssl-1.0.2c')
end

Dependent cookbooks

apt >= 0.0.0
build-essential >= 0.0.0
tar >= 0.0.0
yum-epel >= 0.0.0

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

Collaborator Number Metric 
            
2.0.0 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric 
            
2.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Foodcritic Metric 
            
2.0.0 failed this metric
FC085: Resource using new_resource.updated_by_last_action to converge resource: stow/providers/package.rb:25
FC085: Resource using new_resource.updated_by_last_action to converge resource: stow/providers/package.rb:40
FC122: Use the build_essential resource instead of the recipe: stow/recipes/_debian.rb:2
FC122: Use the build_essential resource instead of the recipe: stow/recipes/_fedora.rb:1
FC122: Use the build_essential resource instead of the recipe: stow/recipes/_rhel.rb:2
FC122: Use the build_essential resource instead of the recipe: stow/recipes/source.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

No Binaries Metric 
            
2.0.0 passed this metric

Testing File Metric 
            
2.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric 
            
2.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number

Steven Haddox Steven Haddox

Details

View Source View Issues

Updated March 29, 2017 Created on

Supported Platforms

  • centos >= 0.0.0
  • fedora >= 0.0.0
  • debian >= 0.0.0
  • ubuntu >= 0.0.0
  • redhat >= 0.0.0
  • scientific >= 0.0.0

License

MIT

Download Cookbook