docker_sigh 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d78e6cd74497a102f6fb6acbc47e378f7fe0c0ec
+  data.tar.gz: 3c65de37d31737ed2a01ad47014e5bbf5b863d5b
+SHA512:
+  metadata.gz: 3fdd68b0d1e2e1b0e99033e7307f929c478be7df68b921a8188d8359268df25d331af9f4e51c67c91f874b157ffd9b77cc458a9c8a456825de3f531c05cfdbbe
+  data.tar.gz: 7332cac90fb68f2a636535fe90c7132d5965218ec1e72780879a64b1411b5f47d289b27491b4e0ec8b9480b2748adedf9e690f8872bdf49f1bf43bc613c90166

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in docker_sigh.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ed Ropple
+
+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,37 @@
+# `docker_sigh` #
+`docker_sigh` is an (opinionated) way of wrangling Docker containers across multiple repositories. It expects a `git-flow` environment and is designed to operate against it.
+
+## Installation ##
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'docker_sigh'
+```
+
+## Usage ##
+Add `docker_sigh` to your Rakefile:
+
+```ruby
+require "docker_sigh"
+DockerSigh::load_tasks \
+    repository_root: File.expand_path(File.dirname(__FILE__)),
+    container_name: "YOURUSERNAME/YOURCONTAINERNAME"
+```
+
+And then invoke it:
+
+    $ rake sighs:dockerize
+
+## Development ##
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing ##
+
+1. Fork it ( https://github.com/eropple/docker_sigh/fork )
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "docker_sigh"
+
+# 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

data/bin/setup

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

data/docker_sigh.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docker_sigh/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "docker_sigh"
+  spec.version       = DockerSigh::VERSION
+  spec.authors       = ["Ed Ropple"]
+  spec.email         = ["ed+dockersigh@edropple.com"]
+
+  spec.summary       = %q{A set of helper Rake tasks to make dealing with Docker a little less horrible.}
+  spec.homepage      = "https://github.com/eropple/docker_sigh"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+
+  spec.add_runtime_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency 'erber', '~> 0.1.1'
+end

data/lib/docker_sigh/version.rb

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

data/lib/docker_sigh.rb

@@ -0,0 +1,204 @@
+require "docker_sigh/version"
+
+require "erber/templater"
+
+require "fileutils"
+require "logger"
+
+require "rake"
+require "rake/file_utils"
+
+module DockerSigh
+  LOGGER = Logger.new($stderr)
+  LOGGER.level = Logger.const_get((ENV["DOCKERSIGH_VERBOSITY"] || "INFO").upcase)
+
+  def self.load_tasks(opts)
+    extend Rake::DSL
+    dockerfile_template = Util::template_url(opts)
+    dockerfile = dockerfile_template.gsub("Dockerfile.template.erb", "Dockerfile")
+
+    namespace :ds do
+      task :template do
+        Util::validate_opts(opts)
+        Util::validate_repo(opts)
+        LOGGER.debug "Beginning 'template' task."
+
+        template = Erber::Templater.new(IO.read(dockerfile_template), DockerfileMash)
+        IO.write(dockerfile, template.render(Util::generate_template_args(opts)))
+
+        LOGGER.debug "Ending 'template' task."
+      end
+      
+      task :build do
+        Util::validate_opts(opts)
+        Util::validate_repo(opts)
+        LOGGER.debug "Beginning 'build' task."
+        Dir.chdir(opts[:repository_root]) do
+          name = opts[:container_name]
+
+          ret = sh "docker build -t '#{name}:working' ."
+          raise "failed to build" unless ret
+
+          [ Util::repo_current_commit(opts),
+              Util::tag_from_branch_name(opts),
+              Util::repo_current_tags(opts) ].flatten.each do |tag|
+            ret = sh "docker tag --force #{name}:working #{name}:#{tag}"
+            raise "failed to tag with '#{tag}'" unless ret
+          end
+
+          ret = sh "docker rmi #{name}:working"
+          raise "failed to rmi working tag" unless ret
+        end
+        LOGGER.debug "Ending 'build' task."
+      end
+
+      task :clean do
+        Util::validate_opts(opts)
+        LOGGER.debug "Beginning 'clean' task."
+
+        LOGGER.debug "Deleting '#{dockerfile}'."
+        FileUtils.rm_f dockerfile
+
+        LOGGER.debug "Ending 'clean' task."
+      end
+
+      task :push do
+        LOGGER.debug "Beginning 'push' task."
+        Dir.chdir(opts[:repository_root]) do
+          name = opts[:container_name]
+          hash = Util::repo_current_commit(opts)
+          branch = Util::tag_from_branch_name(opts)
+
+          ret = sh "docker push #{name}:#{branch}"
+          raise "failed to push with branch tag" unless ret
+          ret = sh "docker push #{name}:#{hash}"
+          raise "failed to push with hash tag" unless ret
+
+        end
+        LOGGER.debug "Ending 'push' task."
+      end
+
+      task :go => [ :template, :build, :clean ]  { }
+    end
+  end
+  
+
+  module Util
+    CONTAINER_NAME_REGEX = /[a-z0-9_]\/[a-zA-Z0-9\-_.]/
+
+    def self.validate_opts(opts)
+      LOGGER.debug "Validating options: #{opts.inspect}"
+
+      raise ":container_name must be set." unless opts[:container_name]
+      raise ":container_name must match regex '#{CONTAINER_NAME_REGEX.to_s}'." \
+        unless opts[:container_name] =~ CONTAINER_NAME_REGEX
+
+      raise "If set, :default_host must be a valid hostname." \
+        unless !opts[:default_host] || Util::valid_hostname?(opts[:default_host])
+
+      raise "If set, the DOCKER_REMOTE env var must be a valid hostname." \
+        unless !ENV["DOCKER_REMOTE"] || Util::valid_hostname?(ENV["DOCKER_REMOTE"])
+
+      opts[:host] = ENV["DOCKER_REMOTE"] || opts[:default_host]
+
+      raise ":repository_root must be set." unless opts[:repository_root]
+      raise ":repository_root must exist and be a non-bare Git root." \
+        unless Dir.exist?(File.join(opts[:repository_root], ".git"))
+
+      LOGGER.debug "Options successfully validated."
+    end
+
+    def self.validate_repo(opts)
+      dockerfile_template = template_url(opts)
+      raise "'#{dockerfile_template}' must exist." unless File.exist?(dockerfile_template)
+
+      gitignore = File.join(opts[:repository_root], ".gitignore")
+      raise "'#{gitignore}' must exist." unless File.exist?(gitignore)
+      system "grep -e 'Dockerfile\|/Dockerfile' #{gitignore}"
+      raise "The repo's .gitignore must ignore the Dockerfile." unless $?
+
+      raise "The repo must be clean (no outstanding changes)." unless clean_git_root?(opts)
+    end
+
+    def self.template_url(opts)
+      File.join(opts[:repository_root], "Dockerfile.template.erb")
+    end
+
+    def self.generate_template_args(opts)
+      {
+        :host => opts[:host],
+        :parent_tag => from_directive_parent_tag(opts)
+      }
+    end
+
+    def self.repo_branch(opts)
+      Dir.chdir(opts[:repository_root]) do
+        name = `git symbolic-ref --short HEAD`.strip
+        raise "git failed to find branch" unless $? == 0
+        name
+      end
+    end
+
+    def self.tag_from_branch_name(opts)
+      repo_branch(opts).gsub("/", "-")
+    end
+
+    def self.repo_current_commit(opts)
+      hash = `git rev-parse --verify HEAD`.strip
+      raise "git failed to get hash" unless $? == 0
+      hash
+    end
+    def self.repo_current_tags(opts)
+      LOGGER.warn "Tags are not currently replicated into the Docker repository. Be advised when using release tags."
+      []
+    end
+
+    def self.from_directive_parent_tag(opts)
+      # TODO: parse .git/config and un-hardcode the git-flow prefixes
+
+      branch = repo_branch(opts)
+      case branch
+      when "develop"
+        "develop"
+      when "master"
+        "master"
+      else
+        if branch.start_with?("feature/")
+          "develop"
+        elsif branch.start_with("release/") || branch.start_with("hotfix/")
+          "master"
+        else
+          logger.warn "Unrecognized branch; can't figure out a parent tag. Assuming 'develop'."
+          "develop"
+        end
+      end
+    end
+
+    # originally from http://www.dzone.com/snippets/simple-hostname-validation
+    def self.valid_hostname?(hostname)
+      return false unless hostname
+      return false if hostname.length > 255 or hostname.scan('..').any?
+      hostname = hostname[0 ... -1] if hostname.index('.', -1)
+      return hostname.split('.').collect { |i|
+        i.size <= 63 and not (i.rindex('-', 0) or i.index('-', -1) or i.scan(/[^a-z\d-]/i).any?)
+      }.all?
+    end
+
+    def self.clean_git_root?(opts)
+      Dir.chdir opts[:repository_root] do
+        `git status | grep 'nothing to commit, working directory clean'`
+        $? == 0
+      end
+    end
+  end
+
+  class DockerfileMash < Hashie::Mash
+    def from_directive(parent_container_name)
+      if host
+        raise "host not supported yet"
+      else
+        "FROM #{parent_container_name}:#{parent_tag}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: docker_sigh
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ed Ropple
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: erber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+description: 
+email:
+- ed+dockersigh@edropple.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker_sigh.gemspec
+- lib/docker_sigh.rb
+- lib/docker_sigh/version.rb
+homepage: https://github.com/eropple/docker_sigh
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A set of helper Rake tasks to make dealing with Docker a little less horrible.
+test_files: []
+has_rdoc: