capistrano_dockerbuild 1.0.0

data/lib/capistrano/tasks/dockerbuild.rake

@@ -0,0 +1,257 @@
+# frozen_string_literal: true
+
+namespace :docker do
+
+  # Any extra command-line opts you'd like to insert into the `docker build` command
+  # Normally has no preset value (fastest option), but a popular full-rebuild-every-time (thorough build) selection is '--pull --no-cache --force-rm'
+  def docker_build_opts
+    fetch(:docker_build_opts, nil)
+  end
+
+  # Relative path to the Dockerfile for image building
+  def dockerfile
+    fetch(:dockerfile, 'Dockerfile')
+  end
+
+  # Docker build source path
+  def docker_build_context
+    fetch(:docker_build_context, '.')
+  end
+
+  def docker_cmd
+    fetch(:docker_cmd, 'docker')
+  end
+
+  def docker_build_image
+    (fetch(:docker_build_image) { fetch(:application) }) || raise('unable to discern docker_build_image name; specify :application or :docker_build_image')
+  end
+
+  def docker_build_tag
+    fetch(:docker_build_tag, 'latest')
+  end
+
+  def docker_build_image_tag
+    return fetch(:docker_build_image_tag) ||
+           set(:docker_build_image_tag, "#{docker_build_image}:#{docker_build_tag}")
+  end
+
+  def docker_build_image_latest_tag
+    return fetch(:docker_build_image_latest_tag) ||
+           set(:docker_build_image_latest_tag, "#{docker_build_image}:latest")
+  end
+
+  def docker_build_image_release_tag
+    return fetch(:docker_build_image_release_tag) ||
+           set(:docker_build_image_release_tag, "#{docker_build_image}:release-#{release_timestamp}")
+  end
+
+  def docker_build_image_revision_tag
+    return nil unless fetch(:current_revision)
+    return fetch(:docker_build_image_revision_tag) ||
+           set(:docker_build_image_revision_tag, "#{docker_build_image}:REVISION-#{fetch(:current_revision)}")
+  end
+
+  def docker_build_image_shortrev_tag
+    return nil unless fetch(:current_revision)
+    return fetch(:docker_build_image_shortrev_tag) ||
+           set(:docker_build_image_shortrev_tag, "#{docker_build_image}:rev-#{fetch(:current_revision)[0..6]}")
+  end
+
+  def docker_build_image_tags
+    [
+      docker_build_image_latest_tag,
+      docker_build_image_revision_tag,
+      docker_build_image_shortrev_tag,
+      docker_build_image_release_tag,
+      docker_build_image_tag,
+    ].uniq.compact
+  end
+
+  def docker_build_image_tags_opt
+    return docker_build_image_tags.map{|t| "--tag=#{t}"}.join(' ')
+  end
+
+  def docker_repo_url
+    fetch :docker_repo_url
+  end
+
+  def docker_repo_tag(local_tag)
+    return nil unless docker_repo_url
+    return "#{docker_repo_url}/#{local_tag}"
+  end
+
+  def docker_repo_tags
+    docker_build_image_tags.map{|t| docker_repo_tag(t)}
+  end
+
+  # TODO: remove this!!!!!!!!
+  task :debug do
+    byebug # rubocop:disable Lint/Debugger
+    puts 'pew pew!'
+  end
+
+  task :check_docker_build_role do
+    if roles(:docker_build).empty?
+      run_locally do
+        fatal ':docker_build role is required for remote builds'
+        raise 'missing :docker_build role'
+      end
+    end
+    unless roles(:docker_build).size == 1
+      run_locally do
+        fatal 'cannot assign :docker_build role to more than one server'
+        raise 'multiple :docker_build role assignments'
+      end
+    end
+  end
+
+  task :check_docker_build_root do
+    on roles(:docker_build).first do # |buildremote|
+      info "checking build path: #{build_path}"
+      execute :test, '-d', build_path # path exists
+      info 'checking for Dockerfile...'
+      execute :test, '-f', build_path.join(dockerfile) # Dockerfile is present
+      info "checking docker_build_context: #{docker_build_context}"
+      execute :test, '-d', build_path.join(docker_build_context) # Dockerfile is present
+    end
+  end
+
+  task :local_build_warning do
+    run_locally do
+      warn 'Building docker image directly from local workspace... (typically undesirable, skips several sanity checks)'
+      warn '>> assign :docker_build role to enable remote builds'
+    end
+  end
+
+
+  task :build_decision do
+    if roles(:docker_build).empty?
+      invoke 'docker:build_local'
+    else
+      invoke 'docker:build_remote'
+    end
+  end
+
+  task :local_build_deps => [:local_build_warning]
+
+  task :build_local => :local_build_deps do
+    current_build_dir = pwd
+    run_locally do
+      info "Current Working Directory: #{current_build_dir}"
+      execute docker_cmd,
+              'build',
+              docker_build_opts,
+              "--file=#{dockerfile}",
+              docker_build_image_tags_opt,
+              docker_build_context
+    end
+  end
+
+  task :remote_build_deps => [:check_docker_build_role, :check_docker_build_root]
+
+  task :build_remote => :remote_build_deps do
+    on roles(:docker_build).first do |buildremote|
+      info "Building docker image on :docker_build role: #{buildremote}"
+      within build_path do
+        execute docker_cmd, :ps
+        execute docker_cmd,
+                'build',
+                docker_build_opts,
+                "--file=#{dockerfile}",
+                docker_build_image_tags_opt,
+                docker_build_context
+      end
+    end
+  end
+
+  task :tag do
+    if roles(:docker_build).empty?
+      invoke 'docker:tag_local'
+    else
+      invoke 'docker:tag_remote'
+    end
+  end
+
+  task :tag_local do
+    if docker_build_image_release_tag
+      run_locally do
+        info 'Re-tagging docker images for upstream push...'
+        docker_repo_tags.each do |repo_tag|
+          execute docker_cmd, :tag,
+                  docker_build_image_latest_tag,
+                  repo_tag
+        end
+      end
+    end
+  end
+
+  task :tag_remote => :check_docker_build_role do
+    if docker_build_image_release_tag
+      on roles(:docker_build).first do # |buildremote|
+        info 'Re-tagging docker images for upstream push...'
+        docker_repo_tags.each do |repo_tag|
+          execute docker_cmd, :tag,
+                  docker_build_image_latest_tag,
+                  repo_tag
+        end
+      end
+    end
+  end
+
+  desc "Push the 'latest' image to the repository"
+  task :push do
+    if roles(:docker_build).empty?
+      invoke 'docker:push_local'
+    else
+      invoke 'docker:push_remote'
+    end
+  end
+
+  task :push_local => :tag_local do
+    run_locally do
+      info 'Pushing docker images upstream...'
+      docker_repo_tags.each do |repo_tag|
+        execute docker_cmd, :push,
+                repo_tag
+      end
+    end
+  end
+
+  task :push_remote => [:check_docker_build_role, :tag_remote] do
+    on roles(:docker_build).first do # |buildremote|
+      info 'Pushing docker images upstream...'
+      docker_repo_tags.each do |repo_tag|
+        execute docker_cmd, :push,
+                repo_tag
+      end
+    end
+  end
+
+  desc 'Build the docker container image'
+  task :build do
+    invoke 'docker:build_decision'
+  end
+
+  desc 'Build and then push docker container image'
+  task :build_push do
+    invoke 'docker:build'
+    invoke 'docker:push'
+  end
+
+  # Default `cap env deploy` flow hook
+  task :capdeploy_hook do
+    if fetch(:dockerbuild_deployhook, true)
+      invoke 'docker:build_push'
+    end
+  end
+
+  task :trim_release_roles do
+    if fetch(:dockerbuild_trim_release_roles, true)
+      docker_build_server = [roles(:docker_build).first]
+      (release_roles(:all) - docker_build_server).each do |server|
+        server.set :no_release, true
+      end
+    end
+  end
+
+end # namespace :docker do

