chef_locker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4bee107a6d01f445def880bd797b5587ef0fd203
+  data.tar.gz: 176bf3f2e14b25b9abcc0b7d1a84657855786847
+SHA512:
+  metadata.gz: '0279aeeb21600beb2cb7d6c54de3cdc117abf921b72a31a23fa6e315428ea495d55ed7342f5f5d6c0d12e14b764c0498de6ba8f26ddbfc180570e8654936d3bf'
+  data.tar.gz: d2cb5e6dd08d4278adefec17c28d59be4bff51c8c6b68216f43975797964fffa3e8b071809c832f87d1fa75bd19f72074583edb35a95e92f146f6c1d1269b6cb

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 AnyPerk Engineering
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,18 @@
+# chef_locker
+
+chef_locker is a Ruby gem that contains a script to prevent Chef clients from
+converging.
+
+To install, declare something like the following in Chef:
+```ruby
+chef_gem 'chef_locker'
+```
+
+To run the script, try something like the following in a screen/tmux session:
+```bash
+$ sudo /opt/chefdk/embedded/bin/chef_locker 'Testing CDN host change'
+```
+Wait until `Lock acquired` appears.
+
+Note that if something like rvm is installed, you may have to create a wrapper
+script to unset some Ruby-related environment variables.

data/bin/chef_locker

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+usage_string = "Usage: #{$0} MESSAGE"
+
+if %w(-h --help).include?(ARGV[0])
+  puts usage_string
+  exit
+end
+
+require 'chef_locker'
+
+begin
+  ChefLocker.new.lock(ARGV.join(' '))
+rescue ArgumentError
+  abort usage_string
+end

data/chef_locker.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name = 'chef_locker'
+  s.version = '0.1.0'
+  s.authors = ['AnyPerk Engineering']
+  s.email = ['engineering@anyperk.com']
+  s.summary = 'Lock Chef runs'
+  s.description = 'This contains a script to lock Chef runs.'
+  s.homepage = 'https://github.com/anyperk/chef_locker'
+  s.license = 'MIT'
+
+  s.add_dependency 'chef', '~> 12.0'
+  s.add_development_dependency 'rspec', '~> 3.5'
+
+  s.executables = %w(chef_locker)
+
+  s.files = `git ls-files`.split($/)
+  s.test_files = s.files.grep(%r{\Aspec/})
+end

data/lib/chef_locker.rb

@@ -0,0 +1,31 @@
+require 'chef'
+
+# @see #lock
+class ChefLocker
+  # @param output [#puts] IO-like object to output info to
+  def initialize(output: $stdout)
+    @output = output
+    @runlock = Chef::RunLock.new(Chef::Config.lockfile)
+  end
+
+  # Locks Chef runs (prevents Chef clients from converging)
+  #
+  # @param message [#to_s] message to include in lock file
+  def lock(message)
+    message = message.to_s
+    raise ArgumentError, "Message can't be blank" if message.strip.empty?
+
+    @runlock.acquire
+    begin
+      @output.puts 'Lock acquired'
+      @runlock.save_pid
+      @runlock.runlock.write(' ' + message)
+      @runlock.runlock.fsync
+
+      # Now we block until interrupted (there might be a better way to do this)
+      loop { $stdin.read }
+    ensure
+      @runlock.release
+    end
+  end
+end

data/spec/chef_locker_spec.rb

@@ -0,0 +1,65 @@
+require 'fileutils'
+require 'securerandom'
+
+require 'chef_locker'
+
+RSpec.describe ChefLocker do
+  let(:output) { StringIO.new }
+  subject(:locker) { ChefLocker.new(output: output) }
+
+  describe '#lock' do
+    context 'when the given message is empty' do
+      it 'raises ArgumentError' do
+        expect { locker.lock }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'when the given message is not blank' do
+      let(:lockfile) { "spec/lockfiles/#{SecureRandom.hex}.pid" }
+
+      before do
+        allow(Chef::Config).to receive(:lockfile).and_return(lockfile)
+        allow(locker).to receive(:loop)
+      end
+
+      after do
+        FileUtils.rm_f(lockfile)
+      end
+
+      it 'acquires the lock' do
+        reached = false
+        allow(locker).to receive(:loop) do
+          File.open(lockfile, 'r') do |f|
+            expect(f.flock(File::LOCK_NB | File::LOCK_EX)).to eq(false)
+            reached = true
+          end
+        end
+
+        locker.lock('test')
+        expect(reached).to eq(true)
+      end
+
+      it 'saves the PID and message in the lock file' do
+        message = SecureRandom.hex
+        locker.lock(message)
+
+        expect(IO.read(lockfile)).to eq("#{$$} #{message}")
+      end
+
+      it 'blocks' do
+        allow(locker).to receive(:loop).and_yield
+        expect($stdin).to receive(:read)
+
+        locker.lock('test')
+      end
+
+      it 'releases the lock' do
+        locker.lock('test')
+
+        File.open(lockfile, 'r') do |f|
+          expect(f.flock(File::LOCK_NB | File::LOCK_EX)).to eq(0)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: chef_locker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- AnyPerk Engineering
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: This contains a script to lock Chef runs.
+email:
+- engineering@anyperk.com
+executables:
+- chef_locker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- bin/chef_locker
+- chef_locker.gemspec
+- lib/chef_locker.rb
+- spec/chef_locker_spec.rb
+- spec/lockfiles/.gitkeep
+homepage: https://github.com/anyperk/chef_locker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Lock Chef runs
+test_files:
+- spec/chef_locker_spec.rb
+- spec/lockfiles/.gitkeep