cpflow 3.0.0 → 4.0.0

data/lib/command/maintenance_off.rb

@@ -15,48 +15,14 @@ module Command
       - Maintenance mode is only supported for domains that use path based routing mode and have a route configured for the prefix '/' on either port 80 or 443
     DESC
 
-    def call # rubocop:disable Metrics/MethodLength
-      one_off_workload = config[:one_off_workload]
-      maintenance_workload = config.current[:maintenance_workload] || "maintenance"
-
-      domain_data = if config.domain
-                      cp.fetch_domain(config.domain)
-                    else
-                      cp.find_domain_for([one_off_workload, maintenance_workload])
-                    end
-      unless domain_data
-        raise "Can't find domain. " \
-              "Maintenance mode is only supported for domains that use path based routing mode " \
-              "and have a route configured for the prefix '/' on either port 80 or 443."
-      end
-
-      domain = domain_data["name"]
-      if cp.domain_workload_matches?(domain_data, one_off_workload)
-        progress.puts("Maintenance mode is already disabled for app '#{config.app}'.")
-        return
-      end
-
-      cp.fetch_workload!(maintenance_workload)
-
-      # Start all other workloads
-      Cpflow::Cli.start(["ps:start", "-a", config.app, "--wait"])
-
-      progress.puts
-
-      # Switch domain workload
-      step("Switching workload for domain '#{domain}' to '#{one_off_workload}'") do
-        cp.set_domain_workload(domain_data, one_off_workload)
-
-        # Give it a bit of time for the domain to update
-        Kernel.sleep(30)
-      end
-
-      progress.puts
+    def call
+      maintenance_mode.disable!
+    end
 
-      # Stop maintenance workload
-      Cpflow::Cli.start(["ps:stop", "-a", config.app, "-w", maintenance_workload, "--wait"])
+    private
 
-      progress.puts("\nMaintenance mode disabled for app '#{config.app}'.")
+    def maintenance_mode
+      @maintenance_mode ||= MaintenanceMode.new(self)
     end
   end
 end

data/lib/command/maintenance_on.rb

@@ -15,48 +15,14 @@ module Command
       - Maintenance mode is only supported for domains that use path based routing mode and have a route configured for the prefix '/' on either port 80 or 443
     DESC
 
-    def call # rubocop:disable Metrics/MethodLength
-      one_off_workload = config[:one_off_workload]
-      maintenance_workload = config.current[:maintenance_workload] || "maintenance"
-
-      domain_data = if config.domain
-                      cp.fetch_domain(config.domain)
-                    else
-                      cp.find_domain_for([one_off_workload, maintenance_workload])
-                    end
-      unless domain_data
-        raise "Can't find domain. " \
-              "Maintenance mode is only supported for domains that use path based routing mode " \
-              "and have a route configured for the prefix '/' on either port 80 or 443."
-      end
-
-      domain = domain_data["name"]
-      if cp.domain_workload_matches?(domain_data, maintenance_workload)
-        progress.puts("Maintenance mode is already enabled for app '#{config.app}'.")
-        return
-      end
-
-      cp.fetch_workload!(maintenance_workload)
-
-      # Start maintenance workload
-      Cpflow::Cli.start(["ps:start", "-a", config.app, "-w", maintenance_workload, "--wait"])
-
-      progress.puts
-
-      # Switch domain workload
-      step("Switching workload for domain '#{domain}' to '#{maintenance_workload}'") do
-        cp.set_domain_workload(domain_data, maintenance_workload)
-
-        # Give it a bit of time for the domain to update
-        Kernel.sleep(30)
-      end
-
-      progress.puts
+    def call
+      maintenance_mode.enable!
+    end
 
-      # Stop all other workloads
-      Cpflow::Cli.start(["ps:stop", "-a", config.app, "--wait"])
+    private
 
-      progress.puts("\nMaintenance mode enabled for app '#{config.app}'.")
+    def maintenance_mode
+      @maintenance_mode ||= MaintenanceMode.new(self)
     end
   end
 end

data/lib/command/no_command.rb

@@ -14,9 +14,9 @@ module Command
 
     def call
       if config.options[:version]
-        Cpflow::Cli.start(["version"])
+        run_cpflow_command("version")
       else
-        Cpflow::Cli.start(["help"])
+        run_cpflow_command("help")
       end
     end
   end

data/lib/command/promote_app_from_upstream.rb

@@ -25,14 +25,14 @@ module Command
     private
 
     def copy_image_from_upstream
