capistrano-data_plane_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f09bc2341ac4e11146025f5ec2fb4dac89fe856ccfa94943487af17dcc63b5f5
+  data.tar.gz: 20cf62b4bbce05fbc1fc9fe8fef6a85fb23ebcd121d5caa8783620a590eb336d
+SHA512:
+  metadata.gz: ba8c47106b3f124602eb6d6214cabc918c4aadc4cba6bd29b799453416d904b4dfb82f835fdd8eee64fabac28c55900f3dfe1c6987bdb53406801d7b8b6ff6b5
+  data.tar.gz: df2302167edfec625fbe2edc5221187025255a24263e1c481f19d130713d20767fd11ec6979b06f9cd5a4f39fb92f56eb715ff4e14d12f960f6ef09ecd77e5c4

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_gem:
+  rubocop-espago: rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7

data/.ruby-version

@@ -0,0 +1 @@
+3.2.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-28
+
+- Initial release

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-data_plane_api.gemspec
+gemspec
+
+gem 'minitest', '~> 5.0' # Test framework
+gem 'rake', '~> 13.0' # Ruby automation tasks
+gem 'rubocop', '~> 1.21' # Ruby linter
+gem 'rubocop-espago', '~> 1.0' # Custom Ruby linter config
+gem 'solargraph' # Ruby language server
+gem 'shoulda-context', '~> 2.0' # Testing utilities
+gem 'vcr' # Save HTTP interactions to files during tests
+gem 'webmock' # Mock network interactions

data/Gemfile.lock

