pygmy 0.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d9ca74d85c1a5306760f436b11560b8dc92b63d
+  data.tar.gz: f41bd940449ec83b530da8f060d23f930a0539e1
+SHA512:
+  metadata.gz: b9932499926356627b02ac6b15765284ff380b9443f39c4da672c7b4fb5c213a77e90d243c8e45e0bc2218a75a5990b337bc485cfb26193c11948c092a70f95b
+  data.tar.gz: b9028cfc479c86481864b6c7e47a0b6d451e2f5af9b948eb371212cbda25623e0fa91ec01a68a409a5620ef3cbc8ad16dc5217de90f4688d5a5fc971d0ce8031

data/bin/pygmy

@@ -0,0 +1,221 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+require 'yaml'
+
+require 'pygmy'
+
+class PygmyBin < Thor
+  class_option :verbose, type: :boolean, aliases: '-v', default: false
+
+  desc 'up', 'Bring up pygmy services (dnsmasq, resolv, ssh-agent)'
+  long_desc <<-LONGDESC
+    Bring up pygmy services (dnsmasq, haproxy, resolv, ssh-agent)
+
+    When run, there will be two docker containers started:
+
+    - dnsmasq: to resolve DNS requests for your the domain *.docker.amazee.io
+
+    - haproxy: to forward HTTP and HTTPs requests to the docker containers running Drupal.
+
+    - ssh-agent: to keep the ssh-agent at one single place, so that all other docker containers
+      can consume the ssh key.
+
+    Additionally the local resolver (/etc/resolv.conf) will be configured to use the dnsmasq
+    instance as a nameserver
+
+    > $ pygmy up
+  LONGDESC
+  def up
+    exec_up(options)
+  end
+
+  desc 'down', 'Stop all pygmy services'
+  long_desc <<-LONGDESC
+    Stops all pygmy services.  Can optionally pass [-d|--destroy]
+    to destroy the containers when they stop.
+
+    > $ pygmy down [-d|--destroy]
+  LONGDESC
+  option :destroy, type: :boolean, aliases: 'd', default: false
+  def down
+    exec_down(options)
+  end
+
+  desc 'addkey [~/.ssh/id_rsa]', 'Add additional ssh-key'
+  long_desc <<-LONGDESC
+    Adds an additional ssh key to the ssh-agent.
+    Needs the absolute path to key as an argument
+    or uses ~/.ssh/id_rsa if none provided
+
+    > $ pygmy addkey [~/.ssh/other_key]
+  LONGDESC
+  def addkey(key = "$HOME/.ssh/id_rsa")
+    add_ssh_key(key)
+  end
+
+  desc 'version', 'Check current installed version of pygmy'
+  def version
+    puts "Pygmy - Version: #{Pygmy::VERSION}"
+  end
+
+  desc 'restart', 'Stop and restart all pygmy services'
+  long_desc <<-LONGDESC
+    Stop and restart pygmy services (dnsmasq, resolv)
+
+    > $ pygmy restart [-d|--destroy]
+  LONGDESC
+  option :destroy, type: :boolean, aliases: 'd', default: false
+  def restart
+    exec_down(options)
+    exec_up(options)
+  end
+
+  desc 'status', 'Report status of the pygmy services'
+  long_desc <<-LONGDESC
+    Checks the current status of the services managed by pygmy.
+    This includes dnsmasq, and resolv
+
+    > $ pygmy status
+  LONGDESC
+  def status
+    exec_status(options)
+  end
+
+  private
+
+
+  def exec_up(options)
+
+    if Pygmy::Dnsmasq.start
+      puts "Successfully started dnsmasq".green
+    else
+      puts "Error starting dnsmasq".red
+    end
+
+    if Pygmy::Haproxy.start
+      puts "Successfully started haproxy".green
+    else
+      puts "Error starting haproxy".red
+    end
+
+    if Pygmy::SshAgent.start
+      puts "Successfully started ssh-agent".green
+    else
+      puts "Error starting ssh-agent".red
+    end
+
+    if Pygmy::SshAgentAddKey.add_ssh_key
+      puts "Successfully injected ssh key".green
+    else
+      puts "Error injected ssh key".red
+    end
+
+    if Pygmy::Resolv.configure
+      puts "Successfully configured local resolver".green
+    else
+      puts "Error configuring local resolver".red
+    end
+  end
+
+  def exec_status(_options)
+
+    if Pygmy::Dnsmasq.running?
+      puts "[*] Dnsmasq: Running as docker container #{Pygmy::Dnsmasq.container_name}".green
+    else
+      puts "[*] Dnsmasq is not running".red
+    end
+
+    if Pygmy::SshAgent.running?
+      puts "[*] ssh-agent: Running as docker container #{Pygmy::Haproxy.container_name}".green
+    else
+      puts "[*] ssh-agent is not running".red
+    end
+
+    if Pygmy::Dnsmasq.running?
+      puts "[*] Dnsmasq: Running as docker container #{Pygmy::Dnsmasq.container_name}".green
+    else
+      puts "[*] Dnsmasq is not running".red
+    end
+
+    if Pygmy::Resolv.has_our_nameserver?
+      puts "[*] Resolv: configured with #{Pygmy::Resolv.file_nameserver_line}".green
+    else
+      puts "[*] Resolv is not configured".red
+    end
+  end
+
+
+  def add_ssh_key(key)
+
+    if Pygmy::SshAgent.running?
+      if Pygmy::SshAgentAddKey.add_ssh_key(key)
+        puts "Successfully added ssh key".green
+      else
+        puts "Error added ssh key".red
+      end
+    else
+      puts "ssh-agent is not running, cannot add key".red
+    end
+
+  end
+
+  def exec_down(options)
+    if Pygmy::Resolv.clean
+      puts "nameserver removed from resolv file".green
+    else
+      puts "Unable to remove nameserver from resolv file".red
+    end
+
+    if Pygmy::Dnsmasq.stop
+      puts "Dnsmasq container stopped".green
+      if options[:destroy]
+        if Pygmy::Dnsmasq.delete
+          puts "Dnsmasq container successfully deleted".green
+        else
+          puts "Dnsmasq container failed to delete".red
+        end
+      end
+    else
+      puts "Dnsmasq container failed to stop".red
+    end
+
+    if Pygmy::SshAgent.stop
+      puts "ssh-agent container stopped".green
+      if options[:destroy]
+        if Pygmy::SshAgent.delete
+          puts "ssh-agent container successfully deleted".green
+        else
+          puts "ssh-agent container failed to delete".red
+        end
+      end
+    else
+      puts "ssh-agent container failed to stop".red
+    end
+
+    if Pygmy::Haproxy.stop
+      puts "Haproxy container stopped".green
+      if options[:destroy]
+        if Pygmy::Haproxy.delete
+          puts "Haproxy container successfully deleted".green
+        else
+          puts "Haproxy container failed to delete".red
+        end
+      end
+    else
+      puts "Haproxy container failed to stop".red
+    end
+
+  end
+end
+
+aliases = {
+  'start' => 'up',
+  'stop'  => 'down',
+}
+
+if !ARGV.empty? && %w[-v --version].include?(ARGV.first)
+  puts "Pygmy - Version: #{Pygmy::VERSION}"
+else
+  PygmyBin.start(ARGV.map { |a| aliases.keys.include?(a) ? aliases[a] : a })
+end

