rzo 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c21d24014263ebcf5c6697563b1011f6bd2eccc0
-  data.tar.gz: b97615e5c8e1139fcf0ef8bcb2551485733321ae
+  metadata.gz: d67408c1091aa82e515dd92bbd1bbcd1034290e6
+  data.tar.gz: 04671d9b7c98f50d71a653489d8862e181cf23a8
 SHA512:
-  metadata.gz: eaaadf9a406689d6827dec05a579403be72d3118acf050b4441733a5956dbe6854b704c09b668fc83b22f472aaf5c49fa6864a03ed0a43ecc594795fe6732d6e
-  data.tar.gz: 1cc68e0ee47ae22c3aa78f40158cc44950e384553a4fdac2e7560a9d324d6c41e9c1803d34df53d8fa72ebfccac7aba0e188f283364e1dda4dfad10e23b656c2
+  metadata.gz: a3897968ecc1fb45588f2888003559de212c0f80300d91528cd71ec3a016a1bbe4efe8632574da15dc6995ddc52ae083fd9adca7b4ca74dcb56032c13cc324d4
+  data.tar.gz: 6252bd6fec7b7f27912f34e29bd6eb0d29469392d177a9df4077fadde5c33d425c2bed73e24f212268b4e9c6bb4ca5e37d37763577eb80a7c90cda4a6393d750

data/.gitignore

@@ -1,3 +1,18 @@
+# Vim
+*.swp
+
+# OS X
+.DS_Store
+
+# Ruby
+Gemfile.lock
+
+# Vagrant
+.vagrant
+
+/.envrc
+
+# Gem
 /.bundle/
 /.yardoc
 /Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,62 @@
+---
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Exclude:
+    - vendor/**/*
+    - pkg/**/*
+    - spec/fixtures/**/*
+    - lib/rzo/trollop.rb
+
+# Cop's to ignore
+
+Lint/UnneededDisable:
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+# With this enabled it suggests a change that will break the Gemfile
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+# This is a good idea, but does not line up the rest of the lines making it
+# harder to read
+Layout/IndentHash:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+# If enabled, this cop makes it harder to understand the logic
+Style/NonNilCheck:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+
+# Cop's that require ruby >= 1.9
+Style/HashSyntax:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+# too many lines is the nature of a Vagrantfile
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+Style/IfInsideElse:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,5 @@
+SimpleCov.start do
+  add_filter '/.bundle/'
+  add_group 'lib', 'lib'
+end
+# vim:ft=ruby

data/.travis.yml

@@ -1,5 +1,14 @@
+---
 sudo: false
 language: ruby
+
+notifications:
+  email: false
+
 rvm:
+  - 2.1.9
   - 2.4.1
