brocket 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82018431e2aef0462f2a1197c516853c210f55d1
-  data.tar.gz: 096d374c5c647fd2a5d7463c1e865e1ce38ceaf1
+  metadata.gz: 54c63386ef0806f1a1e9ac34e9692c8529ad2cc0
+  data.tar.gz: 5965c22451aec6eb6e003df5bbba94219383d1b8
 SHA512:
-  metadata.gz: 96f605adec1bea26494c75bf5c6831aa43d1b6d180fc27d9821ef50821ad3ef85a91ee5906715b2d62879289f037ed7a850154e926f58049754a06aac8ff5c95
-  data.tar.gz: 169748729b2b2531b6b24ba9e382922940657df14944df8c9156c0fc6ccfad6cd0a80e4debb48c55bc61dc656d3522f6b23df441051d17a83d1165058761109f
+  metadata.gz: 2e80157b476a1ff419dcf54501b44dbaabb419ea62ed3d7e4c842fba6f1a2b46f7d0f1d21072097f2e4597b2642b6e809b212d8334a4ab1bdacbf285adb2bd07
+  data.tar.gz: 1cfadc60e0bf8e3b6cd42536d31311e394663b619dd6f80b5afcd21481764c709c295aa01a54ab755bc895ddefbb60efeb9635f536168a183c10279878fc3bdb

data/.rspec

@@ -1,2 +1,2 @@
---format documentation
+--format Fuubar
 --color

data/Gemfile

@@ -2,3 +2,11 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in brocket.gemspec
 gemspec
+
+group :development, :test do
+  gem "fuubar"
+  gem "yard"          , require: false
+  gem 'simplecov'     , require: false
+  gem 'simplecov-rcov', require: false
+  gem "pry"
+end

data/README.md

@@ -12,11 +12,12 @@ config IMAGE_NAME and hooks like BEFORE_BUILD and AFTER_BUILD.
     3. push by git
     4. push by docker
 - `brocket docker build`
-    1. call BEFORE_BUILD
-    2. `docker build` with arguments
+    1. cd WORKING_DIR
+    2. call BEFORE_BUILD
+    3. `docker build` with arguments
         - call ON_BUILD_COMPLETE on success
         - call ON_BUILD_ERROR on failure
-    3. call AFTER_BUILD
+    4. call AFTER_BUILD
 
 ## Installation
 
@@ -54,6 +55,7 @@ add following line to your Dockerfile.
 
 example https://github.com/tengine/brocket/blob/master/spec/brocket/Dockerfiles/Dockerfile-basic#L2
 
+
 ### bump up VERSION
 
 When you increment VERSION file, you can use theese commands.
@@ -71,13 +73,14 @@ You can define commands to execute around `docker build` like this:
 ```
 # [config] IMAGE_NAME: "groovenauts/rails-example"
 # [config]
+# [config] WORKING_DIR: ".."
+# [config]
 # [config] BEFORE_BUILD:
-# [config]   - abc
-# [config]   - def ghi
+# [config]   - rm log/*.log
+# [config]   - cp some/files dest
 # [config]
 # [config] AFTER_BUILD:
-# [config]   - "jkl"
-# [config]   - mno
+# [config]   - rm -rf tmp/build
 # [config]
 # [config] ON_BUILD_COMPLETE: foo bar
 # [config]
@@ -85,9 +88,40 @@ You can define commands to execute around `docker build` like this:
 # [config]
 ```
 
-
 https://github.com/tengine/brocket/blob/master/spec/brocket/Dockerfiles/Dockerfile-hook
 
