niman 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0dd2e66a5efe87391ae8ea496cf819c14cc611bb
-  data.tar.gz: 51bddf363cae6f579f3906cb2a86e62a13243e8d
+  metadata.gz: cec92b45c738e4089f9d9dd278f4c6f84b86e161
+  data.tar.gz: bbbfe3217ab77454b7339aefc5826bf4b5443c91
 SHA512:
-  metadata.gz: 09b62fb72deb43fdb3455b3b11460bdc66eaf3dafd74f9f891481ffd35c4a981e659385d0e3336f241251afc80bd4fffe1ce6531f41b2d55a892ffdabb716603
-  data.tar.gz: 519dbe2cf887550e5c498c5c8a5af914c23cb4b90516155e3ce36650e00149be3ef2e33efa66a06937614cdf43fa917d4cef93247e1bbaf0805d6500c790fcda
+  metadata.gz: 7233e582d4389918020a9ffb1a6ba067841c1d0101bc6fc562f8d1d55fb473786b0bf88617b1294cb124401591d6b0c78575e31e0e6fd4b2b9e41d574de962db
+  data.tar.gz: 9c5a3030863723f7df305f0c26dc390af35c6f59f53af716b906585d8f0eebcc0db1f11fb58e9e3faa5ecf7036e36f64dca26eeb742c255373922ad5febfb829

data/README.md

