specinfra-backend-docker_compose 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: c8542b472aba1105bdf2e970976dea267241c61f
4
+ data.tar.gz: a4c8aca43f370e472dd54767baa23361bf4be128
5
+ SHA512:
6
+ metadata.gz: 5b95b9b7c0582e33b084f2d501f95f0e77e1d747a1750925f10de072fdea162ed35385e1cb6b0cc789956ebf290c619f5c3d46889b29abdd7a654b284ef664df
7
+ data.tar.gz: c2fd6ad7ef378f818fa51eaa67c5eb882e1f71a7548b68e082f4f64634e0f0b3c2f09e9922360ba10d3b15003c4db9de074a86ce6cd6aa433a123173add9f408
@@ -0,0 +1,7 @@
1
+ --markup markdown
2
+ -
3
+ CHANGELOG.md
4
+ CONTRIBUTING.md
5
+ README.md
6
+ TESTING.md
7
+ TODO.md
@@ -0,0 +1,7 @@
1
+ # CHANGELOG for specinfra-backend-docker_compose
2
+
3
+ This file is used to list changes made in each version of `specinfra-backend-docker_compose`.
4
+
5
+ ## 0.1.0 (2016-01-08)
6
+
7
+ * Initial release of `specinfra-backend-docker_compose`.
@@ -0,0 +1,13 @@
1
+ # Contributing
2
+
3
+ 1. [Fork the repository on GitHub](https://help.github.com/articles/fork-a-repo).
4
+ 2. Create a named feature branch (`$ git checkout -b my-new-feature`).
5
+ 3. Write tests for your change (if applicable).
6
+ 4. Write your change.
7
+ 5. Add documentation to your change.
8
+ 6. [Run the tests](https://github.com/zuazo/specinfra-backend-docker_compose/blob/master/TESTING.md), ensuring they all pass (`$ bundle exec rake`). Try as much as possible **not to reduce coverage**.
9
+ 7. Commit your change (`$ git commit -am 'Add some feature'`).
10
+ 8. Push to the branch (`$ git push origin my-new-feature`).
11
+ 9. [Submit a Pull Request using GitHub](https://help.github.com/articles/creating-a-pull-request).
12
+
13
+ You can see the [TODO.md](https://github.com/zuazo/specinfra-backend-docker_compose/blob/master/TODO.md) file if you're looking for inspiration.
data/LICENSE ADDED
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2016 Xabier de Zuazo
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
@@ -0,0 +1,146 @@
1
+ # Specinfra Docker Compose Backend
2
+ [![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg?style=flat)](http://www.rubydoc.info/gems/specinfra-backend-docker_compose)
3
+ [![GitHub](http://img.shields.io/badge/github-z/specinfra--backend--docker__compose-blue.svg?style=flat)](https://github.com/zuazo/specinfra-backend-docker_compose)
4
+ [![License](https://img.shields.io/github/license/zuazo/specinfra-backend-docker_compose.svg?style=flat)](#license-and-author)
5
+
6
+ [![Gem Version](https://badge.fury.io/rb/specinfra-backend-docker_compose.svg)](https://rubygems.org/gems/specinfra-backend-docker_compose)
7
+ [![Dependency Status](http://img.shields.io/gemnasium/zuazo/specinfra-backend-docker_compose.svg?style=flat)](https://gemnasium.com/zuazo/specinfra-backend-docker_compose)
8
+ [![Code Climate](http://img.shields.io/codeclimate/github/zuazo/specinfra-backend-docker_compose.svg?style=flat)](https://codeclimate.com/github/zuazo/specinfra-backend-docker_compose)
9
+ [![Travis CI Build Status](http://img.shields.io/travis/zuazo/specinfra-backend-docker_compose/0.1.0.svg?style=flat)](https://travis-ci.org/zuazo/specinfra-backend-docker_compose)
10
+ [![Circle CI Build Status](https://circleci.com/gh/zuazo/specinfra-backend-docker_compose/tree/master.svg?style=shield)](https://circleci.com/gh/zuazo/specinfra-backend-docker_compose/tree/master)
11
+ [![Coverage Status](http://img.shields.io/coveralls/zuazo/specinfra-backend-docker_compose/0.1.0.svg?style=flat)](https://coveralls.io/r/zuazo/specinfra-backend-docker_compose?branch=0.1.0)
12
+ [![Inline docs](http://inch-ci.org/github/zuazo/specinfra-backend-docker_compose.svg?branch=master&style=flat)](http://inch-ci.org/github/zuazo/specinfra-backend-docker_compose)
13
+
14
+ [Serverspec](http://serverspec.org/) / [Specinfra](https://github.com/mizzy/specinfra) backend for [Docker Compose](https://docs.docker.com/compose/).
15
+
16
+ ## Requirements
17
+
18
+ * Recommended Docker `1.7.0` or higher.
19
+ * Docker Compose
20
+
21
+ ## Installation
22
+
23
+ Add this line to your application's Gemfile:
24
+
25
+ ```ruby
26
+ # Gemfile
27
+
28
+ gem 'specinfra-backend-docker_compose', '~> 0.1.0'
29
+ ```
30
+
31
+ And then execute:
32
+
33
+ $ bundle
34
+
35
+ Or install it yourself as:
36
+
37
+ $ gem install specinfra-backend-docker_compose
38
+
39
+ ## Usage
40
+
41
+ Create the [Docker Compose configuration](https://docs.docker.com/v1.8/compose/yml/) to test:
42
+
43
+ ```yaml
44
+ # docker-compose.yml
45
+
46
+ web:
47
+ build: .
48
+ links:
49
+ - db:mysql
50
+ ports:
51
+ - 8080:80
52
+
53
+ db:
54
+ image: mariadb
55
+ environment:
56
+ - MYSQL_ROOT_PASSWORD=example
57
+ ```
58
+
59
+ And a file example with some Serverspec tests:
60
+
61
+ ```ruby
62
+ # web_test_spec.rb
63
+
64
+ require 'serverspec'
65
+ require 'specinfra/backend/docker_compose'
66
+
67
+ set :docker_compose_file, './docker-compose.yml'
68
+ set :docker_compose_container, :web # The compose container to test
69
+ set :docker_wait, 15 # wait 15 seconds before running the tests
70
+ set :backend, :docker_compose
71
+
72
+ describe 'docker-compose.yml run' do
73
+ describe service('httpd') do
74
+ it { should be_enabled }
75
+ it { should be_running }
76
+ end
77
+ end
78
+ ```
79
+
80
+ To run the tests:
81
+
82
+ $ rspec web_test_spec.rb
83
+
84
+ ## Configuration
85
+
86
+ Uses the following `Specinfra` configuration options:
87
+
88
+ - `:docker_compose_file`: Docker Compose configuration file path (**required**).
89
+ - `:docker_compose_container`: The name of the container you want to test (**required**). Only one can be tested.
90
+ - `:docker_wait`: Seconds to wait for containers to start (i.e., time to sleep before running the tests) (**recommended**).
91
+ - `:backend`: `:docker_compose` or `:docker_compose_lxc` (for LXC execution driver). Always set it after all other options.
92
+
93
+ Keep in mind that some CI environments may be somewhat slower than usual. So maybe you will need to increase the `:docker_wait` value to one or two minutes to allow more time for services to start.
94
+
95
+ Some options used only by the `:docker_compose_lxc` backend:
96
+
97
+ - `:sudo_options`: Sudo command argument list as string or as array.
98
+ - `:sudo_path`: Sudo binary directory.
99
+ - `:sudo_password`
100
+ - `:disable_sudo`: whether to disable Sudo (enabled by default).
101
+
102
+ For example:
103
+
104
+ ```ruby
105
+ set :sudo_password, '0deH3R7RbHoEwzIqQGCD'
106
+ ```
107
+
108
+ ## Important Warning
109
+
110
+ This backend uses the [`docker-compose-api`](https://rubygems.org/gems/docker-compose-api) Ruby gem to emulate Docker Compose. So, some *docker-compose.yml* configuration options may not be supported yet or may not work exactly the same. Let us know if you find any bug or you need a missing feature.
111
+
112
+ Thanks to [Mauricio Klein](https://github.com/mauricioklein) for all his work by the way!
113
+
114
+ ## Testing
115
+
116
+ See [TESTING.md](https://github.com/zuazo/specinfra-backend-docker_compose/blob/master/TESTING.md).
117
+
118
+ ## Contributing
119
+
120
+ Please do not hesitate to [open an issue](https://github.com/zuazo/specinfra-backend-docker_compose/issues/new) with any questions or problems.
121
+
122
+ See [CONTRIBUTING.md](https://github.com/zuazo/specinfra-backend-docker_compose/blob/master/CONTRIBUTING.md).
123
+
124
+ ## TODO
125
+
126
+ See [TODO.md](https://github.com/zuazo/specinfra-backend-docker_compose/blob/master/TODO.md).
127
+
128
+ ## License and Author
129
+
130
+ | | |
131
+ |:---------------------|:-----------------------------------------|
132
+ | **Author:** | [Xabier de Zuazo](https://github.com/zuazo) (<xabier@zuazo.org>)
133
+ | **Copyright:** | Copyright (c) 2016 Xabier de Zuazo
134
+ | **License:** | Apache License, Version 2.0
135
+
136
+ Licensed under the Apache License, Version 2.0 (the "License");
137
+ you may not use this file except in compliance with the License.
138
+ You may obtain a copy of the License at
139
+
140
+ http://www.apache.org/licenses/LICENSE-2.0
141
+
142
+ Unless required by applicable law or agreed to in writing, software
143
+ distributed under the License is distributed on an "AS IS" BASIS,
144
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
145
+ See the License for the specific language governing permissions and
146
+ limitations under the License.
@@ -0,0 +1,57 @@
1
+ # encoding: UTF-8
2
+ # -*- mode: ruby -*-
3
+ # vi: set ft=ruby :
4
+
5
+ # More info at https://github.com/ruby/rake/blob/master/doc/rakefile.rdoc
6
+
7
+ require 'bundler'
8
+ Bundler::GemHelper.install_tasks
9
+
10
+ desc 'Clean some generated files'
11
+ task :clean do
12
+ %w(
13
+ .bundle
14
+ .cache
15
+ coverage
16
+ doc
17
+ *.gem
18
+ Gemfile.lock
19
+ .inch
20
+ vendor
21
+ .yardoc
22
+ ).each { |f| FileUtils.rm_rf(Dir.glob(f)) }
23
+ end
24
+
25
+ desc 'Generate Ruby documentation'
26
+ task :yard do
27
+ require 'yard'
28
+ YARD::Rake::YardocTask.new do |t|
29
+ t.stats_options = %w(--list-undoc)
30
+ end
31
+ end
32
+
33
+ task doc: %w(yard)
34
+
35
+ desc 'Run RuboCop style checks'
36
+ task :rubocop do
37
+ require 'rubocop/rake_task'
38
+ RuboCop::RakeTask.new
39
+ end
40
+
41
+ desc 'Run all style checks'
42
+ task style: %w(rubocop)
43
+
44
+ require 'rspec/core/rake_task'
45
+
46
+ {
47
+ test: '{unit,integration}',
48
+ unit: 'unit',
49
+ integration: 'integration'
50
+ }.each do |test, dir|
51
+ RSpec::Core::RakeTask.new(test) do |t|
52
+ t.pattern = "spec/#{dir}/**{,/*/**}/*_spec.rb"
53
+ t.verbose = true
54
+ end
55
+ end
56
+
57
+ task default: %w(style test)
@@ -0,0 +1,30 @@
1
+ # Testing
2
+
3
+ ## Installing the Requirements
4
+
5
+ You can install gem dependencies with bundler:
6
+
7
+ $ gem install bundler
8
+ $ bundler install
9
+
10
+ ## Generate Documentation
11
+
12
+ $ bundle exec rake doc
13
+
14
+ This will generate the HTML documentation in the `doc/` directory.
15
+
16
+ ## All the Tests
17
+
18
+ $ bundle exec rake test
19
+
20
+ ## Running the Syntax Style Tests
21
+
22
+ $ bundle exec rake style
23
+
24
+ ## Running the Unit Tests
25
+
26
+ $ bundle exec rake unit
27
+
28
+ ## Running the Integration Tests
29
+
30
+ $ bundle exec rake integration
data/TODO.md ADDED
@@ -0,0 +1,3 @@
1
+ # TODO for specinfra-backend-docker_compose
2
+
3
+ * [ ] ...
@@ -0,0 +1,218 @@
1
+ # encoding: UTF-8
2
+ #
3
+ # Author:: Xabier de Zuazo (<xabier@zuazo.org>)
4
+ # Copyright:: Copyright (c) 2016 Xabier de Zuazo
5
+ # License:: Apache License, Version 2.0
6
+ #
7
+ # Licensed under the Apache License, Version 2.0 (the "License");
8
+ # you may not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing, software
14
+ # distributed under the License is distributed on an "AS IS" BASIS,
15
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+
20
+ require 'docker-compose'
21
+ require 'specinfra/backend/exec'
22
+
23
+ # Command Execution Framework for Serverspec, Itamae and so on.
24
+ module Specinfra
25
+ # Specinfra backend types.
26
+ module Backend
27
+ # Specinfra and Serverspec backend for Docker Compose.
28
+ class DockerCompose < Exec
29
+ # Constructs a Docker Compose Specinfra Backend.
30
+ #
31
+ # @param config [Hash] Configuration options.
32
+ # @option config [String] docker_compose_file: Docker Compose
33
+ # configuration file path (**required**).
34
+ # @option config [String] docker_compose_container: The name of the
35
+ # container you want to test (**required**). Only one can be tested.
36
+ # @option config [Fixnum] docker_wait: Seconds to wait for containers to
37
+ # start (i.e., time to sleep before running the tests)
38
+ # (**recommended**).
39
+ # @api public
40
+ def initialize(config = {})
41
+ super
42
+
43
+ ::Docker.url = get_config(:docker_url)
44
+
45
+ file = get_config(:docker_compose_file)
46
+ fail 'Please specify docker_compose_file.' unless file
47
+
48
+ @compose = ::DockerCompose.load(file)
49
+ ObjectSpace.define_finalizer(self, proc { finalize })
50
+ Dir.chdir(::File.dirname(file)) { do_start }
51
+ end
52
+
53
+ # Runs a Specinfra command.
54
+ #
55
+ # @param cmd [String] The command to run.
56
+ # @param opts [Hash] Options to pass to {Docker::Container#exec}.
57
+ # @return nil
58
+ # @api public
59
+ def run_command(cmd, opts = {})
60
+ cmd = build_command(cmd)
61
+ cmd = add_pre_command(cmd)
62
+ docker_compose_run!(cmd, opts)
63
+ end
64
+
65
+ # Builds a command.
66
+ #
67
+ # Does nothing.
68
+ #
69
+ # @param cmd [String] The command to run.
70
+ # @return [String] The command.
71
+ # @api public
72
+ def build_command(cmd)
73
+ cmd
74
+ end
75
+
76
+ # Adds a prefix or previous instruction to the command.
77
+ #
78
+ # Does nothing.
79
+ #
80
+ # @param cmd [String] The command to run.
81
+ # @return [String] The command.
82
+ # @api public
83
+ def add_pre_command(cmd)
84
+ cmd
85
+ end
86
+
87
+ # Sends a file.
88
+ #
89
+ # @note Not implemented yet.
90
+ # @param _from [String] The file origin.
91
+ # @param _to [String] The file destination.
92
+ # @raise [RuntimeError] Always raises an error.
93
+ # @return nil
94
+ # @api public
95
+ def send_file(_from, _to)
96
+ fail 'docker_compose does not support send_file'
97
+ end
98
+
99
+ protected
100
+
101
+ # Returns the selected Docker Container name.
102
+ #
103
+ # Gets the container name to return from the `:docker_compose_container`
104
+ # Specinfra configuration option.
105
+ #
106
+ # @return [String] The container name.
107
+ # @api private
108
+ def docker_compose_container
109
+ get_config(:docker_compose_container).to_s
110
+ end
111
+
112
+ # Returns the selected Docker Container object.
113
+ #
114
+ # Gets the container name to return from the `:docker_compose_container`
115
+ # Specinfra configuration option.
116
+ #
117
+ # @return [Docker::Container] The container object.
118
+ # @raise [RuntimeError] When the container is not selected or the
119
+ # selected container is not found.
120
+ # @api private
121
+ def container
122
+ if docker_compose_container.empty?
123
+ fail 'Please specify docker_compose_container.'
124
+ end
125
+ compose_container = @compose.containers[docker_compose_container]
126
+ if compose_container.nil?
127
+ fail "Container not found: #{docker_compose_container.inspect}"
128
+ end
129
+ compose_container.container
130
+ end
131
+
132
+ # Stops the containers started by Docker Compose and deletes them.
133
+ #
134
+ # Called automatically when this object is destroyed.
135
+ #
136
+ # @return nil
137
+ # @api private
138
+ def finalize
139
+ @compose.stop
140
+ @compose.delete
141
+ end
142
+
143
+ # Parses a rescued exception and returns the command result.
144
+ #
145
+ # @param cmd [Array<String>, String] The command.
146
+ # @param exception [Exception] The exception to parse.
147
+ # @return [Specinfra::CommandResult] The generated result object.
148
+ # @api public
149
+ def erroneous_result(cmd, exception)
150
+ stdout = nil
151
+ stderr = ([exception.message] + exception.backtrace).join("\n")
152
+ status = 1
153
+ rspec_example_metadata(cmd, stdout, stderr)
154
+ CommandResult.new(stdout: stdout, stderr: stderr, exit_status: status)
155
+ end
156
+
157
+ # Updates RSpec metadata used by Serverspec.
158
+ #
159
+ # @param cmd [Array<String>, String] The command.
160
+ # @param stdout [String, nil] The *stdout* output.
161
+ # @param stderr [String, nil] The *stderr* output.
162
+ # @return nil
163
+ # @api public
164
+ def rspec_example_metadata(cmd, stdout, stderr)
165
+ return unless @example
166
+ @example.metadata[:command] = cmd
167
+ @example.metadata[:stdout] = stdout
168
+ @example.metadata[:stderr] = stderr
169
+ end
170
+
171
+ # Runs a command inside a Docker Compose container.
172
+ #
173
+ # @param cmd [String] The command to run.
174
+ # @param opts [Hash] Options to pass to {Docker::Container#exec}.
175
+ # @return [Specinfra::CommandResult] The result.
176
+ # @api public
177
+ def docker_compose_run!(cmd, opts = {})
178
+ stdout, stderr, status = container.exec(['/bin/sh', '-c', cmd], opts)
179
+ rspec_example_metadata(cmd, stdout.join, stderr.join)
180
+ CommandResult.new(
181
+ stdout: stdout.join, stderr: stderr.join, exit_status: status
182
+ )
183
+ rescue ::Docker::Error::DockerError
184
+ raise
185
+ rescue => e
186
+ finalize
187
+ erroneous_result(cmd, e)
188
+ end
189
+
190
+ # Starts Docker Compose and its containers.
191
+ #
192
+ # It also calculates the time to wait before running the tests.
193
+ #
194
+ # @return nil
195
+ # @api private
196
+ def do_start
197
+ start_time = Time.new
198
+ @compose.start
199
+ do_wait((Time.new - start_time).to_i)
200
+ end
201
+
202
+ # Sleeps for some time if required.
203
+ #
204
+ # Reads the seconds to sleep from the `:docker_wait` Specinfra
205
+ # configuration option.
206
+ #
207
+ # @param waited [Integer] The time already waited.
208
+ # @return nil
209
+ # @api private
210
+ def do_wait(waited)
211
+ wait = get_config(:docker_wait)
212
+ return unless wait.is_a?(Integer) || wait.is_a?(Float)
213
+ return if waited >= wait
214
+ sleep(wait - waited)
215
+ end
216
+ end
217
+ end
218
+ end
@@ -0,0 +1,75 @@
1
+ # encoding: UTF-8
2
+ #
3
+ # Author:: Xabier de Zuazo (<xabier@zuazo.org>)
4
+ # Copyright:: Copyright (c) 2016 Xabier de Zuazo
5
+ # License:: Apache License, Version 2.0
6
+ #
7
+ # Licensed under the Apache License, Version 2.0 (the "License");
8
+ # you may not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing, software
14
+ # distributed under the License is distributed on an "AS IS" BASIS,
15
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+
20
+ require 'specinfra/backend/docker_compose'
21
+ require 'specinfra/backend/docker_lxc/exceptions'
22
+ require 'specinfra/backend/docker_lxc/shell_helpers'
23
+
24
+ # Command Execution Framework for Serverspec, Itamae and so on.
25
+ module Specinfra
26
+ # Specinfra backend types.
27
+ module Backend
28
+ # Specinfra and Serverspec backend for Docker Compose using LXC execution
29
+ # driver.
30
+ class DockerComposeLxc < DockerCompose
31
+ include Specinfra::Backend::DockerLxc::ShellHelpers
32
+
33
+ protected
34
+
35
+ # Generates `lxc-attach` command to run.
36
+ #
37
+ # @param cmd [String] The commands to run inside docker.
38
+ # @return [Array] The command to run as unescaped array.
39
+ def lxc_attach_command(cmd)
40
+ id = container.id
41
+ ['lxc-attach', '-n', id, '--', 'sh', '-c', cmd]
42
+ end
43
+
44
+ # Parses `lxc-attach` command output and raises an exception if it is an
45
+ # error from the `lxc-attach` program.
46
+ #
47
+ # @param stderr [String] Command *stderr* output.
48
+ # @param exit_status [Fixnum] Command exit status.
49
+ # @return nil
50
+ def lxc_attach_result_assert(stderr, exit_status)
51
+ return if exit_status == 0
52
+ return if stderr.match(/\A(lxc-attach|lxc_container|sudo): /).nil?
53
+ fail DockerLxc::LxcAttachError, stderr
54
+ end
55
+
56
+ # Runs a command inside a Docker Compose container.
57
+ #
58
+ # @param cmd [String] The command to run.
59
+ # @param opts [Hash] Options to pass to {Open3.popen3}.
60
+ # @return [Specinfra::CommandResult] The result.
61
+ # @api public
62
+ def docker_compose_run!(cmd, opts = {})
63
+ stdout, stderr, status = shell_command!(lxc_attach_command(cmd), opts)
64
+ lxc_attach_result_assert(stderr, status)
65
+ rspec_example_metadata(cmd, stdout, stderr)
66
+ CommandResult.new(stdout: stdout, stderr: stderr, exit_status: status)
67
+ rescue DockerLxc::LxcAttachError
68
+ raise
69
+ rescue => e
70
+ finalize
71
+ erroneous_result(cmd, e)
72
+ end
73
+ end
74
+ end
75
+ end
@@ -0,0 +1,56 @@
1
+ # encoding: UTF-8
2
+ #
3
+ # Author:: Xabier de Zuazo (<xabier@zuazo.org>)
4
+ # Copyright:: Copyright (c) 2016 Xabier de Zuazo
5
+ # License:: Apache License, Version 2.0
6
+ #
7
+ # Licensed under the Apache License, Version 2.0 (the "License");
8
+ # you may not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing, software
14
+ # distributed under the License is distributed on an "AS IS" BASIS,
15
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+
20
+ require 'simplecov'
21
+ if ENV['TRAVIS']
22
+ require 'coveralls'
23
+ SimpleCov.formatter = Coveralls::SimpleCov::Formatter
24
+ end
25
+ SimpleCov.start do
26
+ add_filter '/spec/'
27
+ end
28
+
29
+ require 'specinfra'
30
+ require 'specinfra/backend/docker_compose'
31
+ require 'specinfra/backend/docker_compose_lxc'
32
+ require 'docker'
33
+
34
+ Specinfra.configuration.backend(:base)
35
+
36
+ require 'should_not/rspec'
37
+
38
+ require 'support/docker_logger'
39
+ require 'support/rspec_filters'
40
+ require 'support/docker_compose_helpers'
41
+
42
+ RSpec.configure do |config|
43
+ # Prohibit using the should syntax
44
+ config.expect_with :rspec do |spec|
45
+ spec.syntax = :expect
46
+ end
47
+
48
+ config.order = 'random'
49
+
50
+ config.color = true
51
+ config.tty = true
52
+
53
+ config.filter_run_excluding lxc_driver: true unless lxc_execution_driver?
54
+
55
+ config.before(:each) { DockerComposeHelpers.configuration_reset }
56
+ end
metadata ADDED
@@ -0,0 +1,252 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: specinfra-backend-docker_compose
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Xabier de Zuazo
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2016-01-08 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: specinfra
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '2.13'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '2.13'
27
+ - !ruby/object:Gem::Dependency
28
+ name: docker-compose-api
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: specinfra-backend-docker_lxc
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: 0.2.0
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: 0.2.0
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '10.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '10.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rspec-core
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '3.1'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '3.1'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rspec-expectations
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '3.1'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '3.1'
97
+ - !ruby/object:Gem::Dependency
98
+ name: rspec-mocks
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '3.1'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '3.1'
111
+ - !ruby/object:Gem::Dependency
112
+ name: coveralls
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '0.7'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: '0.7'
125
+ - !ruby/object:Gem::Dependency
126
+ name: simplecov
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: '0.9'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: '0.9'
139
+ - !ruby/object:Gem::Dependency
140
+ name: should_not
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - "~>"
144
+ - !ruby/object:Gem::Version
145
+ version: '1.1'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - "~>"
151
+ - !ruby/object:Gem::Version
152
+ version: '1.1'
153
+ - !ruby/object:Gem::Dependency
154
+ name: rubocop
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - "~>"
158
+ - !ruby/object:Gem::Version
159
+ version: 0.35.0
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - "~>"
165
+ - !ruby/object:Gem::Version
166
+ version: 0.35.0
167
+ - !ruby/object:Gem::Dependency
168
+ name: yard
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - "~>"
172
+ - !ruby/object:Gem::Version
173
+ version: '0.8'
174
+ type: :development
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - "~>"
179
+ - !ruby/object:Gem::Version
180
+ version: '0.8'
181
+ - !ruby/object:Gem::Dependency
182
+ name: docker-api
183
+ requirement: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - "~>"
186
+ - !ruby/object:Gem::Version
187
+ version: '1.22'
188
+ type: :development
189
+ prerelease: false
190
+ version_requirements: !ruby/object:Gem::Requirement
191
+ requirements:
192
+ - - "~>"
193
+ - !ruby/object:Gem::Version
194
+ version: '1.22'
195
+ - !ruby/object:Gem::Dependency
196
+ name: serverspec
197
+ requirement: !ruby/object:Gem::Requirement
198
+ requirements:
199
+ - - "~>"
200
+ - !ruby/object:Gem::Version
201
+ version: '2.24'
202
+ type: :development
203
+ prerelease: false
204
+ version_requirements: !ruby/object:Gem::Requirement
205
+ requirements:
206
+ - - "~>"
207
+ - !ruby/object:Gem::Version
208
+ version: '2.24'
209
+ description: Serverspec / Specinfra backend for Docker Compose.
210
+ email: xabier@zuazo.org
211
+ executables: []
212
+ extensions: []
213
+ extra_rdoc_files: []
214
+ files:
215
+ - ".yardopts"
216
+ - CHANGELOG.md
217
+ - CONTRIBUTING.md
218
+ - LICENSE
219
+ - README.md
220
+ - Rakefile
221
+ - TESTING.md
222
+ - TODO.md
223
+ - lib/specinfra/backend/docker_compose.rb
224
+ - lib/specinfra/backend/docker_compose_lxc.rb
225
+ - spec/spec_helper.rb
226
+ homepage: https://github.com/zuazo/specinfra-backend-docker_compose
227
+ licenses:
228
+ - Apache-2.0
229
+ metadata: {}
230
+ post_install_message:
231
+ rdoc_options: []
232
+ require_paths:
233
+ - lib
234
+ required_ruby_version: !ruby/object:Gem::Requirement
235
+ requirements:
236
+ - - ">="
237
+ - !ruby/object:Gem::Version
238
+ version: 2.0.0
239
+ required_rubygems_version: !ruby/object:Gem::Requirement
240
+ requirements:
241
+ - - ">="
242
+ - !ruby/object:Gem::Version
243
+ version: '0'
244
+ requirements: []
245
+ rubyforge_project:
246
+ rubygems_version: 2.2.2
247
+ signing_key:
248
+ specification_version: 4
249
+ summary: Specinfra Docker Compose Backend
250
+ test_files:
251
+ - spec/spec_helper.rb
252
+ has_rdoc: