lux 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 119e6fb88367cca79ae12766fa38dfcb3265f068
-  data.tar.gz: 4e5952ebb4b318146dc3d1efa7e2dd46807565c9
+  metadata.gz: 470b01fc27a167ded67ac3e78b182c1a6de73ea8
+  data.tar.gz: db905561412bbd7af5d5b5e07a75d2b55b30f49e
 SHA512:
-  metadata.gz: fb5cdfb88d3c5b0a6a729eda74ce0b2c34c59d4f8fa85d722133b1fec84e42e389e58063eae4b89844848c81634ddb69a49df0785f8408c89d931234d2523d7e
-  data.tar.gz: 49a48c452da7bb44147434062ca80973beb24916c61ec32bb1d08a08279af1b201e51b84889f3143a947c102c69b69754a91d6ba1e7fe3ca0e728c853294e59b
+  metadata.gz: a531c424ab7e8791ab40f1d5fc754e30dbbd37adea65c1c0be5f7676e8629709183f04ad50bcd93970566091cc3237bf854f352f276b80a32264efbb7d063d85
+  data.tar.gz: 51d5965a0e686aa7ed79b3cb1906196b3c526a3ec13efd791260868977d8bb37e032677be0c0dd565666f1bc9c62766f9bcb3424a0687224f3868bffc3d57eef

data/CHANGELOG

@@ -1,7 +1,14 @@
+lux (1.0.4)
+
+ * Refactor Lux into a Module
+ * Add the Module function Lux.dockerip to return IP address of DOCKER_HOST
+
+ -- Nick Townsend <nick.townsend@mac.com> Thu, 13 Aug 2015 16:07:08 -0700
+
 lux (1.0.3)
 
-  * Disabled IPv6 in the Docker API host lookup as it causes 5 second delay
-    when using .local names.
+ * Disabled IPv6 in the Docker API host lookup as it causes 5 second delay
+   when using .local names.
 
  -- Nick Townsend <nick.townsend@mac.com> Mon, 10 Aug 2015 14:43:12 -0700
 

data/README.md

@@ -43,6 +43,20 @@ cleaning, tidying and clobbering containers and their images.
 
 Type: `lux help` to get started
 
+### Handy Functions
+
+To assist in creating Rakefiles where the location of container targets is on the Docker
+host use the module function `Lux.dockerip` as follows:
+
+```ruby
+require 'lux'
+
+DOCKER_IP = Lux.dockerip[0]
+```
+
+The function returns a second element which is a Ruby URI object representing the
+environment variable `DOCKER_HOST` or `DOCKER_URL`.
+
 ### Rake Tasks
 
 When trying to write Rakefiles that start Docker containers it is useful to have a Rake

data/bin/lux

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 #
 require 'lux'
+require 'lux/app'
 
 trap('INT') do
   print "\n"

data/lib/lux.rb

@@ -1,199 +1,32 @@
-require 'lux/version'
-
 require 'highline/import'
-require 'pathname'
-require 'shellwords'
-require 'thor'
 require 'uri'
