dev_dock 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bf342db116adc7552aa15815f9e5c72407c2df0ec20b68b5ac07854cc4b90e0
-  data.tar.gz: b10c63014b4a78b3e3b201004c8ca849e00a64120ab4552bdd4b55d703bb487c
+  metadata.gz: 010bb5ac9923609562ed9d55ca2d841832b568916e72779b05610a84842b61f6
+  data.tar.gz: 11d8dc854c1e714a9d54e062be1f5d128b04560dac34178fd36fc8d3d9be816f
 SHA512:
-  metadata.gz: 254607c4792d77eb9e1efefe9c8eb59a119f24c9c9f54225a6c6cf12b4e13822ef0a6d505fad1c756701afc284cc25f552e2a585673c6bd7ee0abc35aed6a95f
-  data.tar.gz: a773de32b234716665ade28235ce1a034ba5ceabccce38c95c08477335d58b2616f4da3ea6fba7d79158ff32be405935685c79c5ace863573194ce056dc8e787
+  metadata.gz: e39ca6d9855d58bec50f06c696bb9eb2a738e5d99585b1ddfc92fa78bbcacfd24b26385d6f63f3e85e5702713681ffac543881693c3bdf7f97b09f8faad2a5cb
+  data.tar.gz: 3467307e94de12974464484fa398f0a57f075bbe06c9cbfdddb804449f01db203c4ec9081b6786fc35ed2ace9bf27371039035946c408c73ab18177a7d37794e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dev_dock (0.1.3)
+    dev_dock (0.2.0)
       docker-api (~> 1.34)
 
 GEM

data/README.md

@@ -9,7 +9,11 @@ A command utility to manage containerized development environments.
 
 ## Usage
 
-Run `dev_dock --help` for full instructions.
+Spin up a development container with `dev_dock start <container>`, for example:
+
+```bash
+dev_dock start aghost7/nodejs-dev:carbon
+```
 
 ## Development
 

data/bin/dev_dock

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'dev_dock'
+require 'dev_dock/options'
 
 def help(code = 1)
 	helpfile = File.expand_path('../../help.txt', __FILE__)
@@ -12,16 +13,18 @@ if ARGV[0] == "-h" or ARGV[0] == "--help"
 	help(0)
 end
 
-if ARGV.length != 2
-	help
-end
+options = DevDock::Options.new(ARGV)
+options.parse
 
-subcommand = ARGV.shift
+if options.error
+  puts options.error
+  help
+end
 
-if subcommand == "start"
-	DevDock::start ARGV[0]
-elsif subcommand == "purge"
-	DevDock::purge ARGV[0]
+if options.subcommand == "start"
+	DevDock::start options
+elsif options.subcommand == "purge"
+	DevDock::purge options
 else
 	help
 end

data/help.txt

@@ -1,10 +1,19 @@
-dev_dock <command> <options>
+dev_dock <subcommand> [options...] <image>
 
 subcommands:
 
   start <image>
     Start a development session.
 
+      options:
+
+        -v <Volume Specification>, --volume <Volume Specification>
+          Mount a specific volume, uses same syntax as docker's volume option.
+
+        -e <List>, --env <List>
+          Specifies additional environment variables for the container. Syntax
+          is identical to docker's.
+
   purge <image>
     Kill your container and remove all volumes tied to it.
 

data/lib/dev_dock/container.rb

@@ -5,28 +5,29 @@ require 'dev_dock/volumes'
 
 module DevDock
 
-	class DevContainer
+  class DevContainer
 
-		def initialize(image_name)
-			@image = DevDock::DevImage.new(image_name)
-			@volumes = DevDock::DevVolumes.new(@image)
-			@name = DevDock::Util::snake_case("dev_dock_#{image_name}")
-		end
+    def initialize(options)
+      @options = options
+      @image = DevDock::DevImage.new(options.image_name)
+      @volumes = DevDock::DevVolumes.new(@image)
+      @name = DevDock::Util::snake_case("dev_dock_#{options.image_name}")
+    end
 
-		def image
-			@image
-		end
+    def image
+      @image
+    end
 
-		def volumes
-			@volumes
-		end
+    def volumes
+      @volumes
+    end
 
     def docker_group
       docker_line = File
         .read('/etc/group')
         .lines
         .find { |line| line.start_with?('docker') }
-      group = docker_line and docker_line.split(':')[2]
+      group = docker_line and docker_line.split(':')[1]
       if docker_line.nil?
         group = docker_line
       else
