kaigara 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e0a7546c9c6a70c5d81bd6f4caa93af7fcb21d9
-  data.tar.gz: dabf75ee6daa3970a01581132710badf1ff27f11
+  metadata.gz: 27b2d14abab4ae27f1ff469bdc05ff998cf23b82
+  data.tar.gz: a65cda128d283f4092df23e47fbf369b2b1b7a4f
 SHA512:
-  metadata.gz: 136c3a11b6c01f2bc47392ac5e3d58159505c7c235be1eed28967fc0e33fd27c25e4442c53014d7beb33c69955a6c951d021a171f58c4de555149a68b855abca
-  data.tar.gz: 72794ea2047d69fd377ecfde7a00af314fc385a690db1c8faeae8661acc38d67c97878db677a9d87697b2abab9e46c53bc7f24db1a189ce2ce81ff1cd2be1548
+  metadata.gz: 4248c5a01785e3f72c7479f2e22d12a463232c3b7efa69e579c1a841cb64ebb362eb5e297d1fb0792feab4da61d52d075fa83ec76bc485135d004c4e502e839c
+  data.tar.gz: e38727d87078ff6dce24177fb2a2bfc2bc1ea2abbbdaf44acf572d701057f954bc6d60c86851367e8c3dc7b793bb06bfb0bb2a2b308da3225ce0b2cf60c9876a

data/.travis.yml

@@ -2,3 +2,6 @@ language: ruby
 rvm:
   - 2.2.3
 before_install: gem install bundler -v 1.11.2
+sudo: required
+services:
+    - docker

data/README.md

@@ -1,5 +1,7 @@
 # Kaigara
 