-      Cpflow::Cli.start(["copy-image-from-upstream", "-a", config.app, "-t", config.options[:upstream_token]])
+      run_cpflow_command("copy-image-from-upstream", "-a", config.app, "-t", config.options[:upstream_token])
       progress.puts
     end
 
     def deploy_image
       args = []
       args.push("--run-release-phase") if config.current[:release_script]
-      Cpflow::Cli.start(["deploy-image", "-a", config.app, *args])
+      run_cpflow_command("deploy-image", "-a", config.app, *args)
     end
   end
 end

data/lib/command/run.rb

@@ -243,7 +243,7 @@ module Command
 
       step("Updating runner workload '#{runner_workload}'") do
         # Update runner workload
-        @expected_deployed_version = cp.cron_workload_deployed_version(runner_workload) + 1
+        @expected_deployed_version = (cp.cron_workload_deployed_version(runner_workload) || 0) + 1
         cp.apply_hash("kind" => "workload", "name" => runner_workload, "spec" => spec)
       end
     end
@@ -256,7 +256,7 @@ module Command
 
     def wait_for_runner_workload_update
       step("Waiting for runner workload '#{runner_workload}' to be updated", retry_on_failure: true) do
-        cp.cron_workload_deployed_version(runner_workload) >= expected_deployed_version
+        (cp.cron_workload_deployed_version(runner_workload) || 0) >= expected_deployed_version
       end
     end
 
@@ -306,7 +306,7 @@ module Command
           exit(ExitCode::SUCCESS)
         end
 
-        Cpflow::Cli.start(["logs", *app_workload_replica_args])
+        run_cpflow_command("logs", *app_workload_replica_args)
       end
       Process.detach(logs_pid)
 

data/lib/command/setup_app.rb

@@ -42,7 +42,7 @@ module Command
 
       args = []
       args.push("--add-app-identity") unless skip_secrets_setup
-      Cpflow::Cli.start(["apply-template", *templates, "-a", config.app, *args])
+      run_cpflow_command("apply-template", *templates, "-a", config.app, *args)
 
       bind_identity_to_policy unless skip_secrets_setup
       run_post_creation_hook unless config.options[:skip_post_creation_hook]

data/lib/command/test.rb

@@ -16,8 +16,8 @@ module Command
     def call
       # Modify this method to trigger the code you want to test.
       # You can use `debugger` to debug.
-      # You can use `Cpflow::Cli.start` to simulate a command
-      # (e.g., `Cpflow::Cli.start(["deploy-image", "-a", "my-app-name"])`).
+      # You can use `run_cpflow_command` to simulate a command
+      # (e.g., `run_cpflow_command("deploy-image", "-a", "my-app-name")`).
     end
   end
 end

data/lib/core/controlplane.rb

@@ -90,7 +90,7 @@ class Controlplane # rubocop:disable Metrics/ClassLength
     api.query_images(org: a_org, gvc: a_gvc, gvc_op_type: gvc_op)
   end
 
-  def image_build(image, dockerfile:, docker_args: [], build_args: [], push: true)
+  def image_build(image, dockerfile:, docker_args: [], build_args: [])
     # https://docs.controlplane.com/guides/push-image#step-2
     # Might need to use `docker buildx build` if compatiblitity issues arise
     cmd = "docker build --platform=linux/amd64 -t #{image} -f #{dockerfile}"
@@ -99,9 +99,8 @@ class Controlplane # rubocop:disable Metrics/ClassLength
     cmd += " #{docker_args.join(' ')}" if docker_args.any?
     build_args.each { |build_arg| cmd += " --build-arg #{build_arg}" }
     cmd += " #{config.app_dir}"
-    perform!(cmd)
 
-    image_push(image) if push
+    perform!(cmd)
   end
 
   def fetch_image_details(image)
@@ -278,7 +277,7 @@ class Controlplane # rubocop:disable Metrics/ClassLength
   end
 
   def workload_exec(workload, replica, location:, container: nil, command: nil)
-    cmd = "cpln workload exec #{workload} #{gvc_org} --replica #{replica} --location #{location}"
+    cmd = "cpln workload exec #{workload} #{gvc_org} --replica #{replica} --location #{location} -it"
     cmd += " --container #{container}" if container
     cmd += " -- #{command}"
     perform!(cmd, output_mode: :all)

data/lib/core/doctor_service.rb

@@ -3,10 +3,12 @@
 class ValidationError < StandardError; end
 
 class DoctorService