@@ -1,5 +1,6 @@
 # Niman
 [![Build Status](https://travis-ci.org/schultyy/Niman.svg?branch=master)](https://travis-ci.org/schultyy/Niman)
+[![Code Climate](https://codeclimate.com/github/schultyy/Niman/badges/gpa.svg)](https://codeclimate.com/github/schultyy/Niman)
 
 Niman is a proof-of-concept provisioner.
 
@@ -34,6 +35,24 @@ This places a new file `hello.txt` in `/home/bob` with rights 0600.
 
 A `Nimanfile` contains all necessary commands for `niman` to run.
 
+### Commands
+
+Niman has support to execute arbitrary commands on the host system:
+
+```ruby
+Niman::Recipe.configure do |config|
+  config.exec "touch ~/hello.txt"
+end
+```
+
+Or if you need sudo privileges:
+
+```ruby
+Niman::Recipe.configure do |config|
+  config.exec :sudo, "apt-get update"
+end
+```
+
 ### Packages
 
 Use a concrete package in your script:
@@ -42,7 +61,6 @@ Use a concrete package in your script:
 Niman::Recipe.configure do |config|
   config.package do |package|
     package.name = "vim"
-    package.version = "7.4"
   end
 end
 ```
@@ -56,8 +74,8 @@ Package description:
 #packages/ruby.rb
 require 'niman'
 class RubyPackage < Niman::Package
-  package :ubuntu, "ruby1.9.1"
-  package :centos, "ruby1.9.1"
+  package_name :ubuntu, "ruby1.9.1"
+  package_name :centos, "ruby1.9.1"
 end
 ```
 In your `Nimanfile`:
@@ -72,14 +90,14 @@ A custom package can have one or more configuration files inside of it:
 ```ruby
 #packages/nginx
 class NginxPackage < Niman::Package
-  package :ubuntu, 'nginx'
+  package_name :ubuntu, 'nginx'
   
-  configuration '/etc/nginx/nginx.conf' do |config|
+  file '/etc/nginx/nginx.conf' do |config|
     #general nginx configuration goes here
     config.content = '...'
   end
   
-  configuration '/etc/nginx/sites-available/example.com' do |config|
+  file '/etc/nginx/sites-available/example.com' do |config|
     config.content = '...'
   end
 end

data/lib/niman/cli/application.rb

@@ -30,7 +30,7 @@ module Niman
 
           resolver    = Niman::PackageResolver.new(config.instructions)
           filehandler = Niman::FileHandler.new(client_shell)
-          provisioner = Niman::Provisioner.new(installer, filehandler, resolver.resolve)
+          provisioner = Niman::Provisioner.new(installer, filehandler, @client_shell, resolver.resolve)
           this = self
           provisioner.run do |instruction|
             this.say "Executing task #{instruction.description}" unless @silent

data/lib/niman/library/command.rb

@@ -0,0 +1,26 @@
+module Niman
+  module Library
+    class Command
+      include Virtus.model
+
+      attribute :command, String
+      attribute :use_sudo, Symbol, default: :no_sudo
+
+      def valid?
+        !command.empty? && [:no_sudo, :sudo].include?(use_sudo)
+      end
+
+      def errors
+        "command must not be empty"
+      end
+
+      def description
+        if use_sudo == :sudo
+          "sudo #{command}"
+        else
+          command
+        end
+      end
+    end
+  end
+end

data/lib/niman/library/custom_package.rb

@@ -2,7 +2,7 @@ module Niman
   module Library
     class CustomPackage
       class << self
-        attr_reader :package_names, :files
+        attr_reader :package_names, :files, :commands
 
         def valid?
           !package_names.nil? &&
@@ -26,6 +26,11 @@ module Niman
           ''
         end
 
+        def exec(sudo=:no_sudo, command)
+          @commands ||= []
+          @commands << Niman::Library::Command.new(use_sudo: sudo, command: command)
+        end
+
         def errors
           return [] if self.valid?
           package_names.keys.map do |key|

data/lib/niman/nimanfile.rb

@@ -1,4 +1,5 @@
 require 'niman/library/file'
+require 'niman/library/command'
 
 module Niman
   class Nimanfile
@@ -20,5 +21,9 @@ module Niman
       yield(package) if block_given?
       @instructions.push(package)
     end
+
+    def exec(use_sudo = :no_sudo, command)
+      @instructions.push(Niman::Library::Command.new(command: command, use_sudo: use_sudo))
+    end
   end
 end

data/lib/niman/provisioner.rb

@@ -4,9 +4,10 @@ module Niman
   class Provisioner
     attr_reader :instructions
 
-    def initialize(installer, filehandler, instructions)
+    def initialize(installer, filehandler, shell, instructions)
       @installer    = installer
       @filehandler  = filehandler
+      @shell        = shell
       @instructions = Array(instructions)
     end
 
@@ -23,16 +24,42 @@ module Niman
       @instructions.each do |instruction|
         yield(instruction) if block_given?
         if instruction.respond_to?(:files)
-          instruction.files.each do |file|
-            @filehandler.run(file)
-          end
+          custom_package_files(instruction)
+        end
+        if instruction.respond_to?(:commands)
+          custom_package_exec(instruction)
         end
         if instruction.respond_to?(:run)
           @filehandler.run(instruction)
+        elsif instruction.respond_to?(:command)
+          command(instruction)
         else
           @installer.install(instruction)
         end
       end
     end
+
+    private
+
+    def custom_package_exec(instruction)
+      return if instruction.commands.nil?
+      instruction.commands.each { |cmd| command(cmd) }
+    end
+
+    def custom_package_files(instruction)
+      instruction.files.each do |file|
+        @filehandler.run(file)
+      end
+    end
+
+    def command(instruction)
+      mode = case instruction.use_sudo
+             when :sudo
+               true
+             when :no_sudo
+               false
+             end
+      @shell.exec(instruction.command, mode)
+    end
   end
 end

data/lib/niman/vagrant/shell.rb

@@ -18,12 +18,10 @@ module VagrantPlugins
 
     def exec(command, use_sudo=false)
       @machine.ui.info(command, {color: :green})
-      opts = { error_check: false, elevated: true }
-      @channel.sudo(command, opts) do |type, data|
+      opts = { error_check: false, elevated: use_sudo }
+      handler = Proc.new do |type, data|
         if [:stderr, :stdout].include?(type)
-          #Output the data with the proper color based on the stream.
           color = type == :stdout ? :green : :red
-          # Clear out the newline since we add one
           data = data.chomp
           next if data.empty?
           options = {}
@@ -31,6 +29,11 @@ module VagrantPlugins
           @machine.ui.info(data.chomp, options)
         end
       end
+      if use_sudo
+        @channel.sudo(command, opts, &handler)
+      else
+        @channel.execute(command, opts, &handler)
+      end
     end
 
     def print(message, type)
@@ -42,20 +45,13 @@ module VagrantPlugins
       end
     end
 
-    def create_file(path, content)
+    def create_file(path, content, use_sudo=false)
       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
-        data = data.chomp
-        next if data.empty?
-        options = {}
-        options[:color] = :green
-        @machine.ui.info(data.chomp, options)
-      end
+      self.exec(cmd, use_sudo)
     end
 
     private

data/lib/niman/version.rb

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

data/spec/lib/application_spec.rb

@@ -18,6 +18,55 @@ describe Niman::CLI::Application do
     File.delete(Niman::Recipe::DEFAULT_FILENAME)
   end
 
+  describe "commands" do
+    def write_file(body)
+      nimanfile = <<-EOS
+        Niman::Recipe.configure do |config|
+          #{body}
+        end
+      EOS
+      File.open(Niman::Recipe::DEFAULT_FILENAME, "w") {|h| h.write(nimanfile)}
+    end
+
+    context 'without sudo' do
+      it 'is passed to shell' do
+        allow(shell).to receive(:exec)
+        write_file("config.exec 'touch hello.txt'")
+        application.apply
+        expect(shell).to have_received(:exec).with("touch hello.txt", false)
+      end
+
+      it 'does not execute when argument is empty' do
+        write_file("config.exec ''")
+        allow(shell).to receive(:print).with(any_args)
+        application.apply
+        expect(shell).to have_received(:print).with(any_args)
+      end
+    end
+    context 'with sudo' do
+      it 'is passed to shell' do
+        allow(shell).to receive(:exec)
+        write_file("config.exec :sudo, 'apt-get update'")
+        application.apply
+        expect(shell).to have_received(:exec).with('apt-get update', true)
+      end
+
+      it 'does not execute when argument is empty' do
+        write_file("config.exec :sudo, ''")
+        allow(shell).to receive(:print).with(any_args)
+        application.apply
+        expect(shell).to have_received(:print).with(any_args)
+      end
+
+      it 'does not execute when sudo_mode is unknown' do
+        write_file("config.exec :foo, 'apt-get update'")
+        allow(shell).to receive(:print).with(any_args)
+        application.apply
+        expect(shell).to have_received(:print).with(any_args)
+      end
+    end
+  end
+
   describe "create files" do
     before do
       nimanfile = <<-EOS
@@ -82,15 +131,18 @@ describe Niman::CLI::Application do
     context 'is existant' do
       before do
         nginx_package = <<-EOS
-       require 'niman'
+          require 'niman'
+
+          class Nginx < Niman::Library::CustomPackage
+            package_name :debian, 'nginx'
 
-       class Nginx < Niman::Library::CustomPackage
-         package_name :debian, 'nginx'
+            file '/etc/nginx/nginx.conf' do |config|
+              config.content = 'foo bar'
+            end
 
-         file '/etc/nginx/nginx.conf' do |config|
-             config.content = 'foo bar'
-         end
-       end
+            exec :sudo, 'ln -s /etc/nginx/sites-available/example.org /etc/nginx/sites-enabled/example.org'
+            exec 'touch ~/install_notes.txt'
+          end
         EOS
 
         nimanfile = <<-EOS
@@ -119,6 +171,14 @@ describe Niman::CLI::Application do
       it 'writes /etc/nginx/nginx.conf' do
         expect(shell).to have_received(:create_file).with('/etc/nginx/nginx.conf', 'foo bar')
       end
+
+      it 'links /etc/nginx/sites-available/example.org' do
+        expect(shell).to have_received(:exec).with('ln -s /etc/nginx/sites-available/example.org /etc/nginx/sites-enabled/example.org', true)
+      end
+
+      it 'creates install_notes.txt in home directory' do
+        expect(shell).to have_received(:exec).with('touch ~/install_notes.txt', false)
+      end
     end
   end
 end

data/spec/lib/provisioner_spec.rb

@@ -4,6 +4,7 @@ require 'niman/installer'
 require 'niman/exceptions'
 
 describe Niman::Provisioner do
+  let(:shell)         { double('Shell') }
   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
@@ -15,7 +16,7 @@ describe Niman::Provisioner do
   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) }
+  subject(:provisioner) { Niman::Provisioner.new(installer, filehandler, shell, instructions) }
 
   describe "#initialize" do
     it 'accepts a list of instructions' do
@@ -23,7 +24,7 @@ describe Niman::Provisioner do
     end
 
     it 'accepts a single instruction' do
-      provisioner = Niman::Provisioner.new(installer, filehandler, file)
+      provisioner = Niman::Provisioner.new(installer, filehandler, shell, file)
       expect(provisioner.instructions).to eq [file]
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: niman
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Jan Schulte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-17 00:00:00.000000000 Z
+date: 2015-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -143,6 +143,7 @@ files:
 - lib/niman/exceptions.rb
 - lib/niman/filehandler.rb
 - lib/niman/installer.rb
+- lib/niman/library/command.rb
 - lib/niman/library/custom_package.rb
 - lib/niman/library/file.rb
 - lib/niman/library/package.rb