chef_instance 0.1.0

data/test/spec/install_spec.rb

@@ -0,0 +1,46 @@
+require_relative 'spec_helper'
+require 'chef_instance/install'
+
+describe ChefInstance::Install, '' do
+  let(:node) do
+    node = Chef::Node.new
+    node.automatic[:platform] = 'ubuntu'
+    node.automatic[:platform_version] = '12.04'
+    node
+  end
+
+  let(:events) { Chef::EventDispatch::Dispatcher.new }
+  let(:run_context) { Chef::RunContext.new(node, {}, events) }
+  let(:resource) { 'package_test' }
+  let(:install) do
+    ChefInstance::Install::Template.new(resource, run_context)
+  end
+
+  before do
+    @install_res = install
+  end
+
+  describe 'Object Ancestry Checks' do
+    it 'Is a ChefInstance::Install::Template?' do
+      @install_res.must_be_kind_of(ChefInstance::Install::Template)
+    end
+
+    it 'Is a instance of Init' do
+      @install_res.must_be_instance_of(ChefInstance::Install::Template)
+    end
+  end
+
+  describe 'It adhears to the Install::Template contract.' do
+    describe 'It should..' do
+      it 'Create.' do
+        @install_res.must_respond_to(:install)
+        proc { @install_res.install }.must_raise(NotImplementedError)
+      end
+
+      it 'Destroy.' do
+        @install_res.must_respond_to(:uninstall)
+        proc { @install_res.uninstall }.must_raise(NotImplementedError)
+      end
+    end
+  end
+end

data/test/spec/provider_instance_spec.rb

@@ -0,0 +1,80 @@
+# minitest spec for ChefInstance::Resource::Instance
+# Uses expectations from:
+# http://docs.seattlerb.org/minitest/Minitest/Expectations.html
+
+require_relative 'spec_helper'
+require 'chef_instance/resource_instance'
+require 'chef_instance/provider_instance'
+require 'chef_instance/service/init'
+
+describe ChefInstance::Resource::Instance,
+  'Tests for ChefInstance::Resource::Instance' do
+
+  let(:node) do
+    node = Chef::Node.new
+    node.automatic['platform'] = 'ubuntu'
+    node.automatic['platform_version'] = '12.04'
+    node
+  end
+
+  let(:events) { Chef::EventDispatch::Dispatcher.new }
+  let(:run_context) { Chef::RunContext.new(node, {}, events) }
+  let(:instance_name) { 'test_instance' }
+  let(:config_res) do
+    ChefInstance::Resource::Instance.new(
+        instance_name, run_context)
+  end
+
+  before :each do
+    @test_instance = ChefInstance::Provider::Instance.new(
+        config_res, run_context)
+  end
+
+  describe 'Class type checks for ChefInstance::Provider::Instance' do
+    it 'Is a ChefInstance::Resource::Instance' do
+      @test_instance.must_be_kind_of(Chef::Provider)
+    end
+    it 'Subclasses Chef::Provider' do
+      @test_instance.must_be_instance_of(ChefInstance::Provider::Instance)
+    end
+  end
+
+  describe 'Why Run' do
+    it 'supported?' do
+      @test_instance.must_respond_to('whyrun_supported?')
+      @test_instance.whyrun_supported?.must_equal(false)
+    end
+  end
+
+  describe 'Can lookup instances.' do
+    before(:each) do
+      class ChefInstance::Provider::Instance
+        public :instance
+      end
+    end
+
+    it 'has a `instance` method.' do
+      @test_instance.must_respond_to(:instance)
+    end
+  end
+
+  describe 'Can lookup class constants.' do
+    before(:each) do
+      class ChefInstance::Provider::Instance
+        public :instance_sub_class
+      end
+    end
+
+    it 'has a `instance` method.' do
+      @test_instance.must_respond_to(:instance_sub_class)
+    end
+
+    it 'can lookup our init service class' do
+      @test_instance.instance_sub_class('service', 'init')
+        .must_be_instance_of(Class)
+      @test_instance.instance_sub_class('service', 'init')
+        .to_s
+        .must_equal('ChefInstance::Service::Init')
+    end
+  end
+end

data/test/spec/resource_instance_spec.rb

