dev_dock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f1a1ac8d0d731242619e6b019959babddc67264c
+  data.tar.gz: 44fef0dbde06722769ea7e31040b810c1ed130a1
+SHA512:
+  metadata.gz: 222e0fbbd9a69a97383a79c3c5d72ef9bd21a997e989debf7a72c5accb8f93d2a75112951c75979408b63b8396759461c061c6a8796761aafeb27249885003e7
+  data.tar.gz: 8c69529e65f2949cd445fea3a2001cc073268a3c37489865ad8a800aa96b40bd26eb409d9894536259917141946ab93fffb622bec142db3d5459441aa86dae8c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+dev-dock

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in dev_dock.gemspec
+gemspec
+
+gem "docker-api", "~> 1.34"

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    dev_dock (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    docker-api (1.34.2)
+      excon (>= 0.47.0)
+      multi_json
+    excon (0.62.0)
+    multi_json (1.13.1)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  dev_dock!
+  docker-api (~> 1.34)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 AGhost-7
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# DevDock
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dev_dock`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dev_dock'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dev_dock
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dev_dock.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dev_dock"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/dev_dock

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'dev_dock'
+
+$help_text = <<TEXT
+dev_dock <command> <options>
+TEXT
+
+def help(code = 1)
+	puts $help_text
+	exit code
+end
+
+if ARGV[0] == "-h" or ARGV[0] == "--help"
+	help(0)
+end
+
+if ARGV.length != 2
+	help
+end
+
+subcommand = ARGV.shift
+
+if subcommand == "start"
+	DevDock::start ARGV[0]
+elsif subcommand == "purge"
+	DevDock::purge ARGV[0]
+else
+	help
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dev_dock.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dev_dock/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dev_dock"
+  spec.version       = DevDock::VERSION
+  spec.authors       = ["AGhost-7"]
+  spec.email         = ["jonathan.boudreau.92@gmail.com"]
+
+	spec.summary       = "Manage your docker development environments."
+	spec.description   = "Manage your development environment (including editor) using docker."
+	spec.homepage      = "https://github.com/AGhost-7/dev-dock"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables   = ['dev_dock']
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/dev_dock/container.rb

@@ -0,0 +1,80 @@
+require 'docker'
+require 'dev_dock/util'
+require 'dev_dock/image'
+require 'dev_dock/volumes'
+
+module DevDock
+
+	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 image
+			@image
+		end
+
+		def volumes
+			@volumes
+		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 = [
+				'/usr/local/bin/docker',
+				'run',
+				'--privileged',
+				'--name', @name,
+				'--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
+end

data/lib/dev_dock/image.rb

@@ -0,0 +1,38 @@
+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
+end

data/lib/dev_dock/log.rb

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

data/lib/dev_dock/util.rb

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

data/lib/dev_dock/version.rb

@@ -0,0 +1,3 @@
+module DevDock
+  VERSION = "0.1.0"
+end

data/lib/dev_dock/volumes.rb

@@ -0,0 +1,98 @@
+require 'docker'
+require 'dev_dock/util'
+require 'dev_dock/log'
+
+# Automatically generated volumes based on what the image has listed in its
+# dockerfile
+
+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
+
+		def name
+			@name
+		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
+
+		# 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
+
+	# Collection representing volumes needed for then development environment
+	class DevVolumes
+		def initialize(image)
+			@image = image
+		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 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
+
+		# purges all related volumes
+		def remove
+			puts 'DevVolumes::remove'
+			list.each do |volume|
+				volume.remove
+			end
+		end
+	end
+
+end

data/lib/dev_dock.rb

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

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: dev_dock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- AGhost-7
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Manage your development environment (including editor) using docker.
+email:
+- jonathan.boudreau.92@gmail.com
+executables:
+- dev_dock
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/dev_dock
+- bin/setup
+- dev_dock.gemspec
+- lib/dev_dock.rb
+- lib/dev_dock/container.rb
+- lib/dev_dock/image.rb
+- lib/dev_dock/log.rb
+- lib/dev_dock/util.rb
+- lib/dev_dock/version.rb
+- lib/dev_dock/volumes.rb
+homepage: https://github.com/AGhost-7/dev-dock
+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.11
+signing_key: 
+specification_version: 4
+summary: Manage your docker development environments.
+test_files: []