@@ -36,61 +37,74 @@ module DevDock
       group
     end
 
-		def exist?
-			Docker::Container.get(@name)
-			true
-		rescue Docker::Error::NotFoundError
-			false
-		end
-
-		# kill container
-		def kill
-			Docker::Container.get(@name).kill		
-		end
-
-		def enable_x11(arguments)
-			arguments.push '-v'
-			arguments.push '/tmp/.X11-unix:/tmp/.X11-unix:ro'
-			arguments.push '-e'
-			arguments.push 'DISPLAY'
-		end
-
-		def run
-			arguments = [
-				'docker',
-				'run',
-				'--privileged',
-				'--name', @name,
+    def exist?
+      Docker::Container.get(@name)
+      true
+    rescue Docker::Error::NotFoundError
+      false
+    end
+
+    # kill container
+    def kill
+      Docker::Container.get(@name).kill		
+    end
+
+    def enable_x11(arguments)
+      if File.exist? '/tmp/.X11-unix'
+        Log::debug('X11 socket file found')
+        arguments.push '-v'
+        arguments.push '/tmp/.X11-unix:/tmp/.X11-unix:ro'
+        arguments.push '-e'
+        arguments.push 'DISPLAY'
+      else
+        Log::debug('Did not find X11 socket file')
+      end
+    end
+
+    def run
+      arguments = [
+        'docker',
+        'run',
+        '--privileged',
+        '--name', @name,
         '--group-add', docker_group,
-				'--net=host',
-				'--rm',
-				'-ti',
-				'--detach-keys',
-				'ctrl-q,ctrl-q',
-				'-e', 'GH_USER',
-				'-e', 'GH_PASS',
-				'-v', '/run/docker.sock:/var/run/docker.sock'
-			]
-
-			['workspaces', '.gitconfig', '.ssh'].each do |directory|
-				arguments.push '-v', "#{ENV['HOME']}/#{directory}:/home/#{@image.user}/#{directory}"
-			end
-
-			if RUBY_PLATFORM == "x86_64-linux"
-				enable_x11(arguments)
-				arguments.push '-v', '/etc/localhost:/etc/localhost:ro'
-			end
-
-			@volumes.list.each do |volume|
-				arguments.push '--mount', "source=#{volume.name},target=#{volume.path}"
-			end
-
-			arguments.push @image.name
-
-			arguments.push 'tmux'
-			arguments.push 'new'
-
-			exec *arguments
-		end
-	end
+        '--net=host',
+        '--rm',
+        '-ti',
+        '--detach-keys',
+        'ctrl-q,ctrl-q',
+        '-e', 'GH_USER',
+        '-e', 'GH_PASS',
+        '-v', '/run/docker.sock:/var/run/docker.sock'
+      ]
+
+      ['workspaces', '.gitconfig', '.ssh'].each do |directory|
+        arguments.push '-v', "#{ENV['HOME']}/#{directory}:/home/#{@image.user}/#{directory}"
+      end
+
+      if RUBY_PLATFORM.start_with?("x86_64-linux")
+        enable_x11(arguments)
+        arguments.push '-v', '/etc/localhost:/etc/localhost:ro'
+      end
+
+      @volumes.list.each do |volume|
+        arguments.push '--mount', "source=#{volume.name},target=#{volume.path}"
+      end
+
+      @options.volumes.each do |volume|
+        arguments.push '-v', volume
+      end
+
+      @options.environment.each do |environment|
+        arguments.push '-e', environment
+      end
+
+      arguments.push @image.name
+
+      arguments.push 'tmux'
+      arguments.push 'new'
+
+      exec *arguments
+    end
+  end
 end

data/lib/dev_dock/image.rb

@@ -2,37 +2,37 @@ require 'docker'
 
 module DevDock
 
-	class DevImage
-
-		def initialize(name)
-			@name = name
-			@container_config = nil
-		end
-
-		def name
-			@name
-		end
-
-		def exist?
-			Docker::Image::exist?(@name)
-		end
-
-		def pull
-			# for some reason pulling images isn't part of the api?
-			`docker pull #{name}`
-		end
-
-		def container_config
-			if @container_config.nil?
-				image = Docker::Image.get(@name)
-				@container_config = image.json['ContainerConfig']
-			end
-			@container_config
-		end
-
-		def user
-			return container_config['User']
-		end
-
-	end
+  class DevImage
+
+    def initialize(image_name)
+      @name = image_name
+      @container_config = nil
+    end
+
+    def name
+      @name
+    end
+
+    def exist?
+      Docker::Image::exist?(@name)
+    end
+
+    def pull
+      # for some reason pulling images isn't part of the api?
+      `docker pull #{@name}`
+    end
+
+    def container_config
+      if @container_config.nil?
+        image = Docker::Image.get(@name)
+        @container_config = image.json['ContainerConfig']
+      end
+      @container_config
+    end
+
+    def user
+      return container_config['User']
+    end
+
+  end
 end

