contained 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9d111821a77162f94e56e4cc1258985969916bfc0e2398ba1e6d73a63041ab9
-  data.tar.gz: adc0d243873960da0980552d4ee3078d01d89469a0f2c0af2b865e24f6e57419
+  metadata.gz: b0cb59a30f87b9f812ea82750eaf3ec2aa709646117f2bd3cd267b74a0a93f4b
+  data.tar.gz: 3f0de08deaa75360d26125eaf1c3e82a1c068a2357eb93d69f9bb15ebe9b7ac8
 SHA512:
-  metadata.gz: 04a7220627e3313d08dec0b056e6695e33ed32f60bf5b4f28ed0e26d1dc843464d3fdbcf9ae5248b9bf9d34f5d77d4d3e385903882f127be76a7db57265c928e
-  data.tar.gz: 7af0e9f1cc1f8f5193f0ce00a76aa192aebcd8b9d08abb3cd12dde56dfa28e8adb9dad65b581e604649960e1c66de2790aea5b9643e868eae2b4069812d563db
+  metadata.gz: 20db27de1725d9aceffaa923e919315b12beb3f1ec7bedc969af903da579f491fd087ce90fa4c86edbf40a88f4898537f9b3419649159a2c3a17ab739edcc6b5
+  data.tar.gz: 3781c551e71dd8ae8e0fd81bf38d07c9e75b64d1f08eb8371359a409575c86636383fc0ec7428f1fe6fb29a41079fb315ff0aee050e5ca71acb1d593dfa561c6

data/Gemfile

@@ -2,12 +2,10 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in contained.gemspec
 gemspec
 
 gem "irb"
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.21"
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-basic"

data/README.md

@@ -1,39 +1,107 @@
 # Contained
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/contained`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
+## Example
+
+**config/deploy.yml**
+
+```yaml
+stack: example
+
+environments:
+  production:
+    servers:
+      - 1.2.3.4
+      - 5.6.7.8
+  test:
+    servers:
+      - 4.3.2.1
+      - 8.7.6.5
+
+config:
+  services:
+    caddy:
+      image: demo/caddy
+      ports:
+        - "80:80"
+      volumes:
+        - caddy_data:/data
+        - caddy_config:/config
+      healthcheck:
+        test: ["CMD", "curl", "-f", "http://localhost:80/up"]
+        interval: 30s
+        timeout: 10s
+        retries: 3
+    backend:
+      build: demo/backend
+      healthcheck:
+        test: ["CMD", "curl", "-f", "http://localhost:3000/up"]
+        interval: 30s
+        timeout: 10s
+        retries: 3
+    frontend:
+      build: demo/frontend
+      healthcheck:
+        test: ["CMD", "curl", "-f", "http://localhost:3000/up"]
+        interval: 30s
+        timeout: 10s
+        retries: 3
+  volumes:
+    caddy_data:
+    caddy_config:
+```
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install contained
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
-
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+contained setup
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+### w/ Caddy
 
-## Development
+**Dockerfile**
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```dockerfile
+# syntax = docker/dockerfile:1
 
-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).
+ARG CADDY_VERSION=2.9.1
 
