niman 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77f2ee2cb32e24e29d3e081d50044edd26819fc8
-  data.tar.gz: 5fdb6bbfa078331f80e538a9e0de5fde3d8d831c
+  metadata.gz: 0dd2e66a5efe87391ae8ea496cf819c14cc611bb
+  data.tar.gz: 51bddf363cae6f579f3906cb2a86e62a13243e8d
 SHA512:
-  metadata.gz: de38665f05cfacb23ac3e7b471b60536c4739c18ab3638c74951e7aeae0111a6dbb9c01fe0a523c9652867edf24ad18248a4a3e798f34a029bc57d83490f3bfb
-  data.tar.gz: bcb6565a2b73e9b14bf005f6f9a2a2fba08749ab6299a9c4cf8c635bd249d8f799c0213dd287a73c9d524acc728ae21b26f31fea3c43bf61239f3d49fda9fc68
+  metadata.gz: 09b62fb72deb43fdb3455b3b11460bdc66eaf3dafd74f9f891481ffd35c4a981e659385d0e3336f241251afc80bd4fffe1ce6531f41b2d55a892ffdabb716603
+  data.tar.gz: 519dbe2cf887550e5c498c5c8a5af914c23cb4b90516155e3ce36650e00149be3ef2e33efa66a06937614cdf43fa917d4cef93247e1bbaf0805d6500c790fcda

data/README.md

@@ -25,10 +25,8 @@ It starts with a `Nimanfile`:
 
 ```ruby
 Niman::Recipe.configure do |config|
-  config.file do |file|
-    file.path = '/home/bob/hello.txt'
+  config.file '/home/bob/hello.txt' do |file|
     file.content = 'hello from alice'
-    file.mode = '0600'
   end
 end
 ```
@@ -49,7 +47,10 @@ Niman::Recipe.configure do |config|
 end
 ```
 
+#### Custom packages
+
 Custom packages live in `packages/`. Every package gets its own file.
+
 Package description:
 ```ruby
 #packages/ruby.rb
@@ -62,9 +63,24 @@ end
 In your `Nimanfile`:
 ```ruby
 Niman::Recipe.configure do |config|
-  config.package do |package|
-    package.name "ruby"
-    package.path = "packages/ruby"
+  config.package "packages/ruby"
+end
+```
+
+A custom package can have one or more configuration files inside of it:
+
+```ruby
+#packages/nginx
+class NginxPackage < Niman::Package
+  package :ubuntu, 'nginx'
+  
+  configuration '/etc/nginx/nginx.conf' do |config|
+    #general nginx configuration goes here
+    config.content = '...'
+  end
+  
+  configuration '/etc/nginx/sites-available/example.com' do |config|
+    config.content = '...'
   end
 end
 ```

data/lib/niman/cli/application.rb

@@ -5,6 +5,7 @@ require "niman/shell"
 require "niman/installer"
 require "niman/exceptions"
 require "niman/filehandler"
+require "niman/package_resolver"
 
 module Niman
   module CLI
@@ -26,11 +27,13 @@ module Niman
             debian: 'apt-get -y',
             redhat: 'yum -y'
           })
+
+          resolver    = Niman::PackageResolver.new(config.instructions)
           filehandler = Niman::FileHandler.new(client_shell)
-          provisioner = Niman::Provisioner.new(installer, filehandler, config.instructions)
+          provisioner = Niman::Provisioner.new(installer, filehandler, resolver.resolve)
           this = self
           provisioner.run do |instruction|
-            this.say "Executing task #{instruction.description}" unless @quiet
+            this.say "Executing task #{instruction.description}" unless @silent
           end
         rescue LoadError => e
           client_shell.print(e.message, :error)

data/lib/niman/installer.rb

@@ -1,5 +1,6 @@
 require 'virtus'
 require 'niman/exceptions'
+require 'niman/package_resolver'
 
 module Niman
   class Installer
@@ -9,8 +10,17 @@ module Niman
     attribute :shell, Object
 
     def install(packages)
-      package_manager = managers.fetch(shell.os.to_sym) { raise Niman::InstallError, shell.os }
       Array(packages).each do |package|
+        self.install_package(package)
+      end
+    end
+
+    def install_package(package)
+      package_manager = managers.fetch(shell.os.to_sym) { raise Niman::InstallError, shell.os }
+      if package.respond_to?(:package_names)
+        package_name = package.package_names.fetch(shell.os.to_sym) { raise Niman::InstallError, "Package has no support for #{shell.os}" }
+        shell.exec("#{package_manager} install #{package_name}", true)
+      elsif package.respond_to?(:name)
         shell.exec("#{package_manager} install #{package.name}", true)
       end
     end

