docker-template 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65d8ac03dfdfff807d45042ee8ef216ab95ed5e9
-  data.tar.gz: 5880b1219f93034e09a4aa2e1883b21613ceebcd
+  metadata.gz: 7d76a4779cec82a6c13f3be1b64a22bc454f6126
+  data.tar.gz: d0f548b2754f2ba999361a4ce9e6f970dfc69e37
 SHA512:
-  metadata.gz: db84df63be77fc58635612412aad480149256d0bfe7d0c1091fe48e63c06b1253847992753ba8246f2e7f4c6060afc75406fe084ae493ecc07e9db930903a89a
-  data.tar.gz: 11fd17eb806960784b721c4b66f0849d484c924384a47b6fa539f4f5d5cdc253c3be37f8adfc3a30941faf8e0122c6cadb563cce4013949157b1054d8d0faa13
+  metadata.gz: 9b63c8cfb7fa0f8ebfc6bcebc581fa1d9f1794e71a6f3a5869226d0e254e7e2f88892eefdea66794a0457c23b8f0f35893075d81ca255b694cc551b1648763c5
+  data.tar.gz: 2ccc93f6003d232028ed0541ce8be0515ebdc199d5dbcafe7359ae078089610015e5371100b9cc7fbae71b9265e69fd84ee1079bb37e93c8d864b4e00a54a495

data/Gemfile

@@ -9,11 +9,11 @@ gem "rake", :require => false
 gemspec
 
 group :test do
+  gem "rubocop", :require => false
   gem "rspec", :require => false
   gem "luna-rspec-formatters", :require => false
   gem "codeclimate-test-reporter", :require => false
   gem "memory_profiler", :require => false, :platform => :mri
-  gem "rubocop", :github => "bbatsov/rubocop", :branch => :master, :require => false
   gem "rugged", :require => false, :platform => :mri
   gem "luna-rubocop-formatters", :require => false
   gem "benchmark-ips", :require => false

data/Rakefile

@@ -1,42 +1,41 @@
-# ----------------------------------------------------------------------------
 # Frozen-string-literal: true
 # Copyright: 2015 - 2016 Jordon Bedwell - Apache v2.0 License
 # Encoding: utf-8
-# ----------------------------------------------------------------------------
 
 $LOAD_PATH.unshift(File.expand_path(
   "../lib", __FILE__
 ))
 
-# ----------------------------------------------------------------------------
+# --
 
 require "simple/ansi"
 require "rspec/core/rake_task"
 require "luna/rubocop/rake/task"
+require "docker/template/cli"
 require "open3"
 
-# ----------------------------------------------------------------------------
+# --
 
 task :default => [:spec]
 RSpec::Core::RakeTask.new :spec
 task :test => :spec
 
-# ----------------------------------------------------------------------------
-
+# --
+# TODO: Cleanup and remove this whenever you can.
+# --
 module CompList
   module_function
 
-  # --------------------------------------------------------------------------
+  # --
   # Update the pak file to have all the completions.
-  # --------------------------------------------------------------------------
-
+  # --
   def update(data = get_commands, msgp = data.to_msgpack)
     pak_file.binwrite(
       msgp
     )
   end
 
-  # --------------------------------------------------------------------------
+  # --
 
   def normalize_command(command)
     if command.is_a?(Array)
@@ -52,10 +51,9 @@ module CompList
     end
   end
 
-  # --------------------------------------------------------------------------
+  # --
   # Provides the base "_reply" for your auto-complete data output.
-  # --------------------------------------------------------------------------
-
+  # --
   def base(const, skip = %w(help))
     keys = const.all_commands.keys
     return "_reply" => normalize_command(keys), "help" => {
@@ -63,7 +61,7 @@ module CompList
     }
   end
 
-  # --------------------------------------------------------------------------
+  # --
 
   def add_opts(out, const)
     const.all_commands.each do |key, val, command = normalize_command(key)|
