dkdeploy-test_environment 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0d8f469b85ed6dba04fd56aca2d53b7440343c1
+  data.tar.gz: 266a4fb1848d3ac70e2810a97dfeae6fa9eadf55
+SHA512:
+  metadata.gz: 55149a20f81a3d9ced37c7d5fa9f853872fc7f67ed1a5a3c35f2a18f90a0db51a781dc77cce7058e7fb849a205526f50da2478c380db3c4563773c2e0a992f0a
+  data.tar.gz: f2394c4be0e3bd7577b48978d8acee73ab01d29b59861adb487f1144b9d2b62e5439258f65d60eca58ed769d97ecfdb9b2ce5f22b9a9067be65221f92f8ca239

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  Exclude:
+    - 'tmp/**/*'
+    - 'spec/fixtures/application/htdocs/stylesheets/**/config.rb'
+    - 'Vagrantfile'
+    - 'config/**/*'
+GlobalVars:
+  AllowedVariables: []
+MethodLength:
+  Max: 25
+LineLength:
+  Max: 200
+SpecialGlobalVars:
+  Enabled: false
+BracesAroundHashParameters:
+  Enabled: false
+CyclomaticComplexity:
+  Max: 10

data/CONTRIBUTORS.md

@@ -0,0 +1,16 @@
+# dkdeploy CONTRIBUTORS
+
+The dkdeploy core maintainers would like to recognize following contributors (in alphabetic order):
+
+- Sascha Egerer
+- Christoph Gerold
+- Johannes Goslar
+- Kieran Hayes
+- Wilfried Irßlinger
+- Thomas Jahnke
+- Gleb Levitin
+- Luka Lüdicke
+- Nicolai Reuschling
+- Lars Tode
+- Timo Webler
+- Mike Zaschka

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dkdeploy-test_environment.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2014-2016 dkd Internet Service GmbH, Frankfurt am Main (Germany), https://dkd.de/
+
+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,19 @@
+# Dkdeploy::Test
+
+[![Gem Version](https://badge.fury.io/rb/dkdeploy-test_environment.svg)](https://badge.fury.io/rb/dkdeploy-test_environment)
+
+## Description
+
+This Rubygem `dkdeploy-test_environment` contains shared testing functionality between other dkdeploy-* gems.
+
+## Contributing
+
+1. Install [git flow](https://github.com/nvie/gitflow)
+2. Install [Homebrew](http://brew.sh/) and run `brew install mysql-connector-c`
+3. If project is not checked out already do git clone `git clone https://github.com/dkdeploy/dkdeploy-test_environment.git`
+4. Checkout origin develop branch (`git checkout --track -b develop origin/develop`)
+5. Git flow initialze `git flow init -d`
+6. Installing gems `bundle install`
+7. Create new feature branch (`git flow feature start my-new-feature`)
+8. Run tests (README.md Testing)
+9. Commit your changes (`git commit -am 'Add some feature'`)

data/Rakefile

@@ -0,0 +1,5 @@
+task default: :spec
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new

data/dkdeploy-test_enviroment.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dkdeploy/test_environment/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dkdeploy-test_environment'
+  spec.version       = Dkdeploy::TestEnvironment::Version
+  spec.license       = 'MIT'
+  spec.authors       = ['Lars Tode', 'Timo Webler', 'Kieran Hayes', 'Nicolai Reuschling', 'Johannes Goslar']
+  spec.email         = ['lars.tode@dkd.de', 'timo.webler@dkd.de', 'kieran.hayes@dkd.de', 'nicolai.reuschling@dkd.de', 'johannes.goslar@dkd.de']
+  spec.description   = 'test infrastructure for dkdeploy'
+  spec.summary       = 'dkdeploy-test_environment provides a test application for dkdeploy'
+  spec.homepage      = 'https://github.com/dkdeploy/dkdeploy-test_environment'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin\/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)\/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'bundler',  '~> 1.12.5'
+  spec.add_dependency 'rake',     '~> 11.2'
+  spec.add_dependency 'rspec',    '~> 3.4'
+  spec.add_dependency 'cucumber', '~> 2.3'
+  spec.add_dependency 'rubocop',  '~> 0.40'
+  spec.add_dependency 'aruba',    '~> 0.14'
+  spec.add_dependency 'mysql2',   '~> 0.3.21'
+  spec.add_dependency 'pry',      '~> 0.10.1'
+  spec.add_dependency 'sshkit',   '~> 1.10.0'
+end

data/lib/dkdeploy/test_environment.rb

@@ -0,0 +1 @@
+require 'dkdeploy/test_environment/version'

data/lib/dkdeploy/test_environment/application.rb

@@ -0,0 +1,60 @@
+require 'fileutils'
+require 'pathname'
+require_relative 'constants'
+require_relative 'remote'
+require_relative 'steps'
+require_relative 'env'
+require_relative 'mysql'
+require_relative 'path'
+
+module Dkdeploy
+  module TestEnvironment
+    # Test application for capistrano with vagrant
+    #
+    # @!attribute [r] remote
+    #   @return [Dkdeploy::TestEnvironment::Remote]
+    class Application
+      include Dkdeploy::TestEnvironment::Constants
+
+      attr_reader :remote
+      attr_accessor :mysql_connection_settings
+
+      def initialize(base, hostname, ssh_config = {})
+        Dkdeploy::TestEnvironment::Constants.class_variable_set :@@root, base
+        @remote = Dkdeploy::TestEnvironment::Remote.new hostname, ssh_config
+        @mysql_connection_settings = {}
+      end
+
+      # Install test environment
+      #
+      def install
+        create_clean_test_application
+        initialize_environment
+      end
+
+      # Copy test application to temporary dirctory
+      #
+      def create_clean_test_application
+        # Clean old test app path
+        FileUtils.rm_rf test_app_path
+        # Create test app path parent directory, if not exists
+        FileUtils.mkdir_p tmp_path
+        # Copy test app to new location
+        FileUtils.cp_r template_path, test_app_path
+      end
+
+      # Initialize rvm and bundler environment
+      #
+      def initialize_environment
+        # Call command at test bundler environment. Not with gem bundler environment
+        Bundler.with_clean_env do
+          cd test_app_path do
+            # Install necessary gems
+            `bundle check || bundle install`
+            raise "Error running 'bundle install'" unless $?.success?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dkdeploy/test_environment/constants.rb

@@ -0,0 +1,118 @@
+require 'fileutils'
+
+module Dkdeploy
+  module TestEnvironment
+    # Dkdeploy test constants.
+    #
+    module Constants
+      include FileUtils
+
+      @@root = File.expand_path '../..', __FILE__ # rubocop:disable Style/ClassVars
+
+      # Gem root path
+      #
+      # @return [String]
+      def gem_root
+        @@root
+      end
+
+      # Test app template path
+      #
+      # @return [String]
+      def template_path
+        File.join gem_root, 'spec', 'fixtures', 'application'
+      end
+
+      # Path to temporary directory
+      #
+      # @return [String]
+      def tmp_path
+        File.join gem_root, 'tmp'
+      end
+
+      # Test app path
+      #
+      # @return [String]
+      def test_app_path
+        File.join tmp_path, 'aruba'
+      end
+
+      # Capistrano configuration fixtures path
+      #
+      # @return [String]
+      def capistrano_configuration_fixtures_path
+        File.join gem_root, 'spec', 'fixtures', 'capistrano', 'configuration'
+      end
+
+      # Capistrano config dev path
+      #
+      # @return [String]
+      def config_dev_path
+        File.join test_app_path, 'config', 'deploy', 'dev.rb'
+      end
+
+      # Capistrano stage for tests
+      #
+      # @return [String]
+      def stage
+        'dev'
+      end
+
+      # Url to vagrant server
+      #
+      # @return [String]
+      def server_url
+        'dkdeploy.dev'
+      end
+
+      # Deploy to path
+      #
+      # @return [String]
+      def deploy_to
+        File.join('/', 'var', 'www', 'dkdeploy')
+      end
+
+      # Shared path
+      #
+      # @return [String]
+      def shared_path
+        File.join deploy_to, 'shared'
+      end
+
+      # Assets path
+      #
+      # @return [String]
+      def assets_path
+        File.join shared_path, 'assets'
+      end
+
+      # Current path
+      #
+      # @return [String]
+      def current_path
+        File.join deploy_to, 'current'
+      end
+
+      # Release path
+      #
+      # @return [String]
+      def releases_path
+        File.join deploy_to, 'releases'
+      end
+
+      # maintenance config file path
+      #
+      # @return [String]
+      def maintenance_config_file_path
+        File.join shared_path, 'config', 'maintenance.json'
+      end
+
+      # remote temporary directory path
+      #
+      # @return [String]
+      def remote_tmp_path
+        '/tmp'
+      end
+    end
+  end
+end

data/lib/dkdeploy/test_environment/env.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/lib/dkdeploy/test_environment/mysql.rb

@@ -0,0 +1,13 @@
+require 'mysql2'
+
+# helper to connect to DB
+module MySQLClientHelpers
+  def instantiate_mysql_client(database = nil)
+    connection_settings = TEST_APPLICATION.mysql_connection_settings
+    connection_settings[:database] = database if database
+
+    Mysql2::Client.new(connection_settings)
+  end
+end
+
+World(MySQLClientHelpers)

data/lib/dkdeploy/test_environment/path.rb

@@ -0,0 +1,36 @@
+# Navigation helper module for cucumber steps
+#
+module NavigationHelpers
+  # Mapping for path names to real remote path
+  #
+  # @param path [String]
+  # @return [String]
+  def path_to(path)
+    case path
+    when 'deploy_path'
+      TEST_APPLICATION.deploy_to
+    when 'current_path'
+      TEST_APPLICATION.current_path
+    when 'config_path'
+      TEST_APPLICATION.remote.config_path
+    when 'releases_path'
+      TEST_APPLICATION.remote.releases_path
+    when 'shared_path'
+      TEST_APPLICATION.remote.shared_path
+    when 'assets_path'
+      TEST_APPLICATION.remote.assets_path
+    when 'tmp_path'
+      TEST_APPLICATION.remote_tmp_path
+    else
+      path
+    end
+  end
+
+  def resolve_path(path)
+    splitted = path.split '/'
+    splitted[0] = path_to splitted[0]
+    splitted.join '/'
+  end
+end
+
+World(NavigationHelpers)

data/lib/dkdeploy/test_environment/remote.rb

@@ -0,0 +1,182 @@
+require 'shellwords'
+require 'sshkit'
+
+require_relative 'constants'
+
+module Dkdeploy
+  module TestEnvironment
+    # Class for remote actions
+    #
+    class Remote
+      include Dkdeploy::TestEnvironment::Constants
+      include SSHKit::DSL
+
+      attr_accessor :last_command_result, :host, :ssh_config
+
+      def initialize(hostname, ssh_config = {})
+        ssh_config[:compression] = 'none'
+        @host = SSHKit::Host.new hostname: hostname, ssh_options: ssh_config
+      end
+
+      # Check if remote directory exists
+      #
+      # @param path [String] Remote path
+      # @return [Boolean]
+      def directory_exists?(path)
+        exists? 'd', path
+      end
+
+      # Check if remote symlink exists
+      #
+      # @param path [String] Remote path
+      # @return [Boolean]
+      def symlink_exists?(path)
+        exists? 'L', path
+      end
+
+      # Check if remote file exists
+      #
+      # @param path [String] Remote path
+      # @return [Boolean]
+      def file_exists?(path)
+        exists? 'f', path
+      end
+
+      # Execute remote if condition
+      #
+      # @param type [String] Type of if condition
+      # @param path [String] Remote path
+      # @return [Boolean]
+      def exists?(type, path)
+        run %([ -#{type} "#{path}" ] && exit 0 || exit 1)
+      end
+
+      # Creates the remote directory
+      #
+      # @param remote_directory_name [String] the remote directory name
+      # @return [Boolean]
+      def create_directory(remote_directory_name)
+        run %(mkdir -p "#{remote_directory_name}")
+      end
+
+      # Creates the remote file with the given content
+      #
+      # @param file_path [String] the file path to be created
+      # @param content [String] the content to be put into the created file
+      # @return [Boolean]
+      def create_file(file_path, content)
+        run %(echo "#{content}" > "#{file_path}")
+      end
+
+      # Removes the remote file or directory
+      #
+      # @param resource_path [String] the remote file or directory path
+      # @return [Boolean]
+      def remove_resource(resource_path)
+        run %(rm -rf "#{resource_path}")
+      end
+
+      # Remove the deploy_to path
+      #
+      # @return [Boolean]
+      def remove_deploy_to_path
+        run %(sudo rm -rf -R "#{deploy_to}")
+      end
+
+      # Remove the source of a symlink
+      #
+      # @return [String]
+      def source_of_symlink(target_symlink_path)
+        run %(readlink "#{target_symlink_path}")
+      end
+
+      # Execute command on server
+      #
+      # @param command [String]
+      # @return [Boolean]
+      def run(command)
+        success = false
+        result = '' # we need a local variable to capture result from sshkit block
+        begin
+          on @host do
+            result = capture command
+          end
+          @last_command_result = result
+          success = true
+        rescue SSHKit::Command::Failed, SSHKit::Runner::ExecuteError
+          success = false
+        end
+        success
+      end
+
+      # Gets the remote file content
+      #
+      # @param file_path [String]
+      # @return [Boolean]
+      def get_file_content(file_path)
+        raise 'Internal server error.' unless run %(less #{file_path})
+        last_command_result
+      end
+
+      # Gets one of the properties of resource
+      #
+      # Examples:
+      #   get_resource_property('/a/b/c/', 'group') -> www-data
+      #   get_resource_property('/a/b/c/', 'group') -> -rwxr-xr--
+      #
+      # @param path [String] path to the remote file or directory to be examined
+      # @param property [String] the property to be returned
+      # @return [String] resource property
+      def get_resource_property(path, property)
+        # run the ls command
+        raise 'Internal server error.' unless run %(ls -lad "#{path}")
+
+        # Parses the returned string value and converts it to an array
+        # Example: Array[drwxrwxr-x, 3, vagrant, www-data,  4096, Apr, 25, 14:12]
+        properties = (last_command_result || '').split(' ')
+        # property mapping to the number of the array element
+        case property
+        when 'permissions'
+          property = 0
+        when 'owner'
+          property = 2
+        when 'group'
+          property = 3
+        else
+          raise ArgumentError, 'The given property can not be mapped.'
+        end
+        properties.at(property) if property.between?(0, properties.count)
+      end
+
+      # Checks, if the actually permissions include the expected user permission
+      #
+      # @param all_permissions [String] Example: -rwxr-xr--
+      # @param examined_user_permission [String] Example: w
+      # @return [Boolean]
+      def user_has_permission?(all_permissions, examined_user_permission)
+        user_permissions = all_permissions[1, 3].delete('-') # Example -rwxr-xr-- -> rwx
+        user_permissions.include?(examined_user_permission)
+      end
+
+      # Checks, if the actually permissions include the expected group permission
+      #
+      # @param all_permissions [String] Example: -rwxr-xr--
+      # @param examined_group_permission [String] Example: w
+      # @return [Boolean]
+      def group_has_permission?(all_permissions, examined_group_permission)
+        group_permissions = all_permissions[4, 3].delete('-') # Example -rwxr-xr-- -> rx
+        group_permissions.include?(examined_group_permission)
+      end
+
+      # Checks, if the actually permissions include the expected others permission
+      #
+      # @param all_permissions [String] Example: -rwxr-xr--
+      # @param examined_others_permission [String] Example: r
+      # @return [Boolean]
+      def others_has_permission?(all_permissions, examined_others_permission)
+        others_permissions = all_permissions[7, 3].delete('-') # Example -rwxr-xr-- -> r
+        others_permissions.include?(examined_others_permission)
+      end
+    end
+  end
+end

data/lib/dkdeploy/test_environment/step_definitions/common.rb

@@ -0,0 +1,3 @@
+When(/I wait (.*) seconds?/) do |seconds|
+  sleep(seconds.to_i)
+end

data/lib/dkdeploy/test_environment/step_definitions/failing_on_purpose.rb

@@ -0,0 +1,15 @@
+Given(/^I provoke an exception for testing purposes before symlinking the new release$/) do
+  extension_content = "after 'deploy:updating', 'deploy:fail'"
+  file_name = TEST_APPLICATION.config_dev_path
+
+  Aruba.platform.mkdir(File.dirname(file_name))
+  File.open(file_name, 'a') { |f| f << "\n#{extension_content}\n" }
+end
+
+Given(/^I provoke an exception for testing purposes after symlinking the new release$/) do
+  extension_content = "before 'deploy:finishing', 'deploy:fail'"
+  file_name = TEST_APPLICATION.config_dev_path
+
+  Aruba.platform.mkdir(File.dirname(file_name))
+  File.open(file_name, 'a') { |f| f << "\n#{extension_content}\n" }
+end

data/lib/dkdeploy/test_environment/step_definitions/mysql.rb

@@ -0,0 +1,30 @@
+Given(/^I want to use the database `(.*)`$/) do |database|
+  @database_name = database
+  mysql_client = instantiate_mysql_client
+  mysql_client.query "DROP DATABASE IF EXISTS #{mysql_client.escape(@database_name)};"
+  mysql_client.query "CREATE DATABASE #{mysql_client.escape(@database_name)};"
+end
+
+Then(/^the database (should|should not) have a table `(.*)` with column `(.*)`$/) do |should_or_not, table, column|
+  mysql_client = instantiate_mysql_client
+  query_string = "SELECT COUNT(*) AS number_of_columns
+                    FROM information_schema.columns
+                   WHERE table_schema = '#{mysql_client.escape(@database_name)}'
+                     AND table_name = '#{mysql_client.escape(table)}'
+                     AND column_name = '#{mysql_client.escape(column)}';"
+  result = mysql_client.query query_string
+  number_of_columns = result.first.fetch('number_of_columns')
+  expectation = should_or_not == 'should' ? 1 : 0
+  expect(number_of_columns).to eq expectation
+end
+
+Then(/^the database (should|should not) have a value `(.*)` in table `(.*)` for column `(.*)`$/) do |should_or_not, row, table, column|
+  mysql_client = instantiate_mysql_client
+  query_string = "SELECT COUNT(*) AS number_of_rows
+                    FROM #{mysql_client.escape(@database_name)}.#{mysql_client.escape(table)}
+                   WHERE #{mysql_client.escape(column)} = '#{mysql_client.escape(row)}';"
+  result = mysql_client.query query_string
+  number_of_rows = result.first.fetch('number_of_rows')
+  expectation = should_or_not == 'should' ? 1 : 0
+  expect(number_of_rows).to eq expectation
+end

data/lib/dkdeploy/test_environment/step_definitions/remote_commands.rb

@@ -0,0 +1,143 @@
+# Creates a file on the remote server with the pre defined content
+#
+# @yieldparam path [String] the file name
+# @yieldparam file_content [String] the content to be inserted in the file
+Given(/^a remote file named "([^"]*)" with:$/) do |path, file_content|
+  path = resolve_path path
+  TEST_APPLICATION.remote.create_file path, file_content
+end
+
+# Creates an empty file on the remote server
+#
+# @yieldparam path [String] the file name
+Given(/^a remote empty file named "([^"]*)"$/) do |path|
+  path = resolve_path path
+  TEST_APPLICATION.remote.run("mkdir -p #{File.dirname(path)}")
+  TEST_APPLICATION.remote.run("touch #{path}")
+end
+
+# Creates a directory on the remote server
+#
+# @yieldparam path [String] the directory to be created
+Given(/^a remote directory named "([^"]*)"$/) do |path|
+  path = resolve_path path
+  TEST_APPLICATION.remote.create_directory path
+end
+
+# Test if the remote directory exists.
+#
+# @yieldparam path [String] the name of the target directory
+# @yieldparam should_or_not [String] decides if it should be tested in a positive or a negative way
+#
+Then(/^a remote directory named "([^"]*)" (should|should not) exist$/) do |path, should_or_not|
+  path = resolve_path path
+  decision = TEST_APPLICATION.remote.directory_exists?(path)
+  if should_or_not == 'should'
+    expect(decision).to be true
+  else
+    expect(decision).to be false
+  end
+end
+
+# Test if the remote file exists.
+#
+# @yieldparam remote_path [String] the name of the file
+# @yieldparam should_or_not [String] decides if it should be tested in a positive or a negative way
+Then(/^a remote file named "([^"]*)" (should|should not) exist$/) do |path, should_or_not|
+  path = resolve_path path
+  decision = TEST_APPLICATION.remote.file_exists?(path)
+  if should_or_not == 'should'
+    expect(decision).to be true
+  else
+    expect(decision).to be false
+  end
+end
+
+# Test if the remote symlink exists.
+#
+# @yieldparam remote_path [String] the name of the symlink
+# @yieldparam should_or_not [String] decides if it should be tested in a positive or a negative way
+Then(/^a remote symlink named "([^"]*)" (should|should not) exist$/) do |path, should_or_not|
+  path = resolve_path path
+  decision = TEST_APPLICATION.remote.symlink_exists?(path)
+  if should_or_not == 'should'
+    expect(decision).to be true
+  else
+    expect(decision).to be false
+  end
+end
+
+# Test if the remote file content matches the test string.
+#
+# @yieldparam path [String] file path on the remote server
+# @yieldparam exact_content [String] the content to be tested with
+Then(/^the remote file "([^"]*)" should contain exactly:$/) do |path, exact_content|
+  path = resolve_path path
+  content = TEST_APPLICATION.remote.get_file_content(path)
+  expect(content).to eq exact_content
+end
+
+# Test if the owner of the remote resource matches the expected one
+#
+# @yieldparam resource [String] file or directory on the remote server
+# @yieldparam owner [String] the expected unix owner of the remote resource
+Then(/^remote owner of "([^"]*)" should be "([^"]*)"$/) do |path, owner|
+  path = resolve_path path
+  expect(TEST_APPLICATION.remote.get_resource_property(path, 'owner')).to eq owner
+end
+
+# Test if the group of the remote resource matches the expected one
+#
+# @yieldparam resource [String] file or directory on the remote server
+# @yieldparam group [String] the expected unix group of the remote resource
+Then(/^remote group of "([^"]*)" should be "([^"]*)"$/) do |path, group|
+  path = resolve_path path
+  expect(TEST_APPLICATION.remote.get_resource_property(path, 'group')).to eq group
+end
+
+# Test if the given resource contain the examined permission
+#
+# @yieldparam resource [String] file or directory on the remote server
+# @yieldparam should_or_not [String] decides if it should be tested in a positive or a negative way
+# @yieldparam permission [String] the unix permission. Possible values ['read', 'write', 'execute']
+# @yieldparam permission_section [String] the unix permission section. Possible values ['user', 'group', 'others']
+Then(/^remote permissions of "([^"]*)" (should|should not) contain "(user|group|others)" "(read|write|execute)"$/) do |path, should_or_not, permission_section, permission|
+  path = resolve_path path
+  all_permissions = TEST_APPLICATION.remote.get_resource_property(path, 'permissions')
+
+  case permission
+  when 'read'
+    permission = 'r'
+  when 'write'
+    permission = 'w'
+  when 'execute'
+    permission = 'x'
+  else
+    raise ArgumentError, 'The given permissions can not be mapped'
+  end
+
+  case permission_section
+  when 'user'
+    decision = TEST_APPLICATION.remote.user_has_permission?(all_permissions, permission)
+  when 'group'
+    decision = TEST_APPLICATION.remote.group_has_permission?(all_permissions, permission)
+  when 'others'
+    decision = TEST_APPLICATION.remote.others_has_permission?(all_permissions, permission)
+  else
+    raise ArgumentError, 'The given permissions can not be mapped'
+  end
+
+  if should_or_not == 'should'
+    expect(decision).to be true
+  else
+    expect(decision).to be false
+  end
+end
+
+When(/^I store the symlink source of current$/) do
+  @symlink_source_of_current = TEST_APPLICATION.remote.source_of_symlink(resolve_path('current_path'))
+end
+
+Then(/^the symlink source of current should not have changed$/) do
+  expect(TEST_APPLICATION.remote.source_of_symlink(resolve_path('current_path'))).to eq @symlink_source_of_current
+end