data/lib/capistrano/tasks/dockerbuild_hooks.rake

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# add the build->push process onto the end of the deploy:published stack
+after 'deploy:published', 'docker:capdeploy_hook'
+
+# push the no_release auto-cull to the very front of the task stack
+before 'deploy:starting', 'docker:trim_release_roles'

data/lib/capistrano/tasks/dockercompose.rake

@@ -0,0 +1,278 @@
+# frozen_string_literal: true
+
+require 'byebug'
+require 'tempfile'
+
+namespace :docker do
+  namespace :compose do
+
+    def docker_compose_cmd
+      fetch(:docker_compose_cmd, 'docker-compose')
+    end
+
+    def docker_compose_project
+      (fetch(:docker_compose_project) { fetch(:application) }) || raise('unable to discern docker_compose_project name; specify :application or :docker_compose_project')
+    end
+
+    def docker_compose_opts
+      fetch(:docker_compose_opts, nil)
+    end
+
+    def docker_compose_up_opts
+      fetch(:docker_compose_up_opts, '--no-build --remove-orphans')
+    end
+
+    def docker_compose_stop_opts
+      fetch(:docker_compose_stop_opts, nil)
+    end
+
+    def docker_compose_down_opts
+      fetch(:docker_compose_down_opts, '-v --remove-orphans')
+    end
+
+    # Relative path to the docker-compose.yml for deployments
+    def docker_compose_file
+      fetch(:docker_compose_file, 'docker-compose.yml')
+    end
+
+    # Path for docker-compose remote deployments
+    def docker_compose_path
+      fetch(:docker_compose_path) { build_path }
+    end
+
+
+    task :check_docker_compose_root do
+      on roles(:docker_compose) do |remote|
+        # info "ON HOST #{remote}"
+        # info "checking docker_compose_path: #{docker_compose_path}"
+        # should really fix this to preserve typical capistrano dir-tree, but meh for now...
+        unless test("[ -d #{docker_compose_path} ]")
+          warn "docker_compose_path does not exist on host (#{remote}): #{docker_compose_path}"
+          warn "creating docker_compose_path on host (#{remote}): #{docker_compose_path}"
+          warn 'this can break future `cap stage deploy` execution on build hosts'
+          execute :mkdir, '-p', docker_compose_path
+        end
+      end
+    end
+
+    task :local_source_warning do
+      run_locally do
+        warn 'Using docker-compose files directly from local workspace... (typically undesirable)'
+        warn '>> assign :docker_build role to enable remote builds'
+      end
+    end
+
+
+    desc 'copies a new docker_compose_file from the docker_build role to each docker_compose role'
+    task :upload do
+      if roles(:docker_compose).empty?
+        invoke 'docker:compose:upload_local'
+      else
+        invoke 'docker:compose:upload_remote'
+      end
+    end
+
+    # copies a new docker-compose.yml file up to each docker_compose host
+    task :upload_local do
+      run_locally do
+        info 'Nothing to do here, docker-compose will run locally...'
+      end
+    end
+
+    # copies a new docker-compose.yml file up to each docker_compose host
+    task :upload_remote => :check_docker_compose_root do
+      tmp_file = Tempfile.new('upload_remote')
+      tmp_file_path = tmp_file.path
+      tmp_file.close(false)
+      begin
+        docker_build_role = roles(:docker_build).first
+        upload_roles = roles(:docker_compose) - [docker_build_role]
+        unless upload_roles.empty?
+          if docker_build_role
+            on docker_build_role do |build_remote|
+              info "fetching #{build_remote}:#{docker_compose_path.join(docker_compose_file)}"
+              download! docker_compose_path.join(docker_compose_file), tmp_file_path
+            end
+          else
+            # byebug
+            invoke 'docker:compose:local_source_warning'
+            run_locally do
+              warn "fetching #{docker_compose_file}"
+              download! docker_compose_file, tmp_file_path
+            end
+          end
+          on upload_roles do |upload_role|
+            info "uploading to #{upload_role}:#{docker_compose_path.join(docker_compose_file)}"
+            upload! tmp_file_path, docker_compose_path.join(docker_compose_file)
+          end
+        end
+      ensure
+        File.unlink(tmp_file_path)
+      end
+    end
+
+
+    desc 'list current services state'
+    task :ps do
+      if roles(:docker_compose).empty?
+        invoke 'docker:compose:ps_local'
+      else
+        invoke 'docker:compose:ps_remote'
+      end
+    end
+
+    task :ps_local do
+      current_build_dir = pwd
+      run_locally do
+        info "Current Working Directory: #{current_build_dir}"
+        execute docker_compose_cmd,
+                "--file=#{docker_compose_file}",
+                "--project-name=#{docker_compose_project}",
+                docker_compose_opts,
+                :ps
+      end
+    end
+
+    task :ps_remote do
+      on roles(:docker_compose) do |buildremote|
+        info "ON HOST #{buildremote}"
+        within build_path do
+          execute docker_compose_cmd,
+                  "--file=#{docker_compose_file}",
+                  "--project-name=#{docker_compose_project}",
+                  docker_compose_opts,
+                  :ps
+        end
+      end
+    end
+
+
+    desc 'starts/updates services'
+    task :up do
+      if roles(:docker_compose).empty?
+        invoke 'docker:compose:up_local'
+      else
+        invoke 'docker:compose:up_remote'
+      end
+    end
+
+    task :up_local do
+      current_build_dir = pwd
+      run_locally do
+        info "Current Working Directory: #{current_build_dir}"
+        execute docker_compose_cmd,
+                "--file=#{docker_compose_file}",
+                "--project-name=#{docker_compose_project}",
+                docker_compose_opts,
+                :up,
+                docker_compose_up_opts
+      end
+    end
+
+    task :up_remote do
+      on roles(:docker_compose) do |buildremote|
+        info "ON HOST #{buildremote}"
+        within build_path do
+          execute docker_compose_cmd,
+                  "--file=#{docker_compose_file}",
+                  "--project-name=#{docker_compose_project}",
+                  docker_compose_opts,
+                  :up, '-d',
+                  docker_compose_up_opts
+        end
+      end
+    end
+
+
+    desc 'stops services but leaves them created'
+    task :stop do
+      if roles(:docker_compose).empty?
+        invoke 'docker:compose:stop_local'
+      else
+        invoke 'docker:compose:stop_remote'
+      end
+    end
+
+    task :stop_local do
+      current_build_dir = pwd
+      run_locally do
+        info "Current Working Directory: #{current_build_dir}"
+        execute docker_compose_cmd,
+                "--file=#{docker_compose_file}",
+                "--project-name=#{docker_compose_project}",
+                docker_compose_opts,
+                :stop,
+                docker_compose_stop_opts
+      end
+    end
+
+    task :stop_remote do
+      on roles(:docker_compose) do |buildremote|
+        info "ON HOST #{buildremote}"
+        within build_path do
+          execute docker_compose_cmd,
+                  "--file=#{docker_compose_file}",
+                  "--project-name=#{docker_compose_project}",
+                  docker_compose_opts,
+                  :stop,
+                  docker_compose_stop_opts
+        end
+      end
+    end
+
+
+    desc 'stop and clean up all services'
+    task :down do
+      if roles(:docker_compose).empty?
+        invoke 'docker:compose:down_local'
+      else
+        invoke 'docker:compose:down_remote'
+      end
+    end
+
+    task :down_local do
+      current_build_dir = pwd
+      run_locally do
+        info "Current Working Directory: #{current_build_dir}"
+        execute docker_compose_cmd,
+                "--file=#{docker_compose_file}",
+                "--project-name=#{docker_compose_project}",
+                docker_compose_opts,
+                :down,
+                docker_compose_down_opts
+      end
+    end
+
+    task :down_remote do
+      on roles(:docker_compose) do |buildremote|
+        info "ON HOST #{buildremote}"
+        within build_path do
+          execute docker_compose_cmd,
+                  "--file=#{docker_compose_file}",
+                  "--project-name=#{docker_compose_project}",
+                  docker_compose_opts,
+                  :down,
+                  docker_compose_down_opts
+        end
+      end
+    end
+
+
+    desc 'Update docker-compose on all hosts and re-up'
+    task :update do
+      invoke 'docker:compose:upload'
+      invoke 'docker:compose:up'
+    end
+
+    desc '(alias for docker:compose:update)'
+    task :deploy => :update
+
+    # Default `cap env deploy` flow hook
+    task :capdeploy_hook do
+      if fetch(:dockercompose_deployhook, true)
+        invoke 'docker:compose:update'
+      end
+    end
+
+  end # namespace :compose do
+end # namespace :docker do

data/lib/capistrano/tasks/dockercompose_hooks.rake

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# add the build->push process onto the end of the deploy:published stack
+after 'deploy:published', 'docker:compose:capdeploy_hook'