data/lib/niman/library/custom_package.rb

@@ -0,0 +1,41 @@
+module Niman
+  module Library
+    class CustomPackage
+      class << self
+        attr_reader :package_names, :files
+
+        def valid?
+          !package_names.nil? &&
+          !package_names.empty? &&
+          package_names.keys.all?{|k| !package_names[k].empty?}
+        end
+
+        def package_name(os, name)
+          @package_names ||= {}
+          @package_names[os.to_sym] = name
+        end
+
+        def file(path)
+          @files ||= []
+          file = Niman::Library::File.new(path: path)
+          yield file if block_given?
+          @files << file
+        end
+
+        def description
+          ''
+        end
+
+        def errors
+          return [] if self.valid?
+          package_names.keys.map do |key|
+            if package_names[key].empty?
+              "No package name configured for OS #{key}"
+            end
+          end.flatten
+        end
+      end
+    end
+  end
+end
+

data/lib/niman/library/package.rb

@@ -4,6 +4,7 @@ module Niman
       include Virtus.model
 
       attribute :name, String, default: ""
+      attribute :path, String, default: ""
       attribute :version, String, default: ""
 
       def description
@@ -11,7 +12,7 @@ module Niman
       end
 
       def valid?
-        !name.empty?
+        !name.empty? || !path.empty?
       end
 
       def errors

data/lib/niman/nimanfile.rb

@@ -8,15 +8,16 @@ module Niman
       @instructions = []
     end
 
-    def file
-      f = Niman::Library::File.new
+    def file(path)
+      f = Niman::Library::File.new(path: path)
       yield(f)
       @instructions.push(f)
     end
 
-    def package
+    def package(path = nil)
       package = Niman::Library::Package.new
-      yield(package)
+      package.path = path unless path.nil?
+      yield(package) if block_given?
       @instructions.push(package)
     end
   end

data/lib/niman/package_resolver.rb

@@ -0,0 +1,38 @@
+module Niman
+  class PackageResolver
+
+    def initialize(instructions)
+      @instructions = instructions
+    end
+
+    def resolve
+      Array(@instructions).map do |instruction|
+        if is_file?(instruction) && !instruction.path.empty?
+          self.by_name(self.load(instruction.path))
+        else
+          instruction
+        end
+      end
+    end
+
+    def load(filename)
+      basename = File.basename(filename ,File.extname(filename))
+      require File.expand_path(File.join('packages/', basename))
+      titleize(basename)
+    end
+
+    def by_name(name)
+      Kernel.const_get(name)
+    end
+
+    private
+
+    def is_file?(obj)
+      obj.respond_to?(:path) && obj.respond_to?(:name)
+    end
+
+    def titleize(filename)
+      filename.split('_').map(&:capitalize).join('')
+    end
+  end
+end

data/lib/niman/provisioner.rb

@@ -22,6 +22,11 @@ module Niman
       raise Niman::ConfigError, self.errors unless self.valid?
       @instructions.each do |instruction|
         yield(instruction) if block_given?
+        if instruction.respond_to?(:files)
+          instruction.files.each do |file|
+            @filehandler.run(file)
+          end
+        end
         if instruction.respond_to?(:run)
           @filehandler.run(instruction)
         else

data/lib/niman/vagrant/shell.rb

@@ -43,10 +43,13 @@ module VagrantPlugins
     end
 
     def create_file(path, content)
-      @channel.sudo(`echo #{content} > #{File.expand_path(path)}`) do |type, data|
-        #Output the data with the proper color based on the stream.
+      if content.include?("\n")
+        cmd = "cat > #{path} << EOL\n#{content}\nEOL"
+      else
+        cmd  = "echo #{content} > #{path}"
+      end
+      @channel.sudo(cmd) do |type, data|
         color = type == :stdout ? :green : :red
-        # Clear out the newline since we add one
         data = data.chomp
         next if data.empty?
         options = {}

data/lib/niman/version.rb

@@ -1,3 +1,3 @@
 module Niman
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/niman.rb

@@ -1,6 +1,7 @@
 require "niman/version"
 require "niman/cli/application"
 require "niman/library/package"
+require "niman/library/custom_package"
 
 module Niman
   if defined?(::Vagrant)

data/niman.gemspec

@@ -23,4 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "3.1"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "pry-byebug", "~> 3.0"
 end

