petra 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MmMwZjJkODBiMTM2ZjEwYTZjOTdhNGJmNGExMTVkNjkwNjQ3MzNhNQ==
+    ZDY5NWFlMmY0MDgxODYyMjM2ZTMwNGE3NDQzN2JiNzJiYTM2Mzg3ZQ==
   data.tar.gz: !binary |-
-    YTgzNjFhMzhlNzFlYWY4MjY0ODczOGY5YTQ4YzZiNTY4YTY5M2FjNg==
+    ZWMyNzM3YTQ1NDJhMjY5YTRlOGY3ODEyYTE4YzhjNDllMmJlOTVmOA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZDRkZjk0MDM4ODVhMGYwZmVkZWI2YjMyYmI2Y2FhNjMzMWE4YWY2MDQ1OGVk
-    NjhhNWI4NTExYTJiNzg4MzA4YTBmZjMwYjZhMWRiOWMyNzE3ZjE4ZGVkZDg4
-    NmIxZDkyYTQ0NWFlNGRkYjQ0MGZjNTA4MmMwYmJlYjg4YmUxZWI=
+    YmRhODNlYjM2OWM0MzRkZDBhNmFlYWRlNGM2MWNhYzY4MGQ4ZDdhMGQyZjlj
+    OGJlZjdiODA1YWJiNGYwMzdiZjUyYTVhYWVlMGRlYTg1MGYxODNjZGFlZWVk
+    ZWNiNDNkZjM1OGJhYzc5MzU0MzQzYTkwYTdkNWQ5MjJmYzUxMjA=
   data.tar.gz: !binary |-
-    NGVjZjZiYTZmMDUzMjdjMzI5NjlkN2VhMzM5MDQzZjUzNzg5NTc5M2FhYTQ4
-    NzlmOTJhZDk2NzljYTBiNzM5ZmZlYjdmZjRlMjMzMjQ5ZDBlOWJkMmZjNWVk
-    YmM3YjZjMGM0NGRjMzY1Y2I2ZTY1YTgwNGE5ZTEwNDY3MDY0OWE=
+    MjM0YzAwZjc2NDJiZTMyMzJmMzUzYTJiNTM2OGJmNTdhMjM5ODg5ZDZlYWZh
+    NjAwMzg0ZTc2Yzg4ZGEyYjU0ODNkOGQ2YmE5NGYxNTVkOWViMjE5ZDE0ZGU3
+    NzY2NDU5M2UzNWY3OGQzYjI1ZGU0ZTU5ODgzYjdhNDQ3M2I0MzY=

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Versions
+
+## 0.0.2
+
+* simplified many subcommands down to just `generate`
+* updated options and calls to reflect new ansible/vagrant versions
+
+## 0.0.1
+
+* initial version
+* pushed to rubygems

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in petra.gemspec
 gemspec
+
+gem 'pry'

data/README.md

@@ -1,24 +1,34 @@
 # Petra
 
-A toolkit for managing Ansible projects.
+A toolkit for managing Ansible/Vagrant projects.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Run the following command on your shell to install the gem, including
+the CLI.
 
-    gem 'petra'
+    gem install petra
 
-And then execute:
+## Usage
 
-    $ bundle
+Start by creating a new project:
 
-Or install it yourself as:
+    petra generate project my-sweet-project
 
-    $ gem install petra
+Or, use the shortcut:
 
-## Usage
+    petra new my-sweet-project
+
+This includes a default machine configuration with the name `default`.
+Machines are Petra's way of describing the different (proto)types of
+boxes that your project may need. If you want to call it `webserver`
+instead, use the `-m` option:
+
+    petra new my-sweet-project -m webserver
+
+When you're ready, `cd` into your project and run `vagrant up`.
 
-TODO: Write usage instructions here
+That's all for now :)
 
 ## Contributing
 

data/bin/petra