data/lib/dev_dock/log.rb

@@ -1,13 +1,13 @@
 module DevDock
-	module Log
-		def self.info(*stuff)
-			puts *stuff
-		end
+  module Log
+    def self.info(*stuff)
+      puts *stuff
+    end
 
-		def self.debug(*stuff)
-			if ENV['DEV_DOCK_DEBUG'] == '1'
-				puts *stuff
-			end
-		end
-	end
+    def self.debug(*stuff)
+      if ENV['DEV_DOCK_DEBUG'] == '1'
+        puts *stuff
+      end
+    end
+  end
 end

data/lib/dev_dock/options.rb

@@ -0,0 +1,83 @@
+module DevDock
+
+  class Options
+
+    def initialize(argv)
+      @volumes = []
+      @environment = []
+      @subcommand = nil
+      @error = nil
+      @argv = argv
+    end
+
+    def parse
+      parse_subcommand @argv[0]
+      if not @error
+        if @subcommand == "start"
+          parse_options @argv.slice(1, @argv.length)
+        end
+        if not @error
+          @image_name = @argv.last
+        end
+      end
+    end
+
+    def parse_subcommand(arg)
+      if arg == 'start' or arg == 's'
+        @subcommand = 'start'
+      elsif arg == 'purge' or arg == 'p'
+        @subcommand = 'purge'
+      else
+        @error = "Invalid subcommand #{arg}"
+      end
+    end
+
+    def parse_options(argv)
+      i = 0
+      while argv[i + 1]
+        arg = argv[i]
+        if arg == '--volume' or arg == '-v'
+          @volumes.push argv[i + 1]
+          i += 1
+        elsif arg == '--env' or arg == '-e'
+          if not argv[i + 2] or not argv[i + 1]
+            @error = "Invalid use of option #{arg}"
+            break
+          else
+            @environment.push argv[i + 1]
+            i += 1
+          end
+        else
+          @error = "Invalid option: #{arg}"
+          break
+        end
+        i += 1
+      end
+    end
+
+    def subcommand
+      @subcommand
+    end
+
+    def error
+      @error
+    end
+
+    def volumes
+      @volumes
+    end
+
+    def image_name
+      @image_name
+    end
+
+    def environment
+      @environment
+    end
+
+    def inspect
+      "Subcommand: #{@subcommand}, Image: #{@image_name}, Volumes: #{volumes}, Environment: "
+    end
+
+  end
+end

data/lib/dev_dock/util.rb

@@ -1,8 +1,8 @@
 module DevDock
-	module Util
-		def self.snake_case(characters)
-			characters.downcase.gsub(/\W/, '_')
-		end
-	end
+  module Util
+    def self.snake_case(characters)
+      characters.downcase.gsub(/\W/, '_')
+    end
+  end
 end
 

data/lib/dev_dock/version.rb

@@ -1,3 +1,3 @@
 module DevDock
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/dev_dock/volumes.rb

@@ -7,92 +7,92 @@ require 'dev_dock/log'
 
 module DevDock
 
-	# Volume which is needed for the development environment
-	class DevVolume
-		def initialize(image_name, path)
-			@path = path
-			@name = DevDock::Util::snake_case("dev_dock_#{image_name}#{path}")
-		end
+  # Volume which is needed for the development environment
+  class DevVolume
+    def initialize(image_name, path)
+      @path = path
+      @name = DevDock::Util::snake_case("dev_dock_#{image_name}#{path}")
+    end
 
-		def name
-			@name
-		end
+    def name
+      @name
+    end
 
-		def path
-			@path
-		end
+    def path
+      @path
+    end
 
-		# returns true if the volume exists
-		def exist?
-			volumes = Docker::Util.parse_json(Docker.connection.get('/volumes'))["Volumes"]
-			Log::debug("Volumes in docker: #{volumes}")
-			volumes.any? { |volume| volume['Name'] == @name }
-		end
+    # returns true if the volume exists
+    def exist?
+      volumes = Docker::Util.parse_json(Docker.connection.get('/volumes'))["Volumes"]
+      Log::debug("Volumes in docker: #{volumes}")
+      volumes.any? { |volume| volume['Name'] == @name }
+    end
 