@@ -92,10 +90,9 @@ module CompList
     out
   end
 
-  # --------------------------------------------------------------------------
+  # --
   # Recursively pulls out and set's up your commands and opts.
-  # --------------------------------------------------------------------------
-
+  # --
   def get_commands(const = Docker::Template::CLI)
     out = base(
       const
@@ -113,18 +110,19 @@ module CompList
     )
   end
 
-  # --------------------------------------------------------------------------
+  # --
 
   def pak_file
-    Pathutil.new("bin/comp-list.pak").expand_path.tap(
+    Pathutil.new("comp/list.pak").expand_path.tap(
       &:touch
     )
   end
 end
 
-# ----------------------------------------------------------------------------
+# --
 
 namespace :update do
+  desc "Update the completion list."
   task "comp-list" do
     require "msgpack"
     require "docker/template"

data/bin/docker-template

@@ -1,15 +1,13 @@
 #!/usr/bin/env ruby
-# ----------------------------------------------------------------------------
 # Frozen-string-literal: true
 # Copyright: 2015 - 2016 Jordon Bedwell - Apache v2.0 License
 # Encoding: utf-8
-# ----------------------------------------------------------------------------
 
 $LOAD_PATH.unshift(File.expand_path(
   "../lib", __dir__
 ))
 
-# ----------------------------------------------------------------------------
+# --
 
 trap :SIGINT do
   $stderr.puts Simple::Ansi.red(
@@ -19,18 +17,17 @@ trap :SIGINT do
   exit
 end
 
-# ----------------------------------------------------------------------------
+# --
 
 begin
-  require "docker/template"
+  require "docker/template/cli"
 rescue LoadError
-  %w(bundler/setup docker/template).each do |k|
+  # Retry and let it fail if it doesn't work again.
+  %w(bundler/setup docker/template/cli).each do |k|
     require k
   end
 end
 
-# ----------------------------------------------------------------------------
 # Time to play the game.
-# ----------------------------------------------------------------------------
-
-Docker::Template::CLI.start
+Docker::Template::CLI \
+  .start

data/comp/list

@@ -1,23 +1,20 @@
 #!/usr/bin/env ruby
-# ----------------------------------------------------------------------------
 # Frozen-string-literal: true
 # Copyright: 2016 Jordon Bedwell - MIT License
-# Encoding: utf-8
-# ----------------------------------------------------------------------------
 # rubocop:disable Style/ElseAlignment
-# ----------------------------------------------------------------------------
+# Encoding: utf-8
 
 ARGV.shift
 require "pathutil"
 require "msgpack"
 
-# ----------------------------------------------------------------------------
+# --
 
 list = MessagePack.unpack(
   Pathutil.new(__dir__).expand_path.join("list.pak").read
 )
 
-# ----------------------------------------------------------------------------
+# --
 
 if ARGV.first == "build"
   dir = Pathutil.new("repos").expand_path
@@ -30,7 +27,7 @@ if ARGV.first == "build"
   end
 end
 
-# ----------------------------------------------------------------------------
+# --
 
 def key?(obj, key)
   obj["_reply"].include?(
@@ -38,7 +35,7 @@ def key?(obj, key)
   )
 end
 
-# ----------------------------------------------------------------------------
+# --
 
 def contains?(obj, key)
   result = obj["_reply"].grep(/#{Regexp.escape(
@@ -48,13 +45,13 @@ def contains?(obj, key)
   !result.empty?
 end
 
-# ----------------------------------------------------------------------------
+# --
 
 def opt?(key)
   key =~ /\A-{1,2}/
 end
 
-# ----------------------------------------------------------------------------
+# --
 
 if ARGV.empty?
   $stdout.puts list["_reply"].join(

data/lib/docker/template.rb

@@ -1,8 +1,6 @@
-# ----------------------------------------------------------------------------
 # Frozen-string-literal: true
 # Copyright: 2015 - 2016 Jordon Bedwell - Apache v2.0 License
 # Encoding: utf-8
-# ----------------------------------------------------------------------------
 
 require "docker"
 require "extras/all"
@@ -12,35 +10,28 @@ require "simple/ansi"
 require "pathutil"
 require "set"
 
-# ----------------------------------------------------------------------------
+# --
 
 Excon.defaults[ :read_timeout] = 1440
 Excon.defaults[:write_timeout] = 1440
 
-# ----------------------------------------------------------------------------
+# --
 
 module Docker
   module Template
     module_function
 
-    # ------------------------------------------------------------------------
-
-    autoload :Notify, "docker/template/notify"
-    autoload :Utils, "docker/template/utils"
-    autoload :Repo, "docker/template/repo"
-    autoload :Error, "docker/template/error"
-    autoload :Logger, "docker/template/logger"
-    autoload :Normal, "docker/template/normal"
-    autoload :Parser, "docker/template/parser"
-    autoload :Builder, "docker/template/builder"
-    autoload :Metadata, "docker/template/metadata"
-    autoload :Scratch, "docker/template/scratch"
-    autoload :Rootfs, "docker/template/rootfs"
-    autoload :Cache, "docker/template/cache"
-    autoload :Alias, "docker/template/alias"
-    autoload :CLI, "docker/template/cli"
-
-    # ------------------------------------------------------------------------
+    # --
+
+    def project?
+      dir = root.join("docker")
+      any = Builder.all.dup.keep_if(&:projects_allowed?)
+      any = any.map(&:files).reduce(&:|).any? { |file| root.join(file).file? }
+      return true if any && root.join(Meta.opts_file(:force => \
+        :project)).file?
+    end
+
+    # --
 
     def root
       @root ||= begin
@@ -48,7 +39,7 @@ module Docker
       end
     end
 
-    # ------------------------------------------------------------------------
+    # --
 
     def gem_root
       @gem_root ||= begin
@@ -58,7 +49,7 @@ module Docker
       end
     end
 
-    # ------------------------------------------------------------------------
+    # --
 
     def template_root
       @template_root ||= begin
@@ -66,10 +57,10 @@ module Docker
       end
     end
 
-    # ------------------------------------------------------------------------
+    # --
     # Pull a `template` from the `template_root` to parse it's data.
-    # TODO: Rename this get template!
-    # ------------------------------------------------------------------------
+    # TODO: Rename this to get_template!
+    # --
 
     def get(name, data = {})
       data = ERB::Context.new(data)
@@ -82,7 +73,7 @@ module Docker
       )
     end
 
-    # ------------------------------------------------------------------------
+    # --
 
     def _require(what)
       require what
@@ -98,12 +89,24 @@ module Docker
   end
 end
 
-# ----------------------------------------------------------------------------
+# --
 # Trick extras into merging array's into array's for us so users can inherit.
-# ----------------------------------------------------------------------------
+# --
 
 class Array
   def deep_merge(new_)
     self | new_
   end
 end
+
+# --
+
+require "docker/template/error"
+require "docker/template/cache"
+require "docker/template/notify"
+require "docker/template/builder"
+require "docker/template/logger"
+require "docker/template/parser"
+require "docker/template/repo"
+require "docker/template/meta"
+require "docker/template/auth"

data/lib/docker/template/auth.rb

@@ -0,0 +1,72 @@
+# Frozen-string-literal: true
+# Copyright: 2015 - 2016 Jordon Bedwell - Apache v2.0 License
+# Encoding: utf-8
+
+module Docker
+  module Template
+    module Auth
+      module_function
+
+      # --
+
+      DEFAULT_SERVER = "https://index.docker.io/v1/"
+
+      # --
+
+      def auth_with_env?
+        (
+          ENV.key?("DOCKER_USERNAME") && \
+          ENV.key?("DOCKER_PASSWORD") && \
+          ENV.key?("DOCKER_EMAIL")
+        ) || \
+        (
+          ENV.key?("bamboo_dockerUsername") && \
+          ENV.key?("bamboo_dockerPassword") && \
+          ENV.key?("bambo_dockerEmail")
+        )
+      end
+
+      # --
+
+      def hub
+        return auth_from_env if auth_with_env?
+
+        auth_from_config
+      rescue Docker::Error::AuthenticationError
+        raise Error::UnsuccessfulAuth
+      end
+
+      # --
+
+      def auth_from_env
+        Docker.authenticate!({
+          "username" => ENV["DOCKER_USERNAME"] || ENV["bamboo_dockerUsername"],
+          "serveraddress" => ENV["DOCKER_SERVER"] || ENV["bamboo_dockerServer"] || DEFAULT_SERVER,
+          "password" => ENV["DOCKER_PASSWORD"] || ENV["bamboo_dockerPassword"],
+          "email" => ENV["DOCKER_EMAIL"] || ENV["bamboo_dockerEmail"]
+        })
+      end
+
+      # --
+
+      def auth_from_config
+        credentials = Pathutil.new("~/.docker/config.json")
+        credentials = credentials.expand_path.read_json
+
+        unless credentials.empty?
+          credentials["auths"].each do |server, info|
+            username, password = Base64.decode64(info["auth"])
+              .split(":", 2)
+
+            Docker.authenticate!({
+              "username" => username,
+              "serveraddress" => server,
+              "email" => info["email"],
+              "password" => password
+            })
+          end
+        end
+      end
+    end
+  end
+end

data/lib/docker/template/builder.rb

@@ -1,44 +1,43 @@
-# ----------------------------------------------------------------------------
 # Frozen-string-literal: true
 # Copyright: 2015 - 2016 Jordon Bedwell - Apache v2.0 License
 # Encoding: utf-8
-# ----------------------------------------------------------------------------
 
 module Docker
   module Template
     class Builder
       extend Forwardable::Extended
 
-      # ----------------------------------------------------------------------
+      # --
 
       attr_reader :repo
       attr_reader :context
+      attr_reader :copy
       attr_reader :img
 
-      # ----------------------------------------------------------------------
+      # --
 
       ALIAS_SETUP = [:cache_context]
-      SETUP = [:setup_context, :copy_global, :copy_all,
-        :copy_group, :copy_tag, :copy_cleanup, :build_context,
+      SETUP = [:setup_context, :copy_global, :copy_project,
+        :copy_all, :copy_group, :copy_tag, :copy_cleanup, :copy_git, :build_context,
           :verify_context, :cache_context].freeze
 
-      # ----------------------------------------------------------------------
+      # --
 
       def initialize(repo)
         @repo = repo
       end
 
-      # ----------------------------------------------------------------------
+      # --
       # Checks to see if this repository is an alias. This happens when the
       # user has alised data inside of their configuration file.  At this point
       # we will not only copy the parent's data but the aliased data.
-      # ----------------------------------------------------------------------
+      # --
 
       def alias?
         !@repo.complex_alias? && @repo.alias? && !rootfs?
       end
 
-      # ----------------------------------------------------------------------
+      # --
 
       def rootfs?
         is_a?(
@@ -46,21 +45,21 @@ module Docker
         )
       end
 
-      # ----------------------------------------------------------------------
+      # --
 
       def normal?
         @repo.type == "normal" \
           && !rootfs?
       end
 
-      # ----------------------------------------------------------------------
+      # --
 
       def scratch?
         @repo.type == "scratch" \
           && !rootfs?
       end
 
-      # ----------------------------------------------------------------------
+      # --
 
       def aliased_img
         if alias?
@@ -77,16 +76,15 @@ module Docker
         end
       end
 
-      # ----------------------------------------------------------------------
+      # --
 
       def push
         return if rootfs? || !@repo.pushable?
-        Notify.push self
-        auth!
 
+        Notify.push(self); Auth.hub
         img = @img || Image.get(@repo.to_s)
-        img.push nil, :repo_tag => \
-          @repo.to_s, &Logger.new.method(:api)
+        img.push nil, :repo_tag => @repo.to_s, \
+          &Logger.new(repo).method(:api)
 
       rescue Docker::Error::NotFoundError
         $stderr.puts Simple::Ansi.red(
@@ -94,7 +92,7 @@ module Docker
         )
       end
 
-      # ----------------------------------------------------------------------
+      # --
 
       def build
         Simple::Ansi.clear if @repo.buildable?
@@ -102,11 +100,9 @@ module Docker
         setup
 
         if @repo.buildable?
-          Notify.build(@repo, {
-            :rootfs => rootfs?
-          })
-
-          chdir_build
+          then Notify.build(@repo, :rootfs => rootfs?) do
+            chdir_build
+          end
         end
 
         push
@@ -121,11 +117,11 @@ module Docker
         end
       end
 
-      # ----------------------------------------------------------------------
+      # --
       # This method is a default reference.  It is called when the image is
       # done building or when there is an error and we need to clean up some
       # stuff before exiting, use it... please.
-      # ----------------------------------------------------------------------
+      # --
 
       def teardown(*_)
         $stderr.puts Ansi.red(
@@ -133,7 +129,25 @@ module Docker
         )
       end
 
-      # ----------------------------------------------------------------------
+      # --
+      # The prebuild happens when a user has "setup_context", which typically
+      # only happens with scratch, which will prebuild it's rootfs image so
+      # it can get to building it's actual image.
+      # --
+
+      def setup
+        unless respond_to?(:setup_context, true)
+          raise Error::NoSetupContext
+        end
+
+        SETUP.map do |val|
+          if respond_to?(val, true)
+            send(val)
+          end
+        end
+      end
+
+      # --
 
       private
       def build_alias
@@ -161,26 +175,7 @@ module Docker
         push
       end
 
-      # ----------------------------------------------------------------------
-      # The prebuild happens when a user has "setup_context", which typically
-      # only happens with scratch, which will prebuild it's rootfs image so
-      # it can get to building it's actual image.
-      # ----------------------------------------------------------------------
-
-      private
-      def setup
-        unless respond_to?(:setup_context, true)
-          raise Error::NoSetupContext
-        end
-
-        SETUP.map do |val|
-          if respond_to?(val, true)
-            send(val)
-          end
-        end
-      end
-
-      # ----------------------------------------------------------------------
+      # --
 
       private
       def alias_setup
@@ -191,19 +186,32 @@ module Docker
         end
       end
 
-      # ----------------------------------------------------------------------
+      # --
 
       private
       def chdir_build
         @context.chdir do
-          logger = Logger.new(self).method(:api)
-          opts = { :t => @repo.to_s(rootfs: rootfs?) }
-          $stderr.puts Simple::Ansi.yellow("TTY not supported: Ignored.") if @repo.metadata["tty"]
-          @img = Docker::Image.build_from_dir(".", opts, &logger)
+          logger = Logger.new(repo).method(:api)
+          opts = {
+            :force => @repo.meta.force?,
+            :t => @repo.to_s(rootfs: rootfs?),
+            :squash => @repo.meta.squash?,
+            :nocache => @repo.meta.force?
+          }
+
+          if @repo.meta["tty"]
+            $stderr.puts Simple::Ansi.yellow(
+              "TTY not supported: Ignored."
+            )
+          end
+
+          @img = Docker::Image.build_from_dir(".",
+            opts, &logger
+          )
         end
       end
 
-      # ----------------------------------------------------------------------
+      # --
 
       private
       def cache_context
@@ -214,16 +222,46 @@ module Docker
         end
       end
 
-      # ----------------------------------------------------------------------
+      # --
+      # Copy any git repositories the user wishes us to copy.
+      # --
+
+      private
+      def copy_git
+        return if rootfs? || !@repo.meta.git?
+        require "rugged"
+
+        @repo.meta[:git].each do |repo|
+          credentials = Rugged::Credentials::SshKey.new({
+            :privatekey => Pathutil.new(repo[:key]).expand_path.to_s,
+             :publickey => Pathutil.new(repo[:pub]).expand_path.to_s,
+             :username => repo[:user]
+          })
+
+          dir = @copy.join(repo[:clone_to])
+          if !dir.exist?
+            $stderr.puts Simple::Ansi.green("Cloning #{repo[:repo]} to #{repo[:clone_to]}.")
+            Rugged::Repository.clone_at(repo[:repo], dir.to_s, {
+              :credentials => credentials
+            })
+          else
+            $stderr.puts Simple::Ansi.yellow(
+              "Skipping #{repo[:repo]}, exists already."
+            )
+          end
+        end
+      end
+
+      # --
       # The root can have it's own global copy directory shared across all
       # repos in your repo container dir so this encapsulates those.
-      # ----------------------------------------------------------------------
+      # --
 
       private
       def copy_global
         unless rootfs?
           dir = Template.root.join(
-            @repo.metadata["copy_dir"]
+            @repo.meta["copy_dir"]
           )
 
           if dir.exist?
@@ -234,7 +272,26 @@ module Docker
         end
       end
 
-      # ----------------------------------------------------------------------
+      # --
+
+      private
+      def copy_project
+        if Template.project?
+          ignores = repo.meta["project_copy_ignore"].map do |path|
+            Pathutil.new(path).expand_path(
+              Template.root
+            )
+          end
+
+          Template.root.safe_copy(
+            context.join(repo.meta.project_copy_dir), {
+              :root => Template.root, :ignore => ignores
+            }
+          )
+        end
+      end
+
+      # --
 
       private
       def copy_tag
@@ -249,11 +306,11 @@ module Docker
         end
       end
 
-      # ----------------------------------------------------------------------
+      # --
 
       private
       def copy_group
-        build_group = @repo.metadata["tags"][
+        build_group = @repo.meta["tags"][
           @repo.tag
         ]
 
@@ -268,7 +325,7 @@ module Docker
         end
       end
 
-      # ----------------------------------------------------------------------
+      # --
 
       private
       def copy_all
@@ -283,33 +340,64 @@ module Docker
         end
       end
 
-      # ----------------------------------------------------------------------
+      # --
 
-      private
-      def auth!
-        credentials = Pathutil.new("~/.docker/config.json").expand_path.read_json
-        return if credentials.empty?
+      rb_delegate :aliased_tag, :to => "repo.meta"
+      rb_delegate :aliased_repo, {
+        :to => :repo, :alias_of => :aliased
+      }
 
-        credentials["auths"].each do |server, info|
-          user, pass = Base64.decode64(info["auth"]).split(
-            ":", 2
-          )
+      class << self
 
-          Docker.authenticate!({
-            "username" => user,
-            "serveraddress" => server,
-            "email" => info["email"],
-            "password" => pass
-          })
+        # --
+        # REFERENCE METHOD: This is here to let you know we access files.
+        # --
+
+        def files
+          return [
+            #
+          ]
         end
-      end
 
-      # ----------------------------------------------------------------------
+        # --
 
-      rb_delegate :aliased_tag, :to => "repo.metadata"
-      rb_delegate :aliased_repo, {
-        :to => :repo, :alias_of => :aliased
-      }
+        def projects_allowed!
+          return @projects_allowed \
+            = true
+        end
+
+        # --
+
+        def projects_allowed?
+          return !!@projects_allowed
+        end
+
+        # --
+
+        def sub?
+          false
+        end
+
+        # --
+
+        def inherited(klass)
+          (@sub_classes ||= []).push(
+            klass
+          )
+        end
+
+        # --
+
+        def all
+          @sub_classes ||= [
+            #
+          ]
+        end
+      end
     end
   end
 end
+
+require "docker/template/builder/rootfs"
+require "docker/template/builder/scratch"
+require "docker/template/builder/normal"