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

Select Status

RSS

line (83) Versions 1.2.0

Provides line editing resources for use by recipes

Policyfile
Berkshelf
Knife
cookbook 'line', '= 1.2.0', :supermarket
cookbook 'line', '= 1.2.0'
knife supermarket install line
knife supermarket download line
README
Dependencies
Changelog
Quality 50%

line cookbook

Build Status

Motivation

Quite often, the need arises to do line editing instead of managing an
entire file with a template resource. This cookbook supplies various
resources that will help you do this.

Usage

Add "depends 'line'" to your cookbook's metadata.rb to gain access to
the resoures.

append_if_no_line "make sure a line is in some file" do
  path "/some/file"
  line "HI THERE I AM STRING"
end

replace_or_add "why hello" do
  path "/some/file"
  pattern "Why hello there.*"
  line "Why hello there, you beautiful person, you."
end

delete_lines "remove hash-comments from /some/file" do
  path "/some/file"
  pattern "^#.*"
end

delete_lines "remove hash-comments from /some/file with a regexp" do
  path "/some/file"
  pattern /^#.*/
end

replace_or_add "change the love, don't add more" do
  path "/some/file"
  pattern "Why hello there.*"
  line "Why hello there, you beautiful person, you."
  replace_only true
end

add_to_list "add entry to a list" do
  path "/some/file"
  pattern "People to call: "
  delim [","]
  entry "Bobby"
end

delete_from_list "delete entry from a list" do
  path "/some/file"
  pattern "People to call: "
  delim [","]
  entry "Bobby"
end

delete_lines 'remove from nonexisting' do
  path '/tmp/doesnotexist'
  pattern /^#/
end

Resource Notes

So far, the only resources implemented are

append_if_no_line
replace_or_add
delete_lines
add_to_list
delete_from_list

Resource: append_if_no_line

Actions

Action Description
edit Append a line if it is missing.

Properties

Properties Description Type Values and Default
path File to update String Required, no default
line Line contents String Required, no default

Resource: replace_or_add

Actions

Action Description
edit Replace lines that match the pattern. Append the line unless a source line matches the pattern.

Properties

Properties Description Type Values and Default
path File to update String Required, no default
pattern Regular expression to select lines Regular expression or String Required, no default
line Line contents String Required, no default
replace_only Don't append only replace matching lines true or false Required, no default

Resource: delete_lines

Actions

Action Description
edit Delete lines that match the pattern.

Properties

Properties Description Type Values and Default
path File to update String Required, no default
pattern Regular expression to select lines Regular expression or String Required, no default

Notes

Removes lines based on a string or regex.

Resource: add_to_list

Actions

Action Description
edit Add an item to a list

Properties

Properties Description Type Values and Default
path File to update String Required, no default
pattern Regular expression to select lines Regular expression or String Required, no default
delim Delimiter entries Array Array of 1, 2 or 3 multi-character elements
entry Value to add String Required, No default
ends_with List ending String No default

Notes

If one delimiter is given, it is assumed that either the delimiter or the given search pattern will proceed each entry and
each entry will be followed by either the delimeter or a new line character:
People to call: Joe, Bobby
delim [","]
entry 'Karen'
People to call: Joe, Bobby, Karen

If two delimiters are given, the first is used as the list element delimiter and the second as entry delimiters:
my @net1918 = ("10.0.0.0/8", "172.16.0.0/12");
delim [", ", "\""]
entry "192.168.0.0/16"
my @net1918 = ("10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16");

if three delimiters are given, the first is used as the list element delimiter, the second as the leading entry delimiter and the third as the trailing delimiter:
multi = ([310], [818])
delim [", ", "[", "]"]
entry "425"
multi = ([310], [818], [425])

end_with is an optional property. If specified a list is expected to end with the given string.

Resource: delete_from_list

Actions

Action Description
edit Delete an item from a list

Properties

Properties Description Type Values and Default
path File to update String Required, no default
pattern Regular expression to select lines Regular expression or String Required, no default
delim Delimiter entries Array Array of 1, 2 or 3 multi-character elements
entry Value to delete String Required, No default
ends_with List ending String No default

Notes

Delimeters works exactly the same way as add_to_list, see above.