data/lib/pygmy/dnsmasq.rb

@@ -0,0 +1,28 @@
+require_relative 'docker_service'
+
+module Pygmy
+  class Dnsmasq
+    extend Pygmy::DockerService
+
+    def self.image_name
+      'andyshinn/dnsmasq:2.75'
+    end
+
+    def self.container_name
+      'amazeeio-dnsmasq'
+    end
+
+    def self.domain
+      'docker.amazee.io'
+    end
+
+    def self.addr
+      '127.0.0.1'
+    end
+
+    def self.run_cmd(domain = self.domain, addr = self.addr)
+      "docker run -d -p 53:53/tcp -p 53:53/udp --name=#{Shellwords.escape(self.container_name)} " \
+      "--cap-add=NET_ADMIN #{Shellwords.escape(self.image_name)} -A /#{Shellwords.escape(domain)}/#{Shellwords.escape(addr)}"
+    end
+  end
+end

data/lib/pygmy/docker_service.rb

@@ -0,0 +1,60 @@
+require 'shellwords'
+
+module Pygmy
+  module DockerService
+    def start
+      unless self.running?
+        success = if self.container_exists?
+                    Sh.run_command(self.start_cmd).success?
+                  else
+                    Sh.run_command(self.run_cmd).success?
+                  end
+        unless success
+          raise RuntimeError.new(
+            "Failed to run #{self.container_name}.  Command #{self.run_cmd} failed"
+          )
+        end
+      end
+      self.running?
+    end
+
+    def running?(container_name = self.container_name)
+      !!(self.ps =~ /#{container_name}/)
+    end
+
+    def container_exists?(container_name = self.container_name)
+      !!(self.ps(all: true) =~ /#{container_name}/)
+    end
+
+    def ps(all: false)
+      cmd = "docker ps#{all ? ' -a' : ''}"
+      ret = Sh.run_command(cmd)
+      if ret.success?
+        return ret.stdout
+      else
+        raise RuntimeError.new("Failure running command '#{cmd}'")
+      end
+    end
+
+    def has_docker_client?
+      Sh.run_command('which docker').success?
+    end
+
+    def stop(container_name = self.container_name)
+      Sh.run_command("docker kill #{Shellwords.escape(container_name)}") if self.running?
+      !self.running?
+    end
+
+    def delete(container_name = self.container_name)
+      if self.container_exists?
+        self.stop if self.running?
+        Sh.run_command("docker rm #{Shellwords.escape(container_name)}")
+      end
+      !self.container_exists?
+    end
+
+    def start_cmd
+      "docker start #{Shellwords.escape(self.container_name)}"
+    end
+  end
+end

data/lib/pygmy/haproxy.rb

@@ -0,0 +1,24 @@
+require_relative 'docker_service'
+
+module Pygmy
+  class Haproxy
+    extend Pygmy::DockerService
+
+    def self.image_name
+      'amazeeio/haproxy'
+    end
+
+    def self.container_name
+      'amazeeio-haproxy'
+    end
+
+    def self.run_cmd()
+      "docker run -d " \
+      "-p 80:80 -p 443:443 " \
+      "--volume=/var/run/docker.sock:/tmp/docker.sock " \
+      "--restart=always " \
+      "--name=#{Shellwords.escape(self.container_name)} " \
+      "#{Shellwords.escape(self.image_name)}"
+    end
+  end
+end

data/lib/pygmy/inst_vars_to_hash.rb

@@ -0,0 +1,33 @@
+module InstVarsToHash
+  def to_s
+    to_h.to_s
+  end
+
+  def to_h
+    retval = {}
+    instance_variables.each do |iv|
+      retval[iv.to_s.delete('@').to_sym] = elem_to_h(instance_variable_get(iv))
+    end
+    retval
+  end
+
+  private
+
+  def expandable_classes
+    [ InstVarsToHash ]
+  end
+
+  def expandable_to_hash(klass)
+    expandable_classes.any?{ |k| klass == k || klass < k }
+  end
+
+  def elem_to_h(elem)
+    if elem.class == Array
+      elem.map { |el| elem_to_h(el) }
+    elsif expandable_to_hash(elem.class)
+      elem.to_h
+    else
+      elem
+    end
+  end
+end

data/lib/pygmy/linux.rb

@@ -0,0 +1,53 @@
+module Dory
+  module Linux
+    def self.bash(command)
+      system("bash -c '#{command}'")
+    end
+
+    def self.ubuntu?
+      self.bash(self.ubuntu_cmd)
+    end
+
+    def self.fedora?
+      self.bash(self.fedora_cmd)
+    end
+
+    def self.arch?
+      self.bash(self.arch_cmd)
+    end
+
+		def self.osx?
+      self.bash('uname -a | grep "Darwin" > /dev/null')
+		end
+
+    def self.ubuntu_cmd
+      %q(
+        if $(which lsb_release >/dev/null 2>&1); then
+            lsb_release -d | grep --color=auto "Ubuntu" > /dev/null
+        else
+            uname -a | grep --color=auto "Ubuntu" > /dev/null
+        fi
+      )
+    end
+
+    def self.fedora_cmd
+     %q(
+        if $(which lsb_release >/dev/null 2>&1); then
+            lsb_release -d | grep --color=auto "Fedora" > /dev/null
+        else
+            uname -r | grep --color=auto "fc" > /dev/null
+        fi
+      )
+    end
+
+    def self.arch_cmd
+     %q(
+        if $(which lsb_release >/dev/null 2>&1); then
+            lsb_release -d | grep --color=auto "Arch" > /dev/null
+        else
+            uname -a | grep --color=auto "ARCH" > /dev/null
+        fi
+      )
+    end
+  end
+end

data/lib/pygmy/resolv.rb

@@ -0,0 +1,87 @@
+require 'colorize'
+
+module Pygmy
+  module Resolv
+    def self.common_resolv_file
+      '/etc/resolv.conf'
+    end
+
+    def self.ubuntu_resolv_file
+      #'/etc/resolvconf/resolv.conf.d/base'
+      # For now, use the common_resolv_file
+      self.common_resolv_file
+    end
+
+    def self.file_comment
+      '# added by pygmy'
+    end
+
+    def self.nameserver
+      "127.0.0.1"
+    end
+
+    def self.file_nameserver_line
+      "nameserver #{self.nameserver}"
+    end
+
+    def self.nameserver_contents
+      "#{self.file_nameserver_line}  #{self.file_comment}"
+    end
+
+    def self.resolv_file
+      if Linux.ubuntu?
+        return self.ubuntu_resolv_file if Linux.ubuntu?
+      elsif Linux.fedora? || Linux.arch? || File.exist?(self.common_resolv_file)
+        return self.common_resolv_file
+      else
+        raise RuntimeError.new(
+          "Unable to determine location of resolv file"
+        )
+      end
+    end
+
+    def self.configure
+      # we want to be the first nameserver in the list for performance reasons
+      # we only want to add the nameserver if it isn't already there
+      prev_conts = self.resolv_file_contents
+      unless self.contents_has_our_nameserver?(prev_conts)
+        if prev_conts =~ /nameserver/
+          prev_conts.sub!(/nameserver/, "#{self.nameserver_contents}\nnameserver")
+        else
+          prev_conts = "#{prev_conts}\n#{self.nameserver_contents}"
+        end
+        prev_conts.gsub!(/\s+$/, '')
+        self.write_to_file(prev_conts)
+      end
+      self.has_our_nameserver?
+    end
+
+    def self.clean
+      prev_conts = self.resolv_file_contents
+      if self.contents_has_our_nameserver?(prev_conts)
+        prev_conts.gsub!(/#{Regexp.escape(self.nameserver_contents + "\n")}/, '')
+        prev_conts.gsub!(/\s+$/, '')
+        self.write_to_file(prev_conts)
+      end
+      !self.has_our_nameserver?
+    end
+
+    def self.write_to_file(contents)
+      # have to use this hack cuz we don't run as root :-(
+      puts "Requesting sudo to write to #{self.resolv_file}".green
+      Bash.run_command("echo -e '#{contents}' | sudo tee #{Shellwords.escape(self.resolv_file)} >/dev/null")
+    end
+
+    def self.resolv_file_contents
+      File.read(self.resolv_file)
+    end
+
+    def self.has_our_nameserver?
+      self.contents_has_our_nameserver?(self.resolv_file_contents)
+    end
+
+    def self.contents_has_our_nameserver?(contents)
+     !!((contents =~ /#{self.file_comment}/) || (contents =~ /#{self.file_nameserver_line}/))
+    end
+  end
+end

data/lib/pygmy/shell.rb

@@ -0,0 +1,25 @@
+require 'ostruct'
+
+module Pygmy
+  module Sh
+    def self.run_command(command)
+      stdout = `#{command}`
+      OpenStruct.new({
+        success?: $?.exitstatus == 0,
+        exitstatus: $?.exitstatus,
+        stdout: stdout
+      })
+    end
+  end
+
+  module Bash
+    def self.run_command(command)
+      stdout = `bash -c "#{command}"`
+      OpenStruct.new({
+        success?: $?.exitstatus == 0,
+        exitstatus: $?.exitstatus,
+        stdout: stdout
+      })
+    end
+  end
+end

data/lib/pygmy/ssh_agent.rb

@@ -0,0 +1,22 @@
+require_relative 'docker_service'
+
+module Pygmy
+  class SshAgent
+    extend Pygmy::DockerService
+
+    def self.image_name
+      'amazeeio/ssh-agent'
+    end
+
+    def self.container_name
+      'amazeeio-ssh-agent'
+    end
+
+    def self.run_cmd()
+      "docker run -d " \
+      "--restart=always " \
+      "--name=#{Shellwords.escape(self.container_name)} " \
+      "#{Shellwords.escape(self.image_name)}"
+    end
+  end
+end

data/lib/pygmy/ssh_agent_add_key.rb

@@ -0,0 +1,20 @@
+module Pygmy
+  class SshAgentAddKey
+    def self.image_name
+      'amazeeio/ssh-agent'
+    end
+
+    def self.container_name
+      'amazeeio-ssh-agent-add-key'
+    end
+
+    def self.add_ssh_key(key = "$HOME/.ssh/id_rsa")
+      system("docker run --rm -it " \
+      "--volume=#{key}:/#{key} " \
+      "--volumes-from=amazeeio-ssh-agent " \
+      "--name=#{Shellwords.escape(self.container_name)} " \
+      "#{Shellwords.escape(self.image_name)} " \
+      "ssh-add #{key}")
+    end
+  end
+end

data/lib/pygmy/version.rb

@@ -0,0 +1,4 @@
+module Pygmy
+  VERSION = '0.9.1'
+  DATE    = '2016-04-30'
+end

data/lib/pygmy.rb

@@ -0,0 +1,3 @@
+Gem.find_files('pygmy/**/*.rb').each do |path|
+  require path.gsub(/\.rb$/, '') unless path =~ /bot.*cli/
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: pygmy
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+platform: ruby
+authors:
+- Michael Schmid
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: ptools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: To fully and easy run a local Drupal development system you need more
+  then just a docker container with the Drupal running. Default development workflows
+  involves running multiple sites at the same time, interacting with other services
+  which are authenticated via ssh and more.Pygmy makes usre that the required Docker
+  containers are started and that youcomfortably can access the Drupal Containers
+  just via the browser.
+email: michael@amazee.io
+executables:
+- pygmy
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/pygmy
+- lib/pygmy.rb
+- lib/pygmy/dnsmasq.rb
+- lib/pygmy/docker_service.rb
+- lib/pygmy/haproxy.rb
+- lib/pygmy/inst_vars_to_hash.rb
+- lib/pygmy/linux.rb
+- lib/pygmy/resolv.rb
+- lib/pygmy/shell.rb
+- lib/pygmy/ssh_agent.rb
+- lib/pygmy/ssh_agent_add_key.rb
+- lib/pygmy/version.rb
+homepage: https://github.com/amazeeio/pygmy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: pygmy provides the required servies to run the amazee.io Drupal local development
+  environment on linux.
+test_files: []