taste_tester 0.0.1 → 0.0.2

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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/README.md

@@ -1,29 +1,145 @@
-# TasteTester
+# Taste Tester
 
-TODO: Write a gem description
+## Intro
+Ohai!
 
-## Installation
+Welcome to Taste Tester, software to manage a chef-zero instance and use it to
+test changes on production servers.
 
-Add this line to your application's Gemfile:
+At its core, Taste Tester starts up a chef-zero server on localhost, uploads a
+repository to it, ssh's to a remote server and points its configs to your new
+chef-zero instance.
 
-    gem 'taste_tester'
+Further, it keeps track of where in git you were when that happened so future
+uploads will do the right thing, even as you switch branches.
 
-And then execute:
+Taste Tester can be controlled via a variety of config-file options, and can be
+further customized by writing a plugin.
 
-    $ bundle
+## Synopsis
 
-Or install it yourself as:
+Typical usage is:
 
-    $ gem install taste_tester
+```text
+vi cookbooks/...             # Make your changes and commit locally
+taste-tester test -s [host]  # Put host in Taste Tester mode
+ssh root@[host]              # Log in to host
+  # Run chef and watch it break
+vi cookbooks/...             # Fix your cookbooks
+taste-tester upload          # Upload the diff
+ssh root@[host]
+  # Run chef and watch it succeed
+<Verify your changes were actually applied as intended!>
+taste-tester untest [host]   # Put host back in production
+                             #   (optional - will revert itself after 1 hour)
+```
 
-## Usage
+See the help for futher information.
 
-TODO: Write usage instructions here
+## Prerequisites
 
-## Contributing
+* Taste Tester assumes that /etc/chef/client.rb on your servers is a symlink and
+that your real config is /etc/chef/client-prod.rb
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+* Taste Tester assumes that it's generally safe to "go back" to production. I.e.
+We set things up so you can set a cronjob to un-taste-test a server after the
+desired amount of time, which means it must be (relatively) safe to revert
+back.
+
+* Taste Tester assumes you use a setup similar to grocery-delivery in
+production. Specifically that you don't use versions or environments. 
+
+## Dependencies
+
+* Mixlib::Config
+* Colorize
+* BetweenMeals
+
+## Automatic Untesting
+
+Taste Tester touches `/etc/chef/test_timestamp` on the remote server as far into
+the future as the user wants to test (default is 1h). You should have a cronjob
+to check the timestamp of this file, and if it is old, remove it and put the
+symlinks for `/etc/chef/client.rb` back to where they belong.
+
+A small shell script to do this is included called `taste-untester`. We
+recommend running this at least every 15 minutes.
+
+If you let Taste Tester setup reverse-SSH tunnels, make sure your untester
+is also killing the ssh tunnel whose PID is in `/etc/chef/test_timestamp`
+(taste-untester will do this for you).
+
+## Config file
+
+The default config file is `/etc/taste-tester-config.rb` but you may use -c to
+specify another. The config file works the same as client.rb does for Chef -
+there are a series of keywords that take an arguement and anything else is just
+standard Ruby.
+
+All command-line options are available in the config file:
+* debug (bool, default: `false`)
+* timestamp (bool, default: `false`)
+* config_file (string, default: `/etc/gd-config.rb`)
+* plugin_path (string, default: `/etc/taste-tester-plugin.rb`)
+* repo (string, default: `#{ENV['HOME']}/ops`)
+* testing_time (int, default: `3600`)
+* chef_client_command (strng, default: `chef-client`)
+* skip_repo_checks (bool, default: `false`)
+* skip_pre_upload_hook (bool, default: `false`)
+* skip_post_upload_hook (bool, default: `false`)
+* skip_pre_test_hook (bool, default: `false`)
+* skip_post_test_hook (bool, default: `false`)
+* skip_repo_checks_hook (bool, default: `false`)
+
+The following options are also available:
+* base_dir - The directory in the repo under which to find chef configs.
+  Default: `chef`
+* cookbook_dirs - An array of cookbook directories relative to base_dir.
+  Default: `['cookbooks']
+* role_dir - A directory of roles, relative to base_dir. Default: `roles`
+* databag_dir - A directory of databags, relative to base_dir.
+  Default: `databags`
+* ref_file - The file to store the last git revision we uploaded in. Default:
+  `#{ENV['HOME']}/.chef/taste-tester-ref.txt`
+* checksum_dir - The checksum directory to put in knife.conf for users. Default:
+  `#{ENV['HOME']}/.chef/checksums`
+
+## Plugin
+
+The plugin should be a ruby file which defines several class methods. It is
+class_eval()d into a Hooks class.
+
+The following functions can optionally be defined:
+
+* self.pre_upload(dryrun, repo, last_ref, cur_ref)
+
+Stuff to do before we upload anything to chef-zero. `Repo` is a BetweenMeals::Repo
+object. `last_ref` is the last git ref we uploaded and `cur_ref` is the git ref
+the repo is currently at,
+
+* self.post_upload(dryrun, repo, last_ref, cur_ref)
+
+Stuff to do after we upload to chef-zero.
+
+* self.pre_test(dryrun, repo, hosts)
+
+Stuff to do before we put machines in test mode. `hosts` is an array of
+hostnames.
+
+* self.test_remote_cmds(dryrun, hostname)
+
+Additional commands to run on the remote host when putting it in test mode.
+Should return an array of strings. `hostname` is the hostname.
+
+* self.test_remote_client_rb_extra_code(hostname)
+
+Should return a string of additional code to include in the remote `client.rb`.
+Example uses: defining json_attribs
+
+* self.post_test(dryrun, repo, hosts)
+
+Stuff to do after putting all hosts in test mode.
+
+* self.repo_checks(dryrun, repo)
+
+Additional checks you want to do on the repo as sanity checks.