capistrano-dockerbuild 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20a884c1147fd81d4f831378fd286fedf5498d4a
+  data.tar.gz: 227ca91c65a6227320fb8b275befc12cca072ba1
+SHA512:
+  metadata.gz: a3ee23aff127683494ba9ddd071492e4d197b3a21e9ff400924e99017d9f2d82379beeba57802e2071c95048b5d56d508e7ee08e243f66f7a881576dc699cb1a
+  data.tar.gz: 273a531f78913872dd10e2ebf288f16978e3dde3bbbaba9e273c4dccf22aadaa2ead72599329badc3b7aefd7a45c1090ae6d7fccd77bb47be0b79c36dbde354c

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in capistrano-dockerbuild.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 joker1007
+
+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,97 @@
+# Capistrano::Dockerbuild
+
+Capistrano tasks for `docker build` on remote server.
+
+These tasks depends on Git.
+And so remote server must have git command.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-dockerbuild'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-dockerbuild
+
+## Usage
+
+Add `require` and `install_plugin` to Capfile.
+
+```ruby
+require 'capistrano/dockerbuild'
+install_plugin Capistrano::Dockerbuild
+```
+
+## Variables
+
+#### Common Variables
+Use common variables
+- repo_url
+- branch
+
+| name                          | required | default                                                                                                            | desc                                                                                     |
+| ----                          | ----     | ----                                                                                                               | ----                                                                                     |
+| docker_build_server_host      | yes      | nil                                                                                                                | Build server hostname or SSH::Host object                                                |
+| docker_build_base_dir         | yes      | nil                                                                                                                | Repository clone to here, and execute build command here                                 |
+| docker_registry               | no       | nil                                                                                                                | Docker registry hostname. if use DockerHub, keep nil                                     |
+| docker_build_cmd              | no       | `-> { [:docker, "build", "-t", fetch(:docker_tag_full), "."] }`                                                    | Execute command for image building                                                       |
+| docker_repository_name        | no       | `-> { fetch(:application) }`                                                                                       | Use by `docker tag {{docker_repository_name}}:tag`                                       |
+| docker_tag                    | no       | `-> { fetch(:branch) }`                                                                                            | Use by `docker tag repository:{{docker_tag}}`                                            |
+| docker_tag_full               | no       | `-> { #{fetch(:docker_repository_name)}:#{fetch(:docker_tag)}" }`                                                  | Use by `docker tag {{docker_tag_full}}`                                                  |
+| docker_remote_repository_name | no       | `-> { fetch(:docker_repository_name) }`                                                                            | Use by `docker push docker_registry/{{docker_remote_repository_name}}:docker_remote_tag` |
+| docker_remote_tag             | no       | `-> { fetch(:docker_tag) }`                                                                                        | Use by `docker push docker_registry/docker_remote_repository_name:{{docker_remote_tag}}` |
+| docker_remote_tag_full        | no       | `-> { "#{fetch(:docker_registry) &.+ "/"}#{fetch(:docker_remote_repository_name)}:#{fetch(:docker_remote_tag)}" }` | Use by `docker push {{docker_remote_tag_full}}`                                          |
+| keep_docker_image_count       | no       | 10                                                                                                                 |                                                                                          |
+
+
+## Tasks
+
+#### docker:check
+- Ensure `#{docker_build_base_dir}`
+- Ensure git reachable
+
+#### docker:clone
+- Clone repo to `#{docker_build_base_dir}` as mirror
+
+#### docker:update_mirror
+- git remote update `#{docker_build_base_dir}`
+
+#### docker:build
+- Create `#{branch}` worktree to `#{docker_tag}-#{timestamp}`
+- With in worktree dir, execute `#{docker_build_cmd}`
+- Clear worktree
+
+#### docker:push
+- docker tag `#{docker_tag_full}` `#{docker_remote_tag_full}`
+- docker push `#{docker_remote_tag_full}`
+
+#### docker:cleanup_local_images
+- Remove docker images
+- Leave `keep_docker_image_count` images
+- Remove from the oldest image
+
+## Task Dependency
+
+docker:push => docker:build => docker:update_mirror => docker:clone => docker:check
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/reproio/capistrano-dockerbuild.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-dockerbuild"
+  spec.version       = "0.1.0"
+  spec.authors       = ["joker1007"]
+  spec.email         = ["kakyoin.hierophant@gmail.com"]
+
+  spec.summary       = %q{Capistrano task definition for `docker build`}
+  spec.description   = %q{Capistrano task definition for `docker build`}
+  spec.homepage      = "https://github.com/reproio/capistrano-dockerbuild"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "capistrano", ">= 3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/capistrano/dockerbuild.rb

