hookit 0.12.3 → 1.0.0

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hookit
 version: !ruby/object:Gem::Version
-  version: 0.12.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Tyler Flint
-- Greg Linton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-06 00:00:00.000000000 Z
+date: 2022-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
@@ -67,34 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: excon
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -123,9 +94,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: The core framework to provide hookit scripts with re-usable components.
+description: A template, build, and configuration framework.
 email:
-- tyler@pagodabox.com
+- tylerflint@gmail.com
 executables:
 - hookit
 extensions: []
@@ -144,41 +115,22 @@ files:
 - lib/hookit/error.rb
 - lib/hookit/exit.rb
 - lib/hookit/helper.rb
-- lib/hookit/helper/cron.rb
-- lib/hookit/helper/nfs.rb
 - lib/hookit/helper/shell.rb
 - lib/hookit/helper/xml.rb
 - lib/hookit/hook.rb
 - lib/hookit/logger.rb
-- lib/hookit/platform.rb
-- lib/hookit/platform/base.rb
-- lib/hookit/platform/docker.rb
-- lib/hookit/platform/smartos.rb
-- lib/hookit/platform/ubuntu.rb
-- lib/hookit/platforms.rb
 - lib/hookit/registry.rb
 - lib/hookit/resource.rb
 - lib/hookit/resource/base.rb
-- lib/hookit/resource/cron.rb
 - lib/hookit/resource/directory.rb
 - lib/hookit/resource/execute.rb
 - lib/hookit/resource/file.rb
 - lib/hookit/resource/hook_file.rb
 - lib/hookit/resource/link.rb
-- lib/hookit/resource/logrotate.rb
-- lib/hookit/resource/mount.rb
-- lib/hookit/resource/package.rb
-- lib/hookit/resource/rsync.rb
-- lib/hookit/resource/scp.rb
-- lib/hookit/resource/service.rb
-- lib/hookit/resource/socket.rb
 - lib/hookit/resource/template.rb
-- lib/hookit/resource/warning.rb
-- lib/hookit/resource/zfs.rb
 - lib/hookit/resources.rb
-- lib/hookit/setup.rb
 - lib/hookit/version.rb
-homepage: ''
+homepage: https://github.com/tylerflint/hookit
 licenses:
 - MIT
 metadata: {}
@@ -197,10 +149,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
-summary: Hookit is a framework to provide hookit scripts with re-usable components
-  and resources via an elegant dsl.
+summary: A template, build, and configuration framework, primarily intended for CI/CD
+  scenarios where generating configuration files, code, and running tasks like compilation
+  and deployment are necessary.
 test_files: []

data/lib/hookit/helper/cron.rb

@@ -1,42 +0,0 @@
-module Hookit
-  module Helper
-    module Cron
-      
-      MINUTES = 59
-      HOURS   = 23
-      DAYS    = 31
-      MONTHS  = 12
-      WEEKDAY = 7
-      
-      def sanitize_cron(cron)
-      
-        time = cron.split(' ')
-        
-        time[0] = compatible_cron(time[0],MINUTES)
-        time[1] = compatible_cron(time[1],HOURS)
-        time[2] = compatible_cron(time[2],DAYS, 1)
-        time[3] = compatible_cron(time[3],MONTHS, 1)
-        time[4] = compatible_cron(time[4],WEEKDAY)
-      
-        time.join(' ')
-      end
-      
-      protected
-
-      # converts */x cron format into solaris compatible format
-      def compatible_cron(time, limit, start = 0)
-        if time =~ /\//
-          increment = time.split('/')[1].to_i
-          x, y      = start, []
-          for i in 0..limit/increment
-            y[i] = x
-            x    +=increment
-          end
-          time = y.join(',')
-        end
-        time
-      end
-
-    end
-  end
-end

data/lib/hookit/helper/nfs.rb

@@ -1,113 +0,0 @@
-module Hookit
-  module Helper
-    module NFS
-
-      def sanitize_network_dirs(payload)
-        net_dirs = net_dirs(payload)
-
-        net_dirs.each do |component, dirs|
-          net_dirs[component] = clean_writables(dirs)
-        end
-
-        net_dirs
-      end
-
-      def net_dirs(payload)
-        key     = payload[:storage].keys.first
-        boxfile = payload[:boxfile]
-
-        if boxfile[:shared_writable_dirs]
-          {
-            key => boxfile[:shared_writable_dirs]
-          }
-        elsif boxfile[:network_dirs].is_a? String
-          {
-            key => [boxfile[:network_dirs]]
-          }
-        elsif boxfile[:network_dirs].is_a? Array
-          {
-            key => boxfile[:network_dirs]
-          }
-        else
-          boxfile[:network_dirs] ||= {}
-        end
-
-      end
-
-      def clean_writables(dirs)
-        begin
-          dirs = dirs.map{|i| i.to_s}
-        rescue
-          dirs = [dirs].map{|i| i.to_s}
-        end
-        dirs = remove_empty(dirs)
-        dirs = filter_offensive(dirs)
-        dirs = strip_leading_slash(dirs)
-        dirs = strip_trailing_slash(dirs)
-        dirs = remove_nested(dirs)
-        dirs.uniq
-      end
-     
-      def remove_empty(dirs)
-        dirs.inject([]) do |res, elem|
-          res << elem if elem && elem != ""
-          res
-        end
-      end
-     
-      def filter_offensive(dirs)
-        dirs.inject([]) do |res, elem|
-          if elem[0] != '.'
-            # ensure not going up a directory
-            # ensure spaces are intended
-            # ensure directory is not . or /
-            unless elem =~ /(\*|\.?\.\/|(?<!\\)\s)|^\.$|^\/$/
-              res << elem
-            end
-          end
-          res
-        end       
-      end
-     
-      def strip_leading_slash(dirs)
-        dirs.inject([]) do |res, elem|
-          if elem[0] == '/'
-            elem.slice!(0)
-          end 
-          res << elem
-        end
-      end
-      
-      def strip_trailing_slash(dirs)
-        dirs.inject([]) do |res, elem|
-          if elem[-1] == '/'
-            elem.slice!(-1)
-          end
-          res << elem
-        end
-      end
-     
-      # this removes nested mounts like:
-      # tmp/
-      # tmp/cache/
-      # tmp/assets/
-      # 
-      # and keeps tmp/
-      def remove_nested(dirs)
-        dirs.sort!
-        dirs.inject([]) do |res, elem|
-          overlap = false
-          # now make sure parents dont contain children
-          res.each do |parent|
-            if elem =~ /^#{parent}\//
-              overlap = true
-            end
-          end
-          res << elem if not overlap
-          res
-        end
-      end
-
-    end
-  end
-end

data/lib/hookit/platform/base.rb

@@ -1,11 +0,0 @@
-module Hookit
-  module Platform
-    class Base
-
-      def detect?; end
-      def name; end
-      def os; end
-
-    end    
-  end
-end

data/lib/hookit/platform/docker.rb

@@ -1,19 +0,0 @@
-module Hookit
-  module Platform
-    class Docker < Base
-      
-      def detect?
-        ! `cat /proc/self/cgroup 2>/dev/null | grep docker`.empty? 
-      end
-
-      def name
-        'docker'
-      end
-
-      def os
-        'linux'
-      end
-
-    end
-  end
-end

data/lib/hookit/platform/smartos.rb

@@ -1,19 +0,0 @@
-module Hookit
-  module Platform
-    class Smartos < Base
-      
-      def detect?
-        ! `cat /etc/release 2>/dev/null | grep -i SmartOS`.empty? 
-      end
-
-      def name
-        'smartos'
-      end
-
-      def os
-        'sun'
-      end
-
-    end
-  end
-end

data/lib/hookit/platform/ubuntu.rb

