lock_manager 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a235cfae8f73825fbc5b738d4f2adeac031f1b2
+  data.tar.gz: 1440406b654d29de1949e76b4f04f80b3117df91
+SHA512:
+  metadata.gz: 884bc3e33046cf124843fc424b22d51f5affff5063886d690243a510b3b4d3927988c95906cbd1dfac82de04486e78ec64188631585655de741b8115a66a28b2
+  data.tar.gz: 6b77f05acfb5f783121bf345c0d93c7c1b96f64af4555cd372999a0071d141ff1a8f226dde7aa9d176a5e5a122cae1eb213a5937f36e021d72ae748ec4483967

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2014-2015 Puppet Labs
+
+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

@@ -0,0 +1,71 @@
+# Lock Manager
+
+Lock manager is designed to be a small helper gem that provides common methods
+for locking and unlocking hardware.
+
+## About
+
+Lock manager is a simple gem designed to place a lock on a host via a
+json value in redis.
+
+The format for the lock is
+
+    {"user":"stahnma","time":"2015-11-20 05:35:40 +0000",
+    "reason":"Because reasons"}
+
+## Usage
+
+Create a lock manager object
+
+    a = LockManager.new(type: 'redis', server: 'localhost')
+
+Check to see if the node is locked.
+
+    a.locked? 'pe-aix-72-builder'
+    => false
+
+Lock the node
+
+    a.lock 'pe-aix-72-builder', 'stahnma'
+    => true
+
+See the lock
+
+    a.show
+    => "{\"user\":\"stahnma\",\"time\":\"2015-11-20 05:55:52 +0000\",\"reason\":null}"
+
+Unlock the node
+
+    a.unlock 'pe-aix-72-builder', 'stahnma'
+    => true
+
+Lock with a purpose
+
+     a.lock 'pe-aix-72-builder', 'stahnma', "Because I'm looking into a failure"
+     => true
+
+Ask for a lock, if node is already locked, keep trying and wait until you get one
+
+    a.polling_lock('pe-aix-72-builder', 'stahnma')
+    pe-aix-72-builder is locked...waiting 1 seconds.
+    pe-aix-72-builder is locked...waiting 2 seconds.
+    pe-aix-72-builder is locked...waiting 3 seconds.
+    pe-aix-72-builder is locked...waiting 5 seconds.
+    # Another operations elsewhere unlocked the node
+    => true
+
+# Testing
+
+Lock Manager now has tests and rubocop setup. There are basic tests for
+the functionality of lock manager.
+
+Tests assume you have redis running on localhost on the default port.
+
+    bundle exec rake
+
+# License
+Apache Sofware License 2.0
+
+# Maintainers
+Michael Stahnke <stahnma@puppetlabs.com>
+Rick Bradley <rick@puppetlabs.com>

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'minitest/autorun'
+require 'json'
+require 'lock_manager'
+
+class LockManager
+  class Worker
+    def log(*)
+    end
+  end
+end

data/test/test_lock.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+class TestLockManagerLock < MiniTest::Test
+  def setup
+    @rlm = LockManager.new(type: 'redis', server: 'localhost')
+    @rlm.unlock 'pe-aix-72-builder', 'stahnma' # clear out any previously set locks
+  end
+
+  def test_lock_method
+    assert_equal true, @rlm.lock('pe-aix-72-builder', 'stahnma')
+  end
+
+  def test_check_lock
+    @rlm.lock('pe-aix-72-builder', 'stahnma', 'because reasons')
+    assert_equal true, @rlm.locked?('pe-aix-72-builder')
+  end
+
+  def test_lock_a_locked_item
+    @rlm.lock('pe-aix-72-builder', 'stahnma')
+    assert_equal false, @rlm.lock('pe-aix-72-builder', 'stahnma')
+  end
+
+  def test_lock_with_ip4
+    assert_raises(ArgumentError) do
+      @rlm.lock('192.168.1.1', 'stahnma')
+    end
+  end
+
+  def test_lock_with_ip6
+    assert_raises(ArgumentError) do
+      @rlm.lock('fe80::12c3:7bff:fe90:dc60', 'stahnma')
+    end
+  end
+end

data/test/test_poll.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class TestLockManagerPoll < MiniTest::Test
+  def setup
+    @rlm = LockManager.new(type: 'redis', server: 'localhost')
+    @rlm.unlock 'pe-aix-72-builder', 'stahnma' # clear out any previously set locks
+  end
+
+  def test_polling_lock
+    assert @rlm.polling_lock('pe-aix-72-builder', 'stahnma')
+  end
+
+  def test_polling_lock_when_locked_already
+    skip "I don't know how to test the case where it is locked, since it just blocks"
+  end
+end

