compose_cucumber 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ce157fd89aede22d6a0e0f59c0e77b8909caede
+  data.tar.gz: 70d362d20fa1737d573e0ec6b65c2cb9fea0045e
+SHA512:
+  metadata.gz: 134df74f93ed7a819d89742aeb0db15eae760a7f8eedfeff2e1c76a83101ace3383ea7fa8eb8bd54d48983f40f772209d29a5ed902ce41e789a64e1d76d1b855
+  data.tar.gz: 0e1f6a7b0a4c836216c785f7018975b3174e97c0ddd959ec50e6deb8ea00f819d433156deeb22a4c1a8f3e19bdd08db8a57e190091c28f28bd96e557e2116e44

data/.rubocop.yml

@@ -0,0 +1,45 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-03-29 02:41:14 +0200 using RuboCop version 0.38.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/RescueException:
+  Exclude:
+    - 'lib/compose_cucumber/world.rb'
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 28
+
+# Offense count: 13
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 130
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 17
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Performance/RedundantBlockCall:
+  Exclude:
+    - 'lib/compose_cucumber/world.rb'
+
+# Offense count: 1
+Style/ClassVars:
+  Exclude:
+    - 'lib/compose_cucumber/world.rb'
+
+# Offense count: 1
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/compose_cucumber/world.rb'

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+ - 2.1.0
+ - 2.0.0

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gem 'rubocop'
+gem 'docker-api'
+gem 'cucumber'
+gem 'gherkin_format'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Funkwerk AG
+
+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,5 @@
+# compose_cucumber
+
+[![Build Status](https://travis-ci.org/funkwerk/compose_cucumber.svg)](https://travis-ci.org/funkwerk/compose_cucumber)
+
+Test docker-compose applications with cucumber

data/Rakefile

@@ -0,0 +1,31 @@
+task default: :build
+
+desc 'Builds the Gem.'
+task build: :test do
+  sh 'gem build compose_cucumber.gemspec'
+end
+
+desc 'Publishes the Gem'
+task :push do
+  sh 'gem push compose_cucumber-0.0.1.gem'
+end
+
+desc 'Tests the application'
+task test: :format
+task test: :rubocop
+task test: :cucumber
+
+task :cucumber do
+  options = %w()
+  options.push '--tags ~@skip' unless ENV['skipped']
+  sh "RUBYLIB=lib:$RUBYLIB cucumber #{options * ' '}"
+end
+
+desc 'Checks ruby style'
+task :rubocop do
+  sh 'rubocop'
+end
+
+task :format do
+  sh 'gherkin_format features/*.feature'
+end

data/compose_cucumber.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name        = 'compose_cucumber'
+  s.version     = '0.0.1'
+  s.date        = '2016-03-29'
+  s.summary     = 'Cucumber Steps for Testing docker-compose applications'
+  s.description = 'cucumber/aruba is for testing command line applications like compose_cucumber for docker-compose applications.'
+  s.authors     = ['Stefan Rohe']
+  s.homepage    = 'http://github.com/funkwerk/compose_cucumber/'
+  s.files       = `git ls-files`.split("\n")
+  s.executables = s.files.grep(%r{^bin/}) { |file| File.basename(file) }
+  s.add_runtime_dependency 'cucumber', ['~> 2.3']
+end

data/docker-compose.yml

@@ -0,0 +1,6 @@
+version: "2"
+
+services:
+  service:
+    image: ubuntu
+    command: /bin/sh -c 'echo "Test" && sleep 1000'

data/features/controlling.feature

@@ -0,0 +1,35 @@
+Feature: Controlling
+  As a DevOps,
+  I want to test my docker orchestration
+  so that I haven't broken anything once I change something
+
+  Scenario: Startable
+    When I start the application
+    Then 1 service is available
+
+  Scenario: Status
+    When I start the application
+    Then the exactly following services are available
+      | Name    | Command            | Image  | Status | Ports |
+      | service | ...Test...sleep... | ubuntu | Up...  |       |
+
+  Scenario: Stoppable
+    Given I started the application
+    When I stop the application
+    Then 0 services are available
+
+  Scenario: Logging
+    When I start the application
+    Then the logs for service contain
+      """
+      ...Test...
+      """
+
+  Scenario: Scalable
+    Given I started the application
+    When I scale the application with
+      | Name    | Count |
+      | service | 10    |
+    Then the following services are available
+      | Name    | Count |
+      | service | 10    |

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'compose_cucumber'

data/lib/compose_cucumber.rb

@@ -0,0 +1,2 @@
+require 'compose_cucumber/steps'
+require 'compose_cucumber/world'

data/lib/compose_cucumber/steps.rb

@@ -0,0 +1,93 @@
+Given(/^I started the application$/) do
+  docker_compose 'up -d'
+end
+
+When(/^I start the application$/) do
+  docker_compose 'up -d'
+end
+
+Given(/^I stopped the application$/) do
+  docker_compose 'stop'
+end
+
+When(/^I stop the application$/) do
+  docker_compose 'stop'
+end
+
+When(/^I scale the application with$/) do |table|
+  scales = table.hashes.map do |row|
+    assert row.key?('Name')
+    assert row.key?('Count')
+
+    "#{row['Name']}=#{row['Count']}"
+  end
+
+  docker_compose "scale #{scales * ' '}"
+end
+
+Then(/^the following services are available$/) do |table|
+  check_services table
+end
+
+Then(/^the exactly following services are available$/) do |table|
+  check_services table
+  actual = services.map { |service| service.info['Labels']['com.docker.compose.service'] }.uniq.sort
+  expected = table.hashes.map { |row| row['Name'] }.sort
+  assert_equal(expected, actual, "expected #{expected}, but got #{actual}")
+end
+
+Then(/^(\d+) services are available$/) do |count|
+  ensure_services count
+end
+
+Then(/^(1) service is available$/) do |count|
+  ensure_services count
+end
+
+def ensure_services(count)
+  actual = services.map { |service| service.info['Labels']['com.docker.compose.service'] }.uniq.sort.length
+  assert_equal(count.to_i, actual, "expected #{count}, but got #{actual} services")
+end
+
+def check_services(table)
+  table.hashes.each do |row|
+    assert row.key?('Name')
+    services = services_by_name row['Name']
+    service = services.first
+
+    row.each do |key, value|
+      next if key == 'Name'
+
+      if key == 'Count'
+        assert_equal(value.to_i, services.length, "Expected #{value} services, but got #{services.length}")
+        next
+      end
+      assert(service.info.key?(key), "service #{service.info} should have key #{key}")
+      actual = service.info[key]
+      actual = actual.map { |port| format_port(port) } if key == 'Ports'
+      actual = actual.join ', ' if actual.is_a? Array
+      assert actual.match(value), "#{actual} should match #{value}"
+    end
+  end
+end
+
+Then(/^the logs for (.+) contain$/) do |service, string|
+  matcher = to_regex string
+
+  def check(service, matcher, string)
+    actual = service_logs service
+    assert actual.match(matcher), "#{actual} should contain #{string}"
+  end
+
+  eventually { check(service, matcher, string) }
+end
+
+def format_port(actual)
+  return "#{actual['IP']}:#{actual['PublicPort']}" if actual.key? 'IP'
+
+  actual['PublicPort'].to_s
+end
+
+def to_regex(matcher)
+  "^#{matcher.gsub('.', '\.').gsub('\.\.\.', '.*')}$"
+end

data/lib/compose_cucumber/world.rb

@@ -0,0 +1,67 @@
+require 'test/unit/assertions'
+
+module ComposeWorld
+  require 'docker'
+
+  include Test::Unit::Assertions
+
+  @@project = 'cucumber'
+
+  def docker_compose(command)
+    require 'open3'
+
+    Open3.popen3("docker-compose --project #{@@project} #{command}") do |_stdin, stdout, stderr, wait_thr|
+      exit_status = wait_thr.value
+
+      assert_equal(exit_status.exitstatus, 0, "stderr: #{stderr}\nstdout: #{stdout}")
+      return stdout
+    end
+  end
+
+  def services
+    candidates = Docker::Container.all
+    candidates.select! { |service| service.info.key?('Labels') }
+    candidates.select! { |service| service.info['Labels']['com.docker.compose.project'] == @@project }
+    candidates
+  end
+
+  def services_by_name(name)
+    candidates = services.select { |service| service.info['Labels']['com.docker.compose.service'] == name }
+    assert_not_nil candidates
+    candidates
+  end
+
+  def services_id(name)
+    candidates = services.select { |service| service.info['Labels']['com.docker.compose.service'] == name }
+    assert_not_nil candidates
+    candidates.map { |service| service[:id] }
+  end
+
+  def service_logs(name)
+    candidates = services.select { |service| service.info['Labels']['com.docker.compose.service'] == name }
+    assert_not_nil candidates
+    # TODO: not just logs for the first service and should use logs since last container start
+    candidates.first.logs(stdout: true, stderr: true)
+  end
+
+  def eventually(timeout = 30, &block)
+    assert_not_nil block
+    error = nil
+    start = Time.now
+    while (Time.now - start) < timeout
+      begin
+        return block.call
+      rescue Exception => assertion
+        error = assertion
+        sleep 0.1
+      end
+    end
+    raise error
+  end
+end
+
+World(Test::Unit::Assertions, ComposeWorld)
+
+Before do
+  docker_compose 'stop'
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: compose_cucumber
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stefan Rohe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: cucumber/aruba is for testing command line applications like compose_cucumber
+  for docker-compose applications.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- compose_cucumber.gemspec
+- docker-compose.yml
+- features/controlling.feature
+- features/support/env.rb
+- lib/compose_cucumber.rb
+- lib/compose_cucumber/steps.rb
+- lib/compose_cucumber/world.rb
+homepage: http://github.com/funkwerk/compose_cucumber/
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Cucumber Steps for Testing docker-compose applications
+test_files: []