@@ -1,19 +0,0 @@
-module Hookit
-  module Platform
-    class Ubuntu < Base
-      
-      def detect?
-        ! `[ -x /usr/bin/lsb_release ] && /usr/bin/lsb_release -i 2>/dev/null | grep Ubuntu`.empty?
-      end
-
-      def name
-        'ubuntu'
-      end
-
-      def os
-        'linux'
-      end
-      
-    end
-  end
-end

data/lib/hookit/platform.rb

@@ -1,10 +0,0 @@
-require 'hookit/platform/base'
-require 'hookit/platform/docker'
-require 'hookit/platform/smartos'
-require 'hookit/platform/ubuntu'
-
-module Hookit
-  module Platform
-    
-  end
-end

data/lib/hookit/platforms.rb

@@ -1,3 +0,0 @@
-Hookit.platforms.register(:docker)   { Hookit::Platform::Docker }
-Hookit.platforms.register(:smartos)  { Hookit::Platform::Smartos }
-Hookit.platforms.register(:ubuntu)   { Hookit::Platform::Ubuntu }

data/lib/hookit/resource/cron.rb

@@ -1,26 +0,0 @@
-module Hookit
-  module Resource
-    class Cron < Execute
-
-      def initialize(name)
-        super
-        timeout 60
-        cwd '/data'
-      end
-
-      protected
-
-      def run!
-        begin
-          Timeout::timeout(timeout) do
-            f = IO.popen("#{cmd} || exit 0", :err=>[:child, :out])
-            puts f.readline while true
-          end
-        rescue Timeout::Error
-          $stderr.puts 'Timed out running cron! Consider using a worker.'
-        end
-      end
-      
-    end
-  end
-end

data/lib/hookit/resource/logrotate.rb

@@ -1,38 +0,0 @@
-module Hookit
-  module Resource
-    class Logrotate < Base
-
-      field :path
-      field :filesize
-      field :max_size
-      field :count
-
-      actions :create
-      default_action :create
-
-      def initialize(name)
-        path name unless path
-        super
-      end
-
-      def run(action)
-        case action
-        when :create
-          create!
-        end
-      end
-
-      protected
-
-      def create!
-        case platform.os
-        when 'sun'
-          `logadm -c -w #{path} -s #{filesize ||= '10m'} -S #{max_size ||= '500m'} -C #{count ||= '10'} -N`
-        else
-          raise Hookit::Error::UnsupportedPlatform, "unsupported platform '#{platform.name}'"
-        end
-      end
-
-    end
-  end
-end

data/lib/hookit/resource/mount.rb

@@ -1,92 +0,0 @@
-module Hookit
-  module Resource
-    class Mount < Base
-
-      field :device
-      # field :device_type
-      # field :dump
-      field :fstype
-      field :mount_point
-      field :options
-      field :pass
-      field :supports
-
-      actions :mount, :umount, :remount, :enable, :disable
-      default_action :mount
-
-      def initialize(name)
-        mount_point(name) unless mount_point
-        pass('-') unless pass
-        super
-      end
-
-      def run(action)
-        case action
-        when :mount
-          mount!
-        when :umount
-          umount!
-        when :remount
-          umount!
-          mount!
-        when :enable
-          disable!
-          enable!
-        when :disable
-          disable!
-        end
-      end
-
-      protected
-
-      def mount!
-        ::FileUtils.mkdir_p(mount_point)
-        case platform.os
-        when 'sun'
-          run_command! "mount -O -F #{fstype} -o retry=5,timeo=300 #{options!(as_arg=true)} #{device} #{mount_point}"
-        when 'linux'
-          run_command! "mount -t #{fstype} -o retry=5,timeo=300 #{options!(as_arg=true)} #{device} #{mount_point}"
-        end
-      end
-
-      def umount!
-        run_command! "umount #{mount_point}"
-      end
-
-      def enable!
-        entry = "#{device}\t#{device =~ /^\/dev/ ? device : "-"}\t#{mount_point}\t#{fstype}\t#{pass}\tyes\t#{options!}"
-        case platform.os
-        when 'sun'
-          `echo "#{entry}" >> /etc/vfstab`
-        when 'linux'
-          `echo "#{entry}" >> /etc/fstab`
-        end
-      end
-
-      def disable!
-        case platform.os
-        when 'sun'
-          `egrep -v "#{device}.*#{mount_point}" /etc/vfstab > /tmp/vfstab.tmp; mv -f /tmp/vfstab.tmp /etc/vfstab`
-        when 'linux'
-          `egrep -v "#{device}.*#{mount_point}" /etc/fstab > /tmp/vfstab.tmp; mv -f /tmp/vfstab.tmp /etc/vfstab`
-        end
-      end
-
-      def options!(as_arg=false)
-        options = self.options.kind_of?(Array) ? self.options.join(',') : self.options
-        if as_arg
-          options ? (return "-o #{options}") : (return "")
-        end
-        options != "" ? (return "#{options}") : (return "-")
-      end
-
-      def run_command!(cmd, expect_code=0)
-        `#{cmd}`
-        code = $?.exitstatus
-        if code != expect_code
-          raise Hookit::Error::UnexpectedExit, "#{cmd} failed with exit code '#{code}'"
-        end
-      end
-    end
-  end
-end

