jisota 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d30b81b24cc0fc7e8bb04cc88f243fc83983dd25
-  data.tar.gz: 5b94aabed9dcb6f17c89e03bd2092d73d79067ae
+  metadata.gz: 6a9b6fbe8f6f04bd26ea84192e789ec977a30b28
+  data.tar.gz: 5ea5c9239da6eb97a9da00f1cf4123e86fe05f2a
 SHA512:
-  metadata.gz: 0d75af1889780c695a60813c9fd8613f60ca0149151e24d39f5ebbdb27ae172eb797c5c570fd92fee1f5de4d877a466ca3079b9affc477ee241ca16168710269
-  data.tar.gz: 6ad96e33cbd4c23b673d075b1b6efd8944218ba7cb2c28756a692d5151c45265f67018b3ebc661bfbc0285a7169544c0c92cef1197a0ece52c51475f05363e4f
+  metadata.gz: 1bb3c31c918cf9ab2a17196a6a64ec2ce60dc58c1c69d28148beef395a969253bf80ee0ce795c0fc228b47d10071cf2dfe4069cfed8d4e0344211a88d6451c4a
+  data.tar.gz: e6d0b2c5023dc125dbb1413b07802f3d9e1dd5ccdaf8c3404e4c7ef3c11d7f1c0067b0668f33819a4ad354181f72caa00a458101a3bdd529c28344798727ccaf

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Jisota changelog
 
-## 0.0.2 (current)
+## 0.0.3 (current)
+
+### Features
+* Packages can have multiple sections of run and verify blocks
+
+### Improvements
+* Rake tasks for vagrant
+* Better acceptance test runner
+* Ruby package also installs bundler gem
+
+### New packages
+* nginx
+
+
+## 0.0.2
 
 ### Features
 * Create and Update actions on file upload
@@ -17,5 +31,6 @@
 * gem_install
 * nginx_passenger
 
+
 ## 0.0.1
 Initial version with basic functionality

data/README.md

@@ -83,6 +83,36 @@ the params section below.
 Inside a run-block, packages can be called by their name, somewhat like a Ruby
 method. See the `apt` example above.
 
+### Having multiple run and verify blocks
+
+Sometimes you need to verify only parts of the package. Just specify multiple
+run and verify blocks:
+
+    package :install_awesome_service do
+      description "Installs a service and starts it"
+
+      run { cmd "sudo apt-get install awesome-service" }
+      verify { cmd "command-to-tell-if-service-is-installed" }
+
+      run { cmd "sudo service awesome start" }
+      verify { cmd "command-to-tell-if-service-is-started" }
+    end
+
+You can optionally name each of these sections to give a more precise output:
+
+    package :install_awesome_service do
+      description "Installs a service and starts it"
+
+      section "Install the service from apt-get"
+      run { cmd "sudo apt-get install awesome-service" }
+      verify { cmd "command-to-tell-if-service-is-installed" }
+
+      section "Start the service"
+      run { cmd "sudo service awesome start" }
+      verify { cmd "command-to-tell-if-service-is-started" }
+    end
+
+
 ### Defining packages to be used in more than one project
 
 Defining packages with `Jisota.config` as above will only add the package to
@@ -233,6 +263,11 @@ You can also use package params and call packages inside these blocks:
     description "Install nginx with passenger module"
     param :config_file, required: true
 
+### nginx
+
+    description "Install nginx from apt"
+    param :config_file
+
 ### More packages?
 
 Jisota is a young gem. Please contribute with any packages that you think
@@ -333,7 +368,7 @@ a near-real environment that is easy to destroy and rebuild.
 
 Start the vagrant:
 
-    $ (cd spec/vagrant && vagrant up)
+    $ rake vagrant:up
 
 Then run acceptance specs
 
@@ -341,11 +376,11 @@ Then run acceptance specs
 
 Or run individual specs. Some of them might take a while:
 
-    $ rspec --tag type:acceptance spec/acceptance/some_spec.rb
+    $ ACCEPTANCE=1 rspec spec/acceptance/some_spec.rb
 
 To kill vagrant and start with a fresh machine:
 
-    $ (cd spec/vagrant && vagrant destroy --force && vagrant up)
+    $ rake vagrant:rebuild
 
 ## Contributing
 

data/Rakefile

@@ -4,7 +4,24 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 namespace :spec do
   RSpec::Core::RakeTask.new(:acceptance) do |config|
-    config.rspec_opts = "--tag type:acceptance"
+    ENV["ACCEPTANCE"] = "Oh_yeah"
+  end
+end
+
+namespace :vagrant do
+  desc "Starts the vagrant VM"
+  task :up do
+    system "(cd spec/vagrant && vagrant up)"
+  end
+
+  desc "Destroys and starts the vagrant VM"
+  task :rebuild do
+    system '(cd spec/vagrant && vagrant destroy --force && vagrant up)'
+  end
+
+  desc "Shuts dows the vagrant VM"
+  task :halt do
+    system "(cd spec/vagrant && vagrant halt)"
   end
 end
 