+[![Build Status](https://travis-ci.org/helios-technologies/kaigara.svg?branch=master)](https://travis-ci.org/helios-technologies/kaigara) [![Gem Version](https://badge.fury.io/rb/kaigara.svg)](https://badge.fury.io/rb/kaigara)
+
 Kaigara is an extendable shell command line for managing simple devops tasks.
 
 ## Installation

data/app/controllers/sysops.rb

@@ -4,9 +4,20 @@ require 'models/sysops/environment'
 require 'models/sysops/spec'
 
 module Kaigara
+
+  #
+  # A plugin to manage system operations
+  #
   class Sysops < BaseController
 
     desc 'create NAME', 'Create a new sysops project'
+    #
+    # Creates an folder with kaigara project. It includes:
+    # * +operations/+ - directory for future kaigara scripts
+    # * +resources/+ - directory for any sources (scripts to template, etc.)
+    # * +metadata.rb+ - file where you should store all your variables (including environment)
+    # * +Vagrantfile+ - if you use Vagrant, you know what is it
+    #
     def create(name)
       package = Package.new(name)
       package.name = name
@@ -19,18 +30,30 @@ module Kaigara
     end
 
     desc 'generate <name>', 'Generate a new operation'
+    #
+    # Generates new kaigara script in +operations/+ dir. You can use any ruby code in it.
+    #
     def generate(label)
       package = Package.new
       package.load!
       filename = File.join(package.operations_dir, package.operation_name(label))
       template('operation.rb.erb', filename)
+
+    rescue Package::MetadataNotFound
+      say "#{package.script_path} not found", :red
+      say "You may want to create a new sysops project first"
+      exit 1
     end
 
     desc 'exec', 'Execute a package'
     method_option :path, aliases: '-p', desc: 'Project path', default: '.'
+    #
+    # Executes every script in +operations/+
+    # <tt>-p</tt> <i>[path]</i>:: set project path
+    #
     def exec
       package = Package.new(options[:path])
-      say "Executing #{package.name}#{"/#{package.version}" if package.version}...", :yellow
+      say "Executing #{package.full_name}...", :yellow
       package.load!
       package.run!
     end

data/app/models/sysops/environment.rb

@@ -1,12 +1,18 @@
 module Kaigara
+
+  #
+  # This class is for managing variables and configurations.
+  #
   class Environment
-    def self.load_variables()
-      package = Package.new
-      @vars = package.load!
+    attr_accessor :vars
+
+    # Loads variables to class +op+
+    def self.load_variables(op)
+      pkg = Package.new
+      @vars = pkg.load!
       @vars.data.each_pair do |k, v|
-        Operation.send(:define_method, k.to_sym, Proc.new {v})
-        Operation::ThorShell.send(:define_method, k.to_sym, Proc.new {v})
-      end unless @vars.empty?
+        op.instance_variable_set("@#{k}".to_sym, v)
+      end if @vars
     end
   end
 end

data/app/models/sysops/operation.rb

@@ -1,20 +1,19 @@
 require 'open3'
 
 module Kaigara
+
+  #
+  # A script that +Sysops+ executes
+  #
   class Operation
+
+    #
+    # A proxy class for Thor
+    #
     class ThorShell
       include Thor::Base
       include Thor::Actions
       include Thor::Shell
-
-      no_commands do
-        def inject(opts = {})
-          opts.each do |k,v|
-            instance_eval { class << self; self end }.send(:attr_accessor, k)
-            send("#{k}=", v)
-          end
-        end
-      end
     end
 
     attr_accessor :work_dir
@@ -25,29 +24,109 @@ module Kaigara
       @shell = ThorShell.new
       @name = File.basename(path)
       @content = File.read(path)
+      Environment.load_variables(self)   # We loads variables to both shell and operation classes.
+      Environment.load_variables(@shell) # So it's available from your ruby code in +operations/+ and from our DSL.
     end
 
+    # Executes operation content
     def apply!
       @shell.say "Applying #{@name}\n--------------------", :yellow
       instance_eval @content
     end
 
+    # One of the most important parts of DSL. You can use it directly in your operations.
     def execute(cmd)
-      Environment.load_variables
       @shell.say "Running: #{cmd}", :yellow
-      stdin, stdout, stderr, wait_thr = Open3.popen3({}, cmd)
-      @shell.say stdout.read(), :green
-      @shell.say stderr.read(), :red
+      stdin, stdout, stderr, wait_thr = Open3.popen3({}, "bash -e")
+      stdin.puts(cmd)
+      Thread.new do
+        stdout.each { |l| @shell.say(l, :green) }
+      end
+      Thread.new do
+        stderr.each { |l| @shell.say(l, :red) }
+      end
       stdin.close
-      stdout.close
-      stderr.close
 
-      exit_status = wait_thr.value
-      raise 'Non zero result' if exit_status != 0
+      exit_status = wait_thr.value.exitstatus
+      if exit_status != 0
+        raise "Command `#{ cmd }` returned status code #{ exit_status }"
+      end
+    end
+
+    #
+    # Return true if the `file` exists? and the content matches the `match`
+    # If a block is given it's executed if the statement is true
+    #
+    def file_matches?(file, match)
+      if File.exists?(file)
+        if File.read(file).match(match)
+          yield if block_given?
+          return true
+        end
+      end
+      false
+    end
+
+    #
+    # Return true if the OS is Ubuntu or Debian
+    # If a block is given it's executed if the statement is true
+    #
+    def debian_family?
+      file_matches?("/etc/issue", /Ubuntu|Debian/i) do
+        yield if block_given?
+      end
+    end
+
+    #
+    # Return true if the OS is CentOS or RedHat
+    # If a block is given it's executed if the statement is true
+    #
+    def redhat_family?
+      file_matches?("/etc/redhat-release", /CentOS|Red Hat/i) do
+        yield if block_given?
+      end
+    end
+
+    #
+    # Add common additional repositories
+    #
+    def repo_extended
+      redhat_family? do
+        package("epel-release")
+        package_update
+      end
+    end
+
+    #
+    # Update the local repository cache
+    #
+    def package_update
+      if debian_family?
+        execute("apt-get update")
+      elsif redhat_family?
+        execute("yum update")
+      end
+    end
+
+    #
+    # Install the package depending on OS
+    #
+    def package(name, version = nil)
+      if debian_family?
+        execute("apt-get install -y #{ name }")
+      elsif redhat_family?
+        execute("yum install -y #{ name }")
+      else
+        raise "OS not supported"
+      end
     end
 
+    #
+    # Templates ERB template. You can use variables from metadata.rb in your templates.
+    # <tt>name</tt> - template name, without '.erb'
+    # <tt>-p</tt> - destination file. If you don't use it, the file renders to +/path-in-resources/+
+    #
     def template(name, target = nil)
-      Environment.load_variables
       tpl_file = name + '.erb'
       destination = target
       destination = "/#{tpl_file}" if destination.nil?
@@ -60,6 +139,10 @@ module Kaigara
       return destination
     end
 
+    #
+    # Renders a template, then executes the script.
+    # You should add shebang to your script.
+    #
     def script(name, path = nil)
       target = template(name, File.join( (path.nil? ? "" : path), name))
       @shell.chmod(target, 0755)

data/app/models/sysops/package.rb

@@ -1,18 +1,27 @@
 module Kaigara
   class Package
 
+    #
+    # The base project files and directories
+    #
     METADATA_FILE_NAME = 'metadata.rb'
     VAGRANT_FILE_NAME = 'Vagrantfile'
     OPERATIONS_DIR_NAME = 'operations'
     RESOURCES_DIR_NAME = 'resources'
 
+    # Project directory
     attr_accessor :work_dir
-    attr_accessor :operations_dir
+
+    # metadata.rb path
     attr_accessor :script_path
+
+    attr_accessor :operations_dir
     attr_accessor :dependencies
     attr_accessor :version
     attr_accessor :name
 
+    class MetadataNotFound < RuntimeError; end
+
     def initialize(path = '.')
       @options = {}
       @work_dir = path ? File.expand_path(path) : '.'
@@ -22,8 +31,13 @@ module Kaigara
       @spec = Spec.new(self)
     end
 
+    def full_name
+      @full_name ||= [name, version].compact.join("/")
+    end
+
     # Read and execute metadata.rb
     def load!
+      raise MetadataNotFound.new unless File.exist?(@script_path)
       script = File.read(@script_path)
       @spec.instance_eval(script)
     end
@@ -49,4 +63,3 @@ module Kaigara
     end
   end
 end
-

data/app/models/sysops/spec.rb

@@ -1,3 +1,6 @@
+#
+# Specification for a Package (project)
+#
 class Spec
   attr_accessor :environment
   def initialize(parent)

data/lib/kaigara/application.rb

@@ -1,4 +1,3 @@
-
 require 'pathname'
 
 module Kaigara

data/lib/kaigara/base_controller.rb

@@ -1,4 +1,8 @@
 module Kaigara
+
+  #
+  # Base class for all plugins
+  #
   class BaseController < Thor
     include Thor::Base
     include Thor::Actions

data/lib/kaigara/client.rb

@@ -1,4 +1,7 @@
 module Kaigara
+  #
+  # Kaigara cli
+  #
   class Client < Thor
 
     def self.exit_on_failure?

data/lib/kaigara/metadata.rb

@@ -4,7 +4,13 @@ require 'ostruct'
 module Kaigara
   class Metadata
 
+    #
+    # Storage for nested hashes
+    #
     class DeepHash < Hash
+      #
+      # Add new variable to a hash, even if it's in nested one.
+      #
       def method_missing(name, *args, &block)
         if name[-1] == '='
           key = name[0...-1]
@@ -19,15 +25,22 @@ module Kaigara
       end
     end
 
+    # Here are all variables from metadata.rb
     attr_reader :data
 
+    #
+    # You can see how it works in +metadata.rb+
+    #
     def initialize(&block)
-      hash = DeepHash.new
-      block.call(hash)
-      json = hash.to_json
-      @data = JSON.parse(json, object_class: OpenStruct)
+      hash = DeepHash.new                                # Here's a hook that changes variables storage class.
+      block.call(hash)                                   # We're passing this hash to initialize block (see metadata.rb example)
+      json = hash.to_json                                # Then we changes the type of it to json, then to OpenStruct.
+      @data = JSON.parse(json, object_class: OpenStruct) # Now we can use any variable as @var.l1.l2.l3.l4.l5 and so on
     end
 
+    #
+    # Returns a variable from @data
+    #
     def method_missing(name, *args, &block)
       return @data.send(name)
     end

data/lib/kaigara/version.rb

@@ -1,4 +1,4 @@
 module Kaigara
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kaigara
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Helios Technologies
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-14 00:00:00.000000000 Z
+date: 2016-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor