ciborg 0.0.1 → 3.0.0

data/chef/travis-cookbooks/worker_host/ntp/TESTING.md

@@ -0,0 +1,213 @@
+## Cookbook testing
+
+Reference documentation for testing cookbooks for correctness
+in a lightweight manner.
+
+## Purpose
+
+We set out at the Chefconf 2012 Hackday to test our cookbooks for correctness
+without doing a full convergence run.  Some of our community cookbooks such
+as `gitlab` or `ruby_build` may take up to 30 minutes to fully converge.
+So a quick sanity check was needed to test the inputs for correctness.
+
+A major problem with developing cross-platform cookbooks is this ugly
+stair-step pattern of case switches on platform and platform_version
+attributes.  This leads to hard to read recipe code, and additional
+maintenance overhead in correcting platform cases on a constant basis.
+Recipe tend to take on quirks for edge cases, as conditionals are stacked
+in inconsistest and unpredictable ways.
+
+Fletcher had done some previous lint checking on some of his cookbooks
+with foodcritic and [Travis CI](http://travis-ci.org).  We wished to
+incorporate attribute sanity checking. Both our testing cases are added
+as a `rake` task which can be run from a development workstation
+or CI platform such as Travis or Jenkins.  The biggest advantage we found
+of this testing method was being able to run quick attribute tests in
+**one-hundredth of a second**.  The biggest drawback in spec tests are
+having to write tests which are very explicit.
+
+The attribute tests uses minitest to mock a node and then check the attributes
+for any platform edge cases as shipped with the cookbook.  Since there is
+no way for a cookbook developer to know how attributes will be overridden
+by the end-user, the only thing you might reasonably test is what ships
+with the cookbook.
+
+We stopped before testing the Resource Collection, or integrating
+`minitest-handler` post-convergence testing.  A good `minitest-handler`
+case for this cookbook would be to ensure a node does not set itself
+as an upstream ntp `server` or `peer` of itself.  As different testing
+methods for Chef emerge and mature, this proof-of-concept should be
+revisited to serve as a reference case.
+
+## Minitest Spec Testing HOWTO
+
+### 1. Identification
+
+Identify your default attribute inputs, and all edge cases.
+
+Refactor the code for readability, if necessary to identify all such inputs.
+
+### 2. Development testing files
+
+#### 2.1 Test and Support file
+
+Foodcritic may identify testing directories as cookbooks if attributes, or recipes, subdirectories are used.
+Otherwise the testing directory structure does not matter much.  Following Ruby conventions, you should probably use `test` or `spec`.
+
+Create a test directory structure.
+
+```sh
+cd chef-repo/cookbooks/<cookbook dir>
+mkdir -p test/support
+mkdir -p test/<cookbook name>
+```
+
+Populate your Gemfile for the rake task, and optionally Travis.
+
+```ruby
+# test/support/Gemfile
+source "https://rubygems.org"
+gem "rake"
+gem "minitest"
+gem "chef", ">= 10.12.0"
+gem "foodcritic"
+```
+
+Create a spec_helper stub to require testing Rubies.
+
+```ruby
+# test/support/spec_helper.rb
+gem 'minitest'
+require 'minitest/autorun'
+```
+
+Create a <name of test>_spec.rb test file.  Following is a partial NTP attributes example.
+
+```ruby
+# test/ntp/attributes_spec.rb
+require File.join(File.dirname(__FILE__), %w{.. support spec_helper})
+require 'chef/node'
+require 'chef/platform'
+
+describe 'Ntp::Attributes::Default' do
+  let(:attr_ns) { 'ntp' }
+
+  before do
+    @node = Chef::Node.new
+    @node.consume_external_attrs(Mash.new(ohai_data), {})
+    @node.from_file(File.join(File.dirname(__FILE__), %w{.. .. attributes default.rb}))
+  end
+
+  # Test unknown edge case
+  describe "for unknown platform" do
+    let(:ohai_data) do
+      { :platform => "unknown", :platform_version => '3.14' }
+    end
+
+    it "sets a package list" do
+      @node[attr_ns]['packages'].must_equal %w{ ntp ntpdate }
+    end
+  end #end unknown platform tests
+
+  # Test CentOS 6 edge case
+  describe "for Centos 6 platform" do
+    let(:ohai_data) do
+      { :platform => "centos", :platform_version => '6.2' }
+    end
+
+    it "sets the service name to ntpd" do
+      @node[attr_ns]['service'].must_equal "ntpd"
+    end
+  end #end CentOS 6 tests
+end
+```
+
+#### 2.2 Set up Rake tasks
+
+Once you have one or two test cases in your *_spec.rb files, the next step is creating a Rakefile for running the tests.
+We will set up a task for the minitest spec tests and a foodcritic run for this example.  The Rakefile should
+be placed at the top-level of the cookbook you wish to test.
+
+```ruby
+#!/usr/bin/env rake
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/**/*_spec.rb']
+  t.verbose = true
+end
+
+desc "Runs foodcritic linter"
+task :foodcritic do
+  if Gem::Version.new("1.9.2") <= Gem::Version.new(RUBY_VERSION.dup)
+    sh "foodcritic --epic-fail any ."
+  else
+    puts "WARN: foodcritic run is skipped as Ruby #{RUBY_VERSION} is < 1.9.2."
+  end
+end
+
+task :default => [ 'test', 'foodcritic' ]
+```
+
+Now you should be able to run `rake` within your cookbook directory you wish to test.  If you are on a bash shell, you can run `echo $?` and see if your rake task returned a `0` which means everything passed.
+
+### 3. Exclude your test directories from knife upload.
+
+It may be a good idea to exclude your development files from getting uploaded to the Chef server, or Opscode platform.  In this case you should populate a chefignore file in the top-level of the cookbook directory you wish to test.
+
+```ruby
+# Put files/directories that should be ignored in this file.
+# Lines that start with '# ' are comments.
+
+# gitignore
+\.gitignore
+
+# tests
+*/test/*
+\.travis.yml
+Rakefile
+```
+
+#### 4. Travis CI integration
+
+Once you have completed the previous steps, Travis CI integration is actually quite simple.
+
+First, you need to click on the link that says `Sign in with Github` and authorize the Travis CI application to read your projects from Github.  Next, you need to authorize Travis to build one, or all, of your projects.
+
+Finally, you need to set up a .travis.yml file, here is an example Travis build file.  Drop this file in the top-level directory of the cookbook you wish to test.
+
+```ruby
+language: ruby
+gemfile:
+  - test/support/Gemfile
+rvm:
+  - 1.9.3
+script: BUNDLE_GEMFILE=test/support/Gemfile bundle exec rake test foodcritic
+```
+
+If you want a shiny red/green, badge of shame/honor in your README, then add this little snippet to your Markdown.  Substituting your github username, and project name in the link.
+
+    [![Build Status](https://secure.travis-ci.org/<github username>/<project name>.png?branch=master)](http://travis-ci.org/<github username>/<project name>)
+
+When you push your code up to github, you should receive an e-mail from Travis every time your tests fail.
+
+## License and Author
+
+Author:: Eric G. Wolfe (<wolfe21@marshall.edu>)
+Author:: Fletcher Nichol (<fletcher@nichol.ca>)
+
+Copyright 2012, Eric G. Wolfe
+Copyright 2012, Fletcher Nichol
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/chef/travis-cookbooks/worker_host/ntp/attributes/default.rb

@@ -0,0 +1,54 @@
+#
+# Cookbook Name:: ntp
+# Attributes:: default
+#
+# Author:: Joshua Timberman (<joshua@opscode.com>)
+#
+# Copyright 2009-2011, Opscode, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# default attributes for all platforms
+default['ntp']['servers']   = %w{ 0.pool.ntp.org 1.pool.ntp.org 2.pool.ntp.org 3.pool.ntp.org }
+default['ntp']['peers'] = Array.new
+default['ntp']['restrictions'] = Array.new
+
+default['ntp']['packages'] = %w{ ntp ntpdate }
+default['ntp']['service'] = "ntp"
+default['ntp']['varlibdir'] = "/var/lib/ntp"
+default['ntp']['driftfile'] = "#{node['ntp']['varlibdir']}/ntp.drift"
+default['ntp']['statsdir'] = "/var/log/ntpstats/"
+default['ntp']['conf_owner'] = "root"
+default['ntp']['conf_group'] = "root"
+default['ntp']['var_owner'] = "ntp"
+default['ntp']['var_group'] = "ntp"
+default['ntp']['leapfile'] = "/etc/ntp.leapseconds"
+
+# overrides on a platform-by-platform basis
+case platform
+when "redhat","centos","fedora","scientific","amazon","oracle"
+  default['ntp']['service'] = "ntpd"
+  default['ntp']['packages'] = %w{ ntp }
+  if node['platform_version'].to_i >= 6
+    default['ntp']['packages'] = %w{ ntp ntpdate } 
+  end
+when "freebsd"
+  default['ntp']['service'] = "ntpd"
+  default['ntp']['varlibdir'] = "/var/db"
+  default['ntp']['driftfile'] = "#{node['ntp']['varlibdir']}/ntpd.drift"
+  default['ntp']['statsdir'] = "#{node['ntp']['varlibdir']}/ntpstats"
+  default['ntp']['packages'] = %w{ ntp }
+  default['ntp']['conf_group'] = "wheel"
+  default['ntp']['var_group'] = "wheel" 
+end

data/chef/travis-cookbooks/worker_host/ntp/attributes/ntpdate.rb

@@ -0,0 +1,21 @@
+#
+# Cookbook Name:: ntp
+# Attributes:: default
+#
+# Author:: Joshua Timberman (<joshua@opscode.com>)
+#
+# Copyright 2009-2011, Opscode, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+default['ntp']['ntpdate']['disable'] = false 

data/chef/travis-cookbooks/worker_host/ntp/chefignore

@@ -0,0 +1,19 @@
+# Put files/directories that should be ignored in this file.
+# Lines that start with '# ' are comments.
+
+# gitignore
+\.gitignore
+
+# emacs
+*~
+
+# vim
+*.sw[a-z]
+
+# subversion
+*/.svn/*
+
+# tests
+*/test/*
+\.travis.yml
+Rakefile

data/chef/travis-cookbooks/worker_host/ntp/files/default/ntp.leapseconds

@@ -0,0 +1,222 @@
+#
+#	In the following text, the symbol '#' introduces
+#	a comment, which continues from that symbol until 
+#	the end of the line. A plain comment line has a
+#	whitespace character following the comment indicator.
+#	There are also special comment lines defined below. 
+#	A special comment will always have a non-whitespace 
+#	character in column 2.
+#
+#	A blank line should be ignored.
+#
+#	The following table shows the corrections that must
+#	be applied to compute International Atomic Time (TAI)
+#	from the Coordinated Universal Time (UTC) values that
+#	are transmitted by almost all time services.
+#
+#	The first column shows an epoch as a number of seconds
+#	since 1900.0 and the second column shows the number of
+#	seconds that must be added to UTC to compute TAI for
+#	any timestamp at or after that epoch. The value on 
+#	each line is valid from the indicated initial instant
+#	until the epoch given on the next one or indefinitely 
+#	into the future if there is no next line.
+#	(The comment on each line shows the representation of
+#	the corresponding initial epoch in the usual 
+#	day-month-year format. The epoch always begins at
+#	00:00:00 UTC on the indicated day. See Note 5 below.)
+#	
+#	Important notes:
+#
+#	1. Coordinated Universal Time (UTC) is often referred to
+#	as Greenwich Mean Time (GMT). The GMT time scale is no
+#	longer used, and the use of GMT to designate UTC is
+#	discouraged.
+#
+#	2. The UTC time scale is realized by many national 
+#	laboratories and timing centers. Each laboratory
+#	identifies its realization with its name: Thus
+#	UTC(NIST), UTC(USNO), etc. The differences among
+#	these different realizations are typically on the
+#	order of a few nanoseconds (i.e., 0.000 000 00x s)
+#	and can be ignored for many purposes. These differences
+#	are tabulated in Circular T, which is published monthly
+#	by the International Bureau of Weights and Measures
+#	(BIPM). See www.bipm.fr for more information.
+#
+#	3. The current defintion of the relationship between UTC 
+#	and TAI dates from 1 January 1972. A number of different 
+#	time scales were in use before than epoch, and it can be 
+#	quite difficult to compute precise timestamps and time 
+#	intervals in those "prehistoric" days. For more information,
+#	consult:
+#
+#		The Explanatory Supplement to the Astronomical
+#		Ephemeris.
+#	or
+#		Terry Quinn, "The BIPM and the Accurate Measurement
+#		of Time," Proc. of the IEEE, Vol. 79, pp. 894-905,
+#		July, 1991.
+#
+#	4.  The insertion of leap seconds into UTC is currently the
+#	responsibility of the International Earth Rotation Service,
+#	which is located at the Paris Observatory: 
+#
+#	Central Bureau of IERS
+#	61, Avenue de l'Observatoire
+#	75014 Paris, France.
+#
+#	Leap seconds are announced by the IERS in its Bulletin C
+#
+#	See hpiers.obspm.fr or www.iers.org for more details.
+#
+#	All national laboratories and timing centers use the
+#	data from the BIPM and the IERS to construct their
+#	local realizations of UTC.
+#
+#	Although the definition also includes the possibility
+#	of dropping seconds ("negative" leap seconds), this has 
+#	never been done and is unlikely to be necessary in the 
+#	foreseeable future.
+#
+#	5. If your system keeps time as the number of seconds since
+#	some epoch (e.g., NTP timestamps), then the algorithm for
+#	assigning a UTC time stamp to an event that happens during a positive
+#	leap second is not well defined. The official name of that leap 
+#	second is 23:59:60, but there is no way of representing that time 
+#	in these systems. 
+#	Many systems of this type effectively stop the system clock for 
+#	one second during the leap second and use a time that is equivalent 
+#	to 23:59:59 UTC twice. For these systems, the corresponding TAI 
+#	timestamp would be obtained by advancing to the next entry in the
+#	following table when the time equivalent to 23:59:59 UTC
+#	is used for the second time. Thus the leap second which
+#	occurred on 30 June 1972 at 23:59:59 UTC would have TAI
+#	timestamps computed as follows:
+#
+#	...
+#	30 June 1972 23:59:59 (2287785599, first time):	TAI= UTC + 10 seconds
+#	30 June 1972 23:59:60 (2287785599,second time):	TAI= UTC + 11 seconds
+#	1  July 1972 00:00:00 (2287785600)		TAI= UTC + 11 seconds
+#	...
+#
+#	If your system realizes the leap second by repeating 00:00:00 UTC twice
+#	(this is possible but not usual), then the advance to the next entry
+#	in the table must occur the second time that a time equivlent to 
+#	00:00:00 UTC is used. Thus, using the same example as above:
+#
+#	...
+#       30 June 1972 23:59:59 (2287785599):		TAI= UTC + 10 seconds
+#       30 June 1972 23:59:60 (2287785600, first time):	TAI= UTC + 10 seconds
+#       1  July 1972 00:00:00 (2287785600,second time):	TAI= UTC + 11 seconds
+#	...
+#
+#	in both cases the use of timestamps based on TAI produces a smooth
+#	time scale with no discontinuity in the time interval.
+#
+#	This complexity would not be needed for negative leap seconds (if they 
+#	are ever used). The UTC time would skip 23:59:59 and advance from 
+#	23:59:58 to 00:00:00 in that case.  The TAI offset would decrease by 
+#	1 second at the same instant.  This is a much easier situation to deal 
+#	with, since the difficulty of unambiguously representing the epoch 
+#	during the leap second does not arise.
+#
+#	Questions or comments to:
+#		Rich Schmidt
+#		Time Service Department
+#		US Naval Observatory
+#		Washington, DC
+#		rich.schmidt@usno.navy.mil
+#
+#	Last Update of leap second values:   10 Jan 2012
+#
+#	The following line shows this last update date in NTP timestamp 
+#	format. This is the date on which the most recent change to
+#	the leap second data was added to the file. This line can
+#	be identified by the unique pair of characters in the first two 
+#	columns as shown below.
+#
+#$	 3535142400
+#
+#	The data in this file will be updated periodically as new leap 
+#	seconds are announced. In addition to being entered on the line
+#	above, the update time (in NTP format) will be added to the basic 
+#	file name leap-seconds to form the name leap-seconds.<NTP TIME>.
+#	In addition, the generic name leap-seconds.list will always point to 
+#	the most recent version of the file.
+#
+#	This update procedure will be performed only when a new leap second
+#	is announced. 
+#
+#	The following entry specifies the expiration date of the data
+#	in this file in units of seconds since 1900.0.  This expiration date 
+#	will be changed at least twice per year whether or not a new leap 
+#	second is announced. These semi-annual changes will be made no
+#	later than 1 June and 1 December of each year to indicate what
+#	action (if any) is to be taken on 30 June and 31 December, 
+#	respectively. (These are the customary effective dates for new
+#	leap seconds.) This expiration date will be identified by a
+#	unique pair of characters in columns 1 and 2 as shown below.
+#	In the unlikely event that a leap second is announced with an 
+#	effective date other than 30 June or 31 December, then this
+#	file will be edited to include that leap second as soon as it is
+#	announced or at least one month before the effective date
+#	(whichever is later). 
+#	If an announcement by the IERS specifies that no leap second is 
+#	scheduled, then only the expiration date of the file will 
+#	be advanced to show that the information in the file is still
+#	current -- the update time stamp, the data and the name of the file 
+#	will not change.
+#
+#	Updated through IERS Bulletin C43
+#	File expires on:  28 Dec 2012
+#
+#@	3565641600
+#
+2272060800	10	# 1 Jan 1972
+2287785600	11	# 1 Jul 1972
+2303683200	12	# 1 Jan 1973
+2335219200	13	# 1 Jan 1974
+2366755200	14	# 1 Jan 1975
+2398291200	15	# 1 Jan 1976
+2429913600	16	# 1 Jan 1977
+2461449600	17	# 1 Jan 1978
+2492985600	18	# 1 Jan 1979
+2524521600	19	# 1 Jan 1980
+2571782400	20	# 1 Jul 1981
+2603318400	21	# 1 Jul 1982
+2634854400	22	# 1 Jul 1983
+2698012800	23	# 1 Jul 1985
+2776982400	24	# 1 Jan 1988
+2840140800	25	# 1 Jan 1990
+2871676800	26	# 1 Jan 1991
+2918937600	27	# 1 Jul 1992
+2950473600	28	# 1 Jul 1993
+2982009600	29	# 1 Jul 1994
+3029443200	30	# 1 Jan 1996
+3076704000	31	# 1 Jul 1997
+3124137600	32	# 1 Jan 1999
+3345062400	33	# 1 Jan 2006
+3439756800	34	# 1 Jan 2009
+3550089600	35	# 1 Jul 2012
+3565987200	36	# 1 Jan 2013
+3581625600	37	# 1 Jul 2013
+3597523200 	38	# 1 Jan 2014
+3613161600 	39	# 1 Jul 2014
+3629059200 	40	# 1 Jan 2015
+#
+#	the following special comment contains the
+#	hash value of the data in this file computed
+#	use the secure hash algorithm as specified
+#	by FIPS 180-1. See the files in ~/sha for
+#	the details of how this hash value is
+#	computed. Note that the hash computation
+#	ignores comments and whitespace characters
+#	in data lines. It includes the NTP values
+#	of both the last modification time and the 
+#	expiration time of the file, but not the
+#	white space on those lines.
+#	the hash line is also ignored in the
+#	computation.
+#
+#h      b2a5e90a 313a6ce afe814f3 46bff6d8 875672e2