data/spec/lib/application_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+require 'niman/cli/application'
+require 'niman/shell'
+
+describe Niman::CLI::Application do
+  let(:shell) { double(Niman::Shell) }
+  subject(:application) { Niman::CLI::Application.new }
+
+  before do
+    FakeFS.deactivate!
+    application.client_shell = shell
+    application.silent = true
+    allow(shell).to receive(:os).and_return(:debian)
+  end
+
+  after do
+    Niman::Recipe.reset
+    File.delete(Niman::Recipe::DEFAULT_FILENAME)
+  end
+
+  describe "create files" do
+    before do
+      nimanfile = <<-EOS
+      #-*- mode: ruby -*-
+      # vi: set ft=ruby :
+      Niman::Recipe.configure do |config|
+        config.file "/etc/nginx/nginx.conf" do |file|
+          file.content = '...'
+        end
+      end
+      EOS
+      File.open(Niman::Recipe::DEFAULT_FILENAME, "w") {|h| h.write(nimanfile)}
+      allow(shell).to receive(:create_file)
+      application.apply
+    end
+
+    specify 'with with content' do
+      expect(shell).to have_received(:create_file).with('/etc/nginx/nginx.conf', '...')
+    end
+  end
+
+  describe "install packages" do
+    before do
+      nimanfile = <<-EOS
+      #-*- mode: ruby -*-
+      # vi: set ft=ruby :
+      Niman::Recipe.configure do |config|
+        config.package do |package|
+          package.name = 'git'
+        end
+      end
+      EOS
+      File.open(Niman::Recipe::DEFAULT_FILENAME, "w") {|h| h.write(nimanfile)}
+      allow(shell).to receive(:exec)
+      application.apply
+    end
+    it 'installs git package' do
+      expect(shell).to have_received(:exec).with("apt-get -y install git", true)
+    end
+  end
+
+  describe "custom package" do
+    context 'is nonexistant' do
+      before do
+        nimanfile = <<-EOS
+            #-*- mode: ruby -*-
+            # vi: set ft=ruby :
+            require 'niman'
+            Niman::Recipe.configure do |config|
+              config.package "packages/nginx" 
+            end
+        EOS
+        File.open(Niman::Recipe::DEFAULT_FILENAME, "w") {|h| h.write(nimanfile)}
+        allow(shell).to receive(:print)
+        application.apply
+      end
+
+      it 'prints out validation error' do
+        expect(shell).to have_received(:print)
+      end
+    end
+    context 'is existant' do
+      before do
+        nginx_package = <<-EOS
+       require 'niman'
+
+       class Nginx < Niman::Library::CustomPackage
+         package_name :debian, 'nginx'
+
+         file '/etc/nginx/nginx.conf' do |config|
+             config.content = 'foo bar'
+         end
+       end
+        EOS
+
+        nimanfile = <<-EOS
+      #-*- mode: ruby -*-
+      # vi: set ft=ruby :
+      require 'niman'
+      Niman::Recipe.configure do |config|
+        config.package "packages/nginx" 
+      end
+        EOS
+        FileUtils.mkdir("packages")
+        File.open("packages/nginx.rb", "w") {|h| h.write(nginx_package)}
+        File.open(Niman::Recipe::DEFAULT_FILENAME, "w") {|h| h.write(nimanfile)}
+        allow(shell).to receive(:create_file)
+        allow(shell).to receive(:exec)
+        application.apply
+      end
+      after do
+        FileUtils.rm_r("packages")
+      end
+
+      it 'installs nginx package' do
+        expect(shell).to have_received(:exec).with("apt-get -y install nginx", true)
+      end
+
+      it 'writes /etc/nginx/nginx.conf' do
+        expect(shell).to have_received(:create_file).with('/etc/nginx/nginx.conf', 'foo bar')
+      end
+    end
+  end
+end

data/spec/lib/installer_spec.rb

@@ -34,6 +34,10 @@ describe Niman::Installer do
     }, shell: shell)}
     let(:vim_package) { Niman::Library::Package.new(name: 'vim') }
     let(:ssh_package) { Niman::Library::Package.new(name: 'ssh') }
+    let(:custom_ruby_package) { Class.new(Niman::Library::CustomPackage) do
+      package_name :redhat, 'ruby-2.0.0-full'
+      package_name :debian, 'ruby-2.0.0'
+    end  }
     let(:packages) { [vim_package, ssh_package] }
 
     context 'with valid operating system' do
@@ -50,6 +54,33 @@ describe Niman::Installer do
       end
     end
 
+    [[:debian, 'apt-get install'], [:redhat, 'yum install']].each do |os, command|
+      context "with custom package on #{os}" do
+        before do
+          allow(shell).to receive(:os).and_return(os)
+          allow(shell).to receive(:exec)
+          installer.install(custom_ruby_package)
+        end
+
+        it 'installs with correct package name' do
+          package_name = custom_ruby_package.package_names[os]
+          expect(shell).to have_received(:exec).with("#{command} #{package_name}", true)
+        end
+      end
+    end
+
+    context 'with unsupported custom package' do
+      let(:custom_nginx_package) { Class.new(Niman::Library::CustomPackage) do
+        package_name :gentoo, 'nginx-full'
+      end  }
+      before do
+        allow(shell).to receive(:os).and_return(:redhat)
+      end
+      it 'raises error' do
+        expect { installer.install(custom_nginx_package) }.to raise_error(Niman::InstallError)
+      end
+    end
+
     it 'raises for unknown operating system' do
       allow(shell).to receive(:os).and_return(:freebsd)
       expect { installer.install(packages) }.to raise_error(Niman::InstallError)

data/spec/lib/library/custom_package_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'niman/library/custom_package'
+
+describe Niman::Library::CustomPackage do
+  subject(:package) { Niman::Library::CustomPackage }
+  describe '.package_name' do
+    it 'sets a package name for a certain OS' do
+      package.package_name(:centos, 'ngnix')
+      expect(package.package_names.length).to eq 1
+    end
+  end
+
+  describe ".file" do
+    let(:path) { '/etc/nginx/nginx.conf' }
+    it 'accepts a filename' do
+      package.file(path)
+      expect(package.files.first.path).to eq path
+    end
+
+    it 'accepts a block and passes a file object' do
+      expect { |b| package.file(path, &b) }.to yield_with_args(Niman::Library::File)
+    end
+  end
+
+  describe '.valid?' do
+    before do
+      package.instance_variable_set(:@package_names, {})
+    end
+
+    it 'is not valid when package_names not set' do
+      expect(package.valid?).to be false
+    end
+
+    it 'is not valid when package name is empty' do
+      package.package_name :ubuntu, ''
+      expect(package.valid?).to be false
+    end
+
+    it 'is valid when at least one package name is set' do
+      package.package_name :ubuntu, 'nginx'
+      expect(package.valid?).to be true
+    end
+  end
+
+  describe '.errors' do
+    it 'returns empty array when package is valid' do
+      package.package_name :centos, 'foo'
+      expect(package.errors).to eq []
+    end
+
+    it 'returns error when package is not valid' do
+      package.package_name :centos, ''
+      expect(package.errors).to_not be nil
+    end
+  end
+end

data/spec/lib/library/file_spec.rb

@@ -57,6 +57,9 @@ describe Niman::Library::File do
     before do
       file.run
     end
+    after do
+      File.delete(path)
+    end
 
     it 'creates a file at path' do
       expect(File.exists?(path)).to be true

data/spec/lib/nimanfile_spec.rb

@@ -15,8 +15,15 @@ describe Niman::Nimanfile do
     end
   end
 
-  specify 'file calls block with config object' do
-    expect { |b| niman_file.file(&b) }.to yield_with_args(Niman::Library::File)
+  describe '#file' do
+    it 'calls block with config object' do
+      expect { |b| niman_file.file('/home/foo.txt', &b) }.to yield_with_args(Niman::Library::File)
+    end
+
+    it 'sets path' do
+      niman_file.file('/home/foo.txt') {}
+      expect(niman_file.instructions.first.path).to eq '/home/foo.txt'
+    end
   end
 
   specify 'package calls block with config object' do
@@ -25,7 +32,7 @@ describe Niman::Nimanfile do
 
   describe '#instructions' do
     before do
-      niman_file.file {}
+      niman_file.file('') {}
     end
 
     specify 'increases when #file is being called' do

data/spec/lib/provisioner_spec.rb

@@ -4,16 +4,22 @@ require 'niman/installer'
 require 'niman/exceptions'
 
 describe Niman::Provisioner do
-  let(:file)         { Niman::Library::File.new(path: '~/hello.txt', content: 'ohai') }
-  let(:vim_package)  { Niman::Library::Package.new(name: 'vim') }
-  let(:instructions) { [file, vim_package] }
-  let(:installer)    { double(Niman::Installer) }
-  let(:filehandler)  { double(Niman::FileHandler) }
+  let(:file)          { Niman::Library::File.new(path: '~/hello.txt', content: 'ohai') }
+  let(:vim_package)   { Niman::Library::Package.new(name: 'vim') }
+  let(:nginx_package) { Class.new(Niman::Library::CustomPackage) do
+    package_name :ubuntu, 'nginx'
+    file '/etc/nginx/nginx.conf' do |file|
+      file.content = 'foo'
+    end
+  end}
+  let(:instructions)  { [file,vim_package, nginx_package] }
+  let(:installer)     { double(Niman::Installer) }
+  let(:filehandler)   { double(Niman::FileHandler) }
   subject(:provisioner) { Niman::Provisioner.new(installer, filehandler, instructions) }
 
   describe "#initialize" do
     it 'accepts a list of instructions' do
-      expect(provisioner.instructions).to eq [file, vim_package]
+      expect(provisioner.instructions).to eq instructions
     end
 
     it 'accepts a single instruction' do
@@ -57,12 +63,16 @@ describe Niman::Provisioner do
         expect(filehandler).to have_received(:run).with(file)
       end
 
+      it 'calls file handler for custom package files' do
+        expect(filehandler).to have_received(:run).with(nginx_package.files.first)
+      end
+
       it 'calls installer for package' do
         expect(installer).to have_received(:install).with(vim_package)
       end
 
       it 'calls block for every instruction' do
-        expect { |b| provisioner.run(&b) }.to yield_successive_args(file, vim_package)
+        expect { |b| provisioner.run(&b) }.to yield_successive_args(file, vim_package, nginx_package)
       end
     end
   end

data/spec/lib/recipe_spec.rb

@@ -5,8 +5,7 @@ describe Niman::Recipe do
   describe '.configure' do
     before do
       Niman::Recipe.configure do |config|
-        config.file do |file|
-          file.path = '/home/bob/hello.txt'
+        config.file '/home/bob/hello.txt' do |file|
           file.content = 'hello from alice'
         end
       end
@@ -20,8 +19,7 @@ describe Niman::Recipe do
   describe '.reset' do
     before do
       Niman::Recipe.configure do |config|
-        config.file do |file|
-          file.path = '/home/bob/hello.txt'
+        config.file '/home/bob/hello.txt' do |file|
           file.content = 'hello from alice'
         end
       end
@@ -38,8 +36,7 @@ describe Niman::Recipe do
       FakeFS.deactivate!
       content = <<-EOS
       Niman::Recipe.configure do |config|
-        config.file do |file|
-          file.path = '/home/bob/hello.txt'
+        config.file '/home/bob/hello.txt' do |file|
           file.content = 'hello from alice'
         end
       end
@@ -49,6 +46,7 @@ describe Niman::Recipe do
     end
     after do
       File.delete(Niman::Recipe::DEFAULT_FILENAME)
+      File.delete('CustomNimanfile')
       FakeFS.activate!
       Niman::Recipe.reset
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: niman
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Jan Schulte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-11 00:00:00.000000000 Z
+date: 2015-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -94,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
 description: 
 email:
 - hello@unexpected-co.de
@@ -115,9 +143,11 @@ files:
 - lib/niman/exceptions.rb
 - lib/niman/filehandler.rb
 - lib/niman/installer.rb
+- lib/niman/library/custom_package.rb
 - lib/niman/library/file.rb
 - lib/niman/library/package.rb
 - lib/niman/nimanfile.rb
+- lib/niman/package_resolver.rb
 - lib/niman/platform.rb
 - lib/niman/provisioner.rb
 - lib/niman/recipe.rb
@@ -127,8 +157,10 @@ files:
 - lib/niman/vagrant/shell.rb
 - lib/niman/version.rb
 - niman.gemspec
+- spec/lib/application_spec.rb
 - spec/lib/filehandler_spec.rb
 - spec/lib/installer_spec.rb
+- spec/lib/library/custom_package_spec.rb
 - spec/lib/library/file_spec.rb
 - spec/lib/library/package_spec.rb
 - spec/lib/nimanfile_spec.rb
@@ -160,8 +192,10 @@ signing_key:
 specification_version: 4
 summary: Provisions your machine
 test_files:
+- spec/lib/application_spec.rb
 - spec/lib/filehandler_spec.rb
 - spec/lib/installer_spec.rb
+- spec/lib/library/custom_package_spec.rb
 - spec/lib/library/file_spec.rb
 - spec/lib/library/package_spec.rb
 - spec/lib/nimanfile_spec.rb