1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
> :warning: **This library will be deprecated in the future** :warning:
>
> You'll still be able to use previous versions of this gem, but there will be no new releases following to the [0.0.33](https://rubygems.org/gems/elasticsearch-extensions/versions/0.0.33) one.
>
> The feature set of this gem will be migrated into the `elasticsearch` gem.
>
# Elasticsearch::Extensions
This library provides a set of extensions to the
[`elasticsearch`](https://github.com/elasticsearch/elasticsearch-ruby) Rubygem.
## Installation
Install the package from [Rubygems](https://rubygems.org):
gem install elasticsearch-extensions
To use an unreleased version, either add it to your `Gemfile` for [Bundler](http://gembundler.com):
gem 'elasticsearch-extensions', git: 'git://github.com/elasticsearch/elasticsearch-ruby.git'
or install it from a source code checkout:
git clone https://github.com/elasticsearch/elasticsearch-ruby.git
cd elasticsearch-ruby/elasticsearch-extensions
bundle install
rake install
## Extensions
### Backup
Backup Elasticsearch indices as flat JSON files on the disk via integration
with the [_Backup_](http://backup.github.io/backup/v4/) gem.
Use the Backup gem's DSL to configure the backup:
require 'elasticsearch/extensions/backup'
Model.new(:elasticsearch_backup, 'Elasticsearch') do
database Elasticsearch do |db|
db.url = 'http://localhost:9200'
db.indices = 'test'
end
store_with Local do |local|
local.path = '/tmp/backups'
end
compress_with Gzip
end
Perform the backup with the Backup gem's command line utility:
$ backup perform -t elasticsearch_backup
See more information in the [`Backup::Database::Elasticsearch`](lib/elasticsearch/extensions/backup.rb)
class documentation.
### ANSI
Colorize and format selected Elasticsearch response parts in terminal:
Display formatted search results:
require 'elasticsearch/extensions/ansi'
puts Elasticsearch::Client.new.search.to_ansi
Display a table with the output of the `_analyze` API:
require 'elasticsearch/extensions/ansi'
puts Elasticsearch::Client.new.indices.analyze(text: 'Quick Brown Fox Jumped').to_ansi
[Full documentation](http://rubydoc.info/gems/elasticsearch-extensions/Elasticsearch/Extensions/ANSI)
### Test::Cluster
Allows to programatically start and stop an Elasticsearch cluster suitable for isolating tests.
The HTTP service is running on ports `9250-*` by default.
Start and stop the default cluster:
require 'elasticsearch/extensions/test/cluster'
Elasticsearch::Extensions::Test::Cluster.start
Elasticsearch::Extensions::Test::Cluster.stop
Start the cluster on specific port, with a specific Elasticsearch version, number of nodes and cluster name:
require 'elasticsearch/extensions/test/cluster'
Elasticsearch::Extensions::Test::Cluster.start \
cluster_name: "my-testing-cluster",
command: "/usr/local/Cellar/elasticsearch/0.90.10/bin/elasticsearch",
port: 9350,
number_of_nodes: 3
# Starting 3 Elasticsearch nodes.....................
# --------------------------------------------------------------------------------
# Cluster: my-testing-cluster
# Status: green
# Nodes: 3
# - node-1 | version: 1.0.0.Beta2, pid: 54469
# + node-2 | version: 1.0.0.Beta2, pid: 54470
# - node-3 | version: 1.0.0.Beta2, pid: 54468
# => true
Stop this cluster:
require 'elasticsearch/extensions/test/cluster'
Elasticsearch::Extensions::Test::Cluster.stop port: 9350
# Stopping Elasticsearch nodes... stopped PID 54469. stopped PID 54470. stopped PID 54468.
# # => [54469, 54470, 54468]
You can control the cluster configuration with environment variables as well:
TEST_CLUSTER_NAME=my-testing-cluster \
TEST_CLUSTER_COMMAND=/usr/local/Cellar/elasticsearch/0.90.10/bin/elasticsearch \
TEST_CLUSTER_PORT=9350 \
TEST_CLUSTER_NODES=3 \
TEST_CLUSTER_NAME=my_testing_cluster \
ruby -r elasticsearch -e "require 'elasticsearch/extensions/test/cluster'; Elasticsearch::Extensions::Test::Cluster.start"
To prevent deleting data and configurations when the cluster is started, for example in a development environment,
use the `clear_cluster: false` option or the `TEST_CLUSTER_CLEAR=false` environment variable.
[Full documentation](http://rubydoc.info/gems/elasticsearch-extensions/Elasticsearch/Extensions/Test/Cluster)
### Test::StartupShutdown
Allows to register `startup` and `shutdown` hooks for Test::Unit, similarly to RSpec's `before(:all)`,
compatible with the [Test::Unit 2](https://github.com/test-unit/test-unit/blob/master/lib/test/unit/testcase.rb) syntax.
The extension is useful for e.g. starting the testing Elasticsearch cluster before the test suite is executed,
and stopping it afterwards.
** IMPORTANT NOTE ** You have to register the handler for `shutdown` hook before requiring 'test/unit':
# File: test_helper.rb
at_exit { MyTest.__run_at_exit_hooks }
require 'test/unit'
Example of handler registration:
class MyTest < Test::Unit::TestCase
extend Elasticsearch::Extensions::Test::StartupShutdown
startup { puts "Suite starting up..." }
shutdown { puts "Suite shutting down..." }
end
[Full documentation](http://rubydoc.info/gems/elasticsearch-extensions/Elasticsearch/Extensions/Test/StartupShutdown)
Examples in the Elasticsearch gem test suite: [1](https://github.com/elasticsearch/elasticsearch-ruby/blob/master/elasticsearch-transport/test/integration/client_test.rb#L4-L6), [2](https://github.com/elasticsearch/elasticsearch-ruby/blob/master/elasticsearch-transport/test/test_helper.rb#L44)
### Test::Profiling
Allows to define and execute profiling tests within [Shoulda](https://github.com/thoughtbot/shoulda) contexts.
Measures operations and reports statistics, including code profile.
Let's define a simple profiling test in a `profiling_test.rb` file:
require 'test/unit'
require 'shoulda/context'
require 'elasticsearch/extensions/test/profiling'
class ProfilingTest < Test::Unit::TestCase
extend Elasticsearch::Extensions::Test::Profiling
context "Mathematics" do
measure "divide numbers", count: 10_000 do
assert_nothing_raised { 1/2 }
end
end
end
Let's run it:
$ QUIET=y ruby profiling_test.rb
...
ProfilingTest
-------------------------------------------------------------------------------
Context: Mathematics should divide numbers (10000x)
mean: 0.03ms | avg: 0.03ms | max: 0.14ms
-------------------------------------------------------------------------------
PASS (0:00:00.490) test: Mathematics should divide numbers (10000x).
...
When using the `QUIET` option, only the statistics on operation throughput are printed.
When omitted, the full code profile by [RubyProf](https://github.com/ruby-prof/ruby-prof) is printed.
[Full documentation](http://rubydoc.info/gems/elasticsearch-extensions/Elasticsearch/Extensions/Test/StartupShutdown)
[Example in the Elasticsearch gem](https://github.com/elasticsearch/elasticsearch-ruby/blob/master/elasticsearch-transport/test/profile/client_benchmark_test.rb)
## Development
To work on the code, clone and bootstrap the main repository first --
please see instructions in the main [README](../README.md#development).
To run tests, launch a testing cluster -- again, see instructions
in the main [README](../README.md#development) -- and use the Rake tasks:
```
time rake test:unit
time rake test:integration
```
Unit tests have to use Ruby 1.8 compatible syntax, integration tests
can use Ruby 2.x syntax and features.
## License
This software is licensed under the [Apache 2 license](./LICENSE).
|