-		# creates the volume if it does not exist
-		def create
-			Log::debug("Checking volume #{@name} for path #{@path}")
-			if !exist?
-				Log::info("Creating volume #{@name}")
-				Docker::Volume.create(@name)
-			end
-		end
+    # creates the volume if it does not exist
+    def create
+      Log::debug("Checking volume #{@name} for path #{@path}")
+      if !exist?
+        Log::info("Creating volume #{@name}")
+        Docker::Volume.create(@name)
+      end
+    end
 
-		# removes the volume if it exists
-		def remove
-			Log::debug("Checking volume #{@name} for path #{@path}")
-			if exist?
-				Log::info("Removing volume #{@name})")
-				Docker::Volume.get(@name).remove
-			end
-		end
-	end
+    # removes the volume if it exists
+    def remove
+      Log::debug("Checking volume #{@name} for path #{@path}")
+      if exist?
+        Log::info("Removing volume #{@name})")
+        Docker::Volume.get(@name).remove
+      end
+    end
+  end
 
-	# Collection representing volumes needed for then development environment
-	class DevVolumes
-		def initialize(image)
-			@image = image
-		end
+  # Collection representing volumes needed for then development environment
+  class DevVolumes
+    def initialize(image)
+      @image = image
+    end
 
-		def name
-			@name
-		end
+    def name
+      @name
+    end
 
-		# returns a list of volumes with their names and paths
-		def list
-			if @image.container_config['Volumes'].nil?
-				[]
-			else
-				@image.container_config['Volumes'].keys.map do |path|
-						DevVolume.new(@image.name, path)
-				end
-			end
-		end
+    # returns a list of volumes with their names and paths
+    def list
+      if @image.container_config['Volumes'].nil?
+        []
+      else
+        @image.container_config['Volumes'].keys.map do |path|
+          DevVolume.new(@image.name, path)
+        end
+      end
+    end
 
-		# returns the volume for the given volume path
-		def get(path)
-			if ! @image.container_config['Volumes'].keys.includes? path
-				nil
-			else
-				DevVolume.new(@image.name, path)
-			end
-		end
+    # returns the volume for the given volume path
+    def get(path)
+      if ! @image.container_config['Volumes'].keys.includes? path
+        nil
+      else
+        DevVolume.new(@image.name, path)
+      end
+    end
 
-		# creates all desired volumes based on the configuration in the image
-		def create
-			Log::debug 'DevVolumes::create'
-			list.each do |volume|
-				volume.create
-			end
-		end
+    # creates all desired volumes based on the configuration in the image
+    def create
+      Log::debug 'DevVolumes::create'
+      list.each do |volume|
+        volume.create
+      end
+    end
 
-		# purges all related volumes
-		def remove
-			puts 'DevVolumes::remove'
-			list.each do |volume|
-				volume.remove
-			end
-		end
-	end
+    # purges all related volumes
+    def remove
+      Log::debug 'DevVolumes::remove'
+      list.each do |volume|
+        volume.remove
+      end
+    end
+  end
 
 end

data/lib/dev_dock.rb

@@ -3,24 +3,24 @@ require "dev_dock/log"
 
 module DevDock
 
-	def self.start(name)
-		container = DevDock::DevContainer.new(name)
+  def self.start(options)
+    container = DevDock::DevContainer.new(options)
 
-		if not container.image.exist?
-			Log::info('image does not exist, pulling')
-			container.image.pull
-		end
-		container.volumes.create
+    if not container.image.exist?
+      Log::info('image does not exist, pulling')
+      container.image.pull
+    end
+    container.volumes.create
 
-		container.run
-	end
+    container.run
+  end
 
-	def self.purge(name)
-		container = DevDock::DevContainer.new(name)
-		if container.exist?
-			container.kill
-		end
-		container.volumes.remove
-	end
+  def self.purge(options)
+    container = DevDock::DevContainer.new(options)
+    if container.exist?
+      container.kill
+    end
+    container.volumes.remove
+  end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dev_dock
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - AGhost-7
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-01 00:00:00.000000000 Z
+date: 2018-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,6 +92,7 @@ files:
 - lib/dev_dock/container.rb
 - lib/dev_dock/image.rb
 - lib/dev_dock/log.rb
+- lib/dev_dock/options.rb
 - lib/dev_dock/util.rb
 - lib/dev_dock/version.rb
 - lib/dev_dock/volumes.rb