lux 0.5 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1eb1c7d352c7326e296feace6572c226beb98ea
-  data.tar.gz: 3c42a89dbc463141bbaf9da031d63fe79ef4eed7
+  metadata.gz: 6288ab37dee1e32be74b9ae50a4e90857ee1f175
+  data.tar.gz: 004c036416714fa00796143a43338b00e307f1dc
 SHA512:
-  metadata.gz: a90943a58a1faca71b089b1f63ef8f593ea9fd419989d1dcba5acb61371f54e3ca15f90030653ac4c31e0a2401ca28a579ac8137bad043ec4ee5cdff1374fb5c
-  data.tar.gz: 2bf8bb996fce1c3fbd89569f197560789787be1f109ab2f53a8998eb78cdde766dd98a75a9c7df9d762f674c3046efea95f793607260d6f4b34090486f46e85d
+  metadata.gz: 5f7504d919e5dac6496d00ab30c625858f7d79d0d7c063396fb5b6a9dcc2fc56a5e1905b6f38b0a3fa4e57bfa1a2810458488bcb949fa9c59d5853fb881e378b
+  data.tar.gz: 8d1ebc2248e1dc3acdb87344a5a8b0308b7d8f55e14f6ca5b802b27c2a59862f2c03021e04a118a787a8e724a94f7d3f6a10b180d1b951e7b826767cafe330dc

data/README.md

@@ -27,8 +27,75 @@ Or install it yourself as:
 
 ## Usage
 
+### Command Line Tool
+
+The `lux` command simplifies a number of Docker command line operations and provides
+unix-style commands for listing and removing images, as well as rake-like tasks for
+cleaning, tidying and clobbering containers and their images.
+
 Type: `lux help` to get started
 
+### Rake Tasks
+
+When trying to write Rakefiles that start Docker containers it is useful to have a Rake
+task that represents a container image. Then you can make other tasks depend on them.
+If the task (when invoked) checks the local Docker server for the image, and
+only executes the task body if the image is not found, then you can build Docker
+dependencies elegantly into the Rakefile.
+
+The boilerplate to do this is included in Lux as a Rake Task Generator. Here are some
+examples:
+
+```ruby
+require 'lux/dockertasks'
+
+# Define a simple task.
+# The tag will default to 'latest' and the name of the task is 'busybox'
+
+DockerImageTask.new('busybox')
+
+# Define a task with a tag.
+# The name of the task is 'ubuntu', the tag is 'trusty'
+
+DockerImageTask.new('ubuntu:trusty')
+
+# Define a task with a tag and a name.
+# The name of the task is 'reedy', the image is 'ubuntu' and the tag 'reedy'
+
+DockerImageTask.new('ubuntu:reedy', :reedy)
+
+# Define a task with a fully qualified image and a block.
+# The block will be executed if the image is not found locally.
+# The task object yielded has the image and tag attributes
+# as well as the usual name and description.
+
+DockerImageTask.new('quay.io/rasputin/tools:1.0') do |t|
+  puts "You want me to build the image #{t.image}:#{t.tag}?"
+  fail "Not from here I can't..."
+end
+
+desc "Run Busybox"
+task :runb => 'busybox' do
+  sh "docker run -it busybox"
+end
+
+desc "Run Ubuntu Trusty"
+task :runu => :ubuntu do
+  sh "docker run -it ubuntu:trusty /bin/bash"
+end
+
+desc "Run Ubuntu Reedy"
+task :runr => :reedy do
+  sh "docker run -it ubuntu:reedy /bin/bash"
+end
+
+# Note how the task name does not include the tag
+desc "Run Tools"
+task :runt => 'quay.io/rasputin/tools' do
+  sh "docker run -it quay.io/turnitin/seu-tools:1.0 /bin/bash"
+end
+```
+
 ## Development
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/Rakefile.test

@@ -0,0 +1,33 @@
+require "bundler/gem_tasks"
+
+require_relative 'lib/lux/dockertasks.rb'
+
+DockerImageTask.new('busybox')
+DockerImageTask.new('ubuntu:trusty')
+DockerImageTask.new('ubuntu:reedy', :reedy)
+DockerImageTask.new('quay.io/turnitin/seu-tools:1.0') do |t|
+  puts "You want me to build the image #{t.image}:#{t.tag}?"
+  fail "Not from here I can't..."
+end
+
+desc "Run Busybox"
+task :runb => 'busybox' do
+  sh "docker run -it busybox"
+end
+
+desc "Run Ubuntu Trusty"
+task :runu => :ubuntu do
+  sh "docker run -it ubuntu:trusty /bin/bash"
+end
+
+desc "Run Ubuntu Reedy"
+task :runr => :reedy do
+  sh "docker run -it ubuntu:reedy /bin/bash"
+end
+
+desc "Run Tools"
+task :runt => 'quay.io/turnitin/seu-tools' do
+  sh "docker run -it quay.io/turnitin/seu-tools /bin/bash"
+end
+
+task :default => %w{ runb runu runt runr }

data/lib/lux/dockertasks.rb

@@ -0,0 +1,64 @@
+require 'highline/import'
+require 'rake/tasklib'
+
+# A Task Generator for Docker images
+#
+# Example:
+#   require "lux/dockertasks"
+#
+#   DockerImageTask.new('myimage') do
+#      puts "Here you can build the image"
+#   end
+#
+#   task :run => 'myimage' do
+#     sh "docker run myimage"
+#   end
+#
+class DockerImageTask < Rake::TaskLib
+
+  # The name of the task (defaults to the image)
+  attr_accessor :name
+
+  # The name of the image (if different to the task name)
+  attr_accessor :image
+
+  # Name of tag (default is latest)
+  attr_accessor :tag
+
+  # Task Description (default is 'Build Docker Image <imagename>')
+  attr_accessor :description
+
+  # The block to execute if this needs building
+  attr_accessor :build
+
+  # The image may include a tag, but the tag is never part of the name
+  # If the tag is omitted it defaults to 'latest'
+  # If a name is specified it becomes the task name.
+  #
+  def initialize(image, name=nil, &block)
+    @image, sep, @tag = image.partition(':')
+    @tag = 'latest' if @tag.empty?
+    @name = name || @image
+    @description = "Build Docker Image #{@image}:#{@tag}"
+    @build = block
+    define
+  end
+
+  def define
+    desc @description
+    task @name do
+      local_images = `docker images #{@image}`.split("\n")[1..-1].map{|l| l.split(/\s+/)}
+      local_images.select!{|i| i[1] == @tag}
+      if local_images.size == 0
+        if @build.nil?
+          HighLine.say "Build Docker Image <%=BOLD%>#{@image}:#{@tag}<%=CLEAR%> before proceeding"
+          exit 2
+        else
+          @build.call self
+        end
+      end
+    end
+    self
+  end
+
+end

data/lib/lux/version.rb

@@ -1,3 +1,3 @@
 module Lux
-  VERSION = "0.5"
+  VERSION = "0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lux
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
 platform: ruby
 authors:
 - Nick Townsend
@@ -81,8 +81,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Rakefile.test
 - bin/lux
 - lib/lux.rb
+- lib/lux/dockertasks.rb
 - lib/lux/version.rb
 - lux.gemspec
 homepage: https://github.com/townsen/lux