foreplay 0.0.1 → 0.0.2

data/.gitignore

@@ -1,3 +1,4 @@
+*.TMP
 *.rbc
 *.sassc
 .sass-cache
@@ -17,7 +18,7 @@ pickle-email-*.html
 
 *.gem
 .bundle
-.config
+/config
 .yardoc
 Gemfile.lock
 InstalledFiles
@@ -31,4 +32,3 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-config

data/.rvmrc

@@ -0,0 +1,5 @@
+rvm_trust_rvmrcs_flag=1
+rvm_install_on_use_flag=1
+rvm_gem_options="--no-rdoc --no-ri"
+rvm_gemset_create_on_use_flag=1
+rvm 1.9.3@foreplay

data/README.md

@@ -52,9 +52,9 @@ defaults:       # global defaults for all environments
   servers: [server1, server2, server3] # which servers to deploy the app on
   user:         # The username to connect with (must have SSH permissions)
   password:     # The password to use to connect (not necessary if you've set up SSH keys)
-  keyfile:      # ...or a file containing a private key that allows the named user access to the server
+  keyfile:      # or a file containing a private key that allows the named user access to the server
   key:          # ...or a private key that allows the named user access to the server
-  path:         # absolute path to deploy the app on each server. %s will be translated to the application name
+  path:         # absolute path to deploy the app on each server. %s will substitute to the app name
   database:     # the database.yml elements to write to the config folder
   env:          # contents of the .env file
     key: value  # will go into the .env file as key=value
@@ -62,7 +62,7 @@ defaults:       # global defaults for all environments
     key: value  # will go into the .foreman file as key: value
 production:     # deployment configuration for the production environment
   defaults:     # defaults for all roles in this environment (structure same as global defaults)