-  attr_reader :config
+  extend Forwardable
 
-  def initialize(config)
-    @config = config
+  def_delegators :@command, :config, :progress
+
+  def initialize(command)
+    @command = command
   end
 
   def run_validations(validations, silent_if_passing: false) # rubocop:disable Metrics/MethodLength
@@ -37,7 +39,7 @@ class DoctorService
   end
 
   def validate_templates
-    @template_parser = TemplateParser.new(config)
+    @template_parser = TemplateParser.new(@command)
     filenames = Dir.glob("#{@template_parser.template_dir}/*.yml")
     templates = @template_parser.parse(filenames)
 
@@ -97,8 +99,4 @@ class DoctorService
            .join("\n")
     progress.puts("\n#{Shell.color("DEPRECATED: #{message}", :yellow)}\n#{list}\n\n")
   end
-
-  def progress
-    $stderr
-  end
 end

data/lib/core/maintenance_mode.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+class MaintenanceMode
+  extend Forwardable
+
+  def_delegators :@command, :config, :progress, :cp, :step, :run_cpflow_command
+
+  def initialize(command)
+    @command = command
+  end
+
+  def enabled?
+    validate_domain_exists!
+    cp.domain_workload_matches?(domain_data, maintenance_workload)
+  end
+
+  def disabled?
+    validate_domain_exists!
+    cp.domain_workload_matches?(domain_data, one_off_workload)
+  end
+
+  def enable!
+    if enabled?
+      progress.puts("Maintenance mode is already enabled for app '#{config.app}'.")
+    else
+      enable_maintenance_mode
+    end
+  end
+
+  def disable!
+    if disabled?
+      progress.puts("Maintenance mode is already disabled for app '#{config.app}'.")
+    else
+      disable_maintenance_mode
+    end
+  end
+
+  private
+
+  def enable_maintenance_mode
+    validate_maintenance_workload_exists!
+
+    start_or_stop_maintenance_workload(:start)
+    switch_domain_workload(to: maintenance_workload)
+    start_or_stop_all_workloads(:stop)
+
+    progress.puts("\nMaintenance mode enabled for app '#{config.app}'.")
+  end
+
+  def disable_maintenance_mode
+    validate_maintenance_workload_exists!
+
+    start_or_stop_maintenance_workload(:start)
+    switch_domain_workload(to: one_off_workload)
+    start_or_stop_all_workloads(:stop)
+
+    progress.puts("\nMaintenance mode disabled for app '#{config.app}'.")
+  end
+
+  def validate_domain_exists!
+    return if domain_data
+
+    raise "Can't find domain. " \
+          "Maintenance mode is only supported for domains that use path based routing mode " \
+          "and have a route configured for the prefix '/' on either port 80 or 443."
+  end
+
+  def validate_maintenance_workload_exists!
+    cp.fetch_workload!(maintenance_workload)
+  end
+
+  def start_or_stop_all_workloads(action)
+    run_cpflow_command("ps:#{action}", "-a", config.app, "--wait")
+
+    progress.puts
+  end
+
+  def start_or_stop_maintenance_workload(action)
+    run_cpflow_command("ps:#{action}", "-a", config.app, "-w", maintenance_workload, "--wait")
+
+    progress.puts
+  end
+
+  def switch_domain_workload(to:)
+    step("Switching workload for domain '#{domain_data['name']}' to '#{to}'") do
+      cp.set_domain_workload(domain_data, to)
+
+      # Give it a bit of time for the domain to update
+      Kernel.sleep(30)
+    end
+
+    progress.puts
+  end
+
+  def domain_data
+    @domain_data ||=
+      if config.domain
+        cp.fetch_domain(config.domain)
+      else
+        cp.find_domain_for([one_off_workload, maintenance_workload])
+      end
+  end
+
+  def one_off_workload
+    @one_off_workload ||= config[:one_off_workload]
+  end
+
+  def maintenance_workload
+    @maintenance_workload ||= config.current[:maintenance_workload] || "maintenance"
+  end
+end

data/lib/core/template_parser.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
 class TemplateParser
-  attr_reader :config, :deprecated_variables
+  extend Forwardable
 
-  def initialize(config)
-    @config = config
+  def_delegators :@command, :config, :cp
+
+  attr_reader :deprecated_variables
+
+  def initialize(command)
+    @command = command
   end
 
   def template_dir
@@ -69,8 +73,4 @@ class TemplateParser
       "APP_IMAGE" => "{{APP_IMAGE}}"
     }
   end
