docker-template 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f3b7843f510727766a84aa47a990fa24e1d75db
+  data.tar.gz: 385b436c17f1ac1c3dcf71236f0d80c833945384
+SHA512:
+  metadata.gz: 4d0e8cb2c9bb3f852be270b072abf34b7cbc8b895d5e3e61c4191af9f21e6e7dacda55e2970b93722add97f0c41e5621d1d5f4a37239274b2ccfb106ced82dcf
+  data.tar.gz: f7615f982ea856ee912d46fe5e2973c0a6932f34d61b0f47c176928b01fb07a7ae928b6c2fdfaff116f25e80c1acb431fc96381ee98666ce0d33e28b41d20732

data/Gemfile

@@ -0,0 +1,13 @@
+# Frozen-string-literal: true
+# Copyright: 2015 Jordon Bedwell - Apache v2.0 License
+# Encoding: utf-8
+
+source "https://rubygems.org"
+gem "rake", :require => false
+gemspec
+
+group :development do
+  gem "guard-rspec", :require => false
+  gem "benchmark-ips", :require => false
+  gem "pry", :require => false
+end

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2015 Jordon Bedwell
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,20 @@
+[![Build Status](https://travis-ci.org/envygeeks/docker-template.svg?branch=master)][travis]
+[![Coverage Status](https://coveralls.io/repos/envygeeks/docker-template/badge.svg?branch=master&service=github)][coveralls]
+[![Code Climate](https://codeclimate.com/github/envygeeks/docker-template/badges/gpa.svg)][codeclimate]
+
+[codeclimate]: https://codeclimate.com/github/envygeeks/docker-template
+[coveralls]: https://coveralls.io/github/envygeeks/docker-template?branch=master
+[travis]: https://travis-ci.org/envygeeks/docker-template
+
+# Docker Template
+
+Docker template is a way to organize your Docker repos into multiple types with
+multiple templates for multiple tags but those templates aren't actually templates,
+they are JSON or YAML files and copy folders with tons of shared or split data.
+The idea is that you can have many tags for a single repo and that each tag
+can have many different things going on.
+
+Docker template makes it so that you can facilitate and organize those things in
+a clean way and just get work done.  It also makes building "scratch" images 100%
+easier for anybody by doing most of the work for you and just asking that you
+build the file system script that pumps out a tar.gz file.

data/Rakefile

@@ -0,0 +1,20 @@
+# Frozen-string-literal: true
+# Copyright: 2015 Jordon Bedwell - Apache v2.0 License
+# Encoding: utf-8
+
+$:.unshift(File.expand_path("../lib", __FILE__))
+require "rspec/core/rake_task"
+task :default => [:spec]
+RSpec::Core::RakeTask.new :spec
+task :test => :spec
+
+task :build do
+  exec "bundle", "exec", "bin/docker-template", *ARGV[
+    1..-1
+  ]
+end
+
+task :pry do
+  exec "bundle", "exec", "pry", "-Ilib/", \
+    "-rdocker/template"
+end

data/lib/docker/template.rb

@@ -0,0 +1,86 @@
+# Frozen-string-literal: true
+# Copyright: 2015 Jordon Bedwell - Apache v2.0 License
+# Encoding: utf-8
+
+require "docker/template/version"
+require "docker/template/patches"
+
+require "docker"
+require "forwardable"
+require "json"
+require "erb"
+
+module Docker
+  module Template module_function
+    autoload :Util, "docker/template/util"
+    autoload :Config, "docker/template/config"
+    autoload :Ansi, "docker/template/ansi"
+    autoload :Parser, "docker/template/parser"
+    autoload :Routable, "docker/template/routable"
+    autoload :Interface, "docker/template/interface"
+    autoload :Metadata, "docker/template/metadata"
+    autoload :Stream, "docker/template/stream"
+    autoload :Safe, "docker/template/safe"
+    autoload :Repo, "docker/template/repo"
+    autoload :Error, "docker/template/error"
+    autoload :Common, "docker/template/common"
+    autoload :Rootfs, "docker/template/rootfs"
+    autoload :Scratch, "docker/template/scratch"
+    autoload :Simple, "docker/template/simple"
+    autoload :Alias, "docker/template/alias"
+    autoload :Auth, "docker/template/auth"
+
+    def config
+      return @config ||= begin
+        Config.new
+      end
+    end
+
+    #
+
+    def root
+      return @root ||= begin
+        Pathname.new(Dir.pwd)
+      end
+    end
+
+    # The location of the standard repos/ dir, you can change this by adding
+    # `repos_dir` into your configuration file. I'm not saying it has to be but
+    # it should probably be relative rather than absolute, ther are no
+    # guarantees that an absolute path will work.
+
+    def repos_root
+      return @repos_root ||= begin
+        root.join(config["repos_dir"])
+      end
+    end
+
+    # Provides the root to Docker template, wherever it is installed so that
+    # we can do things, mostly ignore files for the profiler.  Otherwise it's
+    # not really used, it's just an encapsulator.
+
+    def gem_root
+      return @gem_root ||= begin
+        path = File.expand_path("../../", __dir__)
+        Pathname.new(path)
+      end
+    end
+
+    # Provides the templates directory so you can quickly pull a template
+    # from our templates and use it if you wish to.
+
+    def template_root
+      return @template_root ||= begin
+        gem_root.join("lib/docker/template/templates")
+      end
+    end
+
+    #
+
+    def get(name, data = {})
+      data = Util::Data.new(data)
+      template = template_root.join("#{name}.erb").read
+      ERB.new(template).result(data._binding)
+    end
+  end
+end

data/lib/docker/template/alias.rb

@@ -0,0 +1,28 @@
+module Docker
+  module Template
+    class Alias
+      def initialize(aliased)
+        @aliased = aliased
+      end
+
+      #
+
+      def build
+        Util.notify_alias(@aliased)
+        prebuild unless @aliased.parent_img
+        @aliased.parent_img.tag(@aliased.repo.to_tag_h)
+        @aliased.push
+      end
+
+      #
+
+      private
+      def prebuild
+          repo = @aliased.parent_repo
+        simple = @aliased.repo.type == "simple"
+        @aliased.class.new(repo, @aliased.rootfs_img) unless simple
+        @aliased.class.new(repo).build if simple
+      end
+    end
+  end
+end

data/lib/docker/template/ansi.rb

@@ -0,0 +1,75 @@
+# Frozen-string-literal: true
+# Copyright: 2015 Jordon Bedwell - Apache v2.0 License
+# Encoding: utf-8
+
+module Docker
+  module Template
+    module Ansi module_function
+      Escape = "%c" % 27
+      Match = /#{Escape}\[(?:\d+)(?:;\d+)?(j|k|m|s|u|A|B)|\e\(B\e\[m/ix.freeze
+      Colors = { :red => 31, :green => 32, :black => 30, :magenta => 35,
+        :yellow => 33, :white => 37, :blue => 34, :cyan => 36 }
+
+      # Strip ANSI from the current string.  It also strips cursor stuff,
+      # well some of it, and it also strips some other stuff that a lot of
+      # the other ANSI strippers don't.
+
+      def strip(str)
+        str.gsub Match, ""
+      end
+
+      # Reset the vterm view if it's supported.  Depending on how badly
+      # your vterm is implemented it might reset rather than clear scrollback
+      # with a few empty lines added on the top.
+
+      def clear
+        $stdout.print("%c[H%c[2J" % [27, 27])
+      end
+
+      #
+
+      def has?(str)
+        !!(str =~ Match)
+      end
+
+      # Jump the cursor up and then back down or just up and down.  This is
+      # useful when streaming async downloads from something like Docker.  It
+      # also works better than using `tput`
+
+      def jump(str = "", up: nil, down: nil, both: nil, clear: true)
+        str = clear_line(str) if clear
+
+        return "%c[%dA%s%c[%dB" % [27, up || both, str, 27, down || both] if (up && down) || both
+        up ? "%c[%dA%s" % [27, up, str] : "%s%c[%dB" % [str, 27, down]
+      end
+
+      # Reset the color back to the default color so that you do not leak any
+      # colors when you move onto the next line. This is probably normally
+      # used as part of a wrapper so that we don't leak colors.
+
+      def reset(str = "")
+        @ansi_reset ||= "%c[0m" % 27
+        "#{@ansi_reset}#{str}"
+      end
+
+      #
+
+      def clear_line(str = "")
+        @ansi_clear_line ||= "%c[2K\r" % 27
+        "#{@ansi_clear_line}#{str}\r"
+      end
+
+      # SEE: `self::Colors` for a list of methods.  They are mostly
+      # standard base colors supported by pretty much any xterm-color, we do
+      # not need more than the base colors so we do not include them.
+      # Actually... if I'm honest we don't even need most of the
+      # base colors.
+
+      Colors.each do |color, num|
+        define_method color do |str|
+          "#{"%c" % 27}[#{num}m#{str}#{reset}"
+        end; module_function color
+      end
+    end
+  end
+end

data/lib/docker/template/auth.rb

@@ -0,0 +1,25 @@
+module Docker
+  module Template
+    module Auth
+      module_function
+
+      def auth!
+        return unless login = get_info
+        login["auths"].each do |server, auth|
+          username, password = Base64.decode64(auth["auth"]).split(":", 2)
+          Docker.authenticate!({
+            "username" => username,
+            "serveraddress" => server,
+            "email" => auth["email"],
+            "password" => password
+          })
+        end
+      end
+
+      def get_info
+        path = Pathname.new("~/.docker/config.json").expand_path
+        return JSON.parse(path.read) if path.exist?
+      end
+    end
+  end
+end

data/lib/docker/template/common.rb

@@ -0,0 +1,126 @@
+# Frozen-string-literal: true
+# Copyright: 2015 Jordon Bedwell - Apache v2.0 License
+# Encoding: utf-8
+
+module Docker
+  module Template
+    class Common
+      CopyMethods = [
+        :setup_context, :copy_global,
+        :copy_all, :copy_type, :copy_tag, :build_context,
+        :verify_context].freeze
+
+      def push
+        return if rootfs? || !Interface.push?
+
+        Auth.auth!
+        img = @img || Docker::Image.get(@repo.to_s)
+        logger = Stream.new.method(:log)
+        img.push(&logger)
+      end
+
+      #
+
+      def aliased?
+        @repo.tag != @repo.aliased && !rootfs?
+      end
+
+      #
+
+      def rootfs?
+        false
+      end
+
+      #
+
+      def parent_repo
+        return false unless aliased?
+        @parent_repo ||= Repo.new(@repo.to_h.merge({
+          "tag" => @repo.aliased
+        }))
+      end
+
+      #
+
+      def parent_img
+        return false unless aliased?
+        @parent_img ||= Docker::Image.get(parent_repo.to_s)
+      rescue Docker::Error::NotFoundError
+        if aliased?
+          nil
+        end
+      end
+
+      #
+
+      def build
+        return Alias.new(self).build if aliased?
+
+        Ansi.clear
+        Util.notify_build(@repo, rootfs: rootfs?)
+        logger = Stream.new.method(:log)
+        copy_build_and_verify
+
+        Dir.chdir(@context) do
+          @img = Docker::Image.build_from_dir(".", &logger)
+          @img.tag  rootfs??  @repo.to_rootfs_h  :  @repo.to_tag_h
+          push
+        end
+      rescue SystemExit => exit_
+        unlink img: true
+        raise exit_
+      ensure
+        if rootfs?
+          unlink img: false else unlink
+        end
+      end
+
+      #
+
+      private
+      def copy_build_and_verify
+        unless respond_to?(:setup_context, true)
+          raise Error::NoSetupContextFound
+        end
+
+        CopyMethods.each do |val|
+          send(val) if respond_to?(val, true)
+        end
+      end
+
+      private
+      def copy_tag
+        return if rootfs?
+        dir = @repo.copy_dir("tag", @repo.tag)
+        Util::Copy.directory(dir, @copy)
+      end
+
+      #
+
+      private
+      def copy_global
+        return if rootfs?
+        dir = Template.root.join(@repo.metadata["copy_dir"])
+        Util::Copy.directory(dir, @copy)
+      end
+
+      #
+
+      private
+      def copy_type
+        return unless !rootfs? && build_type = @repo.metadata["tags"][@repo.tag]
+        dir = @repo.copy_dir("type", build_type)
+        Util::Copy.directory(dir, @copy)
+      end
+
+      #
+
+      private
+      def copy_all
+        return if rootfs?
+        dir = @repo.copy_dir("all")
+        Util::Copy.directory(dir, @copy)
+      end
+    end
+  end
+end

data/lib/docker/template/config.rb

@@ -0,0 +1,84 @@
+# Frozen-string-literal: true
+# Copyright: 2015 Jordon Bedwell - Apache v2.0 License
+# Encoding: utf-8
+
+require "json"
+require "yaml"
+
+module Docker
+  module Template
+
+    # Configuration is a global version of meatadata, where anything
+    # that can be set on configuration can be optimized and stored globally
+    # in a opts.{json,yml} file in the current working directory.
+
+    class Config
+      extend Forwardable
+
+      def_delegator :@config, :keys
+      def_delegator :@config, :to_h
+      def_delegator :@config, :to_enum
+      def_delegator :@config, :has_key?
+      def_delegator :@config, :each
+      def_delegator :@config, :[]
+
+      Defaults = {
+        "type" => "simple",
+        "user" => "envygeeks",
+        "local_prefix" => "local",
+        "rootfs_base_img" => "envygeeks/ubuntu:tiny",
+        "maintainer" => "Jordon Bedwell <jordon@envygeeks.io>",
+        "dockerhub_copy" => false,
+        "repos_dir" => "repos",
+        "copy_dir" => "copy",
+        "tag" => "latest",
+
+        "aliases" => {},
+           "pkgs" => { "tag" => {}, "type" => {}, "all" => nil },
+        "entries" => { "tag" => {}, "type" => {}, "all" => nil },
+       "releases" => { "tag" => {}, "type" => {}, "all" => nil },
+       "versions" => { "tag" => {}, "type" => {}, "all" => nil },
+            "env" => { "tag" => {}, "type" => {}, "all" => nil },
+           "tags" => {}
+      }.freeze
+
+      EmptyDefaults = {
+        "tags" => { "latest" => "normal" }
+      }
+
+      #
+
+      def initialize
+        @config = Defaults.deep_merge(read_config_from)
+        @config = @config.merge(EmptyDefaults) do |key, oval, nval|
+          oval.nil? || oval.empty?? nval : oval
+        end
+
+        @config.freeze
+      end
+
+      # Allows you to read a configuration file from a root and get back
+      # either the parsed data or a blank hash that can be merged the way you
+      # wish to merge it (if you even care to merge it.)
+
+      def read_config_from(dir = Docker::Template.root)
+        file = Dir[dir.join("*.{json,yml}")].first
+        return {} unless file && (file = Pathname.new(file)).file?
+        return JSON.parse(file.read).stringify if file.extname == ".json"
+        YAML.load_file(file).stringify
+      end
+
+      #
+
+      def has_default?(key)
+        return @config.has_key?(key)
+      end
+
+      #
+
+      def build_types
+        return @build_types ||= %W(simple scratch).freeze
+      end
+    end
+  end
+end