jisota 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 868630ce53b3e30dee642175d2e3f9269c40749c
-  data.tar.gz: 692a72ec3e1df5c55e7c679837548584096c3bb0
+  metadata.gz: d30b81b24cc0fc7e8bb04cc88f243fc83983dd25
+  data.tar.gz: 5b94aabed9dcb6f17c89e03bd2092d73d79067ae
 SHA512:
-  metadata.gz: e48e212a2175b404f1cfd1d2b122841051902f3f868509b1321096a9e1315440da686113cf8f7b209b872028ed068d50af947dbf3d8e2c97746f80987dea3b73
-  data.tar.gz: 71963bcbed7a13a30aadd4bc17a2bace65ea8ff694924999213c0a63cdf9e2b72b727d41d515dd69e535212e1fe042d0be28f6a5e26d022a8e3d6fba2398657c
+  metadata.gz: 0d75af1889780c695a60813c9fd8613f60ca0149151e24d39f5ebbdb27ae172eb797c5c570fd92fee1f5de4d877a466ca3079b9affc477ee241ca16168710269
+  data.tar.gz: 6ad96e33cbd4c23b673d075b1b6efd8944218ba7cb2c28756a692d5151c45265f67018b3ebc661bfbc0285a7169544c0c92cef1197a0ece52c51475f05363e4f

data/.gitignore

@@ -17,3 +17,4 @@ test/version_tmp
 tmp
 sandi_meter/
 examples/
+.vagrant

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - "2.1.0"
+  - "2.1.1"
+env:
+  - CODECLIMATE_REPO_TOKEN=5d0f3c23f6e2c737a1e4138fba4dd4db00dbe87bc037771402624b6151948c14

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Jisota changelog
+
+## 0.0.2 (current)
+
+### Features
+* Create and Update actions on file upload
+* Params have scope of the entire package, allowing e.g. upload action blocks to access package params
+* Can now specify a private ssh key to use
+
+### Improvements
+* Better DSL blocks.
+* Stuff parsed from script to script are now wrapped in a ScriptContext object
+* Fixed ruby package by ensuring build-essential is installed
+* Runs acceptance tests inside a vagrant
+
+### Packages
+* gem_install
+* nginx_passenger
+
+## 0.0.1
+Initial version with basic functionality

data/README.md

