fucking_shell_scripts 0.99 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8009309508988eb570f497f873f20add0226fa4d
-  data.tar.gz: 067245ebe96188fb2890b02091e8ed3ce65def91
+  metadata.gz: c05b1d90cd1b92a78231e67b153532b29b54024a
+  data.tar.gz: c8706137b7ac4f46d8f8498ff07db9d06db9b23b
 SHA512:
-  metadata.gz: 951bfa262aec8703aa2e043e04ed7b62374d588cf2fd0976da227293fd171117ea389f37adbdda492c1da40f7c4cb5f9a0146d7437258f505355c21f3856a00e
-  data.tar.gz: c6f9c1202e68497580b2cfb31a6fa35e3335847bc96c17b78c20c865cc14151b7189992c4d93024143c8b93121bea6372b0b3891b9418e975fa6059619a0aab3
+  metadata.gz: adf82e3996b4c1fdbebfe60218c6566eb79057f7bc479524c5e11d3c7664c452b943b4aa0b6ae75e96b18fc463d718482d5356953928910dbe017c2236f655e5
+  data.tar.gz: fb5aed54b314a49cebd5f0574b851525ab62a9adf7d32fdadcb2e748194d75426540d9863f9429ff64da26256604e5c1dd0f02b26796b0dd797904306d422ebc

data/README.md

@@ -1,68 +1,185 @@
-# FuckingShellScripts
+# Fucking Shell Scripts
 
-The easiest, most common sense configuration management tool... because you just use fucking shell scripts.
+The easiest, most common sense server configuration management tool...because you just use fucking shell scripts.
 
-## Installation
+Completely confused by Chef?  Blowing your brains out over Ansible?  Lost control of your Puppets?  Wanna just use **fucking shell scripts** to configure a server? Read on!
 
-Add this line to your application's Gemfile:
+# Features
 
-    gem 'fucking_shell_scripts'
+*   Wraps up the fog gem, so it can be used on any cloud service, including AWS, rackspace, etc.
+*   We've intentionally designed this tool to be insanely easy to use
 
-And then execute:
+### Step 0: Install the gem
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install fucking_shell_scripts
+```Shell
+gem install fucking_shell_scripts
+```
 
-## Development
 
-During development of a script, use vagrant:
+### Step 1: Create a project directory
 
-    vagrant up
-    cd /vagrant
+```Shell
+mkdir config_management
+```
 
-`cd /vagrant` will put you in the root folder of the project so that you can run a script such as `./search-service.sh`.
+Folder structure:
+
+*   `/servers` _(required)_ - yaml server definitions _(see example below)_
+
+*   `/scripts` _(required)_ - the shell scripts that will configure your servers _(see example below)_
+
+*   `/files` _(optional)_ - files to be transferred to servers _(nginx.conf, ssh keys, database.yml, etc.)_
+
+An example folder structure:
+
+```Shell
+./config_management
+├── files
+│   ├── keys
+│   │   └── deploy_key
+│   └── rails_config
+│       └── database.yml
+├── scripts
+│   ├── apt.sh
+│   ├── deploy_key.sh
+│   ├── git.sh
+│   ├── redis.sh
+│   ├── ruby2.sh
+│   ├── rubygems.sh
+│   ├── search_service_code.sh
+│   └── search_service_env.sh
+└── servers
+    ├── defaults.yml
+    └── search-server.yml
+```
 
-## Servers
 
-### Defaults
+### Step 2: Create a server definition file
 
-Server defaults are defined by creating the following file:
+The server definition file defines how to build a type of server. Server definitions override settings in `defaults.yml`.
 
-`./servers/defaults.yml`
+```YAML
+# servers/search-server.yml
+##################################################
+# This file defines how to build our search server
+##################################################
 
-```yaml
-name: ppd instance
-security_groups: pd-app-server
-instance_type: c1.xlarge
-image_id: ami-e76ac58e
+name: search-server
+size: c1.xlarge
 availability_zone: us-east-1d