@@ -0,0 +1,128 @@
+PATH
+  remote: .
+  specs:
+    capistrano-data_plane_api (0.1.0)
+      data_plane_api (~> 0.1)
+      pastel (< 1)
+      shale (< 1)
+      thor (> 1, < 2)
+      tty-box (< 1)
+      tty-cursor (< 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.2.1)
+    crack (0.4.5)
+      rexml
+    data_plane_api (0.1.2)
+      faraday (> 1, < 3)
+    diff-lcs (1.5.0)
+    e2mmap (0.1.0)
+    faraday (2.7.2)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    hashdiff (1.0.1)
+    jaro_winkler (1.5.4)
+    json (2.6.3)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    mini_portile2 (2.8.1)
+    minitest (5.16.3)
+    nokogiri (1.13.10)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    public_suffix (5.0.1)
+    racc (1.6.2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.5)
+    rubocop (1.41.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    rubocop-espago (1.0.2)
+      rubocop
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    shale (0.9.0)
+    shoulda-context (2.0.0)
+    solargraph (0.48.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    strings (0.2.1)
+      strings-ansi (~> 0.2)
+      unicode-display_width (>= 1.5, < 3.0)
+      unicode_utils (~> 1.4)
+    strings-ansi (0.2.0)
+    thor (1.2.1)
+    tilt (2.0.11)
+    tty-box (0.7.0)
+      pastel (~> 0.8)
+      strings (~> 0.2.0)
+      tty-cursor (~> 0.7)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    unicode-display_width (2.3.0)
+    unicode_utils (1.4.0)
+    vcr (6.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  arm64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  capistrano-data_plane_api!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  rubocop-espago (~> 1.0)
+  shoulda-context (~> 2.0)
+  solargraph
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.4.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Espago
+
+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,197 @@
+# Capistrano::DataPlaneApi
+
+Capistrano plugin which helps you automatically change the admin state of your HAProxy servers.
+
+## Installation
+
+### Gemfile
+
+Install the gem and add to the application's Gemfile by executing:
+
+```sh
+$ bundle add capistrano-data_plane_api
+```
+
+Or add it to `Gemfile` manually:
+
+```rb
+gem "capistrano-data_plane_api"
+```
+
+### Installer
+
+Afterwards, you can use the installer to set up your app.
+
+We highly recommend it.
+
+```sh
+$ bundle exec cap_data_plane_api install
+```
+
+## Usage
+
+This gem hooks into capistrano to add new tasks which
+enable you to change the admin state of your HAProxy
+servers during the deployment process.
+
+We recommend creating separate Capistrano stages
+for every HAProxy server.
+
+## Deployment script
+
+The installer generates a handy deployment script which
+let's you deploy your app to all servers in a particular HAProxy
+backend with one command.
+
+All admin state switching is handled automatically for you.
+You can go make yourself a coffee without having to worry.
+
+It prints a beautiful summary after the deployment.
+
+![Failed Deployment Summary](readme/failed_deployment_summary.png)
+
+
+It can be invoked like that
+
+```sh
+$ bin/deploy -h
+```
+
+That particular command prints a help message, which is a good
+reference for how to use this script.
+
+```
+Usage: bin/deploy [options]
+
+This script can be used to deploy this app to remote servers.
+
+    -c, --current                    Deploy from the currently checked out branch
+    -t, --test                       Show the commands that would be executed but do not carry out the deployment
+    -g, --group=GROUP                Deploy the code to every server in the passed HAProxy backend/group
+        --no-haproxy                 Do not modify the state of any server in HAProxy
+        --force-haproxy              Ignore the current state of servers in HAProxy
+    -o, --only=ONLY                  Deploy the code only to the passed servers in the same order
+    -H, --haproxy-config             Show the current HAProxy configuration
+    -S, --haproxy-state              Show the current HAProxy state
+    -T, --tasks                      Print a list of all available deployment Rake tasks
+    -r, --rake=RAKE                  Carry out a particular Rake task on the server
+    -h, --help                       Prints this help
+    -b, --branch=BRANCH              Deploy the code from the passed Git branch
+        --no-migrations              Do not carry out migrations
+```
+
+### Example of commands
+
+#### Show the state of all HAProxy servers and live reload every 2 seconds
+
+```sh
+$ bin/deploy -S
+```
+
+![HAProxy State](readme/haproxy_state.png)
+
+#### Show the current config of this gem
+
+```sh
+$ bin/deploy -H
+```
+
+#### Deploy to all servers in the `staging` backend
+
+```sh
+$ bin/deploy -g staging
+```
+
+#### Deploy to all servers in the `staging` backend using the currently checked out git branch
+
+```sh
+$ bin/deploy -g staging -c
+```
+
+#### Deploy to `staging_serv3` and `staging_serv1` in the `staging` backend (in this order)
+
+```sh
+$ bin/deploy -g staging -o staging_serv3,staging_serv1
+```
+
+#### Deploy to all servers in the `edge` backend using the `development` git branch
+
+```sh
+$ bin/deploy -g edge -b development
+```
+
+#### Deploy to the `staging_serv3` server
+
+Same as `cap staging_serv3 deploy`
+
+```sh
+$ bin/deploy staging_serv3
+```
+
+#### Carry out the `deploy:restart` Rake task on all servers in the `production` backend
+
+```sh
+$ bin/deploy -g production -r deploy:restart
+```
+
+## New Rake tasks
+
+There are three new Rake tasks:
+
+- `data_plane_api:server:set_drain` -- sets the admin state of the currently deployed server to `DRAIN`
+- `data_plane_api:server:set_maint` -- sets the admin state of the currently deployed server to `MAINT`
+- `data_plane_api:server:set_ready` -- sets the admin state of the currently deployed server to `READY`
+
+To load them and and invoke them manually you should
+add this line to your `Capfile`
+
+```rb
+require 'capistrano/data_plane_api'
+```
+
+## Hooks
+
+If you used the installer, your app is already
+set up with hooks.
+
+In order to use our recommended configuration of these
+new tasks, you should add the following line to your
+`Capfile`
+
+```rb
+require 'capistrano/data_plane_api/hooks'
+```
+
+Our config works as follows:
+
+```
+deploy
+  deploy:starting
+  deploy:started
+    [after]
+        data_plane_api:server:set_drain
+  deploy:updating
+  deploy:updated
+  deploy:publishing
+    [before]
+        data_plane_api:server:set_maint
+  deploy:published
+  deploy:finishing
+  deploy:finished
+    [after]
+        data_plane_api:server:set_ready
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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 the created tag, 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/espago/capistrano-data_plane_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+::Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = ::FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+::RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/capistrano-data_plane_api.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'lib/capistrano/data_plane_api/version'
+
+::Gem::Specification.new do |spec|
+  spec.name = 'capistrano-data_plane_api'
+  spec.version = ::Capistrano::DataPlaneApi::VERSION
+  spec.authors = ['Mateusz Drewniak', 'Espago']
+  spec.email = ['m.drewniak@espago.com']
+
+  spec.summary = 'Capistrano plugin which helps you automatically change the admin state of your HAProxy servers'
+  spec.description = 'Capistrano plugin which helps you automatically change the admin state of your HAProxy servers'
+  spec.homepage = 'https://github.com/espago/capistrano-data_plane_api'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/espago/capistrano-data_plane_api'
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = ::Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| ::File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'data_plane_api', '~> 0.1'
+  spec.add_dependency 'pastel', '< 1'
+  spec.add_dependency 'shale', '< 1'
+  spec.add_dependency 'thor', '> 1', '< 2'
+  spec.add_dependency 'tty-box', '< 1'
+  spec.add_dependency 'tty-cursor', '< 1'
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/exe/cap_data_plane_api

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'thor'
+
+class ::CapistranoDataPlaneApiCommand < ::Thor
+  include ::Thor::Actions
+
+  class << self
+    # Define the generator's root folder
+    #
+    # @return [String]
+    def source_root
+      ::File.expand_path('..', __dir__)
+    end
+  end
+
+  desc 'install', 'Install the `capistrano-data_plane_api` gem in your application'
+
+  # @return [void]
+  def install
+    copy_file 'templates/bin/deploy', 'bin/deploy'
+    chmod 'bin/deploy', 'a+x'
+    copy_file 'templates/bin/deploy.rb', 'bin/deploy.rb'
+
+    copy_file 'templates/config/data_plane_api.yml', 'config/data_plane_api.yml'
+    copy_file 'templates/config/data_plane_api.rb', 'config/data_plane_api.rb'
+
+    inject_into_file 'Capfile', <<~RUBY, after: %r{require ("|')capistrano/deploy("|')\n}
+      require_relative "config/data_plane_api" # load your `capistrano-data_plane_api` config file
+      require "capistrano/data_plane_api/hooks"
+    RUBY
+
+  end
+end
+
+::CapistranoDataPlaneApiCommand.start

data/lib/capistrano/data_plane_api/configuration/backend.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'symbol'
+require_relative 'server'
+
+module Capistrano
+  module DataPlaneApi
+    class Configuration < Type
+      class Backend < Type
+        attribute :name, ::Shale::Type::String
+        attribute :styles, Symbol, collection: true
+        attribute :basic_user, ::Shale::Type::String
+        attribute :basic_password, ::Shale::Type::String
+        attribute :servers, Server, collection: true
+      end
+    end
+  end
+end

data/lib/capistrano/data_plane_api/configuration/server.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module DataPlaneApi
+    class Configuration < Type
+      class Server < Type
+        attribute :name, ::Shale::Type::String
+        attribute :stage, ::Shale::Type::String
+
+        # @return [String, nil]
+        def stage
+          @stage || @name
+        end
+
+        # @return [String, nil]
+        def name
+          @name || @stage
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/data_plane_api/configuration/symbol.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module DataPlaneApi
+    class Configuration < Type
+      class Symbol < ::Shale::Type::String
+        class << self
+          def cast(value)
+            value&.to_sym
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/capistrano/data_plane_api/configuration.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'erb'
+require 'logger'
+
+require 'shale'
+
+require_relative 'type'
+
+::Dir[::File.expand_path('configuration/*.rb', __dir__)].sort.each { require _1 }
+
+module Capistrano
+  module DataPlaneApi
+    # Configuration object of the `capistrano-data_plane_api` gem.
+    class Configuration < Type
+      attribute :api_url, ::Shale::Type::String
+      attribute :logger_level, ::Shale::Type::Integer, default: -> { ::Logger::DEBUG }
+      attribute :backends, Backend, collection: true
+      attribute :file_path, ::Shale::Type::String
+      attribute :basic_user, ::Shale::Type::String
+      attribute :basic_password, ::Shale::Type::String
+
+      class << self
+        # @param path [String]
+        # @return [self]
+        def from_file(path)
+          from_yaml ::ERB.new(::File.read(path)).result
+        end
+      end
+    end
+  end
+end