-## Contributing
+FROM docker.io/library/caddy:${CADDY_VERSION}-alpine
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/contained.
+COPY Caddyfile /etc/caddy/Caddyfile
+```
 
-## License
+**Caddyfile**
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```caddyfile
+demo.com {
+  encode
+
+  handle /up {
+    respond "OK" 200 {
+      close
+    }
+  }
+
+  handle /backend/up {
+    uri replace /backend/ /
+    reverse_proxy backend:3000
+  }
+
+  handle /frontend/up {
+    uri replace /frontend/ /
+    reverse_proxy frontend:3000
+  }
+
+  handle /api/* {
+    reverse_proxy backend:3000
+  }
+
+  handle /* {
+    reverse_proxy frontend:3000
+  }
+}
+```

data/exe/contained

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "contained"
+
+cli = Contained::CLI.new
+cli.parse

data/lib/contained/cli/base.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Contained
+  class CLI
+    # @abstract
+    class Base
+      # @param stdin [IO]
+      # @param stdout [IO]
+      # @param argv [Array<String>]
+      def self.handle!(stdin:, stdout:, argv:)
+        new(stdin: stdin, stdout: stdout, argv: argv).handle!
+      end
+
+      # @param stdin [IO]
+      # @param stdout [IO]
+      # @param argv [Array<String>]
+      def initialize(stdin:, stdout:, argv:)
+        @stdin = stdin
+        @stdout = stdout
+        @argv = argv
+      end
+
+      def handle!
+        raise NotImplementedError, "#handle! undefined"
+      end
+    end
+  end
+end

data/lib/contained/cli/deploy.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Contained
+  class CLI
+    # @example
+    #   Contained::CLI::Deploy.handle!(stdout: $stdout, stderr: $stderr, argv: %i[--environment demo])
+    class Deploy < Contained::CLI::Base
+      def handle!
+        arguments = arguments!
+
+        config = Contained::Config.load_file(path: arguments.fetch(:config))
+        environment = arguments.fetch(:environment)
+
+        Contained::Command::Deploy.execute!(stdin: @stdin, stdout: @stdout, environment:, config:)
+      end
+
+    private
+
+      # @return [Hash]
+      def arguments!
+        { config: "./config/deploy.yml", environment: "default" }.tap do |arguments|
+          parser(into: arguments).parse!
+        end
+      end
+
+      # @param into [Hash]
+      # @return [OptionParser]
+      def parser(into:)
+        OptionParser.new do |options|
+          options.banner = "usage: contained deploy [options] "
+
+          options.on("-h", "--help", "help") do
+            @stdout.puts(options)
+            exit
+          end
+
+          options.on("-c", "--config=CONFIG", "config") do |config|
+            into[:config] = config
+          end
+          options.on("-e", "--environment=ENVIRONMENT", "environment") do |environment|
+            into[:environment] = environment
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contained/cli/init.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module Contained
+  class CLI
+    # @example
+    #   Contained::CLI::Init.handle!(stdout: $stdout, stderr: $stderr, argv: %i[--image example/app --stack app])
+    class Init < Base
+      Arguments = Data.define(:image, :stack)
+
+      CONFIG_DEPLOY_COMPOSE_YML = <<~YAML
+        services:
+          app:
+            image: example/app
+            ports:
+              - "80:80"
+            healthcheck:
+              test: ["CMD", "curl", "-f", "http://localhost/up"]
+              interval: 30s
+              timeout: 10s
+              retries: 3
+      YAML
+
+      CONFIG_DEPLOY_YML = <<~YAML
+        stack: example
+
+        registry:
+          server: hub.docker.com
+          username:
+            - DOCKER_REGISTRY_TOKEN
+          password:
+            - DOCKER_REGISTRY_TOKEN
+
+        environments:
+          production:
+            servers:
+              - 1.2.3.4
+              - 5.6.7.8
+          test:
+            servers:
+              - 4.3.2.1
+              - 8.7.6.5
+      YAML
+
+      def handle!
+        arguments = arguments!
+        path = arguments.fetch(:path)
+
+        setup_config_dir(path:)
+        setup_config_deploy_yml(path:)
+        setup_config_deploy_compose_yml(path:)
+      end
+
+    private
+
+      def setup_config_dir(path:)
+        FileUtils.mkdir_p("#{path}/config/deploy")
+      end
+
+      def setup_config_deploy_yml(path:)
+        if File.exist?("#{path}/config/deploy.yml")
+          @stdout.puts("overwrite '#{path}/config/deploy.yml' (yes/no)?")
+          @stdin.gets { |response| return unless response.strip.eql?("yes") }
+        end
+
+        File.write("#{path}/config/deploy.yml", CONFIG_DEPLOY_YML)
+        @stdout.puts("setup '#{path}/config/deploy.yml'")
+      end
+
+      def setup_config_deploy_compose_yml(path:)
+        if File.exist?("#{path}/config/deploy/compose.yml")
+          @stdout.puts("overwrite '#{path}/config/deploy/compose.yml' (yes/no)?")
+          @stdin.gets { |response| return unless response.strip.eql?("yes") }
+        end
+
+        File.write("#{path}/config/deploy/compose.yml", CONFIG_DEPLOY_COMPOSE_YML)
+        @stdout.puts("setup '#{path}/config/deploy/compose.yml'")
+      end
+
+      # @return [Arguments]
+      def arguments!
+        { path: "." }.tap do |arguments|
+          parser(into: arguments).parse!(@argv)
+        end
+      end
+
+      # @param into [Arguments]
+      # @return [OptionParser]
+      def parser(into:)
+        OptionParser.new do |options|
+          options.banner = "usage: contained init [options]"
+
+          options.on("-p", "--path=PATH", "path") do |path|
+            into[:path] = path
+          end
+
+          options.on("-h", "--help", "help") do
+            @stdout.puts(options)
+            exit
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contained/cli/setup.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Contained
+  class CLI
+    # @example
+    #   Contained::CLI::Setup.handle!(stdout: $stdout, stderr: $stderr, argv: %i[--environment demo])
+    class Setup < Contained::CLI::Base
+      def handle!
+        arguments = arguments!
+
+        config = Contained::Config.load_file(path: arguments.fetch(:config))
+        environment = arguments.fetch(:environment)
+
+        Contained::Command::Setup.execute!(stdin: @stdin, stdout: @stdout, environment:, config:)
+      end
+
+    private
+
+      # @return [Hash]
+      def arguments!
+        { config: "./config/deploy.yml", environment: "default" }.tap do |arguments|
+          parser(into: arguments).parse!
+        end
+      end
+
+      # @param into [Hash]
+      # @return [OptionParser]
+      def parser(into:)
+        OptionParser.new do |options|
+          options.banner = "usage: contained setup [options] "
+
+          options.on("-h", "--help", "help") do
+            @stdout.puts(options)
+            exit
+          end
+
+          options.on("-c", "--config=CONFIG", "config") do |config|
+            into[:config] = config
+          end
+
+          options.on("-e", "--environment=ENVIRONMENT", "environment") do |environment|
+            into[:environment] = environment
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contained/cli.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module Contained
+  # @example
+  #
+  #   cli = Contained::CLI.new
+  #   cli.parse
+  class CLI
+    # @param input [IO]
+    # @param output [IO]
+    # @param argv [Array<String>] the arguments (e.g. ['deploy', '--help'])
+    def initialize(stdin: $stdin, stdout: $stdout, argv: ARGV)
+      @stdin = stdin
+      @stdout = stdout
+      @argv = argv
+    end
+
+    def parse
+      parser.order!(@argv)
+      command = @argv.shift
+      return if command.nil?
+
+      handler =
+        case command
+        when "init" then ::Contained::CLI::Init
+        when "setup" then ::Contained::CLI::Setup
+        when "deploy" then ::Contained::CLI::Deploy
+        else raise ::Contained::Error, "unsupported command=#{command.inspect}"
+        end
+
+      handler.handle!(stdin: @stdin, stdout: @stdout, argv: @argv)
+    end
+
+  private
+
+    # @return [OptionParser]
+    def parser
+      @parser ||= OptionParser.new do |options|
+        options.banner = "usage: contained [options] <command> [<args>]"
+
+        options.on("-h", "--help", "help") do
+          @stdout.puts(options)
+          exit
+        end
+
+        options.on("-v", "--version", "version") do
+          @stdout.puts(Contained::VERSION)
+          exit
+        end
+
+        options.separator <<~COMMANDS
+          commands:
+            init
+            setup
+            deploy
+        COMMANDS
+      end
+    end
+  end
+end

data/lib/contained/command/base.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "sshkit"
+
+module Contained
+  module Command
+    # @abstract
+    class Base
+      include SSHKit::DSL
+
+      def self.execute!(...)
+        new(...).execute!
+      end
+
+      # @param stdin [IO]
+      # @param stdout [IO]
+      # @environment [String]
+      # @config [Contained::Config]
+      def initialize(stdin:, stdout:, environment:, config:)
+        @stdin = stdin
+        @stdout = stdout
+        @environment = environment
+        @config = config
+      end
+
+      def execute!
+        raise NotImplementedError, "#execute! undefined"
+      end
+
+    protected
+
+      def servers
+        @config.dig("environments", @environment, "servers")
+      end
+    end
+  end
+end

data/lib/contained/command/deploy.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# .contained/itva/compose.yml
+# .contained/itva/.env
+module Contained
+  module Command
+    # @example
+    #   Contained::Command::Deploy.execute(environment: "production", config: {})
+    class Deploy < Base
+      def execute!
+        stack = @config.fetch("stack")
+
+        @stdout.puts("[deploying] stack=#{stack} environment=#{@environment}")
+
+        on servers, in: :sequence do |host|
+          puts("[starting] host=#{host.hostname}")
+          execute(<<~BASH)
+            source ./.contained/#{stack}/.env
+            docker stack deploy -c ./.contained/#{stack}/compose.yml #{stack} --with-registry-auth
+          BASH
+          puts("[done] host=#{host.hostname}")
+        end
+      end
+    end
+  end
+end

data/lib/contained/command/login.rb

@@ -0,0 +1,24 @@
+class Contained::Command::Login
+  # @param stdin [IO]
+  # @param stdout [IO]
+  # @param argv [Array<String>]
+  def initialize(stdin:, stdout:, argv:)
+    @stdin = stdin
+    @stdout = stdout
+    @argv = argv
+  end
+
+  def execute!
+    raise NotImplementedError, "#handle! undefined"
+  end
+
+  # @return [String]
+  def username!
+    @options.fetch(:username)
+  end
+
+  # @return [String]
+  def password
+    @options.fetch(:password)
+  end
+end

data/lib/contained/command/setup.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Contained
+  module Command
+    # @example
+    #   Contained::Command::Setup.execute(environment: "production", config: {})
+    class Setup < Base
+      def execute!
+        stack = @config.fetch("stack")
+
+        deploy_compose_yml = File.open("./config/deploy/compose.yml")
+        deploy_env = File.open("./config/deploy/.#{@environment}.env")
+
+        @stdout.puts("[setup] stack=#{stack} environment=#{@environment} servers=#{servers}")
+
+        on servers, in: :sequence do |host|
+          puts("[starting] host=#{host.hostname}")
+
+          execute("mkdir -p ./.contained/#{stack}")
+
+          upload!(deploy_compose_yml, "./.contained/#{stack}/compose.yml")
+          upload!(deploy_env, "./.contained/#{stack}/.env")
+
+          execute(<<~BASH)
+            source ./.contained/#{stack}/.env
+            docker stack deploy -c ./.contained/#{stack}/compose.yml #{stack} --with-registry-auth
+          BASH
+
+          puts("[done] host=#{host.hostname}")
+        end
+      end
+    end
+  end
+end

data/lib/contained/command.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Contained
+  module Command
+  end
+end

data/lib/contained/config.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module Contained
+  # @example
+  #
+  #  Contained::Config.load_file(path: "./config/deploy.yml")
+  class Config
+    # @param path [String]
+    #
+    # @return [Contained::Config]
+    def self.load_file(path: "./config/deploy.yml")
+      YAML.load_file(path)
+    end
+
+    # # @param data [Hash]
+
+    # # @return [Contained::Config]
+    # def self.parse!(data:)
+    #   new(
+    #     stack: data.fetch("stack"),
+    #     registry: data.fetch("registry"),
+    #     environments: data.fetch("environments"),
+    #     config: data.fetch("config")
+    #   )
+    # end
+
+    # # @!attribute [rw] stack
+    # #   @return [String]
+    # attr_accessor :stack
+
+    # # @!attribute [rw] registry
+    # #   @return [Hash]
+    # attr_accessor :registry
+
+    # # @!attribute [rw] environments
+    # #   @return [Hash]
+    # attr_accessor :environments
+
+    # # @!attribute [rw] config
+    # #   @return [Hash]
+    # attr_accessor :config
+
+    # # @param stack [String]
+    # # @param registry [Hash]
+    # # @param environments [Hash]
+    # # @param config [Hash]
+    # def initialize(stack:, registry:, environments:, config:)
+    #   @stack = stack
+    #   @registry = registry
+    #   @environments = environments
+    #   @config = config
+    # end
+  end
+end

data/lib/contained/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Contained
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/lib/contained.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "contained/version"
+require 'zeitwerk'
+require 'optparse'
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect "cli" => "CLI"
+loader.setup
 
 module Contained
   class Error < StandardError; end

metadata

@@ -1,18 +1,103 @@
 --- !ruby/object:Gem::Specification
 name: contained
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 bindir: exe
 cert_chain: []
-date: 2025-03-20 00:00:00.000000000 Z
-dependencies: []
+date: 2025-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: erb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fileutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Makes releasing docker based containers via SSH using swarm a breeze
 email:
 - kevin@ksylvest.com
-executables: []
+executables:
+- contained
 extensions: []
 extra_rdoc_files: []
 files:
@@ -20,7 +105,20 @@ files:
 - README.md
 - bin/console
 - bin/setup
+- exe/contained
 - lib/contained.rb
+- lib/contained/cli.rb
+- lib/contained/cli/base.rb
+- lib/contained/cli/deploy.rb
+- lib/contained/cli/init.rb
+- lib/contained/cli/setup.rb
+- lib/contained/command.rb
+- lib/contained/command/base.rb
+- lib/contained/command/deploy.rb
+- lib/contained/command/login.rb
+- lib/contained/command/setup.rb
+- lib/contained/config.rb
+- lib/contained/config/registry.rb
 - lib/contained/version.rb
 homepage: https://github.com/ksylvest/contained
 licenses:
@@ -29,6 +127,7 @@ metadata:
   homepage_uri: https://github.com/ksylvest/contained
   source_code_uri: https://github.com/ksylvest/contained
   changelog_uri: https://github.com/ksylvest/contained
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib