bosh-gen 0.3.0 → 0.3.2

data/ChangeLog.md

@@ -7,6 +7,21 @@ Added:
 * `template` - add a template/file to a job
 * `source` - download and add a source file/tarball to a package
 
+### v0.3.1 (never released)
+
+Added:
+
+* `manifest` - generate a deployment manifest for a release
+
+Fixed:
+
+* `job` - creates a monit script and a stub control script
+
+### v0.3.2
+
+* `job` - ctl file has TODO to remind about PID file
+* `job` - use the provided release path to detect jobs
+
 ## v0.2
 
 Added:

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'minitest' do
+  # with Minitest::Spec
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/bosh/gen/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/Rakefile

@@ -1,2 +1,3 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+

data/bosh-gen.gemspec

@@ -19,4 +19,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "bosh_cli"
   
   gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest", "~> 2.12"
+  gem.add_development_dependency "minitest-colorize"
+  gem.add_development_dependency "guard-minitest"
 end

data/lib/bosh/gen/cli.rb

@@ -5,6 +5,7 @@ module Bosh; end
 require "cli/config" 
 require "cli/core_ext"
 
+require 'bosh/gen/models'
 
 module Bosh
   module Gen
@@ -58,7 +59,18 @@ module Bosh
         require 'bosh/gen/generators/job_template_generator'
         Bosh::Gen::Generators::JobTemplateGenerator.start([job_name, file_path])
       end
-      
+
+      desc "manifest NAME PATH", "Creates a deployment manifest based on the release located at PATH"
+      method_option :force, :type => :boolean, :desc => "Force override existing target manifest file"
+      method_option :addresses, :aliases => ['-a'], :type => :array, :desc => "List of IP addresses available for jobs"
+      def manifest(name, release_path)
+        release_path = File.expand_path(release_path)
+        ip_addresses = options["addresses"] || []
+        flags = { :force => options["force"] || false }
+        require 'bosh/gen/generators/deployment_manifest_generator'
+        Bosh::Gen::Generators::DeploymentManifestGenerator.start([name, release_path, ip_addresses, flags])
+      end
+
       no_tasks do
         def cyan; "\033[36m" end
         def clear; "\033[0m" end

data/lib/bosh/gen/generators/deployment_manifest_generator.rb

@@ -0,0 +1,60 @@
+require 'yaml'
+require 'thor/group'
+
+module Bosh::Gen
+  module Generators
+    class DeploymentManifestGenerator < Thor::Group
+      include Thor::Actions
+
+      argument :name
+      argument :release_path
+      argument :ip_addresses
+      argument :flags, :type => :hash
+
+      def check_release_path_is_release
+        unless File.exist?(release_path)
+          raise Thor::Error.new("target path '#{release_path}' doesn't exist")
+        end
+        FileUtils.chdir(release_path) do
+          unless File.exist?("jobs") && File.exist?("packages")
+            raise Thor::Error.new("target path '#{release_path}' is not a BOSH release project")
+          end
+        end
+      end
+
+      # Create a deployment manifest (initially for AWS only)
+      def create_deployment_manifest
+        cloud_properties = { "instance_type" => "m1.small" }
+        manifest = Bosh::Gen::Models::DeploymentManifest.new(name, "DIRECTOR_UUID", cloud_properties)
+        manifest.jobs = job_manifests(ip_addresses)
+        create_file manifest_file_name, manifest.to_yaml, :force => flags[:force]
+      end
+
+      private
+      def jobs_dir(path = "")
+        File.join(release_path, "jobs", path)
+      end
+
+      # Whether +name+ contains .yml suffix or nor, returns a .yml filename for manifest to be generated
+      def manifest_file_name
+        basename = name.gsub(/\.yml/, '') + ".yml"
+      end
+      
+      def job_manifests(ip_addresses)
+        jobs = detect_jobs.map do |job_name|
+          {
+            "name" => job_name
+          }
+        end
+        jobs.first["static_ips"] = ip_addresses if ip_addresses && ip_addresses.size > 0
+        jobs
+      end
+      
+      # Return list of job names in this release based on the contents of jobs/* folder
+      def detect_jobs
+        Dir[File.join(release_path, "jobs/*")].map {|job_path| File.basename(job_path) }
+      end
+
+    end
+  end
+end

data/lib/bosh/gen/generators/job_generator.rb

@@ -6,7 +6,7 @@ module Bosh::Gen
     class JobGenerator < Thor::Group
       include Thor::Actions
 
-      argument :name
+      argument :job_name
       argument :dependencies, :type => :array
       
       def self.source_root
@@ -20,7 +20,7 @@ module Bosh::Gen
       end
       
       def check_name
-        raise Thor::Error.new("'#{name}' is not a vaild BOSH id") unless name.bosh_valid_id?
+        raise Thor::Error.new("'#{job_name}' is not a vaild BOSH id") unless job_name.bosh_valid_id?
       end
       
       def warn_missing_dependencies
@@ -32,26 +32,31 @@ module Bosh::Gen
         end
       end
       
-      def templates
-        empty_directory job_dir("templates")
+      def template_files
+        directory "jobs/%job_name%"
+        @template_files = { "#{job_name}_ctl" => "bin/#{job_name}_ctl" }
       end
       
-      def monit
-        create_file job_dir("monit"), ""
+      def ctl_executable
+        chmod "jobs/#{job_name}/templates/#{job_name}_ctl", 0755
       end
       
       def job_specification
-        config = { "name" => name, "packages" => dependencies, "templates" => {} }
+        config = { "name" => job_name, "packages" => dependencies, "templates" => @template_files }
         create_file job_dir("spec"), YAML.dump(config)
       end
       
+      def show_todo
+        puts File.read(File.join(destination_root, "jobs", job_name, "TODO.md"))
+      end
+      
       private
       def filenames
         files.map {|f| File.basename(f) }
       end
       
       def job_dir(path)
-        File.join("jobs", name, path)
+        File.join("jobs", job_name, path)
       end
       
       # Run a command in git.

data/lib/bosh/gen/generators/job_generator/templates/jobs/%job_name%/TODO.md.tt

@@ -0,0 +1,4 @@
+Next step for <%= job_name %> job:
+
+* Replace "`exec /var/vcap/packages/redis/bin/EXECUTABLE_SERVER`" in jobs/<%= job_name %>/templates/<%= job_name %>_ctl
+

data/lib/bosh/gen/generators/job_generator/templates/jobs/%job_name%/monit.tt

@@ -0,0 +1,5 @@
+check process <%= job_name %>
+  with pidfile /var/vcap/sys/run/<%= job_name %>/<%= job_name %>.pid
+  start program "/var/vcap/jobs/<%= job_name %>/bin/<%= job_name %>_ctl start"
+  stop program "/var/vcap/jobs/<%= job_name %>/bin/<%= job_name %>_ctl stop"
+  group vcap

data/lib/bosh/gen/generators/job_generator/templates/jobs/%job_name%/templates/%job_name%_ctl.tt

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+# Control script to start/stop <%= job_name %> job on a BOSH controlled VM
+#
+# TODO - change "EXECUTABLE_SERVER" to the command to run
+# TODO - ensure executable stores PID in $PIDFILE
+
+RUN_DIR=/var/vcap/sys/run/<%= job_name %>
+LOG_DIR=/var/vcap/sys/log/<%= job_name %>
+STORE=/var/vcap/store/<%= job_name %>
+PIDFILE=$RUN_DIR/<%= job_name %>.pid
+
+case $1 in
+
+  start)
+    mkdir -p $RUN_DIR
+    mkdir -p $LOG_DIR
+    mkdir -p $STORE
+
+    echo $$ > $PIDFILE
+
+    exec /var/vcap/packages/<%= job_name %>/bin/EXECUTABLE_SERVER >>$LOG_DIR/<%= job_name %>.stdout.log 2>>$LOG_DIR/<%= job_name %>.stderr.log
+    ;;
+
+  stop)
+    PID=$(head -1 $PIDFILE)
+    kill $PID
+    while [ -e /proc/$PID ]; do sleep 0.1; done
+    rm -f $PIDFILE
+    ;;
+
+  *)
+  echo "Usage: <%= job_name %>_ctl {start|stop}" ;;
+esac
+exit 0

