ferry 1.3.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2ea374461adb3e147321f225cb172802431a78a
-  data.tar.gz: fae16da54831f76bbc8722d47c5bb8ddedad3313
+  metadata.gz: f492db93e09993eb5609bb9550f8bf3fc3076cd5
+  data.tar.gz: afca6fdd10a193d69ccf45f141c814b914f74972
 SHA512:
-  metadata.gz: 3fc0b7f1a21ab1a7cf7a6d12fcb131615f2e1ae59829464ab3d9a68a1ebd9ff24a28768023ccf1d9938b110531f3967690a5f6412471ed865529cd8356b0e26d
-  data.tar.gz: a29778e674b94c6c89296753e94c98b0bc1ade3993083e595ea4b94b613f060a938a36b104febad177318687a7bf29fd3e68c566440876a922691f33f2251713
+  metadata.gz: 9b17c36ac8df1dff74d595e7f0d1112364562f462b069207fa341986184b9df60a07d2682d672a1445067f4fba97561786d3fc322102806e662ccbf65318ac76
+  data.tar.gz: 366782e71c8fa8a83fd784cc13e965a01a3ef6fcd2b58578ff832f1c59dbaedc8b4e80bc09a5897ae1caf7a5712bf1a3ac5b6e5b004a10d6928ab3a5e0ec637d

data/README.md

@@ -1,4 +1,4 @@
-![ferry](doc/ferry_readme_icon_2.png)
+![ferry](img/ferry_readme_icon_2.png)
 
 [![Build Status](https://travis-ci.org/cmu-is-projects/ferry.svg?branch=master)](https://travis-ci.org/cmu-is-projects/ferry)
 [![Gem Version](https://badge.fury.io/rb/ferry.svg)](http://badge.fury.io/rb/ferry)

data/bin/ferry

@@ -1,5 +1,6 @@
 #!/usr/bin/ruby
 require 'ferry'
+# require 'all'
 
 OptionParser.new do |opts|
   options = {}
@@ -36,10 +37,9 @@ OptionParser.new do |opts|
     importer.import_json(opt, ARGV[0], ARGV[1])
   end
 
-  opts.on('-i', '--init', 'Initializes ferry.rb file in config directory') do |opt|
-    filemaker = Ferry::Utilities.new
-    filemaker.make_starter_file
-  end
+  # opts.on('--init', 'Installs and configures ferry') do |opt|
+  #   Ferry::DSL
+  # end
 
   opts.on("--to_csv ENVIRONMENT TABLE", 'Exports table to csv file in db/csv/[your db environment]/[your table]') do |opt|
     check_appro_args(1)

data/lib/Ferryfile

@@ -0,0 +1,3 @@
+#!/usr/bin/ruby ferry
+include Ferry::DSL
+require 'ferry/install'

data/lib/ferry/all.rb

@@ -0,0 +1,14 @@
+require 'rake'
+require 'sshkit'
+
+require 'io/console'
+
+Rake.application.options.trace = true
+
+require 'ferry/i18n'
+require 'ferry/dsl'
+require 'ferry/configuration'
+
+module Ferry
+
+end

data/lib/ferry/configuration.rb

@@ -0,0 +1,142 @@
+require_relative 'configuration/filter'
+require_relative 'configuration/question'
+require_relative 'configuration/server'
+require_relative 'configuration/servers'
+
+module Ferry
+  class Configuration
+
+    def initialize(config = nil)
+      @config ||= config
+    end
+
+    def self.env
+      @env ||= new
+    end
+
+    def self.reset!
+      @env = new
+    end
+
+    def ask(key, default=nil, options={})
+      question = Question.new(key, default, options)
+      set(key, question)
+    end
+
+    def set(key, value)
+      config[key] = value
+    end
+
+    def set_if_empty(key, value)
+      config[key] = value unless config.has_key? key
+    end
+
+    def delete(key)
+      config.delete(key)
+    end
+
+    def fetch(key, default=nil, &block)
+      value = fetch_for(key, default, &block)
+      while callable_without_parameters?(value)
+        value = set(key, value.call)
+      end
+      return value
+    end
+
+    def keys
+      config.keys
+    end
+
+    def role(name, hosts, options={})
+      if name == :all
+        raise ArgumentError.new("#{name} reserved name for role. Please choose another name")
+      end
+
+      servers.add_role(name, hosts, options)
+    end
+
+    def server(name, properties={})
+      servers.add_host(name, properties)
+    end
+
+    def roles_for(names)
+      servers.roles_for(names)
+    end
+
+    def role_properties_for(names, &block)
+      servers.role_properties_for(names, &block)
+    end
+
+    def primary(role)
+      servers.fetch_primary(role)
+    end
+
+    def backend
+      @backend ||= SSHKit
+    end
+
+    attr_writer :backend
+
+    def configure_backend
+      backend.configure do |sshkit|
+        sshkit.format           = fetch(:format)
+        sshkit.output_verbosity = fetch(:log_level)
+        sshkit.default_env      = fetch(:default_env)
+        sshkit.backend          = fetch(:sshkit_backend, SSHKit::Backend::Netssh)
+        sshkit.backend.configure do |backend|
+          backend.pty                = fetch(:pty)
+          backend.connection_timeout = fetch(:connection_timeout)
+          backend.ssh_options        = (backend.ssh_options || {}).merge(fetch(:ssh_options,{}))
+        end
+      end
+    end
+
+    def timestamp
+      @timestamp ||= Time.now.utc
+    end
+
+    def setup_filters
+      @filters = cmdline_filters.clone
+      @filters << Filter.new(:role, ENV['ROLES']) if ENV['ROLES']
+      @filters << Filter.new(:host, ENV['HOSTS']) if ENV['HOSTS']
+      fh = fetch_for(:filter,{}) || {}
+      @filters << Filter.new(:host, fh[:host]) if fh[:host]
+      @filters << Filter.new(:role, fh[:role]) if fh[:role]
+    end
+
+    def add_cmdline_filter(type, values)
+      cmdline_filters << Filter.new(type, values)
+    end
+
+    def filter list
+      setup_filters if @filters.nil?
+      @filters.reduce(list) { |l,f| f.filter l }
+    end
+
+    private
+
+    def cmdline_filters
+      @cmdline_filters ||= []
+    end
+
+    def servers
+      @servers ||= Servers.new
+    end
+
+    def config
+      @config ||= Hash.new
+    end
+
+    def fetch_for(key, default, &block)
+      if block_given?
+        config.fetch(key, &block)
+      else
+        config.fetch(key, default)
+      end
+    end
+
+    def callable_without_parameters?(x)
+      x.respond_to?(:call) && ( !x.respond_to?(:arity) || x.arity == 0)
+    end
+  end
+end

data/lib/ferry/configuration/filter.rb

@@ -0,0 +1,56 @@
+require 'ferry/configuration'
+
+module Ferry
+  class Configuration
+    class Filter
+      def initialize type, values = nil
+        raise "Invalid filter type #{type}" unless [:host,:role].include? type
+        av = Array(values).dup
+        @mode = case
+                when av.size == 0 then :none
+                when av.include?(:all) then :all
+                else type
+                end
+        @rex = case @mode
+          when :host
+            av.map!{|v| (v.is_a?(String) && v =~ /^(?<name>[-A-Za-z0-9.]+)(,\g<name>)*$/) ? v.split(',') : v }
+            av.flatten!
+            av.map! do |v|
+              case v
+              when Regexp then v
+              else
+                vs = v.to_s
+                vs =~ /^[-A-Za-z0-9.]+$/ ? vs : Regexp.new(vs)
+              end
+            end
+            Regexp.union av
+          when :role
+            av.map!{|v| v.is_a?(String) ? v.split(',') : v }
+            av.flatten!
+            av.map! do |v|
+              case v
+              when Regexp then v
+              else
+                vs = v.to_s
+                vs =~ %r{^/(.+)/$} ? Regexp.new($1) : %r{^#{vs}$}
+              end
+            end
+            Regexp.union av
+          else
+            nil
+          end
+      end
+      def filter servers
+        as = Array(servers)
+        case @mode
+        when :none then return []
+        when :all  then return servers
+        when :host
+          as.select {|s| @rex.match s.to_s}
+        when :role
+          as.select { |s| s.is_a?(String) ? false : s.roles.any? {|r| @rex.match r} }
+        end
+      end
+    end
+  end
+end

data/lib/ferry/configuration/question.rb

@@ -0,0 +1,53 @@
+module Ferry
+  module Configuration
+    module Question
+      def initialize(key, default, options = {})
+        @key, @default, @options = key, default, options
+      end
+
+      def call
+        ask_question
+        value_or_default
+      end
+
+      private
+      attr_reader :key, :default, :options
+
+      def ask_question
+        $stdout.print question
+      end
+
+      def value_or_default
+        if response.empty?
+          default
+        else
+          response
+        end
+      end
+
+      def response
+        return @response if defined? @response
+
+        @response = (gets || "").chomp
+      end
+
+      def gets
+        if echo?
+          $stdin.gets
+        else
+          $stdin.noecho(&:gets).tap{ $stdout.print "\n" }
+        end
+      rescue Errno::EIO
+        # when stdio gets closed
+      end
+
+      def question
+        I18n.t(:question, key: key, default_value: default, scope: :capistrano)
+      end
+
+      def echo?
+        (options || {}).fetch(:echo, true)
+      end
+    end
+  end
+end

data/lib/ferry/configuration/server.rb

@@ -0,0 +1,131 @@
+require 'set'
+module Ferry
+  class Configuration
+    class Server < SSHKit::Host
+      extend Forwardable
+      def_delegators :properties, :roles, :fetch, :set
+
+      def self.[](host)
+        host.is_a?(Server) ? host : new(host)
+      end
+
+      def add_roles(roles)
+        Array(roles).each { |role| add_role(role) }
+        self
+      end
+      alias roles= add_roles
+
+      def add_role(role)
+        roles.add role.to_sym
+        self
+      end
+
+      def has_role?(role)
+        roles.include? role.to_sym
+      end
+
+      def select?(options)
+        options.each do |k,v|
+          callable = v.respond_to?(:call) ? v: ->(server){server.fetch(v)}
+          result = case k
+          when :filter, :select
+            callable.call(self)
+          when :exclude
+            !callable.call(self)
+          else
+            self.fetch(k) == v
+          end
+          return false unless result
+        end
+        return true
+      end
+
+      def primary
+        self if fetch(:primary)
+      end
+
+      def with(properties)
+        properties.each { |key, value| add_property(key, value) }
+        self
+      end
+
+      def properties
+        @properties ||= Properties.new
+      end
+
+      def netssh_options
+        @netssh_options ||= super.merge( fetch(:ssh_options) || {} )
+      end
+
+      def roles_array
+        roles.to_a
+      end
+
+      def matches?(other)
+        hostname == other.hostname
+      end
+
+      private
+
+      def add_property(key, value)
+        if respond_to?("#{key}=")
+          send("#{key}=", value)
+        else
+          set(key, value)
+        end
+      end
+
+      class Properties
+
+        def initialize
+          @properties = {}
+        end
+
+        def set(key, value)
+          pval = @properties[key]
+          if pval.is_a? Hash and value.is_a? Hash
+            pval.merge!(value)
+          elsif pval.is_a? Set and value.is_a? Set
+            pval.merge(value)
+          elsif pval.is_a? Array and value.is_a? Array
+            pval.concat value
+          else
+            @properties[key] = value
+          end
+        end
+
+        def fetch(key)
+          @properties[key]
+        end
+
+        def respond_to?(method, include_all=false)
+          @properties.has_key?(method)
+        end
+
+        def roles
+          @roles ||= Set.new
+        end
+
+        def keys
+          @properties.keys
+        end
+
+        def method_missing(key, value=nil)
+          if value
+            set(lvalue(key), value)
+          else
+            fetch(key)
+          end
+        end
+
+        private
+
+        def lvalue(key)
+          key.to_s.chomp('=').to_sym
+        end
+
+      end
+
+    end
+  end
+end