-  role1:        # settings for the a particular role (e.g. web, worker, etc.) (structure same as global defaults)
+  role1:        # settings for the a particular role (e.g. web, worker, etc.)
 ```
 
 ### Environment

data/features/check.feature

@@ -0,0 +1,74 @@
+Feature: check
+  In order to check Foreplay
+  From the CLI
+  I want to be able to check all features
+
+  Scenario: Check configuration
+    When I run `foreplay check`
+    Then the output should contain:
+        """
+        ERROR: foreplay check was called with no arguments
+        Usage: "foreplay check ENVIRONMENT".
+        """
+
+  Scenario: Check configuration parameters - invalid parameter
+    When I run `foreplay check test --invalid xyz`
+    Then the output should contain:
+    	"""
+    	ERROR: foreplay check was called with arguments ["test", "--invalid", "xyz"]
+		  Usage: "foreplay check ENVIRONMENT".
+    	"""
+
+  Scenario: Check configuration parameters - short invalid parameter
+    When I run `foreplay check test -x xyz`
+    Then the output should contain:
+      """
+		  ERROR: foreplay check was called with arguments ["test", "-x", "xyz"]
+		  Usage: "foreplay check ENVIRONMENT".
+    	"""
+
+  Scenario: Check configuration parameters - no config file
+    When I run `foreplay check test`
+    Then the output should contain "Checking"
+      And the output should contain "Can't find configuration file"
+
+  Scenario: Check configuration parameters
+    When I run `foreplay setup`
+      And I run `foreplay check test`
+    Then the output should contain "create  config/foreplay.yml"
+      And the output should contain "Checking"
+      And the output should contain "test environment"
+      And the output should contain "all roles"
+      And the output should contain "all servers"
+      And the output should contain "No deployment configuration defined for test environment"
+      And the output should not contain "Can't find configuration file"
+      And the following files should exist:
+        | config/foreplay.yml |
+
+  Scenario: Check configuration parameters - role parameter
+    When I run `foreplay check test --role worker`
+    Then the output should contain "Checking"
+      And the output should contain "test environment"
+      And the output should contain "worker role"
+      And the output should contain "all servers"
+
+  Scenario: Check configuration parameters - server parameter
+    When I run `foreplay check test --server worker.example.com`
+    Then the output should contain "Checking"
+      And the output should contain "test environment"
+      And the output should contain "all roles"
+      And the output should contain "worker.example.com server"
+
+  Scenario: Check configuration parameters - short role parameter
+    When I run `foreplay check test -r worker`
+    Then the output should contain "Checking"
+      And the output should contain "test environment"
+      And the output should contain "worker role"
+      And the output should contain "all servers"
+
+  Scenario: Check configuration parameters - short server parameter
+    When I run `foreplay check test -s worker.example.com`
+    Then the output should contain "Checking"
+      And the output should contain "test environment"
+      And the output should contain "all roles"
+      And the output should contain "worker.example.com server"

data/features/deploy.feature

@@ -0,0 +1,96 @@
+Feature: deploy
+  In order to deploy my app
+  From the CLI
+  I want to be able to use all features
+
+  Scenario: No arguments
+    When I run `foreplay deploy`
+    Then the output should contain:
+        """
+        ERROR: foreplay deploy was called with no arguments
+        Usage: "foreplay deploy ENVIRONMENT".
+        """
+
+  Scenario: invalid parameter
+    When I run `foreplay deploy test --invalid xyz`
+    Then the output should contain:
+    	"""
+    	ERROR: foreplay deploy was called with arguments ["test", "--invalid", "xyz"]
+		  Usage: "foreplay deploy ENVIRONMENT".
+    	"""
+
+  Scenario: short invalid parameter
+    When I run `foreplay deploy test -x xyz`
+    Then the output should contain:
+      """
+		  ERROR: foreplay deploy was called with arguments ["test", "-x", "xyz"]
+		  Usage: "foreplay deploy ENVIRONMENT".
+    	"""
+
+  Scenario: no config file
+    When I run `foreplay deploy test`
+    Then the output should contain "Deploying"
+      And the output should contain "test environment"
+      And the output should contain "all roles"
+      And the output should contain "all servers"
+      And the output should contain "Can't find configuration file"
+
+  Scenario: deploy all roles
+    When I run `foreplay setup`
+      And I run `foreplay deploy test`
+    Then the output should contain "create  config/foreplay.yml"
+      And the output should contain "Deploying"
+      And the output should contain "test environment"
+      And the output should contain "all roles"
+      And the output should contain "all servers"
+      And the output should contain "No deployment configuration defined for test environment"
+      And the output should not contain "Can't find configuration file"
+      And the following files should exist:
+        | config/foreplay.yml |
+
+  Scenario: deploy one role
+    When I run `foreplay deploy test --role worker`
+    Then the output should contain "Deploying"
+      And the output should contain "test environment"
+      And the output should contain "worker role"
+      And the output should contain "all servers"
+
+  Scenario: deploy to one server
+    When I run `foreplay deploy test --server worker.example.com`
+    Then the output should contain "Deploying"
+      And the output should contain "test environment"
+      And the output should contain "all roles"
+      And the output should contain "worker.example.com server"
+
+  Scenario: deploy to one role - short role parameter
+    When I run `foreplay deploy test -r worker`
+    Then the output should contain "Deploying"
+      And the output should contain "test environment"
+      And the output should contain "worker role"
+      And the output should contain "all servers"
+
+  Scenario: deployto one server - short server parameter
+    When I run `foreplay deploy test -s worker.example.com`
+    Then the output should contain "Deploying"
+      And the output should contain "test environment"
+      And the output should contain "all roles"
+      And the output should contain "worker.example.com server"
+
+  Scenario: deploy all roles
+    When I run `foreplay setup`
+      And I run `foreplay deploy test`
+    Then the output should contain "create  config/foreplay.yml"
+      And the output should contain "Deploying"
+      And the output should contain "test environment"
+      And the output should contain "all roles"
+      And the output should contain "all servers"
+      And the output should not contain "Can't find configuration file"
+      And the following files should exist:
+        | config/foreplay.yml |
+
+  Scenario: deploy
+    When I run `foreplay setup -r git@github.com:Xenapto/foreplay.git -s web.example.com --password "top-secret"`
+      And I run `foreplay deploy production`
+    Then the output should contain "Deploying aruba to web.example.com in the web role on the production environment"
+      And the output should contain "Connecting to web.example.com"
+      And the output should contain "There was a problem starting an ssh session on web.example.com"

data/features/setup.feature

@@ -0,0 +1,140 @@
+Feature: Setup
+  In order to setup Foreplay
+  As a CLI user
+  I want to be able to create the config scaffold
+
+  Scenario: Setup with defaults
+	When I run `foreplay setup`
+	Then the output should contain "create  config/foreplay.yml"
+	And the following files should exist:
+		| config/foreplay.yml |
+	And the file "config/foreplay.yml" should contain:
+		"""
+		defaults:
+		  name: aruba
+		  repository: TODO Put the git repository path here
+		  user: TODO Put here the user to logon to the deployment server
+		  path: TODO Put here the path to deploy to on the deployment server
+		  port: 50000
+		production:
+		  defaults:
+		    database:
+		      adapter: postgresql
+		      encoding: utf8
+		      database: TODO Put the database name here
+		      pool: 5
+		      host: TODO Put here the database host name
+		      username: TODO Put here the database user
+		      password: TODO Put here the database user's password
+		  web:
+		    servers: [TODO Put here the name or names of the production web servers]
+		    foreman:
+		      concurrency: 'web=1,worker=0,scheduler=0'
+		"""
+
+  Scenario: Setup invalid short option
+	When I run `foreplay setup -x abc`
+	Then the following files should not exist:
+		| config/foreplay.yml |
+	And the output should contain:
+		"""
+		ERROR: foreplay setup was called with arguments ["-x", "abc"]
+		Usage: "foreplay setup".
+		"""
+
+  Scenario: Setup invalid option
+	When I run `foreplay setup --xyz abc`
+	Then the following files should not exist:
+		| config/foreplay.yml |
+	And the output should contain:
+		"""
+		ERROR: foreplay setup was called with arguments ["--xyz", "abc"]
+		Usage: "foreplay setup".
+		"""
+
+  Scenario: Setup invalid pool option type
+	When I run `foreplay setup --db_pool abc`
+	Then the following files should not exist:
+		| config/foreplay.yml |
+	And the output should contain:
+		"""
+		Expected numeric value for '--db-pool'; got "abc"
+		"""
+
+  Scenario: Setup invalid port option type
+	When I run `foreplay setup --port abc`
+	Then the following files should not exist:
+		| config/foreplay.yml |
+	And the output should contain:
+		"""
+		Expected numeric value for '--port'; got "abc"
+		"""
+
+  Scenario: Setup invalid port short option type
+	When I run `foreplay setup -p abc`
+	Then the following files should not exist:
+		| config/foreplay.yml |
+	And the output should contain:
+		"""
+		Expected numeric value for '--port'; got "abc"
+		"""
+
+  Scenario: Setup with short options
+	When I run `foreplay setup -n string1 -r string2 -u string3 -p 10000 --password string4 -f string5 -s string6a string6b string6c -a string7 -e string8 -d string9 -h string10 --db_pool 23 --db_user string11 --db_password string12`
+	Then the output should contain "create  config/foreplay.yml"
+	And the following files should exist:
+		| config/foreplay.yml |
+	And the file "config/foreplay.yml" should contain:
+		"""
+		defaults:
+		  name: string1
+		  repository: string2
+		  user: string3
+		  password: string4
+		  path: string5
+		  port: 10000
+		production:
+		  defaults:
+		    database:
+		      adapter: string7
+		      encoding: string8
+		      database: string9
+		      pool: 23
+		      host: string10
+		      username: string11
+		      password: string12
+		  web:
+		    servers: ["string6a", "string6b", "string6c"]
+		    foreman:
+		      concurrency: 'web=1,worker=0,scheduler=0'
+		"""
+
+  Scenario: Setup with short options
+	When I run `foreplay setup --name string1 --repository string2 --user string3 --port 10000 --password string4 --path string5 --servers string6a string6b string6c --db_adapter string7 --db_encoding string8 --db_name string9 --db_host string10 --db_pool 23 --db_user string11 --db_password string12`
+	Then the output should contain "create  config/foreplay.yml"
+	And the following files should exist:
+		| config/foreplay.yml |
+	And the file "config/foreplay.yml" should contain:
+		"""
+		defaults:
+		  name: string1
+		  repository: string2
+		  user: string3
+		  password: string4
+		  path: string5
+		  port: 10000
+		production:
+		  defaults:
+		    database:
+		      adapter: string7
+		      encoding: string8
+		      database: string9
+		      pool: 23
+		      host: string10
+		      username: string11
+		      password: string12
+		  web:
+		    servers: ["string6a", "string6b", "string6c"]
+		    foreman:
+		      concurrency: 'web=1,worker=0,scheduler=0'
+		"""

data/features/support/env.rb

@@ -0,0 +1,5 @@
+# Initialize simplecov for coverage report.
+require 'simplecov'
+SimpleCov.start
+
+require 'aruba/cucumber'

data/foreplay.gemspec

@@ -14,12 +14,11 @@ Gem::Specification.new do |spec|
 
   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.test_files    = spec.files.grep(%r{^(test|spec|features|coverage)/})
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'activesupport'
   spec.add_dependency 'colorize'
-  spec.add_dependency 'hashie'
   spec.add_dependency 'foreman'
   spec.add_dependency 'net-ssh-shell'
   spec.add_dependency 'thor'
@@ -30,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "cucumber"
   spec.add_development_dependency "aruba"
   spec.add_development_dependency "gem-release"
+  spec.add_development_dependency "simplecov"
 end

data/lib/foreplay.rb

@@ -1,6 +1,4 @@
-require "foreplay/version"
-require "foreplay/config"
-
-module Foreplay
-  # Your code goes here...
-end
+require 'foreplay/version'
+require 'foreplay/setup'
+require 'foreplay/deploy'
+require 'foreplay/utility'

data/lib/foreplay/cli.rb

@@ -1,23 +1,47 @@
 require 'thor'
 require 'foreplay'
-require 'foreplay/generators/setup'
 
 module Foreplay
   class CLI < Thor
-    desc 'check', 'Checks if configuration is OK'
+    desc 'deploy ENVIRONMENT', 'Deploys to specified environment'
 
-    method_option :environment, :aliases => "-e"
-    method_option :role,        :aliases => "-r"
-    method_option :server,      :aliases => "-s"
+    method_option :role,        :aliases => '-r'
+    method_option :server,      :aliases => '-s'
 
-    def check
-      puts Foreplay::Config.check options
+    def deploy(environment)
+      Foreplay::Deploy.start [:deploy, environment, options]
+    end
+
+    desc 'check ENVIRONMENT', 'Checks if configuration is OK for specified environment'
+
+    method_option :role,        :aliases => '-r'
+    method_option :server,      :aliases => '-s'
+
+    def check(environment)
+      Foreplay::Deploy.start [:check, environment, options]
     end
 
     desc 'setup', 'Create the Foreplay config file'
 
+    method_option :name,        :aliases => '-n'
+    method_option :repository,  :aliases => '-r'
+    method_option :user,        :aliases => '-u'
+    method_option :password
+    method_option :keyfile
+    method_option :private_key, :aliases => '-k'
+    method_option :path,        :aliases => '-f'
+    method_option :port,        :aliases => '-p', :type => :numeric
+    method_option :servers,     :aliases => '-s', :type => :array
+    method_option :db_adapter,  :aliases => '-a'
+    method_option :db_encoding, :aliases => '-e'
+    method_option :db_name,     :aliases => '-d'
+    method_option :db_pool                      , :type => :numeric
+    method_option :db_host,     :aliases => '-h'
+    method_option :db_user
+    method_option :db_password
+
     def setup
-      Foreplay::Generators::Setup.start
+      Foreplay::Setup.start
     end
   end
 end