-region: us-east-1
+image: ami-90374bf9
 key_name: pd-app-server
-private_key_path: /Users/bhilkert/.ssh/pd-app-server
-```
+private_key_path: /Users/yourname/.ssh/pd-app-server
+security_groups: search-service  # override the security_groups defined in defaults.yml
 
-To define a server, create a yaml file in the `./servers` directory with the following format:
+############################################
+# Files necessary to build the search server
+############################################
 
-`./servers/search-service.yml`
+files:
+  - files/keys/deploy_key
 
-```yaml
-name: search-service
-security_groups: search-service
-instance_type: c1.medium
-image_id: ami-90374bf9
+###########################################
+# Scripts needed to build the search server
+###########################################
 
 scripts:
   - scripts/apt.sh
-  - scripts/env.sh
+  - scripts/search_service_env.sh
   - scripts/git.sh
-  - scripts/ruby.sh
+  - scripts/ruby2.sh
   - scripts/rubygems.sh
   - scripts/redis.sh
+  - scripts/deploy_key.sh
 ```
 
+`servers/defaults.yml`has the same structure and keys a server definition file, **except**, you cannot define scripts or files.
+
+```YAML
+# servers/defaults.yml
+################################
+# This file defines our defaults
+################################
+
+security_groups: simple-group
+size: c1.medium
+image: ami-e76ac58e
+availability_zone: us-east-1d
+key_name: global-key
+cloud:
+  provider: AWS
+  aws_access_key_id: <=% ENV[AWS_ACCESS_KEY] %>
+  aws_secret_access_key: <%= ENV[AWS_SECRET_ACCESS_KEY] %>
+  region: us-east-1
+
+```
+
+#### Cloud options
+
+Anything passed in the 'cloud' key will be directly passed to
+`Fog::Compute.new`.  See [the fog website](http://fog.io/compute) for more info.
+
+FSS will consider any values that look like "ENV[VAR_NAME]" to be
+environment variables, and will attempt to look up that environment
+variable. If FSS does not find that variable, an exception will be
+raised.
+
+### Step 3: Add shell scripts that configure the server
+
+Seriously...just write shell scripts.
+
+Want to install Ruby 2? Here's an example:
+
+```Shell
+#!/bin/sh
+#
+# scripts/ruby2.sh
+#
+sudo apt-get -y install build-essential zlib1g-dev libssl-dev libreadline6-dev libyaml-dev
+cd /tmp
+wget http://ftp.ruby-lang.org/pub/ruby/2.0/ruby-2.0.0-p247.tar.gz
+tar -xzf ruby-2.0.0-p247.tar.gz
+cd ruby-2.0.0-p247
+./configure --prefix=/usr/local
+make
+sudo make install
+rm -rf /tmp/ruby*
+```
+
+### Step 4: Build/configure your server
+
+```Shell
+fss search-server
+```
+
+This command does 2 things:
+
+1.  Builds the new server
+2.  Runs the scripts configuration
+
+**To build only:**
+
+```Shell
+fss --build search-server
+```
+
+**To configure only:**
+
+```Shell
+fss --instance-id i-9ad6d7af --configure search-server
+```
+
+_Note: `--instance-id` is required when using the `--configure` option_
+
+
+### Step 5: Remove your chef repo and all its contents.
+
+```Shell
+rm -rf ~/old_config_management/chef
+```
+
+**HOLY SHIT! THAT WAS EASY.**
+
 ## Contributing
 
 1. Fork it

data/bin/fss

@@ -26,18 +26,22 @@ OptionParser.new do |opts|
   end
 
   opts.on('-v', '--version', 'Show version' ) do
-    puts FuckingShellScripts::Version
+    puts FuckingShellScripts::VERSION
+    exit
   end
 end.parse!
 
 options.merge!(type: ARGV.first)
 
+abort("Specify the type of server to build/configure as the first argument (ie. fss app-server)") unless options[:type]
+
 cli = FuckingShellScripts::CLI.new(options)
 
 if options[:build]
   cli.build
 
 elsif options[:configure]
+  abort("Specify the server instance ID to configure using the --instance-id option") unless options[:instance_id]
   cli.configure
 
 else

data/fucking_shell_scripts.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
 
   spec.add_dependency "fog", "~> 1.14.0"
 end

data/lib/core_ext/hash.rb

@@ -0,0 +1,10 @@
+class Hash
+  def symbolize_keys_deep!
+    keys.each do |k|
+      symbol_key_name = k.to_sym
+      self[symbol_key_name] = self.delete(k)
+      self[symbol_key_name].symbolize_keys_deep! if self[symbol_key_name].kind_of? Hash
+    end
+    self
+  end
+end

data/lib/ext/fog.rb

@@ -20,13 +20,13 @@ class Fog::SSH::Real
 
               channel.on_data do |ch, data|
                 result.stdout << data
-                puts data
+                print data
               end
 
               channel.on_extended_data do |ch, type, data|
                 next unless type == 1
                 result.stderr << data
-                puts data
+                print data
               end
 
               channel.on_request('exit-status') do |ch, data|

data/lib/fucking_shell_scripts.rb

@@ -1,14 +1,11 @@
 require "fucking_shell_scripts/version"
 
-begin
-  require 'pry'
-rescue LoadError
-end
-
 require_relative 'fucking_shell_scripts/cli'
 require_relative 'fucking_shell_scripts/configuration'
 require_relative 'fucking_shell_scripts/connection'
 require_relative 'fucking_shell_scripts/scp'
 require_relative 'fucking_shell_scripts/server'
+require_relative 'fucking_shell_scripts/errors'
 
+require_relative 'core_ext/hash'
 require_relative 'ext/fog'

data/lib/fucking_shell_scripts/cli.rb

@@ -1,8 +1,9 @@
 module FuckingShellScripts
   class CLI
+    MissingCloudSettings = Class.new(StandardError)
+
     def initialize(opts = {})
       @opts = opts
-      @connection = FuckingShellScripts::Connection.new(options).connection
     end
 
     def bootstrap
@@ -20,7 +21,11 @@ module FuckingShellScripts
     private
 
     def server
-      FuckingShellScripts::Server.new(@connection, options)
+      @server ||= FuckingShellScripts::Server.new(connection, options)
+    end
+
+    def connection
+      FuckingShellScripts::Connection.new(options.fetch(:cloud)).connection
     end
 
     def options

data/lib/fucking_shell_scripts/configuration.rb

@@ -1,9 +1,11 @@
 require 'yaml'
+require 'erb'
 
 module FuckingShellScripts
   class Configuration
     MissingServerType = Class.new(StandardError)
     MissingServerConfiguration = Class.new(StandardError)
+    MissingCloudConfiguration = Class.new(StandardError)
 
     attr_reader :options
 
@@ -13,13 +15,14 @@ module FuckingShellScripts
       read_and_parse_server_options
 
       raise MissingServerType, "Please specify a type of server you want to create using the --type option" unless options[:type]
+      raise MissingCloudConfiguration, "Please specify settings for your provider per http://fog.io/about/provider_documentation.html" unless options[:cloud]
     end
 
     private
 
     def default_options
       begin
-        YAML.load(File.read('servers/defaults.yml'))
+        YAML.load(ERB.new(File.read('servers/defaults.yml')).result)
       rescue Errno::ENOENT
         {}
       end
@@ -27,7 +30,7 @@ module FuckingShellScripts
 
     def server_options
       begin
-        YAML.load(File.read(server_file))
+        YAML.load(ERB.new(File.read(server_file)).result)
       rescue Errno::ENOENT
         raise MissingServerConfiguration, "Please create a configuration file './servers/#{type}.yml'"
       end
@@ -39,11 +42,12 @@ module FuckingShellScripts
 
     def read_and_parse_server_options
       options_string_hash = default_options.merge(server_options).merge(@command_line_options)
-      @options = Hash[options_string_hash.map{ |(k,v)| [k.to_sym, v] }]
+      @options = options_string_hash.symbolize_keys_deep!
     end
 
     def type
       @command_line_options[:type]
     end
+
   end
 end

data/lib/fucking_shell_scripts/connection.rb

@@ -2,25 +2,12 @@ require 'fog'
 
 module FuckingShellScripts
   class Connection
-    MissingAWSCredentials = Class.new(StandardError)
-
     def initialize(opts)
       @opts = opts
-
-      if ENV["AWS_ACCESS_KEY"].nil? || ENV["AWS_SECRET_ACCESS_KEY"].nil?
-        raise FuckingShellScripts::Connection::MissingAWSCredentials, "Make sure AWS_ACCESS_KEY and AWS_SECRET_ACCESS_KEY are environmental variables with your credentials"
-      end
     end
 
     def connection
-      @connection ||= begin
-        Fog::Compute.new(
-          provider: "AWS",
-          aws_access_key_id: ENV["AWS_ACCESS_KEY"],
-          aws_secret_access_key: ENV["AWS_SECRET_ACCESS_KEY"],
-          region: @opts.fetch(:region)
-        )
-      end
+      Fog::Compute.new(@opts)
     end
   end
 end

data/lib/fucking_shell_scripts/errors.rb

@@ -0,0 +1,5 @@
+module FuckingShellScripts
+  class Errors
+    ScriptNotExecutable = Class.new(StandardError)
+  end
+end

data/lib/fucking_shell_scripts/scp.rb

@@ -7,16 +7,24 @@ module FuckingShellScripts
     end
 
     def to_server
+      check_executable_permissions
       create_local_archive
       scp_files_to_server
       extract_remote_archive
+      remove_remote_archive
       remove_local_archive
     end
 
     private
 
+    def check_executable_permissions
+      @opts.fetch(:scripts).each do |file|
+        raise FuckingShellScripts::Errors::ScriptNotExecutable , "The script #{file} is not executable." unless File.executable?(file)
+      end
+    end
+    
     def create_local_archive
-      includes = @opts.fetch(:files) + @opts.fetch(:scripts)
+      includes = @opts.fetch(:files){ [] } + @opts.fetch(:scripts)
       `tar -czf #{FILENAME} #{includes.join(" ")}`
     end
 
