memcache_check 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 93a54941a1ac5c17564d14f5ab974f3d1ace1148
4
+ data.tar.gz: faf2d53e47d3f989b43960978f7682b449f423a8
5
+ SHA512:
6
+ metadata.gz: 3f9f221d9aba6cc31ab5c560abf0e48e369e7cc8e18471f8bec4f953d6a2a60b7e7e7bb179678317fcfc5671ef58063ead40d7f29d623c07c1bb24ccd8fc48c6
7
+ data.tar.gz: 506bdb02a49042a93ff2c2316fdd9aa242a9c5b815ffeb5e688e229e2a073392d451a3f9b724393082f0efc6b72d4e025c5714b716f24c12dc140b566c9db7cc
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --color
2
+ --format progress
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in memcache_check.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2013 Michael Admire
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,67 @@
1
+ # MemcacheCheck
2
+
3
+ This gem is intended to help find problems with Memcached servers.
4
+ MemcacheCheck runs a series of set and get commands against a Memcached
5
+ server and validates the data returned. It also returns the benchmark
6
+ time that it takes to run the get and set commands to help find slow
7
+ responding servers.
8
+
9
+
10
+ ## Installation
11
+
12
+ Add this line to your application's Gemfile:
13
+
14
+ gem 'memcache_check'
15
+
16
+ And then execute:
17
+
18
+ $ bundle
19
+
20
+ Or install it yourself as:
21
+
22
+ $ gem install memcache_check
23
+
24
+
25
+ ## Usage
26
+
27
+ Create an instance of MemcacheCheck::Checker and pass in an argument of
28
+ the server's IP address as a string. If you don't pass an IP address in it
29
+ will default to localhost. You can optionally pass in a second argument of
30
+ the port number if you are running memcached on a non-standard port.
31
+
32
+ Once you have an instance you simply run the start method and pass it the
33
+ number of key value pairs you want to test against the server. If you don't
34
+ pass a value in it will default to 50.
35
+
36
+ The start method returns an array of 3 numbers:
37
+
38
+ - Number of passing set/get pairs
39
+ - Number of failing set/get pairs
40
+ - Benchmark time to run the test
41
+
42
+ example.rb
43
+
44
+ require 'memcache_check'
45
+
46
+ memcache_check = MemcacheCheck::Checker.new('127.0.0.1')
47
+ passes, fails, time = memcache_check.start(500)
48
+
49
+ puts "Number of passes: #{passes}"
50
+ puts "Number of failures: #{fails}"
51
+ puts "Total time: #{time} seconds"
52
+
53
+ Running on my local machine this produces:
54
+
55
+ Number of passes: 500
56
+ Number of failures: 0
57
+ Total time: 0.61212 seconds
58
+
59
+
60
+
61
+ ## Contributing
62
+
63
+ 1. Fork it
64
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
65
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
66
+ 4. Push to the branch (`git push origin my-new-feature`)
67
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
@@ -0,0 +1,3 @@
1
+ #./autotest/discover.rb
2
+
3
+ Autotest.add_discovery { "rspec2" }
@@ -0,0 +1,3 @@
1
+ module MemcacheCheck
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,78 @@
1
+ require "memcache_check/version"
2
+ require 'dalli'
3
+ require 'faker'
4
+ require 'benchmark'
5
+
6
+ module MemcacheCheck
7
+ class Checker
8
+ attr_reader :passes, :fails
9
+
10
+ def initialize(server = 'localhost', port = '11211')
11
+ @server = Server.new(server, port)
12
+ @passes = 0
13
+ @fails = 0
14
+ end
15
+
16
+ def start(num_times = 50)
17
+ time = Benchmark.measure do
18
+ num_times.times do
19
+ test_server
20
+ end
21
+ end
22
+ [@passes, @fails, time.real]
23
+ end
24
+
25
+ def test_server
26
+ key, value = create_key_value_pair
27
+ begin
28
+ @server.set(key, value)
29
+ if is_valid?(key, value)
30
+ @passes += 1
31
+ else
32
+ @fails += 1
33
+ end
34
+ rescue
35
+ @fails += 1
36
+ end
37
+ end
38
+
39
+ def create_key_value_pair
40
+ [Utils.generate_key, Utils.generate_test_data]
41
+ end
42
+
43
+ def is_valid?(key, value)
44
+ value == @server.get(key)
45
+ end
46
+ end
47
+
48
+ class Server
49
+ def initialize(host, port)
50
+ @memcache = Dalli::Client.new("#{host}:#{port}")
51
+ end
52
+
53
+ def set(key, value)
54
+ @memcache.set(key, value)
55
+ end
56
+
57
+ def get(key)
58
+ @memcache.get(key)
59
+ end
60
+ end
61
+
62
+ class Utils
63
+ def self.generate_key
64
+ "MemcacheCheck" + Time.now.strftime("%s%6N")
65
+ end
66
+
67
+ def self.generate_test_data
68
+ {
69
+ name: Faker::Name.name,
70
+ email: Faker::Internet.email,
71
+ phone: Faker::PhoneNumber.phone_number,
72
+ city: Faker::Address.city,
73
+ state: Faker::Address.state,
74
+ bio: Faker::Lorem.words(num = 100).join(", ")
75
+ }
76
+ end
77
+ end
78
+ end
@@ -0,0 +1,28 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'memcache_check/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "memcache_check"
8
+ spec.version = MemcacheCheck::VERSION
9
+ spec.authors = ["Mike Admire"]
10
+ spec.email = ["mike@mikeadmire.com"]
11
+ spec.description = %q{Run checks against a Memcached server}
12
+ spec.summary = %q{MemcacheCheck runs a series of set and get commands against a Memcache host to validate data integrity, verify that the host is responding correctly, and benchmark host speed.}
13
+ spec.homepage = "https://github.com/mikeadmire/memcache_check"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files`.split($/)
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.3"
22
+ spec.add_development_dependency "rake"
23
+ spec.add_development_dependency "rspec"
24
+ spec.add_development_dependency "ZenTest", "~> 4.9.2"
25
+
26
+ spec.add_runtime_dependency "dalli"
27
+ spec.add_runtime_dependency "faker"
28
+ end
@@ -0,0 +1,117 @@
1
+ require 'spec_helper'
2
+ require 'memcache_check'
3
+
4
+
5
+ describe MemcacheCheck do
6
+
7
+ describe "Checker" do
8
+
9
+ before(:each) do
10
+ @checker = MemcacheCheck::Checker.new
11
+ end
12
+
13
+ it { MemcacheCheck::Checker.should respond_to(:new) }
14
+
15
+ context "start" do
16
+ it { @checker.should respond_to(:start).with(1).arguments }
17
+
18
+ it "returns an array" do
19
+ expect(@checker.start).to be_an_instance_of(Array)
20
+ end
21
+
22
+ it "returns an array with 3 numeric elements" do
23
+ passes, fails, time = @checker.start
24
+ expect(passes).to be_an_instance_of(Fixnum)
25
+ expect(fails).to be_an_instance_of(Fixnum)
26
+ expect(time).to be_an_instance_of(Float)
27
+ end
28
+
29
+ it "passes and fails should add up to correct number" do
30
+ passes, fails, time = @checker.start(50)
31
+ expect(passes + fails).to eq(50)
32
+ end
33
+ end
34
+
35
+ end
36
+
37
+ context "Server" do
38
+ before(:each) do
39
+ @tester = MemcacheCheck::Server.new('localhost', '11211')
40
+ end
41
+
42
+ it "can be instantiated" do
43
+ expect(@tester).to be_an_instance_of(MemcacheCheck::Server)
44
+ end
45
+
46
+ it { @tester.should respond_to(:set).with(2).arguments }
47
+ it { @tester.should respond_to(:get).with(1).argument }
48
+
49
+ it "set and retrieve data from memcached" do
50
+ key = "abc123"
51
+ value = {name: 'Mike Admire',
52
+ text: "Lorem ipsum dolor sit amet, consectetur adipisicing" }
53
+ @tester.set(key, value)
54
+ expect(@tester.get(key)).to eq(value)
55
+ end
56
+ end
57
+
58
+
59
+ describe "Utils" do
60
+ it { MemcacheCheck::Utils.should respond_to :generate_key }
61
+ it { MemcacheCheck::Utils.should respond_to :generate_test_data }
62
+
63
+ context "generate_key" do
64
+ before(:each) do
65
+ @key = MemcacheCheck::Utils.generate_key
66
+ end
67
+
68
+ it "can generate an appropriate sized key" do
69
+ expect(@key.length).to be >= 25
70
+ end
71
+
72
+ it "starts with the string MemCacheCheck in key" do
73
+ expect(@key).to start_with("MemcacheCheck")
74
+ end
75
+
76
+ it "is unique" do
77
+ key1 = MemcacheCheck::Utils.generate_key
78
+ key2 = MemcacheCheck::Utils.generate_key
79
+ key3 = MemcacheCheck::Utils.generate_key
80
+ expect(@key).to_not eq(key1)
81
+ expect(@key).to_not eq(key2)
82
+ expect(@key).to_not eq(key3)
83
+ expect(key1).to_not eq(key2)
84
+ expect(key1).to_not eq(key3)
85
+ expect(key2).to_not eq(key3)
86
+ end
87
+ end # generate_key
88
+
89
+ context "generate_test_data" do
90
+ before(:each) do
91
+ @data = MemcacheCheck::Utils.generate_test_data
92
+ end
93
+
94
+ it "generates a data hash" do
95
+ expect(@data).to be_an_instance_of(Hash)
96
+ end
97
+
98
+ it "is a reasonable amount of data" do
99
+ expect(@data.length).to be >= 5
100
+ expect(@data.to_s.length).to be >= 500
101
+ end
102
+
103
+ it "is unique" do
104
+ data1 = MemcacheCheck::Utils.generate_test_data
105
+ data2 = MemcacheCheck::Utils.generate_test_data
106
+ data3 = MemcacheCheck::Utils.generate_test_data
107
+ expect(@data).to_not eq(data1)
108
+ expect(@data).to_not eq(data2)
109
+ expect(@data).to_not eq(data3)
110
+ expect(data1).to_not eq(data2)
111
+ expect(data1).to_not eq(data3)
112
+ expect(data2).to_not eq(data3)
113
+ end
114
+ end # generate_test_data
115
+ end # Utils
116
+
117
+ end
@@ -0,0 +1,17 @@
1
+ # This file was generated by the `rspec --init` command. Conventionally, all
2
+ # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
3
+ # Require this file using `require "spec_helper"` to ensure that it is only
4
+ # loaded once.
5
+ #
6
+ # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
7
+ RSpec.configure do |config|
8
+ config.treat_symbols_as_metadata_keys_with_true_values = true
9
+ config.run_all_when_everything_filtered = true
10
+ config.filter_run :focus
11
+
12
+ # Run specs in random order to surface order dependencies. If you find an
13
+ # order dependency and want to debug it, you can fix the order by providing
14
+ # the seed, which is printed after each run.
15
+ # --seed 1234
16
+ config.order = 'random'
17
+ end
metadata ADDED
@@ -0,0 +1,144 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: memcache_check
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Mike Admire
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2013-08-08 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ~>
18
+ - !ruby/object:Gem::Version
19
+ version: '1.3'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ~>
25
+ - !ruby/object:Gem::Version
26
+ version: '1.3'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - '>='
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - '>='
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - '>='
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - '>='
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: ZenTest
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ~>
60
+ - !ruby/object:Gem::Version
61
+ version: 4.9.2
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ~>
67
+ - !ruby/object:Gem::Version
68
+ version: 4.9.2
69
+ - !ruby/object:Gem::Dependency
70
+ name: dalli
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - '>='
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :runtime
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - '>='
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: faker
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - '>='
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :runtime
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - '>='
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ description: Run checks against a Memcached server
98
+ email:
99
+ - mike@mikeadmire.com
100
+ executables: []
101
+ extensions: []
102
+ extra_rdoc_files: []
103
+ files:
104
+ - .gitignore
105
+ - .rspec
106
+ - Gemfile
107
+ - LICENSE.txt
108
+ - README.md
109
+ - Rakefile
110
+ - autotest/discover.rb
111
+ - lib/memcache_check.rb
112
+ - lib/memcache_check/version.rb
113
+ - memcache_check.gemspec
114
+ - spec/lib/memcache_check_spec.rb
115
+ - spec/spec_helper.rb
116
+ homepage: https://github.com/mikeadmire/memcache_check
117
+ licenses:
118
+ - MIT
119
+ metadata: {}
120
+ post_install_message:
121
+ rdoc_options: []
122
+ require_paths:
123
+ - lib
124
+ required_ruby_version: !ruby/object:Gem::Requirement
125
+ requirements:
126
+ - - '>='
127
+ - !ruby/object:Gem::Version
128
+ version: '0'
129
+ required_rubygems_version: !ruby/object:Gem::Requirement
130
+ requirements:
131
+ - - '>='
132
+ - !ruby/object:Gem::Version
133
+ version: '0'
134
+ requirements: []
135
+ rubyforge_project:
136
+ rubygems_version: 2.0.6
137
+ signing_key:
138
+ specification_version: 4
139
+ summary: MemcacheCheck runs a series of set and get commands against a Memcache host
140
+ to validate data integrity, verify that the host is responding correctly, and benchmark
141
+ host speed.
142
+ test_files:
143
+ - spec/lib/memcache_check_spec.rb
144
+ - spec/spec_helper.rb