+### Other configurations
+
+#### WORKING_DIR
+
+The directory which the build command and hooks are executed in.
+
+#### VERSION_FILE
+
+A text file to define the container version. It must be a relative path from Dockerfile.
+
+#### VERSION_SCRIPT
+
+A script to get the container version. It runs in the directory of Dockerfile.
+
+`ruby -r ./lib/test_gem/version.rb -e 'puts TestGem::VERSION'`
+
+#### GIT_TAG_PREFIX
+
+The prefix for the version tags on git.
+
+#### DOCKER_PUSH_COMMAND
+
+Set `gcloud docker push` to push to [Google Cloud Registry](https://cloud.google.com/container-registry/docs/).
+
+#### DOCKER_PUSH_REGISTRY
+
+Set the registry host name to push not to hub.docker.com .
+
+#### DOCKER_PUSH_USERNAME
+
+Set the user name on the registry host to push.
+
 
 ### For more information
 

data/lib/brocket.rb

@@ -1,12 +1,31 @@
 require "brocket/version"
 
+require 'logger'
+
 module BRocket
   autoload :Cli        ,    "brocket/cli"
   autoload :Base       ,    "brocket/base"
+  autoload :Configurable,   "brocket/configurable"
   autoload :VersionFile,    "brocket/version_file"
   autoload :Git        ,    "brocket/git"
   autoload :Docker     ,    "brocket/docker"
 
   class BuildError < StandardError
   end
+
+  USER_PWD = Dir.pwd
+
+  class << self
+    attr_writer :logger
+    attr_writer :user_pwd
+
+    def logger
+      @logger ||= Logger.new($stderr)
+    end
+
+    def user_pwd
+      @user_pwd ||= USER_PWD
+    end
+  end
+
 end

data/lib/brocket/base.rb

@@ -1,7 +1,5 @@
 require "brocket"
 
-require 'logger'
-
 require 'thor'
 require 'logger_pipe'
 
@@ -18,16 +16,12 @@ module BRocket
         task
       end
 
-      def opts
-        @opts ||= options || {}
-      end
-
       def dryrun?
-        opts[:dryrun]
+        options[:dryrun]
       end
 
       def verbose?
-        opts[:verbose]
+        options[:verbose]
       end
 
       def verbose(msg)
@@ -46,11 +40,11 @@ module BRocket
       end
 
       def logger
-        @logger ||= Logger.new($stderr)
+        BRocket.logger
       end
 
-      def sh(cmd, &block)
-        LoggerPipe.run(logger, cmd + " 2>&1", dry_run: dryrun?)
+      def sh(cmd)
+        LoggerPipe.run(logger, cmd, dry_run: dryrun?)
       end
 
     end

data/lib/brocket/cli.rb

@@ -1,7 +1,7 @@
 require "brocket"
 
 module BRocket
-  class Cli < Base
+  class Cli < Configurable
 
     desc "init", "initialize current directory"
     def init

data/lib/brocket/configurable.rb

@@ -0,0 +1,55 @@
+require "brocket"
+
+require 'yaml'
+require 'thor'
+require 'pathname'
+
+module BRocket
+  class Configurable < Base
+    CONFIG_LINE_SEP = "[config]".freeze
+    CONFIG_LINE_HEADER = /\A\#\s*#{Regexp.escape(CONFIG_LINE_SEP)}\s?/.freeze
+
+    class_option :dockerfile, aliases: '-f', type: :string, default: "Dockerfile", desc: "Dockerfile to build"
+
+    no_commands do
+      def config_image_name
+        img_name = (config_hash['IMAGE_NAME'] || '').strip
+        error "No IMAGE_NAME found in Dockerfile. Please add `# #{CONFIG_LINE_SEP} IMAGE_NAME: [IMAGE NAME on DockerHub]` in Dockerfile" if img_name.empty?
+        img_name
+      end
+
+      def working_dir
+        dir = config_hash['WORKING_DIR'] || '.'
+        File.expand_path(dir, File.dirname(config_filepath))
+      end
+
+      def config_hash
+        @config_hash ||= load_config_hash
+      end
+
+      def load_config_hash
+        content = read_config_file
+        lines = content.lines.select{|line| line =~ CONFIG_LINE_HEADER}.
+          map{|line| line.sub(CONFIG_LINE_HEADER, "")}
+        return (YAML.load(lines.join("\n")) || {})
+      end
+
+      def config_filepath
+        @config_filepath ||= File.expand_path(options[:dockerfile] || './Dockerfile', BRocket.user_pwd)
+      end
+
+      def config_relpath
+        config_p = Pathname.new(config_filepath)
+        base_p   = Pathname.new(working_dir)
+        config_p.relative_path_from(base_p).to_s
+      end
+
+      def read_config_file
+        unless File.readable?(config_filepath)
+          error "File not found: #{config_filepath}"
+        end
+        File.read(config_filepath)
+      end
+    end
+  end
+end

data/lib/brocket/docker.rb

@@ -4,9 +4,7 @@ require 'yaml'
 require 'thor'
 
 module BRocket
-  class Docker < Base
-    CONFIG_LINE_SEP = "[config]".freeze
-    CONFIG_LINE_HEADER = /\A\#\s*#{Regexp.escape(CONFIG_LINE_SEP)}\s?/.freeze
+  class Docker < Configurable
 
     desc "config", "show configurations in Dockerfile"
     def config
@@ -17,17 +15,18 @@ module BRocket
     def build
       info("[docker build] starting")
       c = config_hash
-      img_name = config_image_name(c)
-      begin
-        execute(c['BEFORE_BUILD'])
-        version = sub(VersionFile).current
-        execute("docker build -t #{img_name}:#{version} .")
-        execute(c['ON_BUILD_COMPLETE'])
-      rescue
-        execute(c['ON_BUILD_ERROR'])
-        raise
-      ensure
-        execute(c['AFTER_BUILD'])
+      Dir.chdir(working_dir) do
+        begin
+          execute(c['BEFORE_BUILD'])
+          cmd = build_build_command
+          execute(cmd)
+          execute(c['ON_BUILD_COMPLETE'])
+        rescue
+          execute(c['ON_BUILD_ERROR'])
+          raise
+        ensure
+          execute(c['AFTER_BUILD'])
+        end
       end
       success("[docker build] OK")
     end
@@ -35,40 +34,53 @@ module BRocket
     desc "push", "push docker image to docker hub"
     def push
       info("[docker push] starting")
-      c = config_hash
-      img_name = config_image_name(c)
-      version = sub(VersionFile).current
-      cmd = "docker push #{img_name}:#{version}"
+      cmd = build_push_command
       sh(cmd)
       success("[docker push] OK")
     end
 
     desc "call_before_build", "call BEFORE_BUILD callback manually"
     def call_before_build
-      execute(config_hash['BEFORE_BUILD'])
+      Dir.chdir(working_dir) do
+        execute(config_hash['BEFORE_BUILD'])
+      end
     end
 
     desc "call_after_build", "call AFTER_BUILD callback manually"
     def call_after_build
-      execute(config_hash['AFTER_BUILD'])
+      Dir.chdir(working_dir) do
+        execute(config_hash['AFTER_BUILD'])
+      end
     end
 
     no_commands do
-      def config_image_name(c)
-        img_name = (c['IMAGE_NAME'] || '').strip
-        error "No IMAGE_NAME found in Dockerfile. Please add `# #{CONFIG_LINE_SEP} IMAGE_NAME: [IMAGE NAME on DockerHub]` in Dockerfile" if img_name.empty?
-        img_name
-      end
-
-      def config_hash
-        content = read_config_file
-        lines = content.lines.select{|line| line =~ CONFIG_LINE_HEADER}.
-          map{|line| line.sub(CONFIG_LINE_HEADER, "")}
-        return (YAML.load(lines.join("\n")) || {})
+      def build_build_command
+        img_name = config_image_name
+        version = sub(VersionFile).current
+        cmd = "docker build -t #{img_name}:#{version}"
+        if options[:dockerfile]
+          fp = config_relpath
+          unless fp == "Dockerfile"
+            cmd << ' -f ' << config_relpath
+          end
+        end
+        cmd << ' .'
+        return cmd
       end
 
-      def read_config_file
-        File.read("Dockerfile")
+      def build_push_command
+        registry = config_hash['DOCKER_PUSH_REGISTRY']
+        username = config_hash['DOCKER_PUSH_USERNAME']
+        img_name = [registry, username, config_image_name].compact.join('/')
+        version = sub(VersionFile).current
+        build_cmd = config_hash['DOCKER_PUSH_COMMAND'] || 'docker push'
+        cmd = [
+          (registry || username) ?
+            "docker tag -f #{config_image_name}:#{version} #{img_name}:#{version}" :
+            nil,
+          "#{build_cmd} #{img_name}:#{version}",
+        ].compact.join(' && ')
+        return cmd
       end
 
       def execute(commands)

data/lib/brocket/git.rb

@@ -1,12 +1,15 @@
 require "brocket"
 
+require 'logger_pipe/runner'
+
 module BRocket
-  class Git < Base
+  class Git < Configurable
 
     desc "guard_clean", "Raise error if some difference exists."
     def guard_clean
-      clean? && committed? or error("There are files that need to be committed first. Run `git status`")
-      success("[git guard_clean] OK")
+      (clean? && committed?) ?
+        success("[git guard_clean] OK") :
+        error("There are files that need to be committed first. Run `git status`")
     end
 
     desc "push", "push commit and tag it"
@@ -18,16 +21,23 @@ module BRocket
 
     no_commands do
 
-      def commit(filepath, msg)
+      # This method is called from BRocket::VersionFile#bump_on
+      def add_and_commit(filepath, msg)
         sh("git add #{filepath} && git commit -m \"#{msg}\"")
       end
 
       def clean?
-        sh_with_code("git diff --exit-code")[1] == 0
+        sh("git diff --exit-code")
+        return true
+      rescue LoggerPipe::Failure
+        return false
       end
 
       def committed?
-        sh_with_code("git diff-index --quiet --cached HEAD")[1] == 0
+        sh("git diff-index --quiet --cached HEAD")
+        return true
+      rescue LoggerPipe::Failure
+        return false
       end
 
       def tag_version
@@ -36,20 +46,18 @@ module BRocket
         yield if block_given?
       rescue
         $stderr.puts "Untagging #{version_tag} due to error."
-        sh_with_code "git tag -d #{version_tag}"
+        sh "git tag -d #{version_tag}"
         raise
       end
 
       def git_push
         perform_git_push
-        perform_git_push ' --tags'
+        perform_git_push '--tags'
         $stdout.puts "Pushed git commits and tags."
       end
 
-      def perform_git_push(options = '')
-        cmd = "git push #{options}"
-        out, code = sh_with_code(cmd)
-        error "Couldn't git push. `#{cmd}' failed with the following output:\n\n#{out}\n" unless code == 0
+      def perform_git_push(options = nil)
+        sh(['git push', options].compact.join(' ' ))
       end
 
       def already_tagged?

data/lib/brocket/version.rb

@@ -1,3 +1,3 @@
 module BRocket
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/brocket/version_file.rb

@@ -1,7 +1,7 @@
 require "brocket"
 
 module BRocket
-  class VersionFile < Base
+  class VersionFile < Configurable
     FILENAME = "VERSION".freeze
     INITIAL_VERSION = "0.0.1".freeze
 
@@ -32,14 +32,22 @@ module BRocket
 
     no_commands do
       def filepath
-        FILENAME
+        File.expand_path(config_hash['VERSION_FILE'] || 'VERSION', File.dirname(config_filepath))
       end
 
       def read_file
-        if File.readable?(filepath)
-          File.read(filepath).strip
+        vs = config_hash['VERSION_SCRIPT']
+        if vs
+          Dir.chdir(File.dirname(config_filepath)) do
+            res = `#{vs}`.strip
+            return $? == 0 ? res : error("Error on VERSION_SCRIPT: #{vs}")
+          end
         else
-          raise BuildError, "File not found #{filepath}. You can run `#{$0} init`"
+          if File.readable?(filepath)
+            File.read(filepath).strip
+          else
+            error "File not found #{filepath}. You can run `#{$0} init`"
+          end
         end
       end
       alias_method :current, :read_file
@@ -62,7 +70,7 @@ module BRocket
         ver = parts.join(".")
         ver << "-" << suffix if suffix
         write_file(ver)
-        sub(Git).commit(filepath, "bump up #{pos.to_s} version: #{ver}")
+        sub(Git).add_and_commit(filepath, "bump up #{pos.to_s} version: #{ver}")
         success("[git #{pos.to_s}] #{ver}")
         ver
       end