-before_install: gem install bundler -v 1.15.3
+
+script:
+  - 'bundle exec rake validate rubocop'
+  - 'bundle exec rspec'

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --private

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Change Log
+
+## [v0.2.0](https://github.com/ghoneycutt/rizzo/tree/v0.1.0) (2017-08-23)
+**Closed issues:**
+
+- configuration language should be YAML instead of JSON [\#4](https://github.com/ghoneycutt/rizzo/issues/4)
+
+**Merged pull requests:**
+
+- rzo gem \(bundle exec rizzo --help\) [\#8](https://github.com/ghoneycutt/rizzo/pull/8) ([jeffmccune](https://github.com/jeffmccune))
+- Turn into a gem [\#7](https://github.com/ghoneycutt/rizzo/pull/7) ([ghoneycutt](https://github.com/ghoneycutt))
+- Change formatting in README [\#6](https://github.com/ghoneycutt/rizzo/pull/6) ([ghoneycutt](https://github.com/ghoneycutt))
+- Allow multiple nodes to be a puppetmaster [\#3](https://github.com/ghoneycutt/rizzo/pull/3) ([ghoneycutt](https://github.com/ghoneycutt))
+- Add CI testing with Travis-CI [\#2](https://github.com/ghoneycutt/rizzo/pull/2) ([ghoneycutt](https://github.com/ghoneycutt))
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/Gemfile

@@ -1,6 +1,3 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
 # Specify your gem's dependencies in rzo.gemspec
 gemspec

data/Guardfile

@@ -0,0 +1,41 @@
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+rspec_results = File.expand_path('.rspec_status')
+guard 'yard', server: false do
+  watch(%r{app\/.+\.rb})
+  watch(%r{lib\/.+\.rb})
+  watch(%r{ext\/.+\.c})
+end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch('Gemfile')
+  watch('Guardfile')
+  watch('Vagrantfile')
+  watch('rzo.gemspec')
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard :rspec, cmd: 'bundle exec rspec', results_file: rspec_results do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+# vim:ft=ruby

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (C) 2016-2017 Garrett Honeycutt <code@garretthoneycutt.com>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1,39 +1,327 @@
-# Rzo
+# Rizzo
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rzo`. To experiment with that code, run `bin/console` for an interactive prompt.
+Rizzo is a heavily customized Vagrant configuration and work flow with a
+role based focus. It is meant to make working with Vagrant easier and
+purpose built for layered Puppet control repositories.
 
-TODO: Delete this and the text above, and describe your gem
+There should be at least one node for every role that is managed by a
+control repo. This information is stored in `.rizzo.json` under the
+control repo. This makes it apparent what roles are available and aids
+in functional testing.
 
-## Installation
+Each control repo must have a directory under it named `modules`. It is
+up to you to populate this, so it works with the common tools such as
+librarian-puppet-simple, librarian-puppet and r10k, without being
+dependent on them.
 
-Add this line to your application's Gemfile:
+Rizzo is named after Rizzo the Rat.
 
-```ruby
-gem 'rzo'
+# Installation
+
+Add the rizzo gem to your control repository `Gemfile`.  For example, in
+`puppetdata`:
+
+```diff
+diff --git a/Gemfile b/Gemfile
+index 572f681..5c2f3b0 100644
+--- a/Gemfile
++++ b/Gemfile
+@@ -20,6 +20,7 @@ gem 'puppet-lint-undef_in_function-check'
+ gem 'puppet-lint-unquoted_string-check'
+ gem 'puppet-lint-variable_contains_upcase'
+ gem 'puppet-syntax'
++gem 'rzo'
+
+ gem 'serverspec', :require => false
+ gem 'vagrant-wrapper', :require => false
+```
+
+Then update the bundle with:
+
+```shell
+bundle install --path .bundle/gems/
+bundle update rzo
+```
+
+Interact with rizzo using:
+
+```shell
+bundle exec rizzo --help
+usage: rizzo [GLOBAL OPTIONS] SUBCOMMAND [ARGS]
+Sub Commands:
+
+  config       Print out the combined rizzo json config
+  generate     Initialize Vagrantfile in top control repo
+
+Global options: (Note, command line arguments supersede ENV vars in {}'s)
+  -l, --logto=<s>     Log file to write to or keywords STDOUT, STDERR {RZO_LOGTO} (default: STDERR)
+  -s, --syslog        Log to syslog
+  -v, --verbose       Set log level to INFO
+  -d, --debug         Set log level to DEBUG
+  -c, --config=<s>    Rizzo config file {RZO_CONFIG} (default: ~/.rizzo.json)
+  -e, --version       Print version and exit
+  -h, --help          Show this message
 ```
 
-And then execute:
+Once rizzo is installed, setup your configuration file, `~/.rizzo.json`, then
+use `bundle exec rizzo generate` to write the `Vagrantfile` in your control
+repo.
+
+# Dependencies
+
+1. **vagrant-vbguest gem** See
+   [https://github.com/dotless-de/vagrant-vbguest](https://github.com/dotless-de/vagrant-vbguest)
+
+    `vagrant plugin install vagrant-vbguest`
+
+1. **vagrant-proxyconf gem** This is optional. When used, if you have proxy
+  settings set in your environment, they will be transferred to the
+  guest. See
+  [http://tmatilai.github.io/vagrant-proxyconf/](http://tmatilai.github.io/vagrant-proxyconf/)
+
+    `vagrant plugin install vagrant-proxyconf`
+
+# Setup
+
+## `~/.rizzo.json`
+
+Change the paths to your git repos
+
+```json
+{
+  "defaults": {
+    "bootstrap_repo_path": "/Users/gh/git/bootstrap"
+  },
+  "control_repos": [
+    "/Users/gh/git/puppetdata",
+    "/Users/gh/git/puppet-modules"
+  ],
+  "puppetmaster": {
+    "name": "infra-puppetca",
+    "modulepath": [
+      "./modules",
+      "./puppetdata/modules",
+      "./ghoneycutt/modules"
+    ],
+    "synced_folders": {
+      "/repos/puppetdata": {
+        "local": "/Users/gh/git/puppetdata",
+        "owner": "root",
+        "group": "root"
+      },
+      "/repos/ghoneycutt": {
+        "local": "/Users/gh/git/puppet-modules",
+        "owner": "root",
+        "group": "root"
+      }
+    }
+  }
+}
+```
+
+Once you have `~/.rizzo.json`, change to your top level control repository and generate your `Vagrantfile`.
+
+```shell
+bundle exec rizzo generate
+```
+```
+Wrote vagrant config to Vagrantfile
+```
+
+Once the `Vagrantfile` has been generated, interact with the roles using `vagrant status`.
+
+```shell
+vagrant status
+```
+```
+Current machine states:
+
+infra-puppetfourca        not created (virtualbox)
+infra-puppetfour          not created (virtualbox)
+infra-test                not created (virtualbox)
+
+This environment represents multiple VMs. The VMs are all listed
+above with their current state. For more information about a specific
+VM, run `vagrant status NAME`.
+```
+
+## Configuration Specification
+
+### defaults
+
+The defaults hash is merged with each node entries hash. Put user
+specific entries in `~/.rizzo.json` and project specific entries in
+`${PATH_TO_CONTROL_REPO}/.rizzo.json`.
+
+### control_repos
+
+The control_repos array is a list of control repos. Rizzo takes the
+approach that control repos are layered. The ordering should match your
+`puppetmaster['modulepath']` array. The first control repo with a
+`.rizzo.json` in it will have that Rizzo config used.
+
+### puppetmaster
+
+This hash is for your puppet master and is specific to that purpose.
+
+#### name
+
+If the name of the node matches puppetmaster['name'] then that node will
+be treated as a puppetmaster. This will add the synced folders which map
+to your control repos. This allows you to edit code locally using your
+favorite editor and have it immediately available within the
+puppetmaster.
+
+#### modulepath
+
+An array to describe the modulepath that is used in the puppetmaster's
+environment.conf. This file is available in the `bootstrap_guest_path`
+for use with your bootstrap script.
+
+#### synced_folders
+
+Hash of hashes for directories that are made available to the guest. The
+key for the hash is the directory under the guest and its keys are
+local, which is the path on the host and owner and group which are the
+owner and group permissions the directory will be mounted with on the
+guest.
+
+## `controlrepo/.rizzo.json`
+
+```json
+{
+  "defaults": {
+    "bootstrap_script_path": "bootstrap_puppet4.sh",
+    "bootstrap_script_args": "-l -f `hostname -f`",
+    "bootstrap_guest_path": "/tmp/bootstrap",
+    "box": "centos7.box",
+    "box_url": "https://vagrantboxes/centos7.box",
+    "box_download_checksum": "3764a2c4ae3829aa4b50971e216c3a03736aafb2",
+    "box_download_checksum_type": "sha1",
+    "memory": "1024",
+    "netmask": "255.255.255.0",
+    "update_packages": true,
+    "update_packages_command": "yum -y update",
+    "shutdown": true,
+    "shutdown_command": "/sbin/shutdown -h now"
+  },
+  "nodes": [
+    {
+      "name": "infra-puppetca",
+      "hostname": "infra-puppetca1.example.org",
+      "forwarded_ports": [
+        {
+          "guest": "8140",
+          "host": "8140"
+        }
+      ],
+      "ip": "172.16.100.5",
+      "memory": "2048"
+    },
+    {
+      "name": "infra-puppet",
+      "hostname": "infra-puppet1.example.org",
+      "ip": "172.16.100.6",
+      "memory": "2048"
+    },
+    {
+      "name": "www-api",
+      "hostname": "www-api1.example.org",
+      "ip": "172.16.100.7"
+    }
+  ]
+}
+```
+
+### defaults
+
+This hash is merged with each node entry.
+
+### nodes
+
+A list of node entries.
+
+#### name
+
+Name of the node entry. This is what it will be referred to by Vagrant.
+
+#### hostname
+
+The FQDN (fully qualified domain name).
+
+#### forwarded_ports
+
+An optional array of hashes with the key guest and value is the port on
+the guest and the key host and the value is the port on the host. Rizzo
+will check and fail if you use duplicate host ports, as they must be
+unique.
+
+#### ip
+
+IP address.
+
+#### netmask
+
+Netmask.
+
+#### memory
+
+Amount of memory. This should be specified in MB without any unit
+signifier.
+
+#### bootstrap_repo_path
+
+The path on the host to your bootstrap repo.
+
+#### bootstrap_guest_path
+
+The path on the guest where the `bootstrap_repo_path` will be mounted.
+
+#### bootstrap_script_path
+
+Path of script to be used to bootstrap a system. This is relative to
+`bootstrap_guest_path`.
+
+#### bootstrap_script_args
+
+Any arguments to pass to `bootstrap_script_path`.
+
+#### box
+
+Name of the Vagrant box.
+
+#### box_url
+
+URL to the Vagrant box.
 
-    $ bundle
+#### box_download_checksum
 
-Or install it yourself as:
+Checksum of the Vagrant box.
 
-    $ gem install rzo
+#### box_download_checksum_type
 
-## Usage
+Type of checksum used in `box_download_checksum`.
 
-TODO: Write usage instructions here
+#### update_packages
 
-## Development
+Boolean to determine if packages should be updated.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+#### update_packages_command
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Command to update the packages.
 
-## Contributing
+#### shutdown
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rzo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Boolean to determine if the system should be shutdown after being
+provisioned. This is useful because Rizzo uses
+[vagrant-vbguest](https://github.com/dotless-de/vagrant-vbguest) which
+will check the version of the VirtualBox Guest Additions you have with
+that of the guest VM. If they differ, it will recompile on the guest. If
+the system is not shutdown and just rebooted, then on the next boot the
+guest additions will not work. Instead the system must be brought up
+with `vagrant up node_name` which will activate the vbguest plugin and
+ensure the guest additions are working.
 
-## Code of Conduct
+#### shutdown_command
 
-Everyone interacting in the Rzo project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rzo/blob/master/CODE_OF_CONDUCT.md).
+The command used to shutdown the system.

data/Rakefile

@@ -1,6 +1,31 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'json'
+require 'rubocop/rake_task'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
+RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+desc 'Validation tests'
+task :validate do
+  puts '=== Validating JSON (*.json) files'
+  filelist = FileList.new('**/*.json')
+  filelist.exclude('.bundle/**')
+  filelist.each do |json_file|
+    puts json_file
+    json = File.read(json_file)
+    JSON.parse(json)
+  end
+
+  puts "\n=== Validating ruby (*.rb, Vagrantfile, Rakefile and Gemfile) files"
+  Dir['**/*.rb', 'Vagrantfile', 'Rakefile', 'Gemfile'].each do |ruby|
+    sh "ruby -c #{ruby}"
+  end
+
+  puts "\n=== Validating ERB (*.erb) files"
+  Dir['**/*.erb'].each do |erb|
+    sh "erb -P -x -T '-' #{erb} | ruby -c"
+  end
+end
+
+task :default => %i[validate spec]

data/bin/console

@@ -1,14 +1,13 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "rzo"
+require 'bundler/setup'
+require 'rzo'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+require 'pry'
+Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/exe/rizzo

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'rzo'
+
+app = Rzo::App.new
+exit_code = app.run
+Kernel.exit(exit_code)

data/exe/rzo

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'rzo'
+
+app = Rzo::App.new
+exit_code = app.run
+Kernel.exit(exit_code)

data/ext/_rizzo.json

@@ -0,0 +1,32 @@
+{
+  "defaults": {
+    "bootstrap_repo_path": "/Users/jeff/projects/acme/bootstrap"
+  },
+  "control_repos": [
+    "/Users/jeff/projects/acme/puppetdata",
+    "/Users/jeff/projects/acme/ghoneycutt-modules"
+  ],
+  "puppetmaster": {
+    "name": [
+      "infra-puppetfourca",
+      "infra-puppetfour"
+    ],
+    "modulepath": [
+      "./modules",
+      "./puppetdata/modules",
+      "./ghoneycutt/modules"
+    ],
+    "synced_folders": {
+      "/repos/puppetdata": {
+        "local": "/Users/jeff/projects/acme/puppetdata",
+        "owner": "root",
+        "group": "root"
+      },
+      "/repos/ghoneycutt": {
+        "local": "/Users/jeff/projects/acme/ghoneycutt-modules",
+        "owner": "root",
+        "group": "root"
+      }
+    }
+  }
+}

data/lib/rzo/app/config.rb

@@ -0,0 +1,16 @@
+require 'rzo/app/subcommand'
+module Rzo
+  class App
+    ##
+    # Load all rizzo config files and print the config
+    class Config < Subcommand
+      attr_reader :config
+      def run
+        exit_status = 0
+        load_config!
+        write_file(opts[:output]) { |fd| fd.puts(JSON.pretty_generate(config)) }
+        exit_status
+      end
+    end
+  end
+end