data/lib/dkdeploy/test_environment/step_definitions/setup.rb

@@ -0,0 +1,42 @@
+# Install test application for capistrano
+#
+Given(/^a test app with the default configuration$/) do
+  TEST_APPLICATION.install
+end
+
+# Remove capistrano application at remote server
+#
+Given(/^the remote server is cleared$/) do
+  TEST_APPLICATION.remote.remove_deploy_to_path
+end
+
+# Extend the dev capistrano configuration to the given variable/value paar
+#
+# @yieldparam variable [String] the name of the variable to be set
+# @yieldparam value [Object] the value of the variable to be set. Example: 'test' or Array.new
+#
+# Note: We used to call   step %(I append to "#{TEST_APPLICATION.config_dev_path}" with "#{extension_content}\n")
+# but this seems to be broken due to a wrong path expansion
+When(/^I extend the development capistrano configuration variable (.+?) with value (.+?)$/) do |variable, value|
+  extension_content = "set :#{variable}, #{value}"
+  file_name = TEST_APPLICATION.config_dev_path
+
+  Aruba.platform.mkdir(File.dirname(file_name))
+  File.open(file_name, 'a') { |f| f << "\n#{extension_content}\n" }
+end
+
+# Extend the dev capistrano configuration to the content from the given fixture file
+#
+# @yieldparam file [String] the fixture file which content should extend capistrano configuration
+When(/^I extend the development capistrano configuration from the fixture file (.+?)$/) do |file|
+  extension_content = File.read(File.join(TEST_APPLICATION.capistrano_configuration_fixtures_path, file))
+  file_name = TEST_APPLICATION.config_dev_path
+
+  Aruba.platform.mkdir(File.dirname(file_name))
+  File.open(file_name, 'a') { |f| f << "\n#{extension_content}\n" }
+end
+
+# Execute the cap deploy task on the dev server
+When(/^the project is deployed$/) do
+  step 'I successfully run `cap dev deploy`'
+end

data/lib/dkdeploy/test_environment/steps.rb

@@ -0,0 +1,2 @@
+# Loads steps from directory `./step_definitions'.
+Dir.glob(File.expand_path('../step_definitions/*.rb', __FILE__)).each { |step_file| require step_file }

data/lib/dkdeploy/test_environment/version.rb

@@ -0,0 +1,15 @@
+module Dkdeploy
+  module TestEnvironment
+    # Class for version number
+    #
+    class Version
+      MAJOR = 1
+      MINOR = 0
+      PATCH = 0
+
+      def self.to_s
+        [MAJOR, MINOR, PATCH].join('.')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: dkdeploy-test_environment
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lars Tode
+- Timo Webler
+- Kieran Hayes
+- Nicolai Reuschling
+- Johannes Goslar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.21
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.21
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+description: test infrastructure for dkdeploy
+email:
+- lars.tode@dkd.de
+- timo.webler@dkd.de
+- kieran.hayes@dkd.de
+- nicolai.reuschling@dkd.de
+- johannes.goslar@dkd.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CONTRIBUTORS.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- dkdeploy-test_enviroment.gemspec
+- lib/dkdeploy/test_environment.rb
+- lib/dkdeploy/test_environment/application.rb
+- lib/dkdeploy/test_environment/constants.rb
+- lib/dkdeploy/test_environment/env.rb
+- lib/dkdeploy/test_environment/mysql.rb
+- lib/dkdeploy/test_environment/path.rb
+- lib/dkdeploy/test_environment/remote.rb
+- lib/dkdeploy/test_environment/step_definitions/common.rb
+- lib/dkdeploy/test_environment/step_definitions/failing_on_purpose.rb
+- lib/dkdeploy/test_environment/step_definitions/mysql.rb
+- lib/dkdeploy/test_environment/step_definitions/remote_commands.rb
+- lib/dkdeploy/test_environment/step_definitions/setup.rb
+- lib/dkdeploy/test_environment/steps.rb
+- lib/dkdeploy/test_environment/version.rb
+homepage: https://github.com/dkdeploy/dkdeploy-test_environment
+licenses:
+- MIT
+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.6.4
+signing_key: 
+specification_version: 4
+summary: dkdeploy-test_environment provides a test application for dkdeploy
+test_files: []