data/test/test_redis_connect.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class TestLockManagerRedisConnect < MiniTest::Test
+  def test_connect_good
+    @rlm = LockManager.new(type: 'redis', server: 'localhost')
+    assert_instance_of(LockManager, @rlm)
+    @rlm.lock('pe-aix-72-builder', 'stahnma')
+    lock_data = @rlm.show('pe-aix-72-builder')
+    assert_equal 'stahnma', lock_data['user'], 'Expected user to be properly set'
+    @rlm.unlock('pe-aix-72-builder', 'stahnma')
+  end
+
+  def test_bogus_connect
+    assert_raises(SocketError) do
+      @rlm = LockManager.new(type: 'redis', server: 'nopehost')
+      @rlm.locked?('pe-aix-72-builder')
+    end
+  end
+end

data/test/test_show.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class TestLockManagerShow < MiniTest::Test
+  def setup
+    @rlm = LockManager.new(type: 'redis', server: 'localhost')
+    @rlm.unlock 'pe-aix-72-builder', 'stahnma' # clear out any previously set locks
+  end
+
+  def test_show_works_with_lock
+    assert @rlm.lock('pe-aix-72-builder', 'stahnma'), 'Expected to be able to lock'
+    lock_data = @rlm.show('pe-aix-72-builder')
+    assert_equal 'stahnma', lock_data['user'], 'Expected user to be properly set'
+    assert_nil lock_data['reason'], 'Expected no reason to be set'
+  end
+
+  def test_show_works_with_lock_with_reason
+    assert @rlm.lock('pe-aix-72-builder', 'stahnma', 'because'), 'Expected to be able to lock'
+    lock_data = @rlm.show('pe-aix-72-builder')
+    assert_equal 'stahnma', lock_data['user'], 'Expected user to be set'
+    assert_equal 'because', lock_data['reason'], 'Expected reason to be set'
+  end
+
+  def test_show_returns_nothing_with_no_lock
+    @rlm.unlock 'pe-aix-72-builder', 'stahnma'
+    lock_data = @rlm.show('pe-aix-72-builder')
+    assert_nil lock_data, 'Expected no lock to be set'
+  end
+end

data/test/test_unlock.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+
+class TestLockManagerUnlock < MiniTest::Test
+  def setup
+    @rlm = LockManager.new(type: 'redis', server: 'localhost')
+    @rlm.unlock 'pe-aix-72-builder', 'stahnma' # clear out any previously set locks
+    @rlm.lock 'pe-aix-72-builder', 'stahnma' # clear out any previously set locks
+  end
+
+  def test_unlock_method
+    assert @rlm.unlock('pe-aix-72-builder', 'stahnma')
+  end
+
+  def test_check_locked?
+    @rlm.unlock 'pe-aix-72-builder', 'stahnma'
+    assert_equal(false, @rlm.locked?('pe-aix-72-builder'))
+    @rlm.lock 'pe-aix-72-builder', 'stahnma'
+    assert_equal(true, @rlm.locked?('pe-aix-72-builder'))
+    @rlm.unlock 'pe-aix-72-builder', 'stahnma'
+  end
+
+  def test_unlock_an_unlocked_item
+    @rlm.unlock 'pe-aix-72-builder', 'stahnma'
+    refute @rlm.unlock 'pe-aix-72-builder', 'stahnma'
+  end
+
+  def test_dont_unlock_a_lock_not_with_owner_mismatch
+    refute @rlm.unlock 'pe-aix-72-builder', 'fooman'
+    assert @rlm.unlock 'pe-aix-72-builder', 'stahnma'
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: lock_manager
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Puppet Labs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: A simple interface for locking hardware resources available via ruby
+  and backed by redis.
+email: info@puppetlabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- test/test_helper.rb
+- test/test_lock.rb
+- test/test_poll.rb
+- test/test_redis_connect.rb
+- test/test_show.rb
+- test/test_unlock.rb
+homepage: http://github.com/puppetlabs/lock_manager
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 3
+summary: Simply system for locking and unlocking hardware resources.
+test_files:
+- test/test_redis_connect.rb
+- test/test_unlock.rb
+- test/test_show.rb
+- test/test_lock.rb
+- test/test_helper.rb
+- test/test_poll.rb