@@ -28,6 +36,10 @@ module FuckingShellScripts
       @server.ssh("tar -xzf #{FILENAME}")
     end
 
+    def remove_remote_archive
+      @server.ssh("rm #{FILENAME}")
+    end
+
     def remove_local_archive
       `rm -f #{FILENAME}`
     end

data/lib/fucking_shell_scripts/server.rb

@@ -23,6 +23,7 @@ module FuckingShellScripts
         groups: options.fetch(:security_groups),
         private_key_path: options.fetch(:private_key_path)
       )
+      @server.username = options.fetch(:username) if options.fetch(:username)
       print "Creating #{options.fetch(:size)} from #{options.fetch(:image)}"
 
       server.wait_for do

data/lib/fucking_shell_scripts/version.rb

@@ -1,3 +1,3 @@
 module FuckingShellScripts
-  VERSION = "0.99"
+  VERSION = "1.0"
 end

data/spec/core_ext/hash_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Hash do
+  describe "#symbolize_keys_deep!" do
+    it "symbolizes recusively" do
+      hash = { "a" => 1, "b" => { "c" => 2, "d" => 3 } }
+      hash.symbolize_keys_deep!
+      expect(hash.fetch(:a)).to eq(1)
+      expect(hash.fetch(:b)).to eq({ :c => 2, :d => 3 })
+    end
+  end
+end

data/spec/fucking_shell_scripts/cli_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+module FuckingShellScripts
+  describe CLI do
+    let(:server) { double('server', bootstrap: true, build: true, configure: true) }
+    let(:options) {
+      {
+        type: "test-server",
+        region: "us-east-1",
+      }
+    }
+    let(:config) { double('config', options: options) }
+
+    it "initializes a server with the connection" do
+      connection = double('connection')
+      connection_obj = double('obj connection', connection: connection)
+      FuckingShellScripts::Connection.stub(:new).and_return(connection_obj)
+      FuckingShellScripts::Configuration.stub(:new).and_return(config)
+      FuckingShellScripts::Server.should_receive(:new).with(connection, options).and_return(server)
+      FuckingShellScripts::CLI.new.bootstrap
+    end
+
+    context "instance methods" do
+      before :each do
+        ENV["AWS_ACCESS_KEY"] = "key"
+        ENV["AWS_SECRET_ACCESS_KEY"] = "secret"
+        FuckingShellScripts::Configuration.stub(:new).and_return(config)
+        FuckingShellScripts::Server.stub(:new).and_return(server)
+      end
+
+      it "bootstraps a server" do
+        expect(server).to receive(:bootstrap)
+        FuckingShellScripts::CLI.new.bootstrap
+      end
+
+      it "builds a server" do
+        expect(server).to receive(:build)
+        FuckingShellScripts::CLI.new.build
+      end
+
+      it "configures a server" do
+        expect(server).to receive(:configure)
+        FuckingShellScripts::CLI.new.configure
+      end
+
+    end
+  end
+end

data/spec/fucking_shell_scripts/connection_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+module FuckingShellScripts
+  describe Connection do
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+begin
+  require 'pry'
+rescue LoadError
+end
+
+require 'fucking_shell_scripts'
+

metadata

@@ -1,69 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: fucking_shell_scripts
 version: !ruby/object:Gem::Version
-  version: '0.99'
+  version: '1.0'
 platform: ruby
 authors:
 - Brandon Hilkert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-16 00:00:00.000000000 Z
+date: 2014-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fog
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.14.0
 description: The easiest, most common sense configuration management tool... because
@@ -75,23 +89,28 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/fss
 - fucking_shell_scripts.gemspec
+- lib/core_ext/hash.rb
 - lib/ext/fog.rb
 - lib/fucking_shell_scripts.rb
 - lib/fucking_shell_scripts/cli.rb
 - lib/fucking_shell_scripts/configuration.rb
 - lib/fucking_shell_scripts/connection.rb
+- lib/fucking_shell_scripts/errors.rb
 - lib/fucking_shell_scripts/scp.rb
 - lib/fucking_shell_scripts/server.rb
 - lib/fucking_shell_scripts/version.rb
-- spec/fss_spec.rb
-- spec/servers/search-service.yml
+- spec/core_ext/hash_spec.rb
+- spec/fucking_shell_scripts/cli_spec.rb
+- spec/fucking_shell_scripts/connection_spec.rb
+- spec/spec_helper.rb
+- spec/support/servers/test-server.yml
 homepage: https://github.com/brandonhilkert/fucking_shell_scripts
 licenses:
 - MIT
@@ -102,21 +121,24 @@ 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.0.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: The easiest, most common sense configuration management tool... because you
   just use fucking shell scripts.
 test_files:
-- spec/fss_spec.rb
-- spec/servers/search-service.yml
+- spec/core_ext/hash_spec.rb
+- spec/fucking_shell_scripts/cli_spec.rb
+- spec/fucking_shell_scripts/connection_spec.rb
+- spec/spec_helper.rb
+- spec/support/servers/test-server.yml

data/spec/fss_spec.rb

@@ -1,13 +0,0 @@
-require 'fss'
-
-describe Fss do
-  it "new" do
-    Fss::Configuration.any_instance.stub(:settings_file).and_return('spec/support/settings.yml')
-    Fss.new()
-
-  end
-
-
-
-end
-