data/lib/bosh/gen/models.rb

@@ -0,0 +1,7 @@
+module Bosh
+  module Gen
+    module Models
+    end
+  end
+end
+require "bosh/gen/models/deployment_manifest"

data/lib/bosh/gen/models/deployment_manifest.rb

@@ -0,0 +1,84 @@
+require "yaml"
+
+module Bosh::Gen::Models
+  class DeploymentManifest
+    attr_reader :manifest
+    
+    def initialize(name, director_uuid, cloud_properties)
+      @manifest = {}
+      @cloud_properties = cloud_properties
+      @security_groups = ["default"]
+      @stemcell_version = "0.5.1"
+      @stemcell = { "name" => "bosh-stemcell", "version" => @stemcell_version }
+      manifest["name"] = name
+      manifest["director_uuid"] = director_uuid
+      manifest["release"] = { "name" => name, "version" => 1}
+      manifest["compilation"] = {
+        "workers" => 10,
+        "network" => "default",
+        "cloud_properties" => cloud_properties.dup
+      }
+      manifest["update"] = {
+        "canaries" => 1,
+        "canary_watch_time" => 30000,
+        "update_watch_time" => 30000,
+        "max_in_flight" => 4,
+        "max_errors" => 1
+      }
+      manifest["networks"] = [
+        {
+          "name" => "default",
+          "type" => "dynamic",
+          "cloud_properties" => { "security_groups" => @security_groups.dup }
+        },
+        {
+          "name" => "vip_network",
+          "type" => "vip",
+          "cloud_properties" => { "security_groups" => @security_groups.dup }
+        }
+      ]
+      manifest["resource_pools"] = [
+        {
+          "name" => "common",
+          "network" => "default",
+          "size" => 0,
+          "stemcell" => @stemcell,
+          "cloud_properties" => cloud_properties.dup
+        }
+      ]
+      manifest["jobs"] = []
+      manifest["properties"] = {}
+    end
+    
+    def jobs=(jobs)
+      total_instances = 0
+      manifest["jobs"] = []
+      jobs.each do |job|
+        manifest_job = {
+          "name" => job["name"],
+          "template" => job["template"] || job["name"],
+          "instances" => job["instances"] || 1,
+          "resource_pool" => "common",
+          "networks" => [
+            {
+              "name" => "default",
+              "default" => %w[dns gateway]
+            }
+          ]
+        }
+        if job["static_ips"]
+          manifest_job["networks"] << {
+            "name" => "vip_network",
+            "static_ips" => job["static_ips"]
+          }
+        end
+        manifest["jobs"] << manifest_job
+      end
+      manifest["resource_pools"].first["size"] = manifest["jobs"].inject(0) {|total, job| total + job["instances"]}
+    end
+    
+    def to_yaml
+      manifest.to_yaml
+    end
+  end
+end

data/lib/bosh/gen/version.rb

@@ -1,5 +1,5 @@
 module Bosh
   module Gen
-    VERSION = "0.3.0"
+    VERSION = "0.3.2"
   end
 end

data/spec/fixtures/deployment_manifests/defaults.yml

@@ -0,0 +1,60 @@
+---
+name: myproj
+director_uuid: UUID
+release:
+  name: myproj
+  version: 1
+compilation:
+  workers: 10
+  network: default
+  cloud_properties:
+    instance_type: m1.small
+update:
+  canaries: 1
+  canary_watch_time: 30000
+  update_watch_time: 30000
+  max_in_flight: 4
+  max_errors: 1
+networks:
+- name: default
+  type: dynamic
+  cloud_properties:
+    security_groups:
+    - default
+- name: vip_network
+  type: vip
+  cloud_properties:
+    security_groups:
+    - default
+resource_pools:
+- name: common
+  network: default
+  size: 2
+  stemcell:
+    name: bosh-stemcell
+    version: 0.5.1
+  cloud_properties:
+    instance_type: m1.small
+jobs:
+- name: job-with-ips
+  template: job-with-ips
+  instances: 1
+  resource_pool: common
+  networks:
+  - name: default
+    default:
+    - dns
+    - gateway
+  - name: vip_network
+    static_ips:
+    - 1.2.3.4
+- name: misc
+  template: misc
+  instances: 1
+  resource_pool: common
+  networks:
+  - name: default
+    default:
+    - dns
+    - gateway
+properties: {}

data/spec/models/deployment_manifest_spec.rb

@@ -0,0 +1,18 @@
+require "minitest/spec"
+require "minitest-colorize"
+require "bosh/gen/models"
+
+class DeploymentManifestSpec < MiniTest::Spec
+  it "creates 'defaults' manifest document with 2 jobs" do
+    manifest = Bosh::Gen::Models::DeploymentManifest.new("myproj", "UUID", {"instance_type" => "m1.small"})
+    manifest.jobs = [
+      { "name" => "job-with-ips",  "static_ips" => ['1.2.3.4']},
+      { "name" => "misc"}
+    ]
+    manifest.to_yaml.must_equal fixture_manifest("defaults")
+  end
+  
+  def fixture_manifest(name)
+    File.read(File.expand_path("../../fixtures/deployment_manifests/#{name}.yml", __FILE__))
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bosh-gen
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-04 00:00:00.000000000 Z
+date: 2012-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -59,6 +59,54 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: minitest-colorize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Generators for creating BOSH releases
 email:
 - drnicwilliams@gmail.com
@@ -70,6 +118,7 @@ files:
 - .gitignore
 - ChangeLog.md
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -77,8 +126,12 @@ files:
 - bosh-gen.gemspec
 - lib/bosh/gen.rb
 - lib/bosh/gen/cli.rb
+- lib/bosh/gen/generators/deployment_manifest_generator.rb
 - lib/bosh/gen/generators/job_generator.rb
 - lib/bosh/gen/generators/job_generator/templates/.gitkeep
+- lib/bosh/gen/generators/job_generator/templates/jobs/%job_name%/TODO.md.tt
+- lib/bosh/gen/generators/job_generator/templates/jobs/%job_name%/monit.tt
+- lib/bosh/gen/generators/job_generator/templates/jobs/%job_name%/templates/%job_name%_ctl.tt
 - lib/bosh/gen/generators/job_template_generator.rb
 - lib/bosh/gen/generators/new_release_generator.rb
 - lib/bosh/gen/generators/new_release_generator/templates/README.md.tt
@@ -89,7 +142,11 @@ files:
 - lib/bosh/gen/generators/package_generator.rb
 - lib/bosh/gen/generators/package_generator/templates/.gitkeep
 - lib/bosh/gen/generators/package_source_generator.rb
+- lib/bosh/gen/models.rb
+- lib/bosh/gen/models/deployment_manifest.rb
 - lib/bosh/gen/version.rb
+- spec/fixtures/deployment_manifests/defaults.yml
+- spec/models/deployment_manifest_spec.rb
 homepage: https://github.com/drnic/bosh-gen
 licenses: []
 post_install_message: 
@@ -104,7 +161,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3342967338916077757
+      hash: -1671350536901681396
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -113,11 +170,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3342967338916077757
+      hash: -1671350536901681396
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: ''
-test_files: []
+test_files:
+- spec/fixtures/deployment_manifests/defaults.yml
+- spec/models/deployment_manifest_spec.rb