builderator 0.3.15 → 1.0.0.pre.rc.1

data/template/Buildfile.erb

@@ -0,0 +1,28 @@
+##
+# Generated by `build generate`
+##
+build_name '<%= build_name %>'
+
+## Maven tags releases for now
+autoversion.create_tags false
+
+cookbook do |cookbook|
+  # cookbook.depends 'apt'
+end
+
+profile :default do |profile|
+  # profile.tags(:service => Config.build_name,
+  #              :version => Config.version,
+  #              :created => Config.date.iso8601)
+
+  profile.chef do |chef|
+    # chef.run_list 'apt::default'
+    # chef.node_attrs()
+  end
+
+  ## Lookup the latest Ubuntu 14.04 Server (linux-3.13) AMI-ID
+  # profile.vagrant.ec2.source_ami =
+  #   lookup(:image, 'filter' => 'ubuntu-14.04-daily').first.image_id
+  # profile.packer.build(:default).source_ami =
+  #   lookup(:image, 'filter' => 'ubuntu-14.04-daily').first.image_id
+end

data/template/Gemfile.erb

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gem 'builderator', '<%= generator.project.current.builderator.version %>'
+
+<% if generator.project.current.vagrant.install -%>
+gem 'vagrant', :github => 'mitchellh/vagrant',
+               :tag => '<%= generator.project.current.vagrant.version %>',
+               :group => :development
+
+
+group :plugins do
+  <% generator.project.current.vagrant.plugin.each do |pname, plugin| -%>
+  gem '<%= pname %>'<% if plugin.has?(:version) %>'<%= plugin.version %>'<% end %>
+  <% end -%>
+end
+<% end -%>

data/template/README.md.erb

@@ -0,0 +1,61 @@
+<%= build_name %>
+=====
+
+## Usage
+
+### Install dependencies
+
+1. If you have not already done so, configure [`rbenv`](https://github.com/rbenv/rbenv#installation)
+and [`ruby-build`](https://github.com/rbenv/ruby-build#installation) on your
+workstation and [install Ruby 2.1.5](https://github.com/rbenv/rbenv#installing-ruby-versions).
+1. Ensure that a supported version of [bundler](http://bundler.io/) is installed (`">= 1.5.2", "<= 1.10.6"`):
+
+  ```bash
+  gem install bundler -v 1.10.6
+  ```
+
+1. Use `bundler` to install application-specific dependencies"
+
+  ```bash
+  bundle install
+  ```
+
+1. **Optionally**, add an alias for `build`. In `$HOME/.profile` or `$HOME/bash_profile`
+add the following, then reload your profile:
+
+  ```bash
+  alias build="bundle exec build"
+  ```
+
+  ```bash
+  . ~/.profile
+  ```
+
+  **All subsequent examples with a `build` command assume that you've created an alias
+  or are prepending `bundle exec` to the command string**
+
+### Start a local Vagrant VM, then SSH into it.
+
+```bash
+build local
+build vagrant ssh
+```
+
+To clean up VMs, run
+
+```bash
+build vagrant destroy
+```
+
+### Launch an EC2 instance
+
+```bash
+build ec2
+build vagrant ssh
+```
+
+### Clean up VMs and local generated resources
+
+```bash
+build clean
+```

data/template/Vagrantfile.erb

@@ -0,0 +1,75 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure('2') do |config|
+  config.vm.hostname = 'builderator-<%= build_name %>'
+
+  ## Local Provider
+  config.vm.provider '<%= profile.current.vagrant.local.provider %>' do |local, override|
+    local.memory = <%= profile.current.vagrant.local.memory %>
+    local.cpus = <%= profile.current.vagrant.local.cpus %>
+
+    override.vm.box = '<%= profile.current.vagrant.local.box %>'
+    override.vm.box_url = '<%= profile.current.vagrant.local.box_url %>'
+  end
+
+  ## EC2 Provider
+  config.vm.provider '<%= profile.current.vagrant.ec2.provider %>' do |ec2, override|
+    override.vm.box = '<%= profile.current.vagrant.ec2.box %>'
+    override.vm.box_url = '<%= profile.current.vagrant.ec2.box_url %>'
+    override.ssh.username = '<%= profile.current.vagrant.ec2.ssh_username %>'
+
+    ec2.region = '<%= profile.current.vagrant.ec2.region %>'
+    ec2.subnet_id = '<%= profile.current.vagrant.ec2.subnet_id %>'
+
+    ## VPN Connected VPC
+    ec2.associate_public_ip = <%= profile.current.vagrant.ec2.associate_public_ip %>
+    ec2.ssh_host_attribute = :<%= profile.current.vagrant.ec2.ssh_host_attribute %>
+
+    ec2.instance_type = '<%= profile.current.vagrant.ec2.instance_type %>'
+    ec2.security_groups = <%= profile.current.vagrant.ec2.security_groups %>
+    ec2.iam_instance_profile_arn = '<%= profile.current.vagrant.ec2.iam_instance_profile_arn %>'
+
+    ec2.ami = '<%= profile.current.vagrant.ec2.source_ami %>'
+  end
+
+  # config.vm.network :forwarded_port, :host => 9200, :guest => 9200
+
+  ##
+  # Use the standard data directory for Chef
+  ##
+  config.vm.provision :shell,
+                      :inline => 'mkdir -p <%= chef.staging_directory %>/cache && chown vagrant:vagrant -R <%= chef.staging_directory %>',
+                      :privileged => true
+
+  ##
+  # Sync build artifacts to the VM
+  ##
+<% profile.current.artifact.each do |name, artifact| -%>
+  config.vm.provision :file,
+                      :source => '<%= artifact.path %>',
+                      :destination => '<%= artifact.destination %>'
+<% end -%>
+
+  config.omnibus.chef_version = '<%= chef.version %>'
+  config.vm.provision :chef_solo do |chef|
+    chef.log_level = :<%= chef.log_level %>
+
+    chef.cookbooks_path = '<%= local.cookbook_path %>'
+<% unless local.data_bag_path.nil? -%>
+    chef.data_bags_path = '<%= local.data_bag_path %>'
+<% end -%>
+<% unless local.environment_path.nil? -%>
+    chef.environments_path = '<%= local.environment_path %>'
+<% end -%>
+    chef.provisioning_path = '<%= chef.staging_directory %>'
+
+    chef.run_list = <%= profile.current.chef.run_list %>
+<% unless profile.current.chef.environment.nil? -%>
+    chef.environment = '<%= profile.current.chef.environment %>'
+<% end -%>
+<% unless profile.current.chef.node_attrs.nil? -%>
+    chef.json = <%= profile.current.chef.node_attrs %>
+<% end -%>
+  end
+end

data/template/gitignore.erb

@@ -0,0 +1,104 @@
+# Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+
+# OS generated files #
+######################
+.DS_Store*
+ehthumbs.db
+Icon?
+Thumbs.db
+
+# Editor Files #
+################
+*~
+*#
+.#*
+\#*#
+.*.sw[a-z]
+*.un~
+pkg/
+
+# Berkshelf
+/cookbooks
+Berksfile.lock
+
+# Bundler
+bin/*
+.bundle/*
+
+VERSION
+bundle.tar.gz
+metadata.json
+vendor/
+*.swp
+
+.vagrant
+.builderator/*
+
+# Gradle Files #
+################
+.gradle
+
+# Build output directies
+/target
+*/target
+/build
+*/build
+
+# IntelliJ specific files/directories
+out
+.idea
+*.ipr
+*.iws
+*.iml
+atlassian-ide-plugin.xml
+
+# Eclipse specific files/directories
+.classpath
+.checkstyle
+.project
+.settings
+.metadata
+.checkstyle
+*/bin
+test-output
+
+# NetBeans specific files/directories
+.nbattrs
+
+# JavaScript
+/node_modules
+/bower_components
+
+# Maven
+/.repostory/
+/test-output/
+/logs/
+
+# checkstyle
+.checkstyle
+/logs/
+/bin/

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: builderator
 version: !ruby/object:Gem::Version
-  version: 0.3.15
+  version: 1.0.0.pre.rc.1
 platform: ruby
 authors:
 - John Manero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-06 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -24,6 +24,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+- !ruby/object:Gem::Dependency
+  name: thor-scmversion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: ignorefile
   requirement: !ruby/object:Gem::Requirement
@@ -108,95 +164,175 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.19.0
-- !ruby/object:Gem::Dependency
-  name: thor-scmversion
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.7.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.7.0
 description: |
   # Builderator
-  __Tools to make CI Packer builds awesome__
 
-  ## Installation
+  Orchestration and configuration of the code development life-cycle.
 
-  Add this line to your application's Gemfile:
+  ## Commands
 
-  ```ruby
-  gem 'builderator'
-  ```
+  ### `local [PROFILE = default]`
+
+  Provision a local VM using Vagrant and, by default, VirtualBox. Uses Berkshelf to fetch cookbooks, and Chef to provision the VM.
+
+  ### `ec2 [PROFILE = default]`
+
+  Provision an EC2 VM using Vagrant. Same workflow as `local` using the `vagrant-aws` plugin.
 
-  And then execute:
+  ### `release [PROFILE = default]`
 
-      $ bundle
+  Perform release tasks and execute Packer builds with released artifacts.
 
-  Or install it yourself as:
+  ## Configuration
 
-      $ gem install builderator
+  Configuration can be loaded from DSL files as well as JSON and command line arguments. By default, Builderator searches in your home directory (`$HOME/.builderator/Buildfile`) and the working directory (`./Builderator`) for DSL files. Configuration sources are layered and flattened into a single DSL in the following order:
 
-  ## Usage
+  * Global defaults defined in the Builderator sources
+  * `Config.defaults` set by plugins, tasks, etc. in code
+  * `$HOME/.builderator/Buildfile`
+  * `./Buildfile`
+  * `Config.overrides` set by plugins, tasks, etc. in code
+  * CLI arguments loaded from Thor
 
-  Run `bundle exec thor build help`
+  [Additional documentation](docs/configuration.md) describes the configuration DSL interface.
 
-  ## Contributing
+  ## Integrations
 
-  1. Fork it ( https://github.com/[my-github-username]/builderator/fork )
-  2. Create your feature branch (`git checkout -b my-new-feature`)
-  3. Commit your changes (`git commit -am 'Add some feature'`)
-  4. Push to the branch (`git push origin my-new-feature`)
-  5. Create a new Pull Request
+  Builderator integrates with other tools, including [Berkshelf](http://berkshelf.com), [Vagrant](https://www.vagrantup.com/), and [Packer](https://www.packer.io/), to orchestrate workflows by generating `Berksfile`s, `Vagrantfile`s, and JSON strings for Packer. This means that you can replace all of these files in your project with a single `Buildfile`.
+
+  ### Packer
+
+  The Packer integration generates Packer JSON and passes it to STDIN of `packer build -`.
+
+      *NOTE* Currently, we assume that you're building Ubuntu images, as one of the provisioners is hard-coded to chown the Chef data directories to `ubuntu:ubuntu`
+
+  ## Versioning
+
+  Builderator can automatically detect versions from SCM tags, increment the latest version of an SCM branch by a variety of steps, and create new SCM tags for new versions.
+
+  [Additional documentation](docs/versioning.md) describes CLI commands, configuration, and detailed behavior.
+
+  ## Generators
+
+  Builderator includes a task to generate common project trees from configuration definitions  and templates.
+
+  Each type of project is configurable via the project collection in the `generator` namespace:
+
+  ```ruby
+  generator.project :default do |default|
+    default.ruby.version '2.1.5'
+    default.builderator.version '~> 1.0'
+
+    default.vagrant do |vagrant|
+      vagrant.install false
+      vagrant.version 'v1.8.0'
+
+      vagrant.plugin 'vagrant-aws'
+      vagrant.plugin 'vagrant-omnibus'
+    end
+
+    default.resource :berksfile do |berksfile|
+      berksfile.path 'Berksfile', 'Berksfile.lock'
+      berksfile.action :rm
+    end
+
+    default.resource :buildfile do |buildfile|
+      buildfile.path 'Buildfile'
+      buildfile.action :create
+      buildfile.template 'template/Buildfile.erb'
+    end
+
+    # ...
+  end
+  ```
+
+  Valid actions for resources include `:ignore`, `:create` (update only if missing), `:sync` (create or update with prompt), and `:rm`. `:create` and `:sync` actions require a valid template source.
+
+  By default, the `generator` subcommand includes a `default` project which removes Vagrant, Berkshelf, and Packer configurations.
 email:
 - jmanero@rapid7.com
 executables:
 - build
+- build-clean
+- build-data
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - Thorfile
 - VERSION
 - bin/build
+- bin/build-clean
+- bin/build-data
 - builderator.gemspec
 - docs/clean.md
+- docs/configuration.md
+- docs/configuration/cookbook.md
+- docs/configuration/profile.md
+- docs/versioning.md
 - lib/builderator.rb
-- lib/builderator/control/ami.rb
-- lib/builderator/control/clean.rb
+- lib/builderator/config.rb
+- lib/builderator/config/attributes.rb
+- lib/builderator/config/defaults.rb
+- lib/builderator/config/file.rb
+- lib/builderator/config/rash.rb
+- lib/builderator/control/cleaner.rb
+- lib/builderator/control/cookbook.rb
+- lib/builderator/control/data.rb
+- lib/builderator/control/data/image.rb
+- lib/builderator/control/version.rb
+- lib/builderator/control/version/auto.rb
+- lib/builderator/control/version/bump.rb
+- lib/builderator/control/version/comparable.rb
+- lib/builderator/control/version/git.rb
+- lib/builderator/control/version/scm.rb
+- lib/builderator/interface.rb
+- lib/builderator/interface/berkshelf.rb
+- lib/builderator/interface/packer.rb
+- lib/builderator/interface/vagrant.rb
 - lib/builderator/metadata.rb
-- lib/builderator/model.rb
-- lib/builderator/model/images.rb
-- lib/builderator/model/instances.rb
-- lib/builderator/model/launch_configs.rb
-- lib/builderator/model/scaling_groups.rb
-- lib/builderator/model/snapshots.rb
-- lib/builderator/model/volumes.rb
+- lib/builderator/model/cleaner.rb
+- lib/builderator/model/cleaner/images.rb
+- lib/builderator/model/cleaner/instances.rb
+- lib/builderator/model/cleaner/launch_configs.rb
+- lib/builderator/model/cleaner/scaling_groups.rb
+- lib/builderator/model/cleaner/snapshots.rb
+- lib/builderator/model/cleaner/volumes.rb
+- lib/builderator/patch/berkshelf.rb
+- lib/builderator/patch/thor-actions.rb
 - lib/builderator/tasks.rb
-- lib/builderator/tasks/ami.rb
-- lib/builderator/tasks/berks.rb
-- lib/builderator/tasks/clean.rb
+- lib/builderator/tasks/berkshelf.rb
 - lib/builderator/tasks/cookbook.rb
 - lib/builderator/tasks/packer.rb
 - lib/builderator/tasks/vagrant.rb
+- lib/builderator/tasks/vendor.rb
+- lib/builderator/tasks/version.rb
 - lib/builderator/util.rb
 - lib/builderator/util/aws_exception.rb
-- lib/builderator/util/berkshim.rb
-- lib/builderator/util/cookbook.rb
 - lib/builderator/util/limit_exception.rb
-- lib/builderator/util/packer.rb
-- lib/builderator/util/shell.rb
 - lib/builderator/util/task_exception.rb
+- mkmf.log
+- spec/config_spec.rb
+- spec/data/Berksfile
+- spec/data/Buildfile
+- spec/data/Vagrantfile
+- spec/data/history.json
+- spec/data/packer.json
+- spec/interface_spec.rb
+- spec/resource/Buildfile
+- spec/spec_helper.rb
+- spec/version_spec.rb
+- template/Berksfile.erb
+- template/Buildfile.erb
+- template/Gemfile.erb
+- template/README.md.erb
+- template/Vagrantfile.erb
+- template/gitignore.erb
+- template/rubocop.erb
 homepage: https://github.com/rapid7/builderator
 licenses:
 - MIT
@@ -212,13 +348,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Tools to make CI Packer builds awesome
-test_files: []
+test_files:
+- spec/config_spec.rb
+- spec/data/Berksfile
+- spec/data/Buildfile
+- spec/data/Vagrantfile
+- spec/data/history.json
+- spec/data/packer.json
+- spec/interface_spec.rb
+- spec/resource/Buildfile
+- spec/spec_helper.rb
+- spec/version_spec.rb
+has_rdoc: