pike 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7fb975855d3b151edfc497b4b44b362c7b8005f6
+  data.tar.gz: 046f89d3bd1d0885d18e5f8c77a78ce5937f3d95
+SHA512:
+  metadata.gz: 228f43c695a7a628c0f56eafe55bace606b7d04df0ab92ce333345aa4b8a79945badf240db5d724bb981da3864cb593454172179e9d50333e65d42aa290a5dac
+  data.tar.gz: 35577733d5f61f2ca7432f5e982e5db93cbaac2e65796f91d7821d341d78697ec8cc378293c971c85e73036e1666a3f5afa394762df81f8d5ca9baa7fe266e24

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,12 @@
+branches:
+  only:
+    - 'master'
+
+language: ruby
+
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+
+script: "./script/build"

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pike.gemspec
+gemspec
+
+group :testing do
+  gem 'coveralls', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    pike (0.0.1)
+      net-scp (~> 1.0)
+      net-ssh (~> 2.1)
+      net-ssh-shell (~> 0.2)
+      steps (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colored (1.2)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    docile (1.1.2)
+    highline (1.6.20)
+    mime-types (2.0)
+    multi_json (1.8.4)
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-ssh (2.1.4)
+    net-ssh-shell (0.2.0)
+      net-ssh (~> 2.1.0)
+    rake (10.1.1)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    steps (1.1.3)
+      colored (>= 1.2)
+      highline (>= 1.6)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    tins (0.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  coveralls
+  pike!
+  rake (~> 10.1)

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Benjamin Kammerl aka phortx
+
+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/Pikefile.example

@@ -0,0 +1,103 @@
+# The name of the app to build
+var name: 'example'
+
+env :production do
+  # Hostname to deploy on
+  var host: 'example.com'
+
+  # SSH User to login with
+  var user: 'sheldon'
+
+  # If the user doesn't have any writing permissions to the directory where the app is deployed,
+  # set to true and pike will use sudo
+  var use_sudo: true
+
+  # Destination path where to deploy the app
+  var deploy_to: '/var/www/example.com/'
+
+
+  lifecycle do
+    # Clones the git repo in a temporary directory
+    run :clone, {
+      repository: "https://github.com/example/example.git",
+      branch: :master
+    }
+
+
+    # Runs `git submodules init`
+    run :submodules
+
+
+    # Runs `bundle install --without testing production`
+    run :bundle, {
+      without: [:testing, :production]
+    }
+
+
+    # Runs the rspec suite and cancel the build if it doesn't proceed
+    run :rspec
+
+
+    # Runs `RAILS_ENV=development RAILS_GROUPS=assets bundle exec rake assets:precompile`
+    run :assets, {
+      rails_groups: :assets,
+      rails_env: :development
+    }
+
+
+    # Remove all files and dirs which are not neccessary for production operation
+    run :reduce, {
+      clean: [
+        'coverage',
+        'spec',
+        '.gitignore',
+        'Rbafile',
+        'Guardfile',
+        'db/*.sqlite3',
+        'tmp/sessions',
+        'tmp/cache',
+        'README.md',
+        '.gitignore',
+        '.git',
+        '.rspec',
+        '.gitmodules'
+      ]
+    }
+
+    # Builds the .rba file and removes the temporary directory
+    run :build
+
+
+    #  Uploads the .rba file to the remote machine and deploys it there by creating new release
+    # directory and extract the archive there, creates symlinks for the public directory too.
+    run :deploy
+
+
+    # Creates symlinks for all shared files on the remote machine
+    run :symlink_shared, {
+      files: ['config/config.yml']
+    }
+
+
+    # Creates symlinks for all executables on the remote machine
+    run :symlink_executables, {
+      files: ['run.sh']
+    }
+
+
+    # Runs `bundle install --without testing development assets --deployment`
+    run :bundle_deployment, {
+      without: [:testing, :development, :assets]
+    }
+
+
+    # Migrates the database (or creates a new one)
+    run :migrate
+
+
+    # Remove older revisions except the current and one more. And removes the .rba file.
+    run :cleanup, {
+      keep_releases: 1
+    }
+  end
+end

data/README.md

@@ -0,0 +1,139 @@
+# PIKE >> Intelligent Deployment
+
+[![Build Status](https://travis-ci.org/phortx/pike.png?branch=master)](https://travis-ci.org/phortx/pike)
+[![Coverage Status](https://coveralls.io/repos/phortx/pike/badge.png)](https://coveralls.io/r/phortx/pike)
+[![Dependency Status](https://gemnasium.com/phortx/pike.png)](https://gemnasium.com/phortx/pike)
+[![Code Climate](https://codeclimate.com/github/phortx/pike.png)](https://codeclimate.com/github/phortx/pike)
+
+
+**Warning:** This is an very very early state of development and the codebase is really ugly and cluttered. Don't use it yet.
+
+
+
+
+## What is pike?
+Pike is a smart deployment automation system built to make your life easier.
+
+Based on my experiences made with vlad, capistrano and manual deployments, I've build a deployment automation, which is easier to use and supports sudo, ssh, powerful configuration and very flexible build processes. Additionally I've combined it with the result of my Ruby Archives experiment. So pike doesn't clone the git repository on the production machine, rather then cloning it locally, run the build, packs everything neccessary in a single ruby archive file, compresses it and sends it to the production machine to deploy that file in a very clean way. That reduces the amount of depdencies required on the server, files on the server and the temptation to change files in the repo to quick patch something.
+
+The goal of pike is to ship a smart but easy to use deployment automation system which makes deployments fun and your life easier.
+
+
+
+
+## Features
+* Custom build process: Create your own lifecycle with the tasks you need.
+* Huge arsenal of builtin tasks.
+* Nice verbose logging and a very fancy console output format.
+* Reduces your app code to the required minimum, packs it in one file, compresses it and sends that one file to the server
+* Release management
+* Automated Rollback if something breaks
+* Based on SSH
+* local and remote tasks
+* Integrates well with ...
+  * sudo
+  * your .ssh/config
+  * rvm
+  * rails
+* Built to make you happy. And me.
+
+
+
+
+## Usage
+1. Read the [Pikefile documentation](https://github.com/phortx/pike/wiki/Pikefile)
+2. Setup a Pikefile
+3. Run <code>pike your_environment setup</code> which will setup the infrastructure initially on your server
+4. After that you can deploy the app via <code>pike your_environment</code>
+
+
+
+
+## Documentation
+* [Pikefile](https://github.com/phortx/pike/wiki/Pikefile)
+* [Buildint tasks](https://github.com/phortx/pike/wiki/Tasks)
+* [Write your own Tasks](https://github.com/phortx/pike/wiki/Write-Tasks)
+
+
+
+
+## Contribution
+1. Fork via the github fork button
+2. Clone your fork to your local machine
+3. Run script/setup
+4. Run bundle exec rspec spec/ and see how everything passes (green)
+5. Make your changes
+6. Run bundle exec rspec spec/ and repeat 5. and 6. until everything passes
+7. Commit
+8. Repeat 5. - 7. until you're done
+9. git push
+10. Open a pull request
+11. Get a beer and wait for the merge
+
+
+
+
+## Thanks to
+* Vlad and Capistrano for the idea, a good implementation and the (good and bad) experiences I've made by using them.
+* sshkit and net-ssh-shell for the experiences I've gathered with them about Net::SSH
+* Captain Christopher Pike (Star Trek) for inspiring me to the project name. Or should I thank Gene Roddenberry?
+
+
+
+
+## FAQ
+### Why did you built another deployment automation while there are capistrano and vlad out there? Why are you competing against capistrano/vlad/whatever?
+I want you to understand, that I don't want to replace capistrano or vlad or other deployment
+automations with pike. I've used capistrano and vlad and they do a good job, the huge user base of
+both projects confirm that.
+
+The issue is, both capistrano and vlad don't meet my requirements and are useless for my deployment
+style and use case. If I would use one of them, I had to write many complex recipes. Instead of
+writing those recipipes, I also could write my own deployment automation, which has the features
+I need. So I did. My goal for pike is to create a smart deployment automation with fancy and clear
+output, which integrated well with some mainstream ruby technologies (rails, rvm) and sudo and which
+makes your life easier and deployments more fun.
+
+I have no problem with capistrano, vlad or other deployment automations, I just wanted to create my
+own one, which meets my requirements. That's it :)
+
+If you think, that pike doesn't help you, feel free to use any other software you like, I'll not
+judge you. Software is a tool which should make your life easier and I don't like the way of
+thinking like some developers out there do while arguing against me, that their product is better
+then another one. That's like the Windows vs Mac vs Linux discussion, which I really hate. The point
+is: Everything has it's strengths and weaks. Use those tools that help you to get your work done
+and be happy. And Linux is the best one. ;)
+
+
+
+### WTF is a .rba file?
+It's a ruby archive. A file format I've invented for pike. Ok to be honest, just a file extention
+I've inveted, since is a boring .tar.gz file containing production optimized ruby code.
+
+**The idea behind is simple:** Instead if cloning all your repository code to the production server,
+which contains a lot of clutter like documentation, rspec, coverage reports, git files, IDE files,
+whatever, pike clones the project on your develop machine, removes all the clutter from the
+directory, runs some tasks like precompiling the assets and then packs everything (including the
+compiled assets) without the clutter in a single compressed file, which is sent to the server.
+
+**The advantages:** Your file transfer to your server is faster and your project requires less disk
+space there while it also hides the code from you, which makes it harder to do code changes on the
+production machine to fix something. It forces you to do changes on your development machine and
+redeploy. Additionally your project directory on the server is very clean so you can focus on the
+important stuff like config files.
+
+**The disadvantages:** None ;)
+
+
+
+
+## Licence
+pike is licensed under the MIT License.
+
+Copyright (c) 2013 Benjamin Kammerl aka phortx
+
+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/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/pike

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'pike'

data/lib/pike/dsl/environment.rb

@@ -0,0 +1,56 @@
+module Pike
+  module DSL
+    class Environment
+      ##
+      ## Executes a block with DSL commands
+      ##
+
+      def self.load(env, &block)
+        dsl = new
+        dsl.load env, &block
+        dsl
+      end
+
+      def load(env = nil, &block)
+        @env = env if env
+        instance_eval &block
+      end
+
+
+      ##
+      ## DSL command to define the lifecycle
+      ##
+
+      def lifecycle(&block)
+        load &block
+      end
+
+
+      ##
+      ## DSL command to add a task to the lifecycle
+      ##
+
+      def run(name, params = {})
+        @env.add_task name, params
+      end
+
+
+      ##
+      ## DSL command to set variables
+      ##
+
+      def var(vars = {})
+        @env.set_var vars
+      end
+
+
+      ##
+      ## DSL command to get the value of a variable
+      ##
+
+      def get(key)
+        @env.get_var vars
+      end
+    end
+  end
+end

data/lib/pike/dsl/pikefile.rb

@@ -0,0 +1,51 @@
+module Pike
+	module DSL
+    class Pikefile
+      ##
+      ## Loads a Pike DSL basef file
+      ##
+
+      def self.load(filename)
+        dsl = new
+        dsl.instance_eval File.read(filename), filename
+        dsl
+      end
+
+
+      ##
+      ## DSL Function to set variables
+      ##
+
+  		def var(vars = {})
+  			Main.set_var vars
+  		end
+
+
+      ##
+      ## DSL Function to get a variables values
+      ##
+
+  		def get(key)
+  			Main.get_var key
+  		end
+
+
+      ##
+      ## DSL Function to add a task
+      ##
+
+  		def task(name, &block)
+  			Main.add_task name, &block
+  		end
+
+
+      ##
+      ## DSL Function to add a environment
+      ##
+
+  		def env(name, &block)
+  			Main.add_env name, &block
+  		end
+  	end
+  end
+end

data/lib/pike/dsl/task.rb

@@ -0,0 +1,101 @@
+module Pike
+  module DSL
+    class Task
+      ##
+      ## Executes a block with DSL commands
+      ##
+
+      def self.load(task, &block)
+        dsl = new
+        dsl.load task, &block
+        dsl
+      end
+
+      def load(task = nil, &block)
+        @task = task if task
+        instance_eval &block
+      end
+
+
+      ##
+      ## DSL command to run a command on the remote machine
+      ##
+
+      def remote(cmd, vars = {})
+        Tasks::Command.new(@task, :remote, cmd, vars).run(@task.current_env)
+      end
+
+
+      ##
+      ## DSL command to run a command on the local machine
+      ##
+
+      def local(cmd, vars = {})
+        Tasks::Command.new(@task, :local, cmd, vars).run(@task.current_env)
+      end
+
+
+      ##
+      ## DSL command to run another task
+      ##
+
+      def exec(task)
+        @task.run_tasktask
+      end
+
+
+      ##
+      ## DSL command to build the rba file
+      ##
+
+      def build_rba
+        "!BUILD_RBA"
+      end
+
+
+      ##
+      ## DSL command to upload a file from local machine to remote machine
+      ##
+
+      def upload(local, remote)
+        local "!SCP #{local} #{remote}"
+      end
+
+
+      ##
+      ## DSL command to get the value of a variable
+      ##
+
+      def get(key)
+        @task.get_var key
+      end
+
+
+      ##
+      ## DSL command to get the value of a variable
+      ##
+
+      def param(key, default = nil)
+        @task.get_param key, default
+      end
+
+
+      ##
+      ## DSL command to check if a param is set
+      ##
+
+      def param_given?(key)
+        @task.param_given? key
+      end
+
+
+      ##
+      ## DSL command to check if a variable is set
+      ##
+
+      def var_given?(key)
+        @task.var_given? key
+      end
+    end
+  end
+end