brut 0.20.2 → 0.21.0.pre.2

data/lib/brut/cli/apps/deploy.rb

@@ -1,366 +1,335 @@
 require "brut/cli"
 require "fileutils"
 require "pathname"
+require "yaml"
 
 class Brut::CLI::Apps::Deploy < Brut::CLI::Commands::BaseCommand
+
+  autoload :DeployConfig, "brut/cli/apps/deploy/deploy_config"
+  autoload :GitChecks,    "brut/cli/apps/deploy/git_checks"
+
   def name = "deploy"
 
   def description = "Deploy your Brut-powered app to production"
 
   def default_rack_env = nil
 
-  class Heroku < Brut::CLI::Commands::BaseCommand
-    def description = "Deploy to Heroku using container-based deployment"
+  class Docker < Brut::CLI::Commands::BaseCommand
+    def description = "Build one docker image to use for all commands in production"
     def opts = [
-      [ "--[no-]deploy", "If true, actually deploy the pushed images (default true)" ],
-      [ "--skip-checks", "If true, skip pre-build checks" ],
+      [ "--build-only", "Only generate Dockerfiles and build images, do not deploy" ],
     ]
-
     def default_rack_env = "development"
-
     def run
-      options.set_default(:deploy, true)
-      puts "Logging in to Heroku Container Registry"
-      command = %{heroku container:login}
-      system!(command)
-      execute_result = Brut::CLI::ExecuteResult.new do
-        delegate_to_command(
-          Brut::CLI::Apps::Deploy::Build.new(
-            push: options.deploy? ? "registry.heroku.com/#{Brut.container.app_id}/%{name}": false
-          )
-        )
-      end
-      if execute_result.failed?
-        puts theme.error.render("Build failed.")
-        return execute_result.exit_status do |error_message|
-          puts theme.error.render("Error message from build: #{error_message}")
+      deploy_config_path = Brut.container.project_root / "deploy" / "deploy_config.rb"
+      begin
+        require deploy_config_path
+        if !defined?(AppDeployConfig)
+          fatal "#{deploy_config_path} must define the class AppDeployConfig"
+          return 1
         end
-      end
-      names = []
-      app_docker_files = AppDockerImages.new(
-        project_root: Brut.container.project_root,
-        organization: Brut.container.app_organization,
-        app_id: Brut.container.app_id,
-        short_version: "NA"
-      )
-      app_docker_files.each do |name:, cmd:, dockerfile:|
-        names << name
-      end
-
-      deploy_command = "heroku container:release #{names.join(' ')} -a #{Brut.container.app_id}"
-      if options.deploy?
-        puts "Deploying images to Heroku"
-        system!(deploy_command)
-      else
-        puts "Not deploying.  To deploy the images just pushed:"
-        puts ""
-        puts "  #{deploy_command}"
-      end
-    end
-  end
-
-  class AppDockerImages
-    attr_reader :docker_config_filename, :platform
-    def initialize(organization:, app_id:, project_root:, short_version:)
-      @docker_config_filename = project_root / "deploy" / "docker_config"
-      require_relative @docker_config_filename
-      if ! defined?(DockerConfig)
-        raise "#{@docker_config_filename} did not define the constant `DockerConfig` - it must to provide the configuration values to this script"
-      end
-
-      docker_config = DockerConfig.new
-      @platform = docker_config.platform
-
-      additional_images = (docker_config.additional_images || {}).map { |name,config|
-        cmd = config.fetch(:cmd)
-        image_name = %{#{Brut.container.app_organization}/#{Brut.container.app_id}:#{short_version}-#{name}}
-        [
-          name,
-          {
-            cmd:,
-            image_name:,
-            dockerfile: "deploy/Dockerfile.#{name}",
-          },
-        ]
-      }.to_h
+        if !AppDeployConfig.ancestors.include?(Brut::CLI::Apps::Deploy::DeployConfig)
+          fatal "#{deploy_config_path} must define a subclass of Brut::CLI::Apps::Deploy::DeployConfig"
+          return 1
+        end
+        dockerfile = Brut.container.project_root / "deploy" / "Dockerfile"
+        if !dockerfile.exist?
+          fatal "#{dockerfile} does not exist - it should've been created when you added the Docker Deploy segment"
+          return 1
+        end
+        git_checks = Brut::CLI::Apps::Deploy::GitChecks.new(executor: execution_context.executor)
+        results = git_checks.check!
+        if results.errors?
+          results.errors.each do |_,message|
+            fatal message
+          end
+          return 1
+        end
+        version = ""
+        git_guess = %{git rev-parse HEAD}
+        version = capture!(git_guess).strip.chomp
+        if version == ""
+          fatal "Attempt to use git via command '#{git_guess}' to figure out the version failed"
+          return 1
+        end
+        short_version = version[0..7]
 
-      @images = {
-        "web" => {
-          cmd: "bin/run",
-          image_name: %{#{Brut.container.app_organization}/#{app_id}:#{short_version}-web},
-          dockerfile: "deploy/Dockerfile.web",
-        },
-        "release" => {
-          cmd: "bin/release",
-          image_name: %{#{Brut.container.app_organization}/#{app_id}:#{short_version}-release},
-          dockerfile: "deploy/Dockerfile.release",
-        },
-      }.merge(additional_images)
-    end
+        config = AppDeployConfig.new
 
-    def each(&block)
-      if block.parameters.any? { it[0] != :keyreq }
-        raise "block for #{self.class}#each must only contain required keyword parameters"
-      end
-      @images.each do |name,metadata|
-        args = {}
-        block.parameters.each do |(_,param)|
-          if param == :name
-            args[:name] = name
-          else
-            args[param] = metadata.fetch(param)
-          end
+        image_name = %{#{Brut.container.app_organization}/#{Brut.container.app_id}:#{short_version}}
+        if config.registry_hostname
+          image_name = "#{config.registry_hostname}/#{image_name}"
+        end
+        dockerfile = Brut.container.project_root / "deploy" / "Dockerfile"
+        FileUtils.chdir Brut.container.project_root do
+          command = %{docker build --build-arg app_git_sha1=#{version} --file #{dockerfile} --platform #{config.platform} --tag #{image_name} . 2>&1}
+          system!(command, output: :stream)
+        end
+        if options.build_only?
+          puts "Not pushing image"
+        else
+          system!("docker image push #{image_name}", output: :stream)
         end
-        block.(**args)
+
+        0
+      rescue LoadError => ex
+        fatal "Could not find #{deploy_config_path}: #{ex}"
+        1
       end
+
     end
   end
 
-  class Build < Brut::CLI::Commands::BaseCommand
-    def description      = Docker.new.description
-    def opts             = Docker.new.opts
-    def default_rack_env = Docker.new.default_rack_env
-
-    def initialize(push: false)
-      @push = push
-    end
-    def run
-      delegate_to_command(Docker.new(push: @push))
-    end
+  class Heroku < Brut::CLI::Commands::BaseCommand
+    class DeployConfig < Brut::CLI::Apps::Deploy::DeployConfig
 
-    def commands = []
+      def registry_hostname = "registry.heroku.com"
 
-    class Docker < Brut::CLI::Commands::BaseCommand
-      def description = "Build a series of Docker images from a template Dockerfile"
-      def opts = [
-        [ "--platform=PLATFORM","Override default platform. Can be any Docker platform." ],
-        [ "--dry-run", "Only show what would happen, don't actually do anything" ],
-        [ "--skip-checks", "If true, skip pre-build checks (default )" ],
+      def processes = super + [
+        process_description("release", "bin/release")
       ]
-      def default_rack_env = "development"
 
-      def initialize(push: false)
-        @push = push
+      def each_dockerfile(&block)
+        self.processes.each do |description|
+          dockerfile = "Dockerfile.#{description.name}"
+          block.(dockerfile, description)
+        end
       end
-
-      def run
-        if !options.skip_checks?
-          execute_result = Brut::CLI::ExecuteResult.new do
-            delegate_to_command(Brut::CLI::Apps::Deploy::Check.new)
-          end
-          if execute_result.failed?
-            puts theme.error.render("Pre-build checks failed.")
-            return execute_result.exit_status do |error_message|
-              puts theme.error.render("Error message from checks: #{error_message}")
-            end
+    end
+    def description = "Deploy to Heroku using container-based deployment"
+    def opts = [
+      [ "--build-only", "Only generate Dockerfiles and build images, do not deploy" ],
+    ]
+    def run
+      deploy_config_path = Brut.container.project_root / "deploy" / "deploy_config.rb"
+      begin
+        require deploy_config_path
+        if !defined?(AppDeployConfig)
+          fatal "#{deploy_config_path} must define the class AppDeployConfig"
+          return 1
+        end
+        if !AppDeployConfig.ancestors.include?(Brut::CLI::Apps::Deploy::Heroku::DeployConfig)
+          fatal "#{deploy_config_path} must define a subclass of Brut::CLI::Apps::Deploy::Heroku::DeployConfig"
+          return 1
+        end
+        dockerfile = Brut.container.project_root / "deploy" / "Dockerfile"
+        if !dockerfile.exist?
+          fatal "#{dockerfile} does not exist - it should've been created when you added the Heroku segment"
+          return 1
+        end
+        git_checks = Brut::CLI::Apps::Deploy::GitChecks.new(executor: execution_context.executor)
+        results = git_checks.check!
+        if results.errors?
+          results.errors.each do |_,message|
+            fatal message
           end
+          return 1
+        end
+        begin
+          command = %{heroku container:login}
+          system!(command)
+        rescue Brut::CLI::SystemExecError => ex
+          fatal(ex)
+          fatal("Not logged into Heroku")
+          return 1
         end
+        config = AppDeployConfig.new
         version = ""
         git_guess = %{git rev-parse HEAD}
-        system!(git_guess) do |output|
-          version << output
-        end
-        version.strip!.chomp!
+        version = capture!(git_guess).strip.chomp
         if version == ""
-          error "Attempt to use git via command '#{git_guess}' to figure out the version failed"
+          fatal "Attempt to use git via command '#{git_guess}' to figure out the version failed"
           return 1
         end
-        short_version = version[0..7]
-        app_docker_files = AppDockerImages.new(
-          project_root: Brut.container.project_root,
-          organization: Brut.container.app_organization,
-          app_id: Brut.container.app_id,
-          short_version:
-        )
-        options.set_default(:platform, app_docker_files.platform || "linux/amd64")
-
-        FileUtils.chdir Brut.container.project_root do
-
-          puts
-          puts theme.header.render("Generating Dockerfiles")
-          puts
-          rows = []
-          app_docker_files.each do |name:, cmd:, dockerfile:|
-
-            rows << [theme.subheader.render(name), theme.code.render(dockerfile), theme.code.render(cmd) ]
-
-            if !options.dry_run?
-              File.open(dockerfile,"w") do |file|
-                file.puts "# DO NOT EDIT - THIS IS GENERATED"
-                file.puts "# To make changes, modifiy deploy/Dockerfile and run #{$0}"
-                file.puts File.read("deploy/Dockerfile")
-                file.puts
-                file.puts "# Added by #{$0}"
-                file.puts %{CMD [ "bundle", "exec", "#{cmd}" ]}
-              end
-            end
-          end
-          table = Lipgloss::Table.new.headers(["Name", "Dockerfile", "CMD"]).
-            rows(rows).
-            style_func(rows: rows.length, columns: 3) { Lipgloss::Style.new.padding_right(1).padding_left(1) }
-          puts table.render
-
-          puts
-          puts theme.header.render("Images")
-          puts
-          rows = []
-          items = []
-          push_or_load = @push ? "--push" : "--load"
-          app_docker_files.each do |name:, image_name:, dockerfile:|
-            if @push && @push.kind_of?(String)
-              image_name = @push % { name: name }
-            end
-            rows << [ name, theme.code.render(image_name) ]
-            command = %{docker buildx build --provenance=false --build-arg app_git_sha1=#{version} --file #{Brut.container.project_root}/#{dockerfile} --platform #{options.platform} #{push_or_load} --tag #{image_name} . 2>&1}
-            items << theme.code.render(theme.wrap(command, first_indent: false, indent: 7, newline: " \\\n"))
-            if !options.dry_run?
-              puts theme.subheader.render("Building #{@push ? 'and pushing' : '' } '#{name}' image")
-              system!(command)
-            end
-          end
-          if options.dry_run?
-            table = Lipgloss::Table.new.headers(["Name", "Image Name" ]).
-              rows(rows).
-              style_func(rows: rows.length, columns: 3) { Lipgloss::Style.new.padding_right(1).padding_left(1) }
-            puts table.render
-            puts
-            puts theme.subheader.render("Commands:")
-            puts
-            puts Lipgloss::List.new.items(items).item_style(theme.code).render
+        names = []
+        config.each_dockerfile do |process_dockerfile, process_description|
+          process_dockerfile_path = dockerfile.dirname / process_dockerfile
+          FileUtils.cp dockerfile, process_dockerfile_path
+          File.open(dockerfile.dirname / process_dockerfile, "a") do |file|
+            file.puts(process_description.cmd_directive)
           end
+          image_name = "#{config.registry_hostname}/#{Brut.container.app_id}/#{process_description.name}"
+          push_or_load = if options.build_only?
+                           "--load"
+                         else
+                           "--push"
+                         end
+          command = %{docker buildx build --provenance=false --build-arg app_git_sha1=#{version} --file #{process_dockerfile_path} --platform #{config.platform} #{push_or_load} --tag #{image_name} . 2>&1}
+          system!(command, output: :stream)
+          names << process_description.name
+        end
+        deploy_command = "heroku container:release #{names.sort.join(' ')} -a #{Brut.container.app_id}"
+        if options.build_only?
+          puts "Not deploying"
+        else
+          system!(deploy_command, output: :stream)
         end
+
+        0
+      rescue LoadError => ex
+        fatal "Could not find #{deploy_config_path}: #{ex}"
+        1
       end
     end
   end
-
+  class DockerCompose < Brut::CLI::Commands::BaseCommand
+    def default_rack_env = "development"
+    def description = "Manage a docker-compose.yml file to be consistent with your deploy config"
     class Check < Brut::CLI::Commands::BaseCommand
-
-      def description = "Check that a deploy can be reasonably expected to succeed"
-
-      def opts = Git.new.opts
-      def run = delegate_to_command(Git.new)
-      def commands = []
-
-      class Git < Brut::CLI::Commands::BaseCommand
-        def description = "Perform the check assuming Git is the version-control system"
-        def opts = [
-          [ "--[no-]check-branch", "If true, requires that you are on 'main' (default true)" ],
-          [ "--[no-]check-changes", "If true, requires that you have committed all local changes (default true)" ],
-          [ "--[no-]check-push", "If true, requires that you are in sync with origin/main (default true)" ],
-        ]
-
-        def run
-          puts theme.header.render("Checking Git repo to see if changes have all been pushed to main")
-          puts
-
-          options.set_default(:check_branch,  true)
-          options.set_default(:check_changes, true)
-          options.set_default(:check_push,    true)
-
-          checks = []
-
-          branch = ""
-          system!("git branch --show-current") do |output|
-            branch << output
-          end
-          branch = branch.strip.chomp
-          checks << [
-            "Deploy from main",
-          ]
-          if branch != "main"
-            checks.last << "Currently on #{theme.code.render(branch)}"
-            checks.last << options.check_branch?
-          end
-
-          system!("git status") do |*| # reset local caches to account for Docker/host wierdness
-            # ignore
-          end
-          local_changes = ""
-          system!("git diff-index --name-only HEAD --") do |output|
-            local_changes << output
+      def description = "Check if the existing docker-compose.yml is consistent with the deploy config"
+      def default_rack_env = "development"
+      def run
+        docker_compose_path = Brut.container.project_root / "deploy" / "docker-compose.yml"
+        if !docker_compose_path.exist?
+          fatal "Could not find #{docker_compose_path}"
+          return 1
+        end
+        deploy_config_path = Brut.container.project_root / "deploy" / "deploy_config.rb"
+        begin
+          require deploy_config_path
+          if !defined?(AppDeployConfig)
+            fatal "#{deploy_config_path} must define the class AppDeployConfig"
+            return 1
           end
-          checks << [
-            "No un-committed changes",
-          ]
-          if local_changes.strip != ""
-            items = local_changes.split(/\n/)
-            list = Lipgloss::List.new.items(items).item_style(theme.error)
-            checks.last << "Files not committed:\n#{list.render.strip}\n"
-            checks.last << options.check_changes?
+          if !AppDeployConfig.ancestors.include?(Brut::CLI::Apps::Deploy::DeployConfig)
+            fatal "#{deploy_config_path} must define a subclass of Brut::CLI::Apps::Deploy::DeployConfig"
+            return 1
           end
-
-          rev_list = ""
-          system!("git rev-list --left-right --count origin/main...main") do |output|
-            rev_list << output
+          config = AppDeployConfig.new
+          docker_compose_contents = YAML.load(File.read(docker_compose_path))
+          missing = []
+          extra   = []
+          wrong   = {}
+          failed  = false
+          configured_services = []
+          expected_image_name = "#{Brut.container.app_organization}/#{Brut.container.app_id}:${DOCKER_IMAGE_TAG}"
+          if config.registry_hostname
+            expected_image_name = "#{config.registry_hostname}/#{expected_image_name}"
           end
-          remote_ahead, local_ahead = rev_list.strip.chomp.split(/\t/,2).map(&:to_i)
-          checks << [
-            "Pulled from origin",
-          ]
-          if remote_ahead != 0
-            if remote_ahead == 1
-              checks.last << "There is 1 commit in origin you don't have"
+          config.processes.each do |process_description|
+            configured_services << process_description.name
+            service = docker_compose_contents["services"][process_description.name]
+            if service
+              image = service["image"]
+              cmd   = service["command"]
+              if image != expected_image_name
+                wrong[process_description] ||= {}
+                wrong[process_description][:image] = {
+                  expected: expected_image_name,
+                  actual: image
+                }
+                failed = true
+              end
+              if cmd != process_description.cmd
+                wrong[process_description] ||= {}
+                wrong[process_description][:command] = {
+                  expected: process_description.cmd,
+                  actual: cmd
+                }
+                failed = true
+              end
             else
-              checks.last << "There are #{remote_ahead} commits in origin you don't have"
+              missing << process_description
+              failed = true
             end
-            checks.last << options.check_push?
           end
-          checks << [
-            "Pushed to origin",
-          ]
-
-          if local_ahead != 0
-            if local_ahead == 1
-              checks.last << "There is 1 commit not pushed to origin"
-            else
-              checks.last << "There are #{local_ahead} commits not pushed to origin"
+          docker_compose_contents["services"].each do |service_name,configuration|
+            if !configured_services.include?(service_name)
+              extra << service_name
+              failed = true
             end
-            checks.last << options.check_push?
           end
-
-          rows = []
-          checks.each do |(check,status,error)|
-            row = [ check ]
-            if status
-              if error
-                row << theme.error.render("FAILED")
-              else
-                row << theme.warning.render("Ignored")
+          if failed
+            missing.each do |process_description|
+              fatal "service #{process_description.name}: MISSING"
+            end
+            wrong.each do |process_description, problems|
+              problems.each do |key,expected_actual|
+                fatal "service #{process_description.name}: #{key} incorrect. Expected '#{expected_actual[:expected]}', but got '#{expected_actual[:actual]}'"
               end
-              row << theme.error.render(status)
-            else
-              row << theme.success.render("OK")
-              row << ""
             end
-            rows << row
-          end
-          table = Lipgloss::Table.new.
-            headers(["Check", "Result", "Details"]).
-            rows(rows).
-            style_func(rows: rows.length, columns: 3) { |row,column|
-            if row == Lipgloss::Table::HEADER_ROW
-              Lipgloss::Style.new.inherit(theme.header).padding_left(1).padding_right(1)
-            elsif column == 0
-              Lipgloss::Style.new.inherit(theme.subheader).padding_left(1).padding_right(1).padding_bottom(1)
-            else
-              Lipgloss::Style.new.inherit(theme.none).padding_left(1).padding_right(1).padding_bottom(1)
+            extra.each do |service_name|
+              fatal "service #{service_name}: not in deploy config"
             end
-          }
-        puts table.render
-        checks_failed = checks.count { |(_,status,_)| status }
-        checks_failed_not_ignored = checks.count { |(_,status,error)| status && error }
-        if checks_failed > 0
-          if checks_failed_not_ignored > 0
-            puts theme.error.render("#{checks_failed} checks failed - aborting")
             return 1
-          else
-            puts theme.warning.render("#{checks_failed} checks failed but ignored")
           end
-        else
-          puts theme.success.render("All checks passed")
+          0
+        rescue LoadError => ex
+          fatal "Could not find #{deploy_config_path}: #{ex}"
+          1
         end
+      end
+    end
+    class Generate < Brut::CLI::Commands::BaseCommand
+      def description = "Generate or update the existing docker-compose.yml based on current deploy config"
+      def default_rack_env = "development"
+      def run
+        docker_compose_path = Brut.container.project_root / "deploy" / "docker-compose.yml"
+        deploy_config_path = Brut.container.project_root / "deploy" / "deploy_config.rb"
+        begin
+          require deploy_config_path
+          if !defined?(AppDeployConfig)
+            fatal "#{deploy_config_path} must define the class AppDeployConfig"
+            return 1
+          end
+          if !AppDeployConfig.ancestors.include?(Brut::CLI::Apps::Deploy::DeployConfig)
+            fatal "#{deploy_config_path} must define a subclass of Brut::CLI::Apps::Deploy::DeployConfig"
+            return 1
+          end
+          config = AppDeployConfig.new
+          yaml_contents = if docker_compose_path.exist?
+                            YAML.load(File.read(docker_compose_path))
+                          else
+                            {}
+                          end
+          yaml_contents["services"] ||= {}
+
+          image_name = "#{Brut.container.app_organization}/#{Brut.container.app_id}:${DOCKER_IMAGE_TAG}"
+          if config.registry_hostname
+            image_name = "#{config.registry_hostname}/#{image_name}"
+          end
+          configured_services = []
+          config.processes.each do |process_description|
+            configured_services << process_description.name
+            existing = yaml_contents["services"][process_description.name]
+            if !existing
+              puts "Creating configuration for '#{process_description.name}'"
+              existing = {
+                "env_file" => "/etc/#{Brut.container.app_id}/env",
+                "extra_hosts" => [
+                  "host.docker.internal:host-gateway",
+                ],
+                "restart" => "unless-stopped",
+              }
+              if process_description.name == "web"
+                existing["ports"] = [
+                  "127.0.0.1:6502:6502",
+                ]
+              end
+            else
+              puts "Updating image and command for '#{process_description.name}'"
+            end
+            existing["image"] = image_name
+            existing["command"] = process_description.cmd
+            yaml_contents["services"][process_description.name] = existing
+          end
+          trimmed_services = yaml_contents["services"].select { |service_name, service_configuration|
+            configured_services.include?(service_name).tap { |exists|
+              if !exists
+                puts "Removing configuration for '#{service_name}'"
+              end
+            }
+          }.to_h
+          yaml_contents["services"] = trimmed_services
 
-        0
+          File.open(docker_compose_path,"w") do |file|
+            file.puts YAML.dump(yaml_contents)
+          end
+          0
+        rescue LoadError => ex
+          fatal "Could not find #{deploy_config_path}: #{ex}"
+          1
+        end
       end
     end
   end

data/lib/brut/cli/apps/new/add_segment.rb

@@ -28,6 +28,11 @@ class Brut::CLI::Apps::New
                      project_root: add_segment_options.project_root,
                      templates_dir:
                    )
+                 elsif @add_segment_options.segment_name == "docker-deploy"
+                   Brut::CLI::Apps::New::Segments::DockerDeploy.new(
+                     project_root: add_segment_options.project_root,
+                     templates_dir:
+                   )
                  end
     end