@@ -0,0 +1,74 @@
+# minitest spec for ChefInstance::Resource::Instance
+# Uses expectations from:
+# http://docs.seattlerb.org/minitest/Minitest/Expectations.html
+
+require_relative 'spec_helper'
+require 'chef_instance/resource_instance'
+require 'chef_instance/provider_instance'
+
+describe ChefInstance::Resource::Instance,
+  'Tests for ChefInstance::Resource::Instance' do
+
+  let(:node) do
+    node = Chef::Node.new
+    node.automatic['platform'] = 'ubuntu'
+    node.automatic['platform_version'] = '12.04'
+    node
+  end
+
+  let(:events) { Chef::EventDispatch::Dispatcher.new }
+  let(:run_context) { Chef::RunContext.new(node, {}, events) }
+  let(:instance_name) { 'test_instance' }
+
+  before :each do
+    @test_instance = ChefInstance::Resource::Instance.new(
+        instance_name, run_context)
+  end
+
+  describe 'Class type checks for ChefInstance::Resource::Instance' do
+    it 'Is a ChefInstance::Resource::Instance' do
+      @test_instance.must_be_kind_of(Chef::Resource)
+    end
+    it 'Subclasses Chef::Resource' do
+      @test_instance.must_be_instance_of(ChefInstance::Resource::Instance)
+    end
+  end
+
+  describe 'Parameter tests for ChefInstance::Resource::Instance' do
+    it 'has a `install_type` parameter that can be set' do
+      @test_instance.must_respond_to(:install_type)
+      @test_instance.install_type(:package)
+      @test_instance.install_type.must_equal(:package)
+    end
+
+    it 'has a `install_options` parameter that can be set' do
+      test_config = {
+        format: 'plain',
+        path: %w(/var/log/httpd/*_log),
+        type: 'httpd'
+      }
+
+      @test_instance.must_respond_to(:install_options)
+      @test_instance.install_options(test_config)
+      @test_instance.install_options.must_equal(test_config)
+    end
+
+    it 'has a `service_type` parameter that can be set' do
+      @test_instance.must_respond_to(:service_type)
+      @test_instance.service_type(:init)
+      @test_instance.service_type.must_equal(:init)
+    end
+
+    it 'has a `service_options` parameter that can be set' do
+      test_config = {
+        format: 'plain',
+        path: %w(/var/log/httpd/*_log),
+        type: 'httpd'
+      }
+
+      @test_instance.must_respond_to(:service_options)
+      @test_instance.service_options(test_config)
+      @test_instance.service_options.must_equal(test_config)
+    end
+  end
+end

data/test/spec/service/init_spec.rb

@@ -0,0 +1,54 @@
+require_relative '../spec_helper'
+require 'chef_instance/service/init'
+
+describe ChefInstance::Service::Init, '' do
+
+  let(:node) do
+    node = Chef::Node.new
+    node.automatic[:platform] = 'ubuntu'
+    node.automatic[:platform_version] = '12.04'
+    node
+  end
+
+  let(:events) { Chef::EventDispatch::Dispatcher.new }
+  let(:run_context) { Chef::RunContext.new(node, {}, events) }
+  let(:resource) { 'init_test' }
+  let(:service) do
+    ChefInstance::Service::Init.new(resource, run_context)
+  end
+
+  before(:each) do
+    @service_res = service
+  end
+
+  describe 'Object Ancestry Checks' do
+    it 'Is a ChefInstance::Service::Template?' do
+      @service_res.must_be_kind_of(ChefInstance::Service::Template)
+    end
+
+    it 'Is a instance of Init' do
+      @service_res.must_be_instance_of(ChefInstance::Service::Init)
+    end
+  end
+
+  describe 'It adhears to the Service::Template contract.' do
+
+    describe 'It should..' do
+      it 'Create.' do
+        @service_res.must_respond_to(:create)
+      end
+
+      it 'Destroy.' do
+        @service_res.must_respond_to(:destroy)
+      end
+
+      it 'Enable.' do
+        @service_res.must_respond_to(:enable)
+      end
+
+      it 'Disable.' do
+        @service_res.must_respond_to(:disable)
+      end
+    end
+  end
+end

data/test/spec/service/runit_spec.rb

@@ -0,0 +1,54 @@
+require_relative '../spec_helper'
+require 'chef_instance/service/runit'
+
+describe ChefInstance::Service::Runit, '' do
+
+  let(:node) do
+    node = Chef::Node.new
+    node.automatic[:platform] = 'ubuntu'
+    node.automatic[:platform_version] = '12.04'
+    node
+  end
+
+  let(:events) { Chef::EventDispatch::Dispatcher.new }
+  let(:run_context) { Chef::RunContext.new(node, {}, events) }
+  let(:resource) { 'runit_test' }
+  let(:service) do
+    ChefInstance::Service::Runit.new(resource, run_context)
+  end
+
+  before do
+    @service_res = service
+  end
+
+  describe 'Object Ancestry Checks' do
+    it 'Is a ChefInstance::Service::Template?' do
+      @service_res.must_be_kind_of(ChefInstance::Service::Template)
+    end
+
+    it 'Is a instance of Init' do
+      @service_res.must_be_instance_of(ChefInstance::Service::Runit)
+    end
+  end
+
+  describe 'It adhears to the Service::Template contract.' do
+
+    describe 'It should..' do
+      it 'Create.' do
+        @service_res.must_respond_to(:create)
+      end
+
+      it 'Destroy.' do
+        @service_res.must_respond_to(:destroy)
+      end
+
+      it 'Enable.' do
+        @service_res.must_respond_to(:enable)
+      end
+
+      it 'Disable.' do
+        @service_res.must_respond_to(:disable)
+      end
+    end
+  end
+end

data/test/spec/service_spec.rb

@@ -0,0 +1,62 @@
+require_relative 'spec_helper'
+require 'chef_instance/service'
+
+describe ChefInstance::Service, '' do
+
+  let(:node) do
+    node = Chef::Node.new
+    node.automatic[:platform] = 'ubuntu'
+    node.automatic[:platform_version] = '12.04'
+    node
+  end
+  let(:events) { Chef::EventDispatch::Dispatcher.new }
+  let(:run_context) { Chef::RunContext.new(node, {}, events) }
+  let(:resource) { 'runit_test' }
+  let(:service) do
+    ChefInstance::Service::Template.new(resource, run_context)
+  end
+  let(:service_options) do
+    {
+      service: {
+        pattern: 'test',
+        init_command: '/etc/init.d/test'
+      }
+    }
+  end
+
+  before do
+    @service_res = service
+    @service_options = service_options
+  end
+
+  describe 'Object Ancestry Checks' do
+    it 'Is a ChefInstance::Service::Template?' do
+      @service_res.must_be_kind_of(ChefInstance::Service::Template)
+    end
+
+    it 'Is a instance of Init' do
+      @service_res.must_be_instance_of(ChefInstance::Service::Template)
+    end
+  end
+
+  describe 'It adhears to the Service::Template contract.' do
+
+    describe 'It should..' do
+      it 'Create.' do
+        @service_res.must_respond_to(:create)
+      end
+
+      it 'Destroy.' do
+        @service_res.must_respond_to(:destroy)
+      end
+
+      it 'Enable.' do
+        @service_res.must_respond_to(:enable)
+      end
+
+      it 'Disable.' do
+        @service_res.must_respond_to(:disable)
+      end
+    end
+  end
+end

data/test/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+unless ENV['TRAVIS']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/.gems/'
+    add_filter '/test/'
+  end
+end
+
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+end
+
+require 'chef/event_dispatch/dispatcher'
+require 'chef/platform'
+require 'chef/run_context'
+require 'chef/resource'
+require 'chef/resource/service'
+require 'chef/provider'
+require 'minitest/autorun'
+
+Minitest::Test.parallelize_me!

metadata

@@ -0,0 +1,293 @@
+--- !ruby/object:Gem::Specification
+name: chef_instance
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Miah Johnson
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDbDCCAlSgAwIBAgIBATANBgkqhkiG9w0BAQUFADA+MQ0wCwYDVQQDDARtaWFo
+  MRgwFgYKCZImiZPyLGQBGRYIY2hpYS1wZXQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
+  HhcNMTQwODA4MjM1OTA1WhcNMTUwODA4MjM1OTA1WjA+MQ0wCwYDVQQDDARtaWFo
+  MRgwFgYKCZImiZPyLGQBGRYIY2hpYS1wZXQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
+  ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDeeUAfEXaV/W0FlwfZtSPU
+  i7+ED6EzPPxPKbhOd4bvP/9OF9iVpK4KLBdSbUL0d4TQ4yxSe6+5ZDmqYxolsA0H
+  VWokWnSXxW3vuLKOMp57JDc6hSkymPZD0vsmUh7UsERaicgdt9FQYYAM2gTyQvDR
+  S/ZanDvZIrU+l1HXx3O+txYid8W8bCxDRWHUbJ8meDHHrHn8hmB6m39LXMJy1k3Y
+  fccDTNI7Ni7otY682ti8yuBJF4Xw9ojwhzXnH7l/E75AlCX/ggFXK3l6CppwDfys
+  KP8pPFAlVnuMThYaRvmnOI9IiF5qEsI7c4goZy+LrpZFdz2zlX6BN54MuFcpG/MD
+  AgMBAAGjdTBzMAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBRN/hw/
+  8vKHvJiYOxM1uRZ3eAfihjAcBgNVHREEFTATgRFtaWFoQGNoaWEtcGV0Lm9yZzAc
+  BgNVHRIEFTATgRFtaWFoQGNoaWEtcGV0Lm9yZzANBgkqhkiG9w0BAQUFAAOCAQEA
+  S/lmW6szMp0gb3rKtAM9j4XS0aHUCmEDiPFlkjvsKxj5aIU81rvePaJyxoulID4H
+  mnW4BuxKC1YaBo0R3CL7izJ9Jrw09L6NTOLiTXdLNctNLZbVc4APywspvNlijtGa
+  kDHXTC6ftbxcU6SGjVw70yirtFhJGj2nmA69k7vj0/XiMbj6wcg1degf4ln0+B7O
+  IN8npbJjudV+Gok+TaIBJF+mxUIWw0Q3X+ZbM5vku5GU41Fdyc5d8zJ38CwOGTbf
+  HceOUVz35kgamNj0WW4lNAHyZi7cS0MeI/0B/AGUkaG7gWvyGBAgr1gJ2+4kMmcY
+  vg9xNKI52TEvhr97dNRNTQ==
+  -----END CERTIFICATE-----
+date: 2014-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.12.2
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.3.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.3
+description: |
+  # chef_instance
+
+  ## Why
+
+  What is our goal when we install a piece of daemonized software? Why does the
+  minutia of configuration concern us so greatly? Do we really want to emulate
+  shell scripts in a recipe and end up with hundreds of random resources on our node?
+  Why do I even care about resources on my node?
+
+  Before I answer those questions lets get back to our goal, which was?
+
+  Goal: A unique instance of a daemon with our supplied configuration.
+
+  ## Usage
+
+  ```
+  # In this hypothetical instance we have a 'pie' daemon named 'pumpkin' that stores
+  # pies recieved on port 314. We may want to run another instance called 'pecan' on
+  # a different port that receives different types of pies.
+  # htce::default.rb
+  pie_instance 'pumpkin' do
+    # File owner and group.
+    # Daemon user and group.
+    user  'pumpkin'
+    group 'pies'
+    # creates `/opt/pies/pumpkins` then stores all config and runtime data.
+    root_path  '/opt/pies'
+    service_options({
+      port: 314,
+      store_pies: true,
+      daemon_args: %w(-Tsteaming -Sdelicious)
+    })
+  end
+  ```
+
+  ## How it works
+
+  Provides resource provider super classes for building instances of software.
+
+  ```
+  class Chef
+    class Resource
+      class Daemon < Chef::Resource::Instance
+      end
+    end
+  end
+  ```
+
+  Ignores system defaults (configuration, initscripts, etc).
+
+  ## Installation
+
+  Because of Ruby library load race conditions with Chef and Gems you need to ensure that `chef_instance` is
+  installed before you execute Chef.
+
+  This can be achieved by:
+
+   - Install the Chef (through the Omnibus, or however you do it).
+   - Install `chef_instance` into the Ruby system used by Chef. If you used Omnibus you'll need to use the `gem`
+     command provided in `/opt/chef/embedded/bin`
+
+  ## Code Style
+
+  This code follows the [Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide) and all contributions should as well.
+
+  The code style is checked by [Rubocop](http://batsov.com/rubocop/) and can be checked by executing `rake test:rubocop` or `rubocop`.
+
+  [![Build Status](https://travis-ci.org/miah/chef_instance.png?branch=master)](https://travis-ci.org/miah/chef_instance)
+  [![Code Climate](https://codeclimate.com/github/miah/chef_instance.png)](https://codeclimate.com/github/miah/chef_instance)
+  [![Code Climate Coverage](https://codeclimate.com/github/miah/chef_instance/coverage.png)](https://codeclimate.com/github/miah/chef_instance)
+  [![Dependency Status](https://gemnasium.com/miah/chef_instance.svg)](https://gemnasium.com/miah/chef_instance)
+
+  # Author
+
+  Author:: Miah Johnson (<miah@chia-pet.org>)
+
+  # License
+
+      Copyright 2013 Miah Johnson
+
+      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.
+email:
+- miah@chia-pet.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".kitchen.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- certs/miah_johnson.pem
+- chef_instance.gemspec
+- lib/chef_instance/install.rb
+- lib/chef_instance/install/existing.rb
+- lib/chef_instance/install/package.rb
+- lib/chef_instance/provider_instance.rb
+- lib/chef_instance/resource_instance.rb
+- lib/chef_instance/service.rb
+- lib/chef_instance/service/init.rb
+- lib/chef_instance/service/runit.rb
+- lib/chef_instance/version.rb
+- test/spec/install/existing_spec.rb
+- test/spec/install/package_spec.rb
+- test/spec/install_spec.rb
+- test/spec/provider_instance_spec.rb
+- test/spec/resource_instance_spec.rb
+- test/spec/service/init_spec.rb
+- test/spec/service/runit_spec.rb
+- test/spec/service_spec.rb
+- test/spec/spec_helper.rb
+homepage: https://gitlab.com/viscera/chef_instance
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Chef Resource & Provider Super Classes forbuilding stand-alone instances
+  of software.
+test_files:
+- test/spec/install/existing_spec.rb
+- test/spec/install/package_spec.rb
+- test/spec/install_spec.rb
+- test/spec/provider_instance_spec.rb
+- test/spec/resource_instance_spec.rb
+- test/spec/service/init_spec.rb
+- test/spec/service/runit_spec.rb
+- test/spec/service_spec.rb
+- test/spec/spec_helper.rb