@@ -8,8 +8,15 @@ BEGIN {
     require 'petra/cli'
   rescue LoadError => e
     raise e if has_retried
-    libpath = File.expand_path "#{ __FILE__ }/../../lib"
-    $LOAD_PATH.unshift libpath
+
+    rootdir = File.expand_path "#{ __FILE__ }/../.."
+    gitdir  = "#{ rootdir }/.git"
+
+    if Dir.exists?( gitdir )
+      ENV[ 'BUNDLE_GEMFILE' ] ||= "#{ rootdir }/Gemfile"
+      require 'bundler/setup'
+    end
+
     has_retried = true
     retry
   end

data/lib/petra.rb

@@ -1,4 +1,6 @@
 require "petra/version"
 
 module Petra
+  ROOTPATH = File.expand_path "#{ __FILE__ }/../.."
+  LIBPATH  = "#{ ROOTPATH }/lib"
 end

data/lib/petra/cli.rb

@@ -1,6 +1,25 @@
+require 'petra'
 require 'thor'
 
 module Petra
   class CLI < Thor
+    desc \
+      'new <name>',
+      'Shortcut to create a new Petra project named <name>'
+
+    option \
+      :machine_name,
+      :aliases  => '-m',
+      :default  => 'default',
+      :desc     => 'The name of the first machine in the project.'
+
+    def new( project_name )
+      invoke \
+        Generate,
+        :project
+    end
   end
 end
+
+require 'petra/cli/subcommand'
+require 'petra/cli/generate'

data/lib/petra/cli/generate.rb

@@ -0,0 +1,126 @@
+module Petra
+  class CLI
+    Subcommand :Generate do
+      attr_reader \
+        :machine_name,
+        :playbook_name,
+        :project_name,
+        :seed_name
+
+      command_description 'Template various parts of, or whole, Petra projects'
+      command_invocation  'generate'
+      command_usage       'generate <subcommand> <...args>'
+
+      desc \
+        'machine <name>',
+        'Create a new machine named <name>'
+
+      def machine( machine_name )
+        @machine_name ||= machine_name
+
+        template_new_machine!
+
+        invoke_new_seed!
+        invoke_new_playbook!
+      end
+
+      desc \
+        'playbook <name>',
+        'Create a new playbook named <name>'
+
+      def playbook( playbook_name )
+        @playbook_name ||= playbook_name
+        template_new_playbook!
+      end
+
+      desc \
+        'project <name>',
+        'Create a new Petra project named <name>'
+
+      option \
+        :machine_name,
+        :aliases  => '-m',
+        :default  => 'default',
+        :desc     => 'The name of the first machine in the project.'
+
+      def project( project_name )
+        @project_name ||= project_name
+
+        template_new_project_directory!
+
+        inside project_name do
+          invoke_new_machine!
+        end
+      end
+
+      desc \
+        'seed <name>',
+        'Create a new seed named <name>'
+
+      def seed( seed_name )
+        @seed_name ||= seed_name
+        template_new_seed!
+      end
+
+      no_commands do
+        def invoke_new_playbook!
+          invoke \
+            Generate,
+            :playbook,
+            [ machine_name ]
+        end
+
+        def invoke_new_seed!
+          invoke \
+            Generate,
+            :seed,
+            [ machine_name ]
+        end
+
+        def invoke_new_machine!
+          invoke \
+            Generate,
+            :machine,
+            [ machine_name ],
+            Hash.new
+        end
+
+        def machine_name
+          @machine_name or options.machine_name
+        end
+
+        def petra_version
+          Petra::VERSION
+        end
+
+        def template_new_machine!
+          empty_directory 'machines'
+
+          directory \
+            'machine/new',
+            '.'
+        end
+
+        def template_new_playbook!
+          directory \
+            'playbook/new',
+            '.'
+        end
+
+        def template_new_project_directory!
+          directory \
+            'project/new',
+            project_name
+        end
+
+        def template_new_seed!
+          empty_directory 'seeds'
+
+          directory \
+            'seed/new',
+            '.'
+        end
+      end
+    end
+  end
+end

data/lib/petra/cli/subcommand.rb

@@ -0,0 +1,53 @@
+require 'petra/patches/thor'
+
+module Petra
+  class CLI
+    class Subcommand < Thor
+      include Thor::Actions
+
+      module ClassMethods
+        %w(
+          description
+          invocation
+          usage
+        ).each do | attr |
+          module_eval <<-___ , __FILE__ , __LINE__
+            def command_#{ attr }( val = nil )
+              if val
+                @_command_#{ attr } ||= val
+              end
+
+              @_command_#{ attr }
+            end
+          ___
+        end
+      end
+
+      def self.inherited( klass )
+        klass.source_root "#{ LIBPATH }/sources"
+        klass.extend ClassMethods
+      end
+    end
+
+    private
+
+    def self.Subcommand( command_name , &block )
+      subcommand_class =
+        Class.new \
+          Subcommand,
+          &block
+
+      const_set \
+        command_name,
+        subcommand_class
+
+      register \
+        subcommand_class,
+        subcommand_class.command_invocation,
+        subcommand_class.command_usage,
+        subcommand_class.command_description
+
+      subcommand_class
+    end
+  end
+end

data/lib/petra/patches/thor.rb

@@ -0,0 +1 @@
+require 'petra/patches/thor/command'

data/lib/petra/patches/thor/command.rb

@@ -0,0 +1,40 @@
+class Thor
+  class Command
+   def formatted_usage(klass, namespace = true, subcommand = false)
+      if namespace
+        namespace = klass.namespace
+        formatted = "#{namespace.gsub(/^(default)/,'')}:"
+      end
+      formatted = "#{klass.namespace.split(':').last} " if subcommand
+
+      formatted ||= ""
+
+      # PATCH :: properly display subcommands
+      #
+      # Tasks/Commands registered in subcommands incorrectly
+      # display at the top level with the default Thor help
+      # task. This attempts to fix the issue.
+      #
+      # WARN :: it probably won't work for subcommands of subcommands
+      #
+      if !subcommand and klass.ancestors.include?( Petra::CLI::Subcommand )
+        formatted << "#{ klass.command_invocation } "
+      end
+
+      # Add usage with required arguments
+      formatted << if klass && !klass.arguments.empty?
+        usage.to_s.gsub(/^#{name}/) do |match|
+          match << " " << klass.arguments.map{ |a| a.usage }.compact.join(' ')
+        end
+      else
+        usage.to_s
+      end
+
+      # Add required options
+      formatted << " #{required_options}"
+
+      # Strip and go!
+      formatted.strip
+    end
+  end
+end

data/lib/petra/version.rb

@@ -1,3 +1,3 @@
 module Petra
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/sources/machine/new/machines/%machine_name%.vagrant.rb.tt

@@ -0,0 +1,17 @@
+App.machine_configs.register '<%= machine_name %>' do | base_config |
+  base_config.vm.define :<%= machine_name %> do | config |
+    config.vm.hostname = '<%= machine_name %>'
+
+    config.vm.network \
+      :forwarded_port,
+      :guest => 22,
+      :host  => App.seeds[ '<%= machine_name %>' ][ 'ansible_ssh_port' ]
+
+    config.vm.provision :ansible do | ansible |
+      ansible.raw_arguments  = '--extra-vars=@seeds/<%= machine_name %>.seed.yml'
+      ansible.inventory_path = 'hosts/local.hosts'
+      ansible.playbook       = '<%= machine_name %>.yml'
+      ansible.verbose        = true
+    end
+  end
+end

data/lib/sources/playbook/new/%playbook_name%.yml.tt

@@ -0,0 +1,5 @@
+---
+- name: <%= playbook_name %> machine playbook
+  hosts: all
+  roles:
+    - common

data/lib/sources/project/new/.gitignore

@@ -0,0 +1,9 @@
+/.bundle
+/.vagrant
+/.venv
+
+/seeds/*.seed.rb
+/vendor/bundle
+
+*.crt
+*.key

data/lib/sources/project/new/README.md.tt

@@ -0,0 +1,6 @@
+# <%= project_name %>
+
+TODO: Write documentation about your infrastructure
+
+------------------------
+Generated Using [Petra](https://github.com/cookrn/petra) v<%= petra_version %>

data/lib/sources/project/new/Vagrantfile

@@ -0,0 +1,21 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+load 'lib/app.rb'
+
+Vagrant.configure( '2' ) do | config |
+  config.vm.box     = 'precise64'
+  config.vm.box_url = 'http://files.vagrantup.com/precise64.box'
+
+  config.vm.provider :virtualbox do | vb |
+    vb.customize [
+      'modifyvm',
+      :id,
+      '--memory',
+      '512'
+    ]
+  end
+
+  App.load_seeds!
+  App.load_machines! config
+end

data/lib/sources/project/new/hosts/local.hosts

@@ -0,0 +1 @@
+127.0.0.1

data/lib/sources/project/new/lib/app.rb

@@ -0,0 +1,63 @@
+require 'yaml'
+
+module App
+  extend self
+
+  attr_accessor \
+    :seeds,
+    :machine_configs,
+    :root
+
+  class Hashy < Hash
+    alias_method :__old_get__ , :[]
+
+    def get( key )
+      if has_key?( key )
+        __old_get__ key
+      else
+        self[ key ] = self.class.new
+      end
+    end
+    alias_method :[] , :get
+
+    def register( key , &block )
+      self[ key ] = block
+    end
+  end
+
+  self.machine_configs = Hashy.new
+  self.seeds           = Hashy.new
+
+  self.root = File.expand_path "#{ __FILE__ }/../.."
+
+  def load_seed!( seed )
+    seed_name = seed.split( '/' ).last.split( '.' ).first
+    data = YAML.load_file seed
+    seeds[ seed_name ] = data
+  end
+
+  def load_seeds!
+    Dir[ "#{ root }/seeds/**/**.seed.yml" ].each do | seed |
+      load_seed! seed
+    end
+  end
+
+  def load_machines!( config )
+    Dir[ "#{ root }/machines/**/**.vagrant.rb" ].each do | machine |
+      load machine
+    end
+
+    machines =
+      if ENV[ 'MACHINES' ]
+        ENV[ 'MACHINES' ].split ','
+      else
+        machine_configs.keys
+      end
+
+    machines.each do | machine |
+      if machine_config = machine_configs[ machine ]
+        instance_exec config , &machine_config
+      end
+    end
+  end
+end

data/lib/sources/project/new/roles/common/tasks/main.yml

@@ -0,0 +1,16 @@
+---
+- name: update apt
+  apt: update_cache=yes cache_valid_time=3600
+  sudo: yes
+
+- name: install common packages
+  apt: pkg={{ item }}
+  sudo: yes
+  with_items:
+    - curl
+    - git
+    - screen
+    - subversion
+    - traceroute
+    - vim
+    - build-essential

data/lib/sources/seed/new/seeds/%seed_name%.seed.example.yml

@@ -0,0 +1,16 @@
+# -*- mode: yaml -*-
+# vi: set ft=yaml :
+
+# This is an example app seed file. It will not be ignored by
+# the default `.gitignore` file included in this repository.
+# Use it to keep track of the required Ansible key/value
+# variable pairs required by your playbooks so that other users
+# of this repository will simply need to copy in the required
+# secret values. See the example key `super_secret_key` included
+# below.
+
+---
+ansible_ssh_port: 42000
+ansible_ssh_private_key_file: ~/.vagrant.d/insecure_private_key
+ansible_ssh_user: vagrant
+super_secret_key: example not real super secret value

data/lib/sources/seed/new/seeds/%seed_name%.seed.yml

@@ -0,0 +1,20 @@
+# -*- mode: yaml -*-
+# vi: set ft=yaml :
+
+# This is a real, usable seed file. It will be ignored by
+# the default `.gitignore` file included in this repository
+# since it may contain actual secret values not meant to be
+# included in your source repository. See the example key
+# `super_secret_key` included below.
+
+# Ultimately, these values will be passed as `--extra-vars` to the
+# `ansible-playbook` command for provisioning your machine(s). This
+# happens either by passing them to Vagrant during the machine
+# provisioning step or during a playbook run using the `petra`
+# command.
+
+---
+ansible_ssh_port: 42000
+ansible_ssh_private_key_file: ~/.vagrant.d/insecure_private_key
+ansible_ssh_user: vagrant
+super_secret_key: actual super secret value

data/petra.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Petra::VERSION
   spec.authors       = ["Ryan Cook"]
   spec.email         = ["cookrn@gmail.com"]
-  spec.description   = %q{A toolkit for managing Ansible projects.}
+  spec.description   = %q{A toolkit for managing Ansible/Vagrant projects.}
   spec.summary       = "#{ spec.name } v#{ spec.version }"
   spec.homepage      = "https://github.com/cookrn/petra"
   spec.license       = "MIT"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: petra
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ryan Cook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-07 00:00:00.000000000 Z
+date: 2013-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -52,7 +52,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A toolkit for managing Ansible projects.
+description: A toolkit for managing Ansible/Vagrant projects.
 email:
 - cookrn@gmail.com
 executables:
@@ -61,6 +61,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -68,7 +69,21 @@ files:
 - bin/petra
 - lib/petra.rb
 - lib/petra/cli.rb
+- lib/petra/cli/generate.rb
+- lib/petra/cli/subcommand.rb
+- lib/petra/patches/thor.rb
+- lib/petra/patches/thor/command.rb
 - lib/petra/version.rb
+- lib/sources/machine/new/machines/%machine_name%.vagrant.rb.tt
+- lib/sources/playbook/new/%playbook_name%.yml.tt
+- lib/sources/project/new/.gitignore
+- lib/sources/project/new/README.md.tt
+- lib/sources/project/new/Vagrantfile
+- lib/sources/project/new/hosts/local.hosts
+- lib/sources/project/new/lib/app.rb
+- lib/sources/project/new/roles/common/tasks/main.yml
+- lib/sources/seed/new/seeds/%seed_name%.seed.example.yml
+- lib/sources/seed/new/seeds/%seed_name%.seed.yml
 - petra.gemspec
 homepage: https://github.com/cookrn/petra
 licenses:
@@ -93,5 +108,5 @@ rubyforge_project:
 rubygems_version: 2.0.4
 signing_key: 
 specification_version: 4
-summary: petra v0.0.1
+summary: petra v0.0.2
 test_files: []