Author

Author: Sean OMeara (sean@sean.io)

Contributor: Antek S. Baranski (antek.baranski@gmail.com)

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

al_agents Applicable Versions
apparmor Applicable Versions
autofs Applicable Versions
aws-kinesis-agent Applicable Versions
bash_history_timestamp Applicable Versions
cerner_splunk Applicable Versions
chamber-kibana Applicable Versions
checkmk Applicable Versions
chefdk_bootstrap Applicable Versions
cis-el7-l1-hardening Applicable Versions
codenamephp_chef Applicable Versions
dynatrace Applicable Versions
dynatrace-appmon Applicable Versions
elk Applicable Versions
elkstack Applicable Versions
fipsify Applicable Versions
fqdn Applicable Versions
hdp-cloud Applicable Versions
java Applicable Versions
jenkinsstack Applicable Versions
linux-tweak Applicable Versions
mondoo Applicable Versions
network_interfaces Applicable Versions
nfs Applicable Versions
nyan-cat Applicable Versions
ocserv Applicable Versions
openvpnas Applicable Versions
percona Applicable Versions
ps1 Applicable Versions
puncha-kibana Applicable Versions
pyload Applicable Versions
r1337-linux-users Applicable Versions
rails_ubuntu Applicable Versions
rc Applicable Versions
starship Applicable Versions
vpn Applicable Versions
websrv Applicable Versions
yum-plugin-versionlock Applicable Versions
zf2 Applicable Versions

line Cookbook CHANGELOG

v1.2.0 (2018-04-18)

  • A missing file is ok for append_if_no_line, delete_lines and delete_from_list.

v1.1.1 (2018-04-16)

  • Allow appending to an empty file

v1.1.0 (2018-03-26)

  • Rework delete_lines to use file provider subresource.
  • Support matching with regexps in addition to strings with delete_lines.
  • Rework append_if_no_line to use file provider subresource.
  • Fix edge conditions around files-with-no-trailing-CR being fed to append_if_no_line.
  • Remove library helpers.
  • Remove the escape_regexp and escape_string methods in favour of native Regexp.escape

v1.0.6 (2018-03-23)

  • Add question mark to regular expression escape characters

v1.0.5 (2018-02-20)

  • Minor Testing updates
  • Remove custom matchers for ChefSpec. ChefDK 1 versions of ChefSpec will no longer work when unit testing against this cookbook.

v1.0.4 (2018-01-10)

  • Handle deleting items from a list using spaces as the delimeter

v1.0.3 (2017-08-22)

  • Add edge case tests for add_to_list
  • Handle the delete_lines, add_to_list, and delete_from_list resources when a missing file is specified.

v1.0.2 (2017-07-07)

  • Fix #58 Add resource locator matchers
  • Fix #59 Add resource matcher tests
  • Make cookstyle 2.0.0 fixes
  • Delete the unused minitest files
  • Clean up the file_ext inspec resource

v1.0.1 (2017-07-05)

  • Fix #53 append_if_no_line appends line always appends

v1.0.0 (2017-06-13)

  • Move cookbook to Sous-Chefs org
  • Move to using custom resources

v0.6.3 (2015-10-27)

  • Fixing Ruby and Chef deprecation warnings
  • Cleaning up tests a bit
  • Adding support for source_url and issues_url
  • delete_from_list resource

v0.6.2 (2015-07-15)

  • Catch lines missed by strict patterns
  • Add rspec tests for the replace_or_add provider. The existing chefspec tests don't step into the provider code and so don't check the provider functionality.
  • Change the Gemfile to reflect the need for berkshelf 3, chefspec v4.2, rspec 3 for the tests.
  • Update provider_replace_or_add to handle cases where the pattern does not match the replacement line.
  • Fix notification problem where updated_by_last_action was set when nothing changed.

v0.6.1 (2015-02-24)

  • Adding CHANGELOG
  • Adding ChefSpec matchers

Collaborator Number Metric
            

1.2.0 passed this metric

Contributing File Metric
            

1.2.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
            

1.2.0 passed this metric

No Binaries Metric
            

1.2.0 passed this metric

Testing File Metric
            

1.2.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
            

1.2.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