serverspec-extra-types 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c4ce9a546e2c4e66f97a22a3898e5aa5d02fa614f6c4ae1baa7ea00fa72ac41
+  data.tar.gz: 5d7c518a35cc6c4815873cf4d3a6c113d5f94131e4fc6f74e8e27ab9b07049be
+SHA512:
+  metadata.gz: c4d2a3f3606a724c0d1b8b50711432a59042b0de563d693172a9293aa125102d8e39de27235285ed63943ad60e8fb870772ceb70b7d187bc6e765d7c6ce1e648
+  data.tar.gz: 6caa5ca15e36ccb6551868b328800570068a01fc7fecb425c9dc85665d3668de032d10c65002ec8b14730a945d18c5c356c00d97948d5359f65233a390318a6b

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/
+# rspec failure tracking
+.rspec_status
+Gemfile.lock
+.vagrant/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  Exclude:
+    - 'serverspec-extra-types.gemspec'
+
+Metric/LineLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andrew.g.wardrobe@googlemail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in serverspec-extra-types.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrew Wardrobe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,191 @@
+# ServerspecExtraTypes
+
+serverspec-extra-types is a set of addition resource types and matchers for ServerSpec, providing types for technologies such as 
+docker swarm, consul, and rabbitmq.
+
+All checks run on the target, which can be useful when executing via a bastion host
+
+
+## Requirements
+* rabbitmq and consul checks requires curl to be installed on the target
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'serverspec-extra-types'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install serverspec-extra-types
+
+## Usage
+
+### docker_container
+Extension of the serverspec docker container type, and provides the following matchers:
+
+this type now supports selecting the container via a filter or by name
+##### exist
+Check if a container exists by name
+```ruby
+describe docker_container('focused_currie') do
+  it { should exist }
+end
+
+# Using a filter (useful for containers launch via docker swarm)
+describe docker_container('name=focused_currie') do
+  it { should exist }
+end
+```
+Check if a container exists by filter
+```ruby
+# Look for a container publishing port 80
+describe docker_container('publish=80') do
+  it { should exist }
+end
+```
+
+##### be_running
+Check if a container is runnig (from serverspec)
+```ruby
+describe docker_container('focused_curie') do
+  it { should be_running }
+end
+```
+##### have_image
+Check if container is running a spefic image
+```ruby
+describe docker_container('focused_currie') do
+  it { should have_image('jenkins/jenkins:lts') }
+end
+```
+##### have_hostname / has_host_name
+Check container hostname
+```ruby
+describe docker_container('focused_currie') do
+  it { should have_hostname('container1') }
+end
+```
+##### have_domainname / have_domain_name
+Check container domain name
+```ruby
+describe docker_container('focused_currie') do
+  it { should have_domainname('leek.com') }
+end
+```
+##### have_user / run_as_user
+Check if container is running as the specified user
+```ruby
+describe docker_container('focused_currie') do
+  it { should run_as_user('jenkins') }
+end
+```
+
+##### map_port
+Check if host port is mapped to container port
+```ruby
+describe docker_container('focused_currie') do
+  it { should map_port('80','8080') }
+end
+```
+Check if host port is mapped to container port using a specific protocol
+```ruby
+describe docker_container('focused_currie') do
+  it { should map_port('80','8080').using_protocol('tcp') }
+end
+```
+##### have_volume
+Check the for a volume (from serverspec)
+```ruby
+describe docker_container('focused_currie') do
+  it {  it { should have_volume('/tmp','/data') }}
+end
+```
+##### have_mount
+Check the for mounted volume
+```ruby
+describe docker_container('focused_currie') do
+  it { should have_mount('/var/run/docker.sock', '/var/run/docker.sock') }
+end
+```
+##### have_restart_policy
+Check the containers restart policy
+```ruby
+describe docker_container('focused_currie') do
+  it { should have_restart_policy('always') }
+end
+```
+##### have_restart_limit
+Check the containers restart limit
+```ruby
+describe docker_container('focused_currie') do
+  it { should have_restart_limit(1) }
+end
+```
+##### have_host
+Check for additional /etc/hosts entries
+```ruby
+describe docker_container('focused_currie') do
+  it { should have_host('8.8.8.8 dns') }
+end
+```
+##### have_environment_variable
+Check if the container has an specific environment variable
+```ruby
+describe docker_container('focused_currie') do
+  it { should have_environment_variable('CONSUL_VERSION')  }
+end
+# check its value
+describe docker_container('focused_currie') do
+  it { should have_environment_variable('CONSUL_VERSION').with_value('1.2.0') }
+end
+```
+
+##### be_privileged
+Check if the container runs in privileged mode
+```ruby
+describe docker_container('focused_currie') do
+  it { should be_privileged }
+end
+```
+
+##### publishes_all_ports
+Check if the container publishes all exposed ports
+```ruby
+describe docker_container('focused_currie') do
+  it { should publishes_all_ports }
+end
+```
+
+### docker_service
+##### exist
+Check if a service exists by name
+```ruby
+describe docker_service('my_service') do
+  it { should exist }
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/andrewwardrobe/serverspec-extra-types. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Serverspec::Extra::Types project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/serverspec-extra-types/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'serverspec_launcher/rake_tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'serverspec_extra_types/extra/serverspec_extra_types'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/serverspec_extra_types.rb

@@ -0,0 +1,3 @@
+require 'serverspec_extra_types/version'
+require 'serverspec_extra_types/matchers'
+require 'serverspec_extra_types/types'

data/lib/serverspec_extra_types/helpers/properties.rb

@@ -0,0 +1,11 @@
+require 'specinfra'
+
+rabbitmq_user = ENV['RABBITMQ_USER'] || 'guest'
+rabbitmq_password = ENV['RABBITMQ_PASSWORD'] || 'guest'
+rabbitmq_url = ENV['RABBITMQ_URL'] || 'http://localhost:15672'
+props = {
+  rabbitmq_user: rabbitmq_user,
+  rabbitmq_password: rabbitmq_password,
+  rabbitmq_url: rabbitmq_url
+}
+set_property props

data/lib/serverspec_extra_types/matchers.rb

@@ -0,0 +1,34 @@
+
+#--- Docker Matchers
+require 'serverspec_extra_types/matchers/be_active'
+require 'serverspec_extra_types/matchers/be_a_manager_node'
+require 'serverspec_extra_types/matchers/be_a_worker_node'
+require 'serverspec_extra_types/matchers/have_domain_name'
+require 'serverspec_extra_types/matchers/have_engine_version'
+require 'serverspec_extra_types/matchers/have_placement_constraint'
+require 'serverspec_extra_types/matchers/have_hostname'
+require 'serverspec_extra_types/matchers/have_host'
+require 'serverspec_extra_types/matchers/have_image'
+require 'serverspec_extra_types/matchers/have_image_sha'
+require 'serverspec_extra_types/matchers/have_restart_limit'
+require 'serverspec_extra_types/matchers/have_restart_policy'
+require 'serverspec_extra_types/matchers/have_environment_variable'
+require 'serverspec_extra_types/matchers/have_user'
+require 'serverspec_extra_types/matchers/have_mount'
+require 'serverspec_extra_types/matchers/publish_all_ports'
+require 'serverspec_extra_types/matchers/map_port'
+require 'serverspec_extra_types/matchers/be_active'
+require 'serverspec_extra_types/matchers/include_regex'
+require 'serverspec_extra_types/matchers/have_network'
+require 'serverspec_extra_types/matchers/have_replica_count'
+
+#--- RabbitMQ Matchers
+require 'serverspec_extra_types/matchers/have_ha_mode'
+require 'serverspec_extra_types/matchers/have_ha_nodes'
+require 'serverspec_extra_types/matchers/have_vhost'
+require 'serverspec_extra_types/matchers/have_ha_sync_mode'
+require 'serverspec_extra_types/matchers/mirror_all'
+require 'serverspec_extra_types/matchers/read_from_queue'
+require 'serverspec_extra_types/matchers/write_to_queue'
+require 'serverspec_extra_types/matchers/configure_queue'
+require 'serverspec_extra_types/matchers/have_count'

data/lib/serverspec_extra_types/matchers/be_a_manager_node.rb

@@ -0,0 +1,15 @@
+RSpec::Matchers.define :be_a_manager_node do
+  match do |actual|
+    actual.role == 'manager'
+  end
+  failure_message do |actual|
+    "expected '#{actual.role}' to be manager"
+  end
+  description do
+    'be a manager node'
+  end
+end
+
+RSpec::Matchers.alias_matcher :be_manager, :be_a_manager_node
+RSpec::Matchers.alias_matcher :be_a_manager, :be_a_manager_node
+RSpec::Matchers.alias_matcher :be_manager_node, :be_a_manager_node