@@ -0,0 +1,21 @@
+class Capistrano::Dockerbuild < Capistrano::Plugin
+  def set_defaults
+    set_if_empty :docker_build_cmd, -> { [:docker, "build", "-t", fetch(:docker_tag_full), "."] }
+    set_if_empty :docker_repository_name, -> { fetch(:application) }
+    set_if_empty :docker_tag, -> { fetch(:branch) }
+    set_if_empty :docker_tag_full, -> { "#{fetch(:docker_repository_name)}:#{fetch(:docker_tag)}" }
+    set_if_empty :docker_remote_repository_name, -> { fetch(:docker_repository_name) }
+    set_if_empty :docker_remote_tag, -> { fetch(:docker_tag) }
+    set_if_empty :docker_remote_tag_full, -> { "#{fetch(:docker_registry) &.+ "/"}#{fetch(:docker_remote_repository_name)}:#{fetch(:docker_remote_tag)}" }
+    set_if_empty :keep_docker_image_count, 10
+  end
+
+  def define_tasks
+    eval_rakefile File.expand_path("../tasks/docker.rake", __FILE__)
+  end
+
+  def docker_build_base_path
+    raise "Need to set :docker_build_base_dir" unless fetch(:docker_build_base_dir)
+    Pathname(fetch(:docker_build_base_dir))
+  end
+end

data/lib/capistrano/tasks/docker.rake

@@ -0,0 +1,80 @@
+dockerbuild_plugin = self
+
+namespace :docker do
+  desc "check directory exist"
+  task :check do
+    on fetch(:docker_build_server_host) do
+      execute :mkdir, "-p", dockerbuild_plugin.docker_build_base_path.dirname.to_s
+      execute :git, :'ls-remote', repo_url, "HEAD"
+    end
+  end
+
+  desc "Clone the repo to docker build base directory"
+  task :clone => [:'docker:check'] do
+    on fetch(:docker_build_server_host) do
+      if test " [ -f #{dockerbuild_plugin.docker_build_base_path}/HEAD ] "
+        info t(:mirror_exists, at: dockerbuild_plugin.docker_build_base_path.to_s)
+      else
+        within dockerbuild_plugin.docker_build_base_path.dirname do
+          execute :git, :clone, "--mirror", repo_url, dockerbuild_plugin.docker_build_base_path.to_s
+        end
+      end
+    end
+  end
+
+  desc "Update the repo mirror to reflect the origin state"
+  task update_mirror: :'docker:clone' do
+    on fetch(:docker_build_server_host) do
+      within dockerbuild_plugin.docker_build_base_path do
+        execute :git, :remote, :update, "--prune"
+      end
+    end
+  end
+
+  desc "build and push docker image on remote host"
+  task :build => [:'docker:update_mirror'] do
+    on fetch(:docker_build_server_host) do
+      within dockerbuild_plugin.docker_build_base_path do
+        timestamp = Time.now.to_i
+        worktree_dir_name = "worktree-#{fetch(:docker_tag)}-#{timestamp}"
+
+        execute(:git, :worktree, :add, worktree_dir_name, fetch(:branch))
+
+        begin
+          within worktree_dir_name do
+            execute(*fetch(:docker_build_cmd))
+          end
+        ensure
+          execute(:rm, "-rf", worktree_dir_name)
+          execute(:git, :worktree, :prune)
+          # Execute "git gc" manually to avoid "There are too many unreachable loose objects" warning
+          execute(:git, :gc, "--auto", "--prune=3.days.ago")
+        end
+      end
+    end
+  end
+
+  task :push => [:'docker:build'] do
+    on fetch(:docker_build_server_host) do
+      execute(:docker, :tag, fetch(:docker_tag_full), fetch(:docker_remote_tag_full))
+      execute(:docker, :push, fetch(:docker_remote_tag_full))
+    end
+  end
+
+  task :cleanup_local_images do
+    on fetch(:docker_build_server_host) do
+      local_images = []
+      capture(:docker, "images --format='{{.ID}}\t{{.Repository}}\t{{.CreatedAt}}'").split("\n").map do |line|
+        id, repository, created_at = line.split("\t")
+        if repository == fetch(:docker_repository_name)
+          local_images << { id: id, created_at: created_at }
+        end
+      end
+      local_images.uniq!  # Same image could exist in different repository.
+      if local_images.size > fetch(:keep_docker_image_count)
+        deleting_image_ids = local_images.sort_by { |i| i[:created_at] }.first(local_images.size - fetch(:keep_docker_image_count)).map { |i| i[:id] }
+        execute(:docker, "rmi -f #{deleting_image_ids.join(" ")}")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-dockerbuild
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- joker1007
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: Capistrano task definition for `docker build`
+email:
+- kakyoin.hierophant@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capistrano-dockerbuild.gemspec
+- lib/capistrano/dockerbuild.rb
+- lib/capistrano/tasks/docker.rake
+homepage: https://github.com/reproio/capistrano-dockerbuild
+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.12
+signing_key: 
+specification_version: 4
+summary: Capistrano task definition for `docker build`
+test_files: []