data/lib/hookit/resource/package.rb

@@ -1,74 +0,0 @@
-module Hookit
-  module Resource
-    class Package < Base
-
-      field :package_name
-      field :source
-      field :version
-      field :scope
-
-      actions :install
-      default_action :install
-
-      def initialize(name)
-        package_name(name) unless source
-        scope :default unless scope
-        super
-      end
-
-      def run(action)
-        case action
-        when :install
-          install!
-        end
-      end
-
-      def install!
-        begin
-          install_package
-        rescue Hookit::Error::UnexpectedExit
-          if not registry("pkgsrc.#{scope}.updated")
-            update_pkg_db
-            registry("pkgsrc.#{scope}.updated", true)
-            retry
-          else
-            raise
-          end
-        end
-      end
-
-      protected
-
-      def install_package
-        `#{pkgin} -y in #{package}`
-
-        code = $?.exitstatus
-        if not code == 0
-          raise Hookit::Error::UnexpectedExit, "pkgin in #{package} failed with exit code '#{code}'"
-        end
-      end
-
-      def update_pkg_db
-        `#{pkgin} -y up`
-      end
-
-      def package
-        if version
-          "#{package_name}-#{version}"
-        else
-          package_name
-        end
-      end
-
-      def pkgin
-        case scope
-        when :default
-          "/opt/local/bin/pkgin"
-        when :gopagoda
-          "/opt/gopagoda/bin/pkgin"
-        end
-      end
-
-    end
-  end
-end

data/lib/hookit/resource/rsync.rb

@@ -1,67 +0,0 @@
-module Hookit
-  module Resource
-    class Rsync < Base
-
-      field :source
-      field :destination
-      field :wrapper
-      field :archive
-      field :recursive
-      field :checksum
-      field :compress
-
-      actions :sync
-      default_action :sync
-
-      def initialize(name)
-        source name unless source
-        super
-      end
-
-      def run(action)
-        case action
-        when :sync
-          sync!
-        end
-      end
-
-      def sync!
-        run_command! "rsync -q#{archive!}#{recursive!}#{checksum!}#{compress!} #{wrapper!} #{source} #{destination}"
-      end
-
-      def archive!
-        (return "a") if archive
-        ""
-      end
-
-      def recursive!
-        (return "r") if archive
-        ""
-      end
-
-      def checksum!
-        (return "c") if archive
-        ""
-      end
-
-      def compress!
-        (return "z") if archive
-        ""
-      end
-
-      def wrapper!
-        (return "-e '#{wrapper}'") if wrapper
-        ""
-      end
-
-      def run_command!(cmd, expect_code=0)
-        `#{cmd}`
-        code = $?.exitstatus
-        if code != expect_code
-          raise Hookit::Error::UnexpectedExit, "#{cmd} failed with exit code '#{code}'"
-        end
-      end
-
-    end
-  end
-end