data/jisota.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "net-ssh", "~> 2.8.0"
-  spec.add_dependency "net-scp", "~> 1.1.2"
+  spec.add_dependency "net-ssh", "~> 2.8"
+  spec.add_dependency "net-scp", "~> 1.2"
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"

data/lib/jisota/package.rb

@@ -1,15 +1,22 @@
 module Jisota
   class Package
-    attr_accessor :name, :description, :params, :run_block, :verify_block
+    attr_accessor :name, :description, :params, :sections
 
     def initialize(name = nil, &block)
       @params = []
+      @sections = []
       @name = name
       DSL.new(self).evaluate(&block) if block_given?
     end
 
     alias_method :key, :name
 
+    class InvalidBlockOrder < StandardError; end
+
+    class Section
+      attr_accessor :description, :run_block, :verify_block
+    end
+
     class DSL < DSLBase
       def initialize(target)
         @target = target
@@ -23,12 +30,30 @@ module Jisota
         @target.params << Param.new(name, options)
       end
 
+      def section(description)
+        @target.sections << Section.new.tap do |section|
+          section.description = description
+        end
+      end
+
       def run(&block)
-        @target.run_block = ScriptBlock.new(&block)
+        run_block = ScriptBlock.new(&block)
+        section = @target.sections.last
+        if section && section.run_block.nil?
+          section.run_block = run_block
+        else
+          @target.sections << Section.new.tap do |new_section|
+            new_section.run_block = run_block
+          end
+        end
       end
 
       def verify(&block)
-        @target.verify_block = ScriptBlock.new(&block)
+        section = @target.sections.last
+        if section.nil? || section.verify_block
+          raise InvalidBlockOrder, "A verify block must come after a run block"
+        end
+        section.verify_block = ScriptBlock.new(&block)
       end
     end
   end

data/lib/jisota/package_script.rb

@@ -18,7 +18,7 @@ module Jisota
     def execute(context)
       context.param_scope(parse_params) do
         context.logger.system_message("Package #{self}") do
-          execute_verify_and_run(context)
+          execute_package(context)
         end
       end
     end
@@ -39,23 +39,33 @@ module Jisota
       ParamParser.new(package.params, args).parse
     end
 
-    def execute_verify_and_run(context)
-      if package.verify_block
-        verify_script = package.verify_block.evaluate(context)
+    def execute_package(context)
+      package.sections.each do |section|
+        context.logger.system_message("Section #{section.description}") do
+          result = execute_section(section, context)
+          return false unless result
+        end
+      end
+      true
+    end
+
+    def execute_section(section, context)
+      if section.verify_block
+        verify_script = section.verify_block.evaluate(context)
         result = verify_script.execute(context)
         if result
-          context.logger.system_message("Package #{self} already installed")
+          context.logger.system_message("Section #{section.description} already installed")
           true
         else
-          execute_run(context)
+          execute_run(section, context)
         end
       else
-        execute_run(context)
+        execute_run(section, context)
       end
     end
 
-    def execute_run(context)
-      run_script = package.run_block.evaluate(context)
+    def execute_run(section, context)
+      run_script = section.run_block.evaluate(context)
       run_script.execute(context)
     end
   end

data/lib/jisota/packages/nginx.rb

@@ -0,0 +1,25 @@
+require 'jisota'
+
+Jisota.global_config do
+  package :nginx do
+    description "Install nginx from apt"
+    param :config_file
+
+    section "Install nginx aåt package"
+    run { apt :nginx }
+
+    section "Files"
+    run do
+      if config_file
+        upload from: config_file, to: '/etc/nginx/nginx.conf' do
+          update { cmd "sudo service nginx restart || true" }
+        end
+      end
+    end
+
+    section "Start nginx"
+    run { cmd "sudo service nginx start" }
+    verify { cmd "ps -C nginx" }
+  end
+end
+

data/lib/jisota/packages/nginx_passenger.rb

@@ -5,11 +5,18 @@ Jisota.global_config do
     description "Install nginx with passenger module"
     param :config_file, required: true
 
+    section "Prerequisites"
     run do
       gem_install :passenger
       apt "libcurl4-openssl-dev"
-      nginx_passenger_install
+    end
+
+    section "Install nginx with passenger"
+    run { cmd 'sudo passenger-install-nginx-module --auto --auto-download --prefix=/opt/nginx' }
+    verify { cmd 'which /opt/nginx/sbin/nginx' }
 
+    section "Files"
+    run do
       upload from: config_file, to: '/opt/nginx/conf/nginx.conf' do
         update { cmd "sudo service nginx restart" }
       end
@@ -17,17 +24,9 @@ Jisota.global_config do
       upload from: "package_files/nginx_passenger/nginx_service", to: "/etc/init.d/nginx" do
         create { cmd 'sudo update-rc.d nginx defaults 99' }
       end
-
-      nginx_passenger_start
     end
-  end
-
-  package :nginx_passenger_install do
-    run { cmd 'sudo passenger-install-nginx-module --auto --auto-download --prefix=/opt/nginx' }
-    verify { cmd 'which /opt/nginx/sbin/nginx' }
-  end
 
-  package :nginx_passenger_start do
+    section "Start nginx"
     run { cmd "sudo service nginx start" }
     verify { cmd "ps -C nginx" }
   end

data/lib/jisota/packages/ruby.rb

@@ -21,9 +21,11 @@ Jisota.global_config do
         sudo make install
       }
     end
-
     verify do
       cmd "ruby -v | grep #{version}"
     end
+
+    section "Install bundler"
+    run { gem_install :bundler }
   end
 end

data/lib/jisota/version.rb

@@ -1,3 +1,3 @@
 module Jisota
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/lib/jisota/package_spec.rb

@@ -31,28 +31,13 @@ module Jisota
       end
     end
 
-    describe "#run_block" do
-      it "has one" do
-        package = Package.new
-        package.run_block = :foo
-        expect(package.run_block).to eq(:foo)
-      end
-    end
-
-    describe "#verify_block" do
-      it "has one" do
-        package = Package.new
-        package.verify_block = :foo
-        expect(package.verify_block).to eq(:foo)
-      end
-    end
-
     describe Package::DSL do
       it "initializes using DSL" do
         package = Package.new(:my_awesome_package) do
           description "Does cool stuff"
           param :foo
           param :bar, default: 42
+
           run { cmd "touch #{foo}" }
           verify { cmd "[ -f foo ]" }
         end
@@ -62,8 +47,47 @@ module Jisota
         expect(package.params.size).to eq(2)
         expect(package.params.last.name).to eq(:bar)
         expect(package.params.last.options).to eq({ default: 42 })
-        expect(package.run_block).to be_a(ScriptBlock)
-        expect(package.verify_block).to be_a(ScriptBlock)
+        expect(package.sections.size).to eq(1)
+        expect(package.sections.first.run_block).to be_a(ScriptBlock)
+        expect(package.sections.first.verify_block).to be_a(ScriptBlock)
+      end
+
+      it "has many run and verify blocks" do
+        package = Package.new(:something) do
+          run { cmd "touch foo" }
+          verify { cmd "[ -f foo ]" }
+
+          run { cmd "touch bar" }
+
+          run { cmd "touch baz" }
+          verify { cmd "[ -f baz ]" }
+        end
+
+        expect(package.sections.size).to eq(3)
+      end
+
+      it "must have a run block per verify block" do
+        expect {
+          package = Package.new { verify { } }
+        }.to raise_exception(Package::InvalidBlockOrder)
+
+        expect {
+          package = Package.new do
+            run { }
+            verify { }
+            verify { }
+          end
+        }.to raise_exception(Package::InvalidBlockOrder)
+      end
+
+      it "accepts section names" do
+        package = Package.new(:foo) do
+          section "do amazing stuff"
+          run {}
+        end
+
+        expect(package.sections.size).to eq(1)
+        expect(package.sections.first.description).to eq("do amazing stuff")
       end
     end
   end

data/spec/spec_helper.rb

@@ -13,7 +13,11 @@ require './spec/support/acceptance_helpers'
 
 RSpec.configure do |config|
   config.filter_run :focus
-  config.filter_run_excluding type: :acceptance unless config.filter_run[:type] == "acceptance"
+  if ENV["ACCEPTANCE"]
+    config.filter_run type: :acceptance
+  else
+    config.filter_run_excluding type: :acceptance
+  end
   config.run_all_when_everything_filtered = true
 
   config.order = :random

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jisota
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Lasse Skindstad Ebert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-08 00:00:00.000000000 Z
+date: 2014-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: net-scp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -168,6 +168,7 @@ files:
 - lib/jisota/package_script.rb
 - lib/jisota/packages/apt.rb
 - lib/jisota/packages/gem_install.rb
+- lib/jisota/packages/nginx.rb
 - lib/jisota/packages/nginx_passenger.rb
 - lib/jisota/packages/ruby.rb
 - lib/jisota/param.rb
@@ -266,4 +267,3 @@ test_files:
 - spec/test_files/nginx_default.conf
 - spec/vagrant/Vagrantfile
 - spec/vagrant/ssh_key
-has_rdoc: