opskeleton 0.0.2 → 0.0.4

data/README.md

@@ -1,16 +1,19 @@
-Intro
-==========
 
-Opskelaton is an opinionated bootstrap tool for local sandboxes project that uses/creates:
+<img src="https://raw.github.com/narkisr/vagrant-sketching-board/master/images/opskeleton.png" width='100%' hight='100%'  alt="" />
 
- * A vagrant file matching OS
- * RVM (creates an .rvmrc with a matching gemset) 
- * bundler (with dependencies defined)
- * librarian-puppet for puppet module depdency managment
- * basic folder strucuture (
-  * static-module for currently developed modules and modules for imported ones
-  * run.sh (for simple running of puppet within the sandbox)
-  * License and README
+# Intro
+
+Opskelaton is an opinionated bootstrap tool for local Sandbox projects.
+
+Opsk aims to solve the following common issues:
+ * Devops develop Puppet modules on master machines which results with 'It works on my (machine) master' approach.
+ * Implicit/Missing dependencies, like ruby version used, operating system, gems, third party puppet module
+ * Manual steps in setting up puppet modules and local sandboxes (like installing third party code).
+ * Non standard layout, projects missing README and LICENSE files, no clear seperation between developed and depdendant code.
+ * No clear development guidelines, for example extracting general modules and exporting them.
+ 
+
+See it in action [here](https://www.youtube.com/watch?v=LNlHC54Ej8c).
 
 Usage
 =========
@@ -18,3 +21,27 @@ Usage
 ```bash
  $ opsk generate name box-type
 ```
+
+
+## Layout
+
+Opskelaton creates the complete folder structure fine tuned to match best practices:
+
+Folder layout:
+
+<img src="https://raw.github.com/narkisr/vagrant-sketching-board/master/images/opsk-folders.png" width='30%' hight='50%'  alt="" />
+
+
+## Lifecycle
+
+Opskelaton defines a simple module life cycle:
+
+ 1. Internal non reusable modules (usually specific to a client site) go under static-modules
+ 2. If we create a general reusable module which is ready for prime time we pull out to a new git repository.
+ 3. The extracted module is added back as a third party (using [librarian-puppet](https://github.com/rodjek/librarian-puppet) module which reside under module folder.
+
+Life cycle scheme:
+
+<img src="https://raw.github.com/narkisr/vagrant-sketching-board/master/images/module-lifecycle-black.png" width='30%' hight='50%'  alt="" />
+
+

data/TODOS

@@ -0,0 +1,3 @@
+* Add testing support, both smoke and rspec
+* Add travis.ci support
+* Test thor tasks using http://tinyurl.com/a7x4j8r  

data/bin/opsk

@@ -1,10 +1,65 @@
 #!/usr/bin/env ruby
 
+$:.push 'lib'
 require 'rubygems'
 require 'thor'
 require 'thor/group'
+require 'opskeleton/version'
 
 module  Opsk 
+  class Package < Thor::Group
+    include Thor::Actions
+
+    def self.source_root
+	# during dev time
+	if(File.dirname(__FILE__) == './bin')
+	  File.dirname('.')
+	else 
+	  "#{File.dirname(__FILE__)}/../"
+	end
+    end
+
+    def create_pkg
+       empty_directory('pkg')
+    end
+
+    def package
+      name = File.basename(Dir.getwd)
+      ignored = IO.readlines('.gitignore').map(&:chomp)
+	ignored.delete('modules')
+	excludes = ignored.map{|f| "'#{f}'"}.join(" --exclude=") << ' --exclude-backups --exclude-vcs --exclude=pkg'
+	run("tar --exclude=#{excludes} -czf pkg/#{name}.tar.gz ../#{name} > /dev/null", :verbose => false)
+    end
+
+  end
+
+
+  class Specgen < Thor::Group
+    include Thor::Actions
+
+    argument :name, :type => :string, :desc => "static module name"
+
+    def self.source_root
+	# during dev time
+	if(File.dirname(__FILE__) == './bin')
+	  File.dirname('.')
+	else 
+	  "#{File.dirname(__FILE__)}/../"
+	end
+    end
+
+    def create_spec_folders
+	%w(classes defines functions hosts).each do |t|
+	  empty_directory("static-modules/#{name}/spec/#{t}")
+	end
+    end
+
+    def create_class_spec
+	template('templates/spec.erb', "static-modules/#{name}/spec/classes/")
+    end
+
+  end
+
   class Generate < Thor::Group
     include Thor::Actions
 
@@ -32,17 +87,14 @@ module  Opsk
 	template('templates/vagrant.erb', "#{path}/Vagrantfile")
     end
 
-    def git
-	copy_file('templates/gitignore', "#{path}/.gitignore")
-	inside(path) do
-	  run('git init .')
-	end
-    end
-
     def create_gemfile
 	copy_file('templates/gemfile', "#{path}/Gemfile")
     end
 
+    def create_rakefile
+	copy_file('templates/Rakefile', "#{path}/Rakefile")
+    end
+
     def create_rvmrc
 	template('templates/rvmrc.erb', "#{path}/.rvmrc")
     end
@@ -70,6 +122,15 @@ module  Opsk
 	template('templates/README.erb', "#{path}/README.md")
 	copy_file('templates/LICENSE-2.0.txt',"#{path}/LICENSE-2.0.txt")
     end
+
+    def git
+	copy_file('templates/gitignore', "#{path}/.gitignore")
+	inside(path) do
+	  run('git init .')
+	  run('git add -A')
+	  run("git commit -m 'initial sandbox import'")
+	end
+    end
   end
 end
 
@@ -77,6 +138,13 @@ end
 module Opsk
   class Root < Thor
     register Opsk::Generate, 'generate', 'generate [name] [box]', 'generates opskelaton project structure'
+    register Opsk::Specgen, 'specgen', 'specgen [module]', 'generates rspec-puppet for static-modules/module'
+    register Opsk::Package, 'package', 'package', 'packages current module for celestial'
+
+    desc 'version', 'print opsk version'  
+    def version
+	puts Opskeleton::VERSION    
+    end
   end 
 end
 

data/lib/opskeleton/version.rb

@@ -1,3 +1,3 @@
 module Opskeleton
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/templates/Rakefile

@@ -0,0 +1,9 @@
+require 'rake'
+require 'rspec/core/rake_task'
+require 'puppet-lint/tasks/puppet-lint'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = 'spec/*/*_spec.rb'
+end
+
+task :default => [:spec, :lint]

data/templates/gemfile

@@ -6,3 +6,5 @@ gem 'puppet'
 gem 'puppet-lint'
 gem 'librarian-puppet'
 gem 'rake'
+gem 'rspec-puppet'
+gem 'opskeleton'

data/templates/puppetfile.erb

@@ -1,11 +1,8 @@
 forge "http://forge.puppetlabs.com"
 
 mod 'puppetlabs/stdlib'
-
-
 <% if(box.include?('ubuntu')) %>
 mod 'puppetlabs/apt'
 <% end %>
-
 mod 'editfile', 
    :git => 'git://github.com/mstrauss/puppet-editfile.git'

data/templates/run.sh

@@ -1 +1 @@
-puppet apply --modulepath=modules:static-modules manifests/default.pp $@
+puppet apply --modulepath=modules:static-modules manifests/default.pp --hiera_config hiera.yaml $@

data/templates/spec.erb

@@ -0,0 +1,4 @@
+describe 'init', :type => :class do
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opskeleton
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-18 00:00:00.000000000 Z
+date: 2013-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -41,12 +41,14 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- TODOS
 - bin/opsk
 - lib/opskeleton.rb
 - lib/opskeleton/version.rb
 - opskeleton.gemspec
 - templates/LICENSE-2.0.txt
 - templates/README.erb
+- templates/Rakefile
 - templates/clean.yaml
 - templates/default.erb
 - templates/gemfile
@@ -55,6 +57,7 @@ files:
 - templates/puppetfile.erb
 - templates/run.sh
 - templates/rvmrc.erb
+- templates/spec.erb
 - templates/vagrant.erb
 homepage: https://github.com/narkisr/opskeleton
 licenses: []