-
-  def cp
-    @cp ||= Controlplane.new(config)
-  end
 end

data/lib/cpflow/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Cpflow
-  VERSION = "3.0.0"
-  MIN_CPLN_VERSION = "2.0.1"
+  VERSION = "4.0.0"
+  MIN_CPLN_VERSION = "3.1.0"
 end

data/lib/cpflow.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "date"
+require "forwardable"
 require "dotenv/load"
 require "cgi"
 require "json"
@@ -30,25 +31,7 @@ at_exit do
   end
 end
 
-# Fix for https://github.com/erikhuda/thor/issues/398
-# Copied from https://github.com/rails/thor/issues/398#issuecomment-622988390
-class Thor
-  module Shell
-    class Basic
-      def print_wrapped(message, options = {})
-        indent = (options[:indent] || 0).to_i
-        if indent.zero?
-          stdout.puts(message)
-        else
-          message.each_line do |message_line|
-            stdout.print(" " * indent)
-            stdout.puts(message_line.chomp)
-          end
-        end
-      end
-    end
-  end
-end
+require_relative "patches/thor"
 
 module Cpflow
   class Error < StandardError; end
@@ -64,7 +47,7 @@ module Cpflow
       check_cpflow_version
       fix_help_option
 
-      super(*args)
+      super
     end
 
     def self.check_cpln_version # rubocop:disable Metrics/MethodLength
@@ -127,7 +110,7 @@ module Cpflow
     def self.is_thor_reserved_word?(word, type) # rubocop:disable Naming/PredicateName
       return false if word == "run"
 
-      super(word, type)
+      super
     end
 
     def self.deprecated_commands
@@ -226,12 +209,14 @@ module Cpflow
 
           Cpflow::Cli.show_info_header(config) if with_info_header
 
+          command = command_class.new(config)
+
           if validations.any? && ENV.fetch("DISABLE_VALIDATIONS", nil) != "true"
-            doctor = DoctorService.new(config)
+            doctor = DoctorService.new(command)
             doctor.run_validations(validations, silent_if_passing: true)
           end
 
-          command_class.new(config).call
+          command.call
         rescue RuntimeError => e
           ::Shell.abort(e.message)
         end

data/lib/patches/thor.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class Thor
+  # Fix for https://github.com/erikhuda/thor/issues/398
+  # Copied from https://github.com/rails/thor/issues/398#issuecomment-622988390
+  module Shell
+    class Basic
+      def print_wrapped(message, options = {})
+        indent = (options[:indent] || 0).to_i
+        if indent.zero?
+          stdout.puts(message)
+        else
+          message.each_line do |message_line|
+            stdout.print(" " * indent)
+            stdout.puts(message_line.chomp)
+          end
+        end
+      end
+    end
+  end
+
+  # Fix for https://github.com/rails/thor/issues/742
+  def self.basename
+    @package_name || super
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpflow
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Justin Gordon
@@ -9,22 +9,8 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-21 00:00:00.000000000 Z
+date: 2024-08-22 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: debug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.7.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.7.1
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -81,132 +67,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.1
-- !ruby/object:Gem::Dependency
-  name: overcommit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.60.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.60.0
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.12.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.12.0
-- !ruby/object:Gem::Dependency
-  name: rspec-retry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.2
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.45.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.45.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.18.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.18.1
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.22.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.22.0
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.6
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.18.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.18.1
 description: CLI for providing Heroku-like platform-as-a-service on Control Plane
 email:
 - justin@shakacode.com
@@ -219,6 +79,7 @@ files:
 - ".github/workflows/check_cpln_links.yml"
 - ".github/workflows/command_docs.yml"
 - ".github/workflows/rspec-shared.yml"
+- ".github/workflows/rspec-specific.yml"
 - ".github/workflows/rspec.yml"
 - ".github/workflows/rubocop.yml"
 - ".gitignore"
@@ -288,6 +149,7 @@ files:
 - lib/core/controlplane_api_direct.rb
 - lib/core/doctor_service.rb
 - lib/core/helpers.rb
+- lib/core/maintenance_mode.rb
 - lib/core/shell.rb
 - lib/core/template_parser.rb
 - lib/cpflow.rb
@@ -299,6 +161,7 @@ files:
 - lib/generator_templates/templates/app.yml
 - lib/generator_templates/templates/postgres.yml
 - lib/generator_templates/templates/rails.yml
+- lib/patches/thor.rb
 - rakelib/create_release.rake
 - script/add_command
 - script/check_command_docs