dockerspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a39571e9f5eb647131860a8950bce41592c9887c
+  data.tar.gz: f61ee33d8d382ec51859aa15ea296cbf64acaf64
+SHA512:
+  metadata.gz: 9a4e57c561111f07730b533ff1e43514c19a6f6858be23acd1819203ad035aa4a425fba88a6dc718d7fde7b046055a6fd30afc1949b8a99f93c6414175eefb50
+  data.tar.gz: 9c40fd10e8cef3e785bbcc83cde4de774ae1dcef53d8d029ce6a1e507c7954641ee868d81788378ecfa34ad6afbbf03da871ddb78107a45635dd72cb1cefa897

data/.yardopts

@@ -0,0 +1,7 @@
+--markup markdown
+-
+CHANGELOG.md
+CONTRIBUTING.md
+README.md
+TESTING.md
+TODO.md

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG for Dockerspec
+
+This file is used to list changes made in each version of `dockerspec` Ruby Gem.
+
+## 0.1.0 (2015-12-09)
+
+* Initial release of `dockerspec`.

data/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+
+1. [Fork the repository on GitHub](https://help.github.com/articles/fork-a-repo).
+2. Create a named feature branch (`$ git checkout -b my-new-feature`).
+3. Write tests for your change (if applicable).
+4. Write your change.
+5. Add documentation to your change.
+6. [Run the tests](https://github.com/zuazo/dockerspec/blob/master/TESTING.md), ensuring they all pass (`$ bundle exec rake`). Try as much as possible **not to reduce coverage**.
+7. Commit your change (`$ git commit -am 'Add some feature'`).
+8. Push to the branch (`$ git push origin my-new-feature`).
+9. [Submit a Pull Request using GitHub](https://help.github.com/articles/creating-a-pull-request).
+
+You can see the [TODO.md](https://github.com/zuazo/dockerspec/blob/master/TODO.md) file if you're looking for inspiration.

data/LICENSE

@@ -0,0 +1,190 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2015 Xabier de Zuazo
+
+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,202 @@
+# Dockerspec
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg?style=flat)](http://www.rubydoc.info/gems/dockerspec)
+[![GitHub](http://img.shields.io/badge/github-zuazo/dockerspec-blue.svg?style=flat)](https://github.com/zuazo/dockerspec)
+[![License](https://img.shields.io/github/license/zuazo/dockerspec.svg?style=flat)](#license-and-author)
+
+[![Gem Version](https://badge.fury.io/rb/dockerspec.svg)](http://github.com/zuazo/dockerspec/releases)
+[![Dependency Status](http://img.shields.io/gemnasium/zuazo/dockerspec.svg?style=flat)](https://gemnasium.com/zuazo/dockerspec)
+[![Code Climate](http://img.shields.io/codeclimate/github/zuazo/dockerspec.svg?style=flat)](https://codeclimate.com/github/zuazo/dockerspec)
+[![Travis CI Build Status](http://img.shields.io/travis/zuazo/dockerspec/0.1.0.svg?style=flat)](https://travis-ci.org/zuazo/dockerspec)
+[![Circle CI Build Status](https://circleci.com/gh/zuazo/dockerspec/tree/master.svg?style=shield)](https://circleci.com/gh/zuazo/dockerspec/tree/master)
+[![Coverage Status](http://img.shields.io/coveralls/zuazo/dockerspec/0.1.0.svg?style=flat)](https://coveralls.io/r/zuazo/dockerspec?branch=0.1.0)
+[![Inline docs](http://inch-ci.org/github/zuazo/dockerspec.svg?branch=master&style=flat)](http://inch-ci.org/github/zuazo/dockerspec)
+
+## Description
+
+A small Ruby Gem to run RSpec and [Serverspec](http://serverspec.org/) tests against Dockerfiles or Docker images easily.
+
+This gem is designed to work out of the box on [Travis CI](https://travis-ci.org/), [CircleCI](https://circleci.com/) and other similar CI environments.
+
+## Requirements
+
+* Ruby `2` or higher.
+* Recommended Docker `1.7.0` or higher.
+
+## Installation
+
+You can install the Ruby Gem with:
+
+```
+$ gem install dockerspec
+```
+
+Or you can add this line to the *Gemfile* of your application:
+
+```ruby
+# Gemfile
+
+gem 'dockerspec', '~> 0.1.0'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+**Warning:** As the gem is in its early development stages, [the API is very likely to break between minor versions](http://semver.org/).
+
+## Documentation
+
+- [`docker_build`](http://www.rubydoc.info/gems/dockerspec/Dockerspec/RSpecResources#docker_build-instance_method)
+  - [*Docker Build* helpers](http://www.rubydoc.info/gems/dockerspec/Dockerspec/Builder/ConfigHelpers)
+- [`docker_run`](http://www.rubydoc.info/gems/dockerspec/Dockerspec/Serverspec/RSpecResources#docker_run-instance_method)
+  - [*Docker Run* Serverspec resource types](http://serverspec.org/resource_types.html)
+
+## Usage Examples
+
+### Run Tests Against a Dockerfile in the Current Directory
+
+```ruby
+require 'dockerspec'
+require 'dockerspec/serverspec'
+
+describe 'My Dockerfile' do
+  describe docker_build('.', tag: 'myapp') do
+
+    it { should have_maintainer /John Doe/ }
+    it { should have_cmd ['/bin/dash'] }
+    it { should have_expose '80' }
+    it { should have_user 'nobody' }
+
+    describe docker_run('myapp') do
+      describe file('/etc/httpd.conf') do
+        it { should be_file }
+        it { should contain 'ServerName www.example.jp' }
+      end
+
+      describe service('httpd') do
+        it { should be_enabled }
+        it { should be_running }
+      end
+    end
+  end
+end
+```
+
+See the documentation above for more examples.
+
+### Prepare the Ruby Environment
+
+1. Create a **Gemfile**:
+
+```ruby
+# Gemfile
+
+gem 'dockerspec', '~> 0.1.0'
+```
+
+2. Create the *spec/* directory:
+
+```
+$ mkdir spec
+```
+
+3. Add your tests to a file with the *spec/myapp_spec.rb* format:
+
+```ruby
+# spec/myapp_spec.rb
+
+require 'dockerspec'
+require 'dockerspec/serverspec'
+
+describe 'My Dockerfile' do
+  describe docker_build('.', tag: 'myapp') do
+    # [...]
+    describe docker_run('myapp') do
+      # [...]
+    end
+  end
+end
+```
+
+4. Install the gems:
+
+```
+$ bundle
+```
+
+5. Run the tests:
+
+```
+$ bundle exec rspec
+```
+
+### Travis CI Configuration Example
+
+**.travis.yml** file example:
+
+```yaml
+language: ruby
+
+rvm:
+- 2.0.0
+- 2.1
+- 2.2
+
+sudo: required
+
+services: docker
+
+script: travis_retry bundle exec rspec
+```
+
+### CircleCI Configuration Example
+
+**circle.yml** file example:
+
+```yaml
+machine:
+  services:
+  - docker
+  ruby:
+    version: 2.2.3
+
+test:
+  override:
+  - bundle exec rspec
+```
+
+## Testing
+
+See [TESTING.md](https://github.com/zuazo/dockerspec/blob/master/TESTING.md).
+
+## Contributing
+
+Please do not hesitate to [open an issue](https://github.com/zuazo/dockerspec/issues/new) with any questions or problems.
+
+See [CONTRIBUTING.md](https://github.com/zuazo/dockerspec/blob/master/CONTRIBUTING.md).
+
+## TODO
+
+See [TODO.md](https://github.com/zuazo/dockerspec/blob/master/TODO.md).
+
+## License and Author
+
+|                      |                                          |
+|:---------------------|:-----------------------------------------|
+| **Author:**          | [Xabier de Zuazo](https://github.com/zuazo) (<xabier@zuazo.org>)
+| **Copyright:**       | Copyright (c) 2015 Xabier de Zuazo
+| **License:**         | Apache License, Version 2.0
+
+    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/Rakefile

@@ -0,0 +1,57 @@
+# encoding: UTF-8
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# More info at https://github.com/ruby/rake/blob/master/doc/rakefile.rdoc
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc 'Clean some generated files'
+task :clean do
+  %w(
+    .bundle
+    .cache
+    coverage
+    doc
+    *.gem
+    Gemfile.lock
+    .inch
+    vendor
+    .yardoc
+  ).each { |f| FileUtils.rm_rf(Dir.glob(f)) }
+end
+
+desc 'Generate Ruby documentation'
+task :yard do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.stats_options = %w(--list-undoc)
+  end
+end
+
+task doc: %w(yard)
+
+desc 'Run RuboCop style checks'
+task :rubocop do
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+end
+
+desc 'Run all style checks'
+task style: %w(rubocop)
+
+require 'rspec/core/rake_task'
+
+{
+  test: '{unit,integration}',
+  unit: 'unit',
+  integration: 'integration'
+}.each do |test, dir|
+  RSpec::Core::RakeTask.new(test) do |t|
+    t.pattern = "spec/#{dir}/**{,/*/**}/*_spec.rb"
+    t.verbose = true
+  end
+end
+
+task default: %w(style test)