@@ -1,3 +1,9 @@
+[![Gem Version](https://badge.fury.io/rb/jisota.png)](http://badge.fury.io/rb/jisota)
+[![Code Climate](https://codeclimate.com/github/lasseebert/jisota.png)](https://codeclimate.com/github/lasseebert/jisota)
+[![Code Climate](https://codeclimate.com/github/lasseebert/jisota/coverage.png)](https://codeclimate.com/github/lasseebert/jisota)
+[![Build Status](https://travis-ci.org/lasseebert/jisota.svg)](https://travis-ci.org/lasseebert/jisota)
+[![Dependency Status](https://gemnasium.com/lasseebert/jisota.svg)](https://gemnasium.com/lasseebert/jisota)
+
 # Jisota
 
 Jisota is a simple provisioning tool meant for smaller projects.
@@ -5,6 +11,8 @@ Jisota is a simple provisioning tool meant for smaller projects.
 Provisioning, in this context, is the act of turning an empty server
 into a working machine tailored to your needs.
 
+***Note: Jisota is still considered unstable. Breaking changes may occur in patch version updates.***
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -41,6 +49,10 @@ Run the script with the ruby executable:
 
     $ ruby config/provision.rb
 
+## Ruby version
+
+Jisota is cutting edge and requires Ruby 2.1.0 or later.
+
 ## Defining a package
 
 Inside a `Jisota.config` block, use the `package` method to define a package.
@@ -133,6 +145,15 @@ Example:
       apt :vim, :git, command: "sudo apt-get install -y :package"
     end
 
+## Defining a server
+
+A server needs at least a host, a user and a role:
+
+    server "mydomain.com", user: "john", roles: :app
+
+Other options:
+
+* `key`: File path to ssh private key
 
 ## Atomic script operations
 
@@ -151,6 +172,43 @@ Uploads the file to the server. Example:
 
     upload from: "path/to/nginx.conf", to: "/etc/nginx.conf"
 
+You can register script blocks to be called if the file was created or updated.
+If the file on the server is identical with the uploaded file, no action is
+done and the file will not be overwritten.
+
+    upload from: "foo", to: "bar" do
+      create { cmd 'echo "File was created!"' }
+      update { cmd 'echo "File was updated!"' }
+    end
+
+You can disable creation or update of the file:
+
+    upload from: "foo", to: "bar" do
+      create false # Only update is allowed. File will not be created if it does not exists
+    end
+
+    - OR -
+
+    upload from: "foo", to: "bar", create: false
+
+You can also use package params and call packages inside these blocks:
+
+    package :nginx_config do
+      param :config_file, require: true
+      run do
+        upload from: config_file, to: "/etc/nginx.conf" do
+          update do
+            cmd %q{echo "#{config_file} was updated. Restarting nginx..."}
+            nginx_restart
+          end
+          create do
+            cmd %q{echo "#{config_file} was started. Starting nginx..."}
+            nginx_start
+          end
+        end
+      end
+    end
+
 ## Complete list of build-in packages
 
 ### ruby
@@ -164,6 +222,17 @@ Uploads the file to the server. Example:
     description "Installs packages with apt-get"
     param :packages, required: true, splat: true
 
+### gem_install
+
+    description "Installs a gem"
+    param :gem_name, required: true
+    param :sudo, default: true
+
+### nginx_passenger
+
+    description "Install nginx with passenger module"
+    param :config_file, required: true
+
 ### More packages?
 
 Jisota is a young gem. Please contribute with any packages that you think
@@ -193,7 +262,11 @@ is equivalent to:
 
 ## Full example
 
-An example using most of the features of Jisota:
+An example using most of the features of Jisota.
+
+Note: This was not tested and probably won't make sense in a real application.
+This is just meant to show some features. A good place to look for examples are
+in the build-in packages
 
     require 'jisota'
 
@@ -220,7 +293,10 @@ An example using most of the features of Jisota:
         param :config_file, required: true
         run do
           cmd "sudo apt get install nginx"
-          upload from: config_file, to: /etc/nginx.conf
+          upload from: config_file, to: /etc/nginx.conf do
+            update { cmd "sudo service nginx restart" }
+            create { cmd "sudo service nginx start" }
+          end
         end
       end
 
@@ -243,6 +319,34 @@ An example using most of the features of Jisota:
 
     Jisota.run(config)
 
+## Testing
+
+### Unit tests
+
+Run with `rake`
+
+### Acceptance tests
+
+Acceptance tests are not meant to be run regularly. Some of them might take a
+long time to finish. They are a way to run Jisota and the build-in packages in
+a near-real environment that is easy to destroy and rebuild.
+
+Start the vagrant:
+
+    $ (cd spec/vagrant && vagrant up)
+
+Then run acceptance specs
+
+    $ rake spec:acceptance
+
+Or run individual specs. Some of them might take a while:
+
+    $ rspec --tag type:acceptance spec/acceptance/some_spec.rb
+
+To kill vagrant and start with a fresh machine:
+
+    $ (cd spec/vagrant && vagrant destroy --force && vagrant up)
+
 ## Contributing
 
 Any pull requests, suggestions, bug reports and feedback are most welcome :)

data/Rakefile

@@ -1 +1,11 @@
 require "bundler/gem_tasks"
+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"
+  end
+end
+
+task :default => :spec

data/jisota.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "rspec", "~> 3.0.0.beta2"
   spec.add_development_dependency "guard-rspec", "~> 4.2.8"
+  spec.add_development_dependency "codeclimate-test-reporter"
 end

data/lib/jisota.rb

@@ -5,11 +5,11 @@ module Jisota
   #
   # Options allow default depenedencies to be overridden. Example:
   #
-  #     Jisota.run(config, logger: Jisota::Logger.new(verbose: true))
+  #     Jisota.run(config, logger: Jisota::Output.new(verbose: true))
   #
   def self.run(configuration, options = {})
     provisioner = options.fetch(:provisioner) { Provisioner.new }
-    logger      = options.fetch(:logger) { Logger.new }
+    logger      = options.fetch(:logger) { Output.new }
     provisioner.run(configuration, logger)
   end
 
@@ -59,5 +59,7 @@ module Jisota
   end
 end
 
+require_relative 'jisota/dsl_base'
+require_relative 'jisota/output'
 Dir[File.expand_path("../jisota/*.rb", __FILE__)].each { |file| require file }
 Dir[File.expand_path("../jisota/packages/*.rb", __FILE__)].each { |file| require file }

data/lib/jisota/collection.rb

@@ -1,3 +1,5 @@
+require 'forwardable'
+
 module Jisota
 
   ##
@@ -36,10 +38,6 @@ module Jisota
       @items.first[1]
     end
 
-    def last
-      @items.last[1]
-    end
-
     def each(&block)
       @items.values.each(&block)
     end

data/lib/jisota/command_script.rb

@@ -10,8 +10,9 @@ module Jisota
       @command = command
     end
 
-    def execute(ssh_session, logger = nil)
-      ssh_session.command(command, logger)
+    def execute(context)
+      exit_code = context.command(command)
+      exit_code == 0
     end
   end
 end

data/lib/jisota/composite_script.rb

@@ -12,9 +12,9 @@ module Jisota
       @scripts = []
     end
 
-    def execute(ssh_session, logger = nil)
+    def execute(context)
       scripts.each do |inner|
-        result = inner.execute(ssh_session, logger)
+        result = inner.execute(context)
         return false unless result
       end
       true

data/lib/jisota/configuration.rb

@@ -11,8 +11,8 @@ module Jisota
       @packages   = options.fetch(:packages) { Collection.new }
       @roles      = options.fetch(:role) { Collection.new }
       @servers    = options.fetch(:servers) { [] }
-      @ssh_engine = options.fetch(:ssh_engine) { SSHEngine }
-      DSL.new(self).instance_eval(&block) if block_given?
+      @ssh_engine = options.fetch(:ssh_engine) { SSHEngine.new }
+      DSL.new(self).evaluate(&block) if block_given?
     end
 
     def add_package(package)
@@ -39,7 +39,7 @@ module Jisota
       servers.each(&block)
     end
 
-    class DSL
+    class DSL < DSLBase
       def initialize(target)
         @target = target
       end

data/lib/jisota/dsl_base.rb

@@ -0,0 +1,12 @@
+module Jisota
+  class DSLBase
+    def evaluate(&block)
+      @outer = eval("self", block.binding)
+      instance_eval(&block)
+    end
+
+    def method_missing(method, *args, &block)
+      @outer.send(method, *args, &block)
+    end
+  end
+end

data/lib/jisota/file_script.rb

@@ -1,21 +1,119 @@
+require 'forwardable'
+
 module Jisota
   ##
   # Part of the Script duck type
   #
   # Uploads a file on execution
   class FileScript
-    attr_accessor :file
+    attr_accessor :from, :to, :create, :update
+
+    def initialize(from: , to: , create: true, update: true, &block)
+      @from = from
+      @to = to
+      @create = create
+      @update = update
+      if block_given?
+        dsl = DSL.new(self)
+        dsl.evaluate(&block)
+      end
+    end
+
+    def execute(context)
+      Executor.new(script: self, context: context).run
+    end
+
+    class DSL < DSLBase
+      def initialize(target)
+        @target = target
+      end
+
+      def create(value = nil, &block)
+        set_callback(:create=, value, &block)
+      end
+
+      def update(value = nil, &block)
+        set_callback(:update=, value, &block)
+      end
+
+      private
 
-    def initialize(file)
-      @file = file
+      def set_callback(method, value, &block)
+        raise "Can not use both a value and block on create or update" if !value.nil? && block_given?
+        if value.nil?
+          @target.send(method, ScriptBlock.new(&block))
+        else
+          @target.send(method, value)
+        end
+      end
     end
 
-    def execute(ssh_session, logger = nil)
-      logger.prefixed_message("File #{file.from} -> #{file.to}") if logger
-      logger.indent if logger
-      result = ssh_session.upload(file, logger)
-      logger.outdent if logger
-      result
+    class Executor
+      extend Forwardable
+      attr_reader :script, :context
+      def_delegators :script, :from, :to, :create, :update
+      def_delegators :context, :ssh_session, :logger
+
+      def initialize(script: , context: )
+        @script = script
+        @context = context
+      end
+
+      def tmp_file
+        @tmp_file ||= "#{tmp_dir}/#{SecureRandom.hex}"
+      end
+
+      def tmp_dir
+        "tmp/jisota"
+      end
+
+      def run
+        logger.system_message("File #{from} -> #{to}") do
+          make_temp_dir
+          upload
+          handle_file_move
+        end
+      end
+
+      def make_temp_dir
+        ssh_session.command("mkdir -p #{tmp_dir}", logger)
+      end
+
+      def upload
+        logger.system_message("Uploading #{from} -> #{tmp_file}")
+        ssh_session.upload(from: from, to: tmp_file)
+      end
+
+      def handle_file_move
+        result = ssh_session.command("cmp -s #{tmp_file} #{to}")
+        case result
+        when 0 then same_file
+        when 1 then move_with_callback(update, "File exists and update is not allowed. Skipping.")
+        when 2 then move_with_callback(create, "File does not exist and create is not allowed. Skipping.")
+        end
+      end
+
+      def same_file
+        logger.system_message("Files are the same. Skipping move.")
+        true
+      end
+
+      def move_with_callback(callback, callback_not_found_message)
+        if callback
+          result = ssh_session.command("sudo mkdir -p `dirname #{to}` && sudo mv #{tmp_file} #{to}", logger)
+          if result == 0
+            if callback.is_a?(ScriptBlock)
+              callback_script = callback.evaluate(context)
+              callback_script.execute(context)
+            else
+              true
+            end
+          end
+        else
+          logger.system_message(callback_not_found_message)
+          true
+        end
+      end
     end
   end
 end