-
-# The Thor subclass containing useful tasks shared between the Lux
-# standalone executable and Rake tasks.
-#
-class Lux::App < Thor
-
-  desc "version", "Show the version"
-  def version
-    puts "Version #{Lux::VERSION}"
-  end
-
-  desc "check", "Check the integrity of the Git repositories"
-  def check
-    repobranch = `git symbolic-ref -q HEAD`.chomp.gsub(%r{^.*/},'')
-    puts "Repository is on branch #{repobranch}"
-    `git fetch --recurse-submodules=on-demand`
-    nModuleErr = 0
-    nModuleWarn = 0
-    # Inspect the submodules currently checked out in turtle
-    submodules = Hash[`git submodule status --recursive`.split(/\n/).map do |s|
-      die "Bad submodule status #{s}" unless /^(?<flag>[-+U\s])(?<sha>[0-9a-f]{40})\s(?<path>\S+)(\s*\((?<ref>\S+)\))?$/ =~ s
-      case flag
-      when '-'
-        Highline.say "Submodule at #{path} is <%= color('not initialized', RED) %>!"
-        nModuleWarn += 1
-      when '+'
-        Highline.say "Submodule at #{path} is <%= color('not at correct commit', RED) %>!"
-        nModuleErr += 1
-      when 'U'
-        Highline.say "Submodule at #{path} is <%= color('conflicted', RED) %>!"
-        nModuleErr += 1
-      else
-        Highline.say "Submodule at #{path} is <%= color('OK', GREEN) %>"
-      end
-      [path, [flag, sha, ref]]
-    end ]
-    die "There were #{nModuleErr} submodule errors and #{nModuleWarn} warnings" if nModuleErr > 0
-    # If the submodule status (above) was good, then we can ignore any submodule issues here
-    changes = `git status --porcelain`.split(/\n/).reject do |ch|
-      die "Bad status #{ch}" unless /^(?<x>.)(?<y>.)\s(?<path1>\S+)( -> (?<path2>\S+))?$/ =~ ch
-      submodules.include? path1
-    end
-    if changes.size > 0
-      die "Repository is not clean (#{changes.size} issues), use 'git status'"
-    else
-      HighLine.say "<%= color('Repository is clean', GREEN) %>"
-    end
-  end
-
-  desc "start IMAGE", "Run a Docker image with user/home mapping"
-  method_option :env, type: :string, aliases: '-e', desc: 'Path to environment file'
-  method_option :name, type: :string, aliases: '-n', default: '<autogenerated>', desc: 'Docker container name'
-  method_option :port, type: :string, aliases: '-p', default: nil, desc: 'Expose ports (default all)'
-  def start(image)
-    image = findimage image
-    raise "no image" if image.empty?
-    puts "Starting #{image} container..."
-    me, setup_cmd = user_setup_cmd()
-    args = ["-v #{ENV['HOME']}:#{ENV['HOME']}"]
-    args << "--env-file=#{options.env}" if options.env
-    args << "--name=#{options.name}" unless options.name == '<autogenerated>'
-    args << (options.port ? "-p #{options.port}" : "-P")
-    cid = `docker run -dit #{args.join(' ')} #{image} /bin/bash`.strip
-    die "Container failed to start" unless cid =~ /^[a-z0-9]+$/
-    system "docker exec #{cid} bash -c #{setup_cmd.shellescape}"
-    puts "Type 'su [-] #{me}' then hit enter to attach to the container as yourself:"
-    Kernel.exec "docker attach #{cid}"
-  end
-
-  EXCLUDE_VARS = %w{
-    _ HOME PWD TMPDIR SSH_AUTH_SOCK SHLVL DISPLAY Apple_PubSub_Socket_Render SECURITYSESSIONID
-    XPC_SERVICE_NAME XPC_FLAGS __CF_USER_TEXT_ENCODING TERM_PROGRAM TERM_PROGRAM_VERSION TERM_SESSION_ID
-  }
-
-  desc "exec IMAGE COMMAND", "Run a command inside a Docker container"
-  method_option :env, type: :string, aliases: '-e', desc: 'Path to environment file'
-  def exec(image, *command)
-    image = findimage image
-    me, setup_cmd = user_setup_cmd
-    die "You must be within your home directory!" unless relwd = Pathname.pwd.to_s.gsub!(/^#{ENV['HOME']}/,'~')
-    command.map!{|m| m.start_with?('/') ? Pathname.new(m).relative_path_from(Pathname.pwd) : m }
-    env = ENV.reject{|k,v| EXCLUDE_VARS.include? k or v =~/\s+/}.map{|k,v| "#{k}=#{v.shellescape}"}
-    env += IO.readlines(options.env).grep(/^(?!#)/).map(&:rstrip) if options.env
-    cmd = setup_cmd + "su - #{me} -c 'cd #{relwd}; env -i #{env.join(' ')} #{command.join(' ')}'"
-    args = ["-v #{ENV['HOME']}:#{ENV['HOME']}"]
-    system "docker run --rm #{args.join(' ')} #{image} /bin/bash -c #{cmd.shellescape}"
-  end
-
-  desc "clean", "Destroy all exited containers"
-  def clean
-    exited = `docker ps -q -f status=exited`.gsub! /\n/,' '
-    if exited and not exited.empty?
-      system "docker rm #{exited}"
-    else
-      puts "No exited containers"
-    end
-  end
-
-  desc "tidy", "Remove dangling Docker images"
-  def tidy
-    images = `docker images -f "dangling=true" -q`
-    if images.size > 0
-      system 'docker rmi $(docker images -f "dangling=true" -q)'
-    else
-      puts "No dangling images"
-    end
-  end
-
-  desc "lsimages [PATTERN]", "List Docker images (with optional pattern)"
-  method_option :regex, type: :boolean, aliases: '-r', default: false, desc: 'Pattern is a regular expression'
-  def lsimages(pattern=nil)
-    if options.regex
-      pattern = '.*' unless pattern
-      rx = Regexp.new(pattern)
-      matcher = lambda {|s| rx.match(s)}
-    else
-      pattern = '*' unless pattern
-      matcher = lambda {|s| File.fnmatch?(pattern, s)}
-    end
-    imagelines = `docker images`.split("\n")[1..-1].sort
-    imagelines.each do |imageline|
-      imageinfo = imageline.split(/\s+/)
-      next if imageinfo[0] == '<none>'
-      imagename = imageinfo[0]+':'+imageinfo[1]
-      imagesize = imageinfo[-2]+' '+imageinfo[-1]
-      imageage  = imageinfo[3..-3].join(' ')
-      next unless matcher.call(imagename)
-      printf "%-54s%-16s%10s\n", imagename, imageage, imagesize
-    end
-  end
-
-  desc "rmimages [PATTERN]", "Remove Docker images (with optional pattern)"
-  method_option :regex, type: :boolean, aliases: '-r', default: false, desc: 'Pattern is a regular expression'
-  method_option :force, type: :boolean, aliases: '-f', default: false, desc: 'Do not prompt for confirmation'
-  def rmimages(pattern=nil)
-    if options.regex
-      pattern = '.*' unless pattern
-      rx = Regexp.new(pattern)
-      matcher = lambda {|s| rx.match(s)}
-    else
-      pattern = '*' unless pattern
-      matcher = lambda {|s| File.fnmatch?(pattern, s)}
-    end
-    imagelines = `docker images`.split("\n")[1..-1]
-    imagelines.each do |imageline|
-      imageinfo = imageline.split(/\s+/)
-      next if imageinfo[0] == '<none>'
-      imagename = imageinfo[0]+':'+imageinfo[1]
-      imagesize = imageinfo[-2]+' '+imageinfo[-1]
-      imageage  = imageinfo[3..-3].join(' ')
-      next unless matcher.call(imagename)
-      if options.force or (agree("Delete #{imagename} (#{imageage}, #{imagesize})? "){|q|q.echo=true})
-        `docker rmi #{options.force ? '-f':''} #{imageinfo[2]}`
-        HighLine.say "Image <%= color('#{imagename}', RED)%> deleted"
-      end
-    end
-  end
-
-  desc "clobber", "Destroy all containers (even if running!)"
-  def clobber
-    clean
-    running = `docker ps -q -f status=running`.gsub! /\n/,' '
-    if running and not running.empty?
-      system "docker rm -f #{running}"
-    else
-      puts "No running containers"
-    end
-  end
-
-  desc "dockerip", "Show DOCKER_HOST IP address"
-  def dockerip
-    docker_url = URI(ENV['DOCKER_HOST'])
-    name = docker_url.host
-    if z = Socket.gethostbyname(name) rescue nil
-        z.shift 3
-        z.each do |a|
-            name = a.unpack('CCCC').join('.') if a.size == 4
-        end
-    end
-    puts "DOCKER_HOST=#{docker_url.to_s}"
-    docker_url.host = name
-    puts "export DOCKER_HOST=#{docker_url.to_s}"
+require 'socket'
+
+module Lux
+
+  # Determine the IPv4 address of the current Docker host
+  # Used to avoid long reverse DNS lookups on .local names
+  # Returns either nil if the lookup failed, or a triplet:
+  # - the IPv4 address as a string
+  # - a URI object
+  # - a string saying which variable was used, 'URL' or 'HOST'
+  # Note that DOCKER_URL is used by the docker-api client, but
+  # as Docker uses the misleading DOCKER_HOST we fallback to that.
+  #
+  def self.dockerip
+    vars = ['DOCKER_URL', 'DOCKER_HOST']
+    var, url = vars.map{|v| [v, ENV[v]]}.find{|d| d[1]}
+    return nil unless var
+    uri = URI.parse(url)
+    name = uri.host
+    addrs = Socket.getaddrinfo(name, nil, :INET, :STREAM, 0, 0, false) rescue []
+    name = addrs.first[3] if addrs.size > 0
+    return name, var, uri
   end
 
-  private
-
   # Get the current list of images and make a guess at which one it is...
   #
-  def findimage image
+  def self.findimage image
     local_images = `docker images`.strip.split("\n")[1..-1].map{|l| l.gsub!(/^(\S+)\s+(\S+).*/,'\1:\2')}.sort
     matching_images = local_images.select{|l| l.include? image }
     if matching_images.size > 0
@@ -218,7 +51,7 @@ class Lux::App < Thor
   # - user name (defaults to current user), and
   # - a bash script setup command
   #
-  def user_setup_cmd user = `id -nu`.strip
+  def self.user_setup_cmd user = `id -nu`.strip
     [user, <<-COMMAND.gsub(/^\s*/,'').gsub(/\n/,' ; ')]
       uid=$(echo $(stat -c %u:%g #{ENV['HOME']}) | cut -d: -f2)
       useradd -M -d #{ENV['HOME']} -u $uid -s #{ENV['SHELL']} #{user}
@@ -226,7 +59,7 @@ class Lux::App < Thor
     COMMAND
   end
 
-  def die msg, rc = 1
+  def self.die msg, rc = 1
     HighLine.say HighLine.color(msg, HighLine::RED)
     exit(rc)
   end

data/lib/lux/app.rb

@@ -0,0 +1,189 @@
+require 'lux/version'
+
+require 'highline/import'
+require 'pathname'
+require 'shellwords'
+require 'thor'
+
+# The Thor subclass containing useful tasks shared between the Lux
+# standalone executable and Rake tasks.
+#
+class Lux::App < Thor
+
+  desc "version", "Show the version"
+  def version
+    puts "Version #{Lux::VERSION}"
+  end
+
+  desc "check", "Check the integrity of the Git repositories"
+  def check
+    repobranch = `git symbolic-ref -q HEAD`.chomp.gsub(%r{^.*/},'')
+    puts "Repository is on branch #{repobranch}"
+    `git fetch --recurse-submodules=on-demand`
+    nModuleErr = 0
+    nModuleWarn = 0
+    # Inspect the submodules currently checked out in turtle
+    submodules = Hash[`git submodule status --recursive`.split(/\n/).map do |s|
+      Lux.die "Bad submodule status #{s}" unless /^(?<flag>[-+U\s])(?<sha>[0-9a-f]{40})\s(?<path>\S+)(\s*\((?<ref>\S+)\))?$/ =~ s
+      case flag
+      when '-'
+        Highline.say "Submodule at #{path} is <%= color('not initialized', RED) %>!"
+        nModuleWarn += 1
+      when '+'
+        Highline.say "Submodule at #{path} is <%= color('not at correct commit', RED) %>!"
+        nModuleErr += 1
+      when 'U'
+        Highline.say "Submodule at #{path} is <%= color('conflicted', RED) %>!"
+        nModuleErr += 1
+      else
+        Highline.say "Submodule at #{path} is <%= color('OK', GREEN) %>"
+      end
+      [path, [flag, sha, ref]]
+    end ]
+    Lux.die "There were #{nModuleErr} submodule errors and #{nModuleWarn} warnings" if nModuleErr > 0
+    # If the submodule status (above) was good, then we can ignore any submodule issues here
+    changes = `git status --porcelain`.split(/\n/).reject do |ch|
+      Lux.die "Bad status #{ch}" unless /^(?<x>.)(?<y>.)\s(?<path1>\S+)( -> (?<path2>\S+))?$/ =~ ch
+      submodules.include? path1
+    end
+    if changes.size > 0
+      Lux.die "Repository is not clean (#{changes.size} issues), use 'git status'"
+    else
+      HighLine.say "<%= color('Repository is clean', GREEN) %>"
+    end
+  end
+
+  desc "start IMAGE", "Run a Docker image with user/home mapping"
+  method_option :env, type: :string, aliases: '-e', desc: 'Path to environment file'
+  method_option :name, type: :string, aliases: '-n', default: '<autogenerated>', desc: 'Docker container name'
+  method_option :port, type: :string, aliases: '-p', default: nil, desc: 'Expose ports (default all)'
+  def start(image)
+    image = Lux.findimage image
+    raise "no image" if image.empty?
+    puts "Starting #{image} container..."
+    me, setup_cmd = user_setup_cmd()
+    args = ["-v #{ENV['HOME']}:#{ENV['HOME']}"]
+    args << "--env-file=#{options.env}" if options.env
+    args << "--name=#{options.name}" unless options.name == '<autogenerated>'
+    args << (options.port ? "-p #{options.port}" : "-P")
+    cid = `docker run -dit #{args.join(' ')} #{image} /bin/bash`.strip
+    Lux.die "Container failed to start" unless cid =~ /^[a-z0-9]+$/
+    system "docker exec #{cid} bash -c #{setup_cmd.shellescape}"
+    puts "Type 'su [-] #{me}' then hit enter to attach to the container as yourself:"
+    Kernel.exec "docker attach #{cid}"
+  end
+
+  EXCLUDE_VARS = %w{
+    _ HOME PWD TMPDIR SSH_AUTH_SOCK SHLVL DISPLAY Apple_PubSub_Socket_Render SECURITYSESSIONID
+    XPC_SERVICE_NAME XPC_FLAGS __CF_USER_TEXT_ENCODING TERM_PROGRAM TERM_PROGRAM_VERSION TERM_SESSION_ID
+  }
+
+  desc "exec IMAGE COMMAND", "Run a command inside a Docker container"
+  method_option :env, type: :string, aliases: '-e', desc: 'Path to environment file'
+  def exec(image, *command)
+    image = Lux.findimage image
+    me, setup_cmd = user_setup_cmd
+    Lux.die "You must be within your home directory!" unless relwd = Pathname.pwd.to_s.gsub!(/^#{ENV['HOME']}/,'~')
+    command.map!{|m| m.start_with?('/') ? Pathname.new(m).relative_path_from(Pathname.pwd) : m }
+    env = ENV.reject{|k,v| EXCLUDE_VARS.include? k or v =~/\s+/}.map{|k,v| "#{k}=#{v.shellescape}"}
+    env += IO.readlines(options.env).grep(/^(?!#)/).map(&:rstrip) if options.env
+    cmd = setup_cmd + "su - #{me} -c 'cd #{relwd}; env -i #{env.join(' ')} #{command.join(' ')}'"
+    args = ["-v #{ENV['HOME']}:#{ENV['HOME']}"]
+    system "docker run --rm #{args.join(' ')} #{image} /bin/bash -c #{cmd.shellescape}"
+  end
+
+  desc "clean", "Destroy all exited containers"
+  def clean
+    exited = `docker ps -q -f status=exited`.gsub! /\n/,' '
+    if exited and not exited.empty?
+      system "docker rm #{exited}"
+    else
+      puts "No exited containers"
+    end
+  end
+
+  desc "tidy", "Remove dangling Docker images"
+  def tidy
+    images = `docker images -f "dangling=true" -q`
+    if images.size > 0
+      system 'docker rmi $(docker images -f "dangling=true" -q)'
+    else
+      puts "No dangling images"
+    end
+  end
+
+  desc "lsimages [PATTERN]", "List Docker images (with optional pattern)"
+  method_option :regex, type: :boolean, aliases: '-r', default: false, desc: 'Pattern is a regular expression'
+  def lsimages(pattern=nil)
+    if options.regex
+      pattern = '.*' unless pattern
+      rx = Regexp.new(pattern)
+      matcher = lambda {|s| rx.match(s)}
+    else
+      pattern = '*' unless pattern
+      matcher = lambda {|s| File.fnmatch?(pattern, s)}
+    end
+    imagelines = `docker images`.split("\n")[1..-1].sort
+    imagelines.each do |imageline|
+      imageinfo = imageline.split(/\s+/)
+      next if imageinfo[0] == '<none>'
+      imagename = imageinfo[0]+':'+imageinfo[1]
+      imagesize = imageinfo[-2]+' '+imageinfo[-1]
+      imageage  = imageinfo[3..-3].join(' ')
+      next unless matcher.call(imagename)
+      printf "%-54s%-16s%10s\n", imagename, imageage, imagesize
+    end
+  end
+
+  desc "rmimages [PATTERN]", "Remove Docker images (with optional pattern)"
+  method_option :regex, type: :boolean, aliases: '-r', default: false, desc: 'Pattern is a regular expression'
+  method_option :force, type: :boolean, aliases: '-f', default: false, desc: 'Do not prompt for confirmation'
+  def rmimages(pattern=nil)
+    if options.regex
+      pattern = '.*' unless pattern
+      rx = Regexp.new(pattern)
+      matcher = lambda {|s| rx.match(s)}
+    else
+      pattern = '*' unless pattern
+      matcher = lambda {|s| File.fnmatch?(pattern, s)}
+    end
+    imagelines = `docker images`.split("\n")[1..-1]
+    imagelines.each do |imageline|
+      imageinfo = imageline.split(/\s+/)
+      next if imageinfo[0] == '<none>'
+      imagename = imageinfo[0]+':'+imageinfo[1]
+      imagesize = imageinfo[-2]+' '+imageinfo[-1]
+      imageage  = imageinfo[3..-3].join(' ')
+      next unless matcher.call(imagename)
+      if options.force or (agree("Delete #{imagename} (#{imageage}, #{imagesize})? "){|q|q.echo=true})
+        `docker rmi #{options.force ? '-f':''} #{imageinfo[2]}`
+        HighLine.say "Image <%= color('#{imagename}', RED)%> deleted"
+      end
+    end
+  end
+
+  desc "clobber", "Destroy all containers (even if running!)"
+  def clobber
+    clean
+    running = `docker ps -q -f status=running`.gsub! /\n/,' '
+    if running and not running.empty?
+      system "docker rm -f #{running}"
+    else
+      puts "No running containers"
+    end
+  end
+
+  desc "dockerip", "Show DOCKER_HOST IP address"
+  def dockerip
+    name, var, uri = Lux.dockerip
+    Lux.die "Docker URL or HOST not found" unless name
+    puts "Found #{var}=#{uri.to_s}"
+    if uri.host != name
+      uri.host = name
+      puts "export #{var}=#{uri.to_s}"
+    end
+  end
+
+end
+
+# vim: ft=ruby sts=2 sw=2 ts=8

data/lib/lux/docker_tasks.rb

@@ -1,6 +1,7 @@
 # Extend rake with file-like Docker tasks
 #
 require 'docker'
+require 'lux'
 require 'rake'
 require 'socket'
 

data/lib/lux/version.rb

@@ -1,3 +1,3 @@
 module Lux
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lux
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Nick Townsend
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-10 00:00:00.000000000 Z
+date: 2015-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -99,6 +99,7 @@ files:
 - Rakefile.test
 - bin/lux
 - lib/lux.rb
+- lib/lux/app.rb
 - lib/lux/docker_tasks.rb
 - lib/lux/version.rb
 - lux.gemspec