cpl 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0be2530a33ac1f8a6b71d6d90eca0026b1048faf76b3e2f88cf13572f7e50a92
-  data.tar.gz: c15e191f5d8e984aece73bf5954ba977ee1c3013851447592ef4f2e96c1e2732
+  metadata.gz: cfd7383099c36f633d327424fcb36561e2b925120e63f1b814158a43bd55103f
+  data.tar.gz: eafdf0607fe28d3c24f8132e3a116085020c94639d5b05a5accec4d4de651ca5
 SHA512:
-  metadata.gz: 9fe01da2ec88fdb25ba56b9ca78267f8cca42b73f219576decc4af5c0aa695168d08b32692bcdcabc7274ab1f5e9f587d3d7b09d18817c262f011fc328ee7409
-  data.tar.gz: a88847f98eaa1426eeabe23919cd1dbbf31275491e61ba825eebb44ae991b8eba087ffa1c61986e9f576026dbac59f4f118f00abcbfdfb273997ba95c1b27cdc
+  metadata.gz: b443d26a3fa91400dbb6d2e71b730a26bd1405df2f03e7f9446179323e2becb532ec69d81d93f22578fe8793dbabec9a2283efc16a107decdb5aaa9e4a615281
+  data.tar.gz: 34ab7670bc372af9b8991678de9d99a9c60429b3caebeeeb2775046a9be3d4a7fb7335d9cbeb3a6c2ba06bb29ef40ab7c2cffbcd20737cfb62eb4048b07a8926

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cpl (0.5.0)
+    cpl (0.6.0)
       debug (~> 1.7.1)
       dotenv (~> 2.8.1)
       psych (~> 5.1.0)
@@ -20,7 +20,7 @@ GEM
     dotenv (2.8.1)
     iniparse (1.5.0)
     io-console (0.6.0)
-    irb (1.6.3)
+    irb (1.6.4)
       reline (>= 0.3.0)
     json (2.6.3)
     overcommit (0.60.0)
@@ -77,7 +77,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    stringio (3.0.5)
+    stringio (3.0.6)
     thor (1.2.1)
     unicode-display_width (2.4.2)
 

data/docs/commands.md

@@ -11,6 +11,30 @@ This `-a` option is used in most of the commands and will pick all other app con
 
 ### Commands
 
+### `apply-template`
+
+- Applies application-specific configs from templates (e.g., for every review-app)
+- Publishes (creates or updates) those at Control Plane infrastructure
+- Picks templates from the `.controlplane/templates` directory
+- Templates are ordinary Control Plane templates but with variable preprocessing
+
+**Preprocessed template variables:**
+
+```
+APP_GVC      - basically GVC or app name
+APP_LOCATION - default location
+APP_ORG      - organization
+APP_IMAGE    - will use latest app image
+```
+
+```sh
+# Applies single template.
+cpl apply-template redis -a $APP_NAME
+
+# Applies several templates (practically creating full app).
+cpl apply-template gvc postgres redis rails -a $APP_NAME
+```
+
 ### `build-image`
 
 - Builds and pushes the image to Control Plane
@@ -238,6 +262,13 @@ cpl run rails c -a $APP_NAME
 # Uses a different image (which may not be promoted yet).
 cpl run rails db:migrate -a $APP_NAME --image appimage:123 # Exact image name
 cpl run rails db:migrate -a $APP_NAME --image latest       # Latest sequential image
+
+# Uses a different workload
+cpl run bash -a $APP_NAME -w other-workload
+
+# Overrides remote CPLN_TOKEN env variable with local token.
+# Useful when need superuser rights in remote container
+cpl run bash -a $APP_NAME --use-local-token
 ```
 
 ### `run:detached`
@@ -263,30 +294,19 @@ cpl run:detached rails db:migrate -a $APP_NAME --image latest
 # Uses a different image (which may not be promoted yet).
 cpl run:detached rails db:migrate -a $APP_NAME --image appimage:123 # Exact image name
 cpl run:detached rails db:migrate -a $APP_NAME --image latest       # Latest sequential image
-```
-
-### `setup`
 
-- Applies application-specific configs from templates (e.g., for every review-app)
-- Publishes (creates or updates) those at Control Plane infrastructure
-- Picks templates from the `.controlplane/templates` directory
-- Templates are ordinary Control Plane templates but with variable preprocessing
+# Uses a different workload
+cpl run:detached rails db:migrate:status -a $APP_NAME -w other-workload
+```
 
-**Preprocessed template variables:**
+### `setup-app`
 
-```
-APP_GVC      - basically GVC or app name
-APP_LOCATION - default location
-APP_ORG      - organization
-APP_IMAGE    - will use latest app image
-```
+- Creates an app and all its workloads
+- Specify the templates for the app and workloads through `setup` in the `.controlplane/controlplane.yml` file
+- This should should only be used for temporary apps like review apps, never for persistent apps like production (to update workloads for those, use 'cpl apply-template' instead)
 
 ```sh
-# Applies single template.
-cpl setup redis -a $APP_NAME
-
-# Applies several templates (practically creating full app).
-cpl setup gvc postgres redis rails -a $APP_NAME
+cpl setup-app -a $APP_NAME
 ```
 
 ### `version`

data/lib/command/{setup.rb → apply_template.rb}

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 module Command
-  class Setup < Base
-    NAME = "setup"
-    USAGE = "setup TEMPLATE [TEMPLATE] ... [TEMPLATE]"
+  class ApplyTemplate < Base # rubocop:disable Metrics/ClassLength
+    NAME = "apply-template"
+    USAGE = "apply-template TEMPLATE [TEMPLATE] ... [TEMPLATE]"
     REQUIRES_ARGS = true
     OPTIONS = [
-      app_option(required: true)
+      app_option(required: true),
+      skip_confirm_option
     ].freeze
     DESCRIPTION = "Applies application-specific configs from templates"
     LONG_DESCRIPTION = <<~DESC
@@ -27,28 +28,35 @@ module Command
     EXAMPLES = <<~EX
       ```sh
       # Applies single template.
-      cpl setup redis -a $APP_NAME
+      cpl apply-template redis -a $APP_NAME
 
       # Applies several templates (practically creating full app).
-      cpl setup gvc postgres redis rails -a $APP_NAME
+      cpl apply-template gvc postgres redis rails -a $APP_NAME
       ```
     EX
 
     def call # rubocop:disable Metrics/MethodLength
+      ensure_templates!
+
       @app_status = :existing
       @created_workloads = []
       @failed_workloads = []
+      @skipped_workloads = []
 
-      config.args.each do |template|
-        filename = "#{config.app_cpln_dir}/templates/#{template}.yml"
+      @asked_for_confirmation = false
 
-        step("Applying template '#{template}'", abort_on_error: false) do
-          unless File.exist?(filename)
-            report_failure(template)
+      pending_templates = templates.select do |template|
+        if template == "gvc"
+          confirm_app(template)
+        else
+          confirm_workload(template)
+        end
+      end
 
-            raise "Can't find template '#{template}' at '#{filename}', please create it."
-          end
+      progress.puts if @asked_for_confirmation
 
+      pending_templates.each do |template, filename|
+        step("Applying template '#{template}'", abort_on_error: false) do
           apply_template(filename)
           if $CHILD_STATUS.success?
             report_success(template)
@@ -63,10 +71,58 @@ module Command
       print_app_status
       print_created_workloads
       print_failed_workloads
+      print_skipped_workloads
     end
 
     private
 
+    def templates
+      @templates ||= config.args.to_h do |template|
+        [template, "#{config.app_cpln_dir}/templates/#{template}.yml"]
+      end
+    end
+
+    def ensure_templates!
+      missing_templates = templates.filter { |_template, filename| !File.exist?(filename) }.to_h
+      return if missing_templates.empty?
+
+      missing_templates_str = missing_templates.map do |template, filename|
+        "  - #{template} (#{filename})"
+      end.join("\n")
+      progress.puts("#{Shell.color('Missing templates:', :red)}\n#{missing_templates_str}\n\n")
+
+      raise "Can't find templates above, please create them."
+    end
+
+    def confirm_apply(message)
+      return true if config.options[:yes]
+
+      @asked_for_confirmation = true
+      Shell.confirm(message)
+    end
+
+    def confirm_app(template)
+      app = cp.fetch_gvc
+      return true unless app
+
+      confirmed = confirm_apply("App '#{config.app}' already exists, do you want to re-create it?")
+      return true if confirmed
+
+      report_skipped(template)
+      false
+    end
+
+    def confirm_workload(template)
+      workload = cp.fetch_workload(template)
+      return true unless workload
+
+      confirmed = confirm_apply("Workload '#{template}' already exists, do you want to re-create it?")
+      return true if confirmed
+
+      report_skipped(template)
+      false
+    end
+
     def apply_template(filename)
       data = File.read(filename)
                  .gsub("APP_GVC", config.app)
@@ -93,13 +149,24 @@ module Command
       end
     end
 
+    def report_skipped(template)
+      if template == "gvc"
+        @app_status = :skipped
+      else
+        @skipped_workloads.push(template)
+      end
+    end
+
     def print_app_status
       return if @app_status == :existing
 
-      if @app_status == :success
+      case @app_status
+      when :success
         progress.puts("\n#{Shell.color("Created app '#{config.app}'.", :green)}")
-      else
+      when :failure
         progress.puts("\n#{Shell.color("Failed to create app '#{config.app}'.", :red)}")
+      when :skipped
+        progress.puts("\n#{Shell.color("Skipped app '#{config.app}' (already exists).", :blue)}")
       end
     end
 
@@ -116,5 +183,12 @@ module Command
       workloads = @failed_workloads.map { |template| "  - #{template}" }.join("\n")
       progress.puts("\n#{Shell.color('Failed to create workloads:', :red)}\n#{workloads}")
     end
+
+    def print_skipped_workloads
+      return unless @skipped_workloads.any?
+
+      workloads = @skipped_workloads.map { |template| "  - #{template}" }.join("\n")
+      progress.puts("\n#{Shell.color('Skipped workloads (already exist):', :blue)}\n#{workloads}")
+    end
   end
 end

data/lib/command/base.rb

@@ -142,13 +142,24 @@ module Command
       }
     end
 
+    def self.use_local_token_option(required: false)
+      {
+        name: :use_local_token,
+        params: {
+          desc: "Override remote CPLN_TOKEN with local token",
+          type: :boolean,
+          required: required
+        }
+      }
+    end
+
     def self.all_options
       methods.grep(/_option$/).map { |method| send(method.to_s) }
     end
 
     def self.all_options_by_key_name
       all_options.each_with_object({}) do |option, result|
-        option[:params][:aliases].each { |current_alias| result[current_alias.to_s] = option }
+        option[:params][:aliases]&.each { |current_alias| result[current_alias.to_s] = option }
         result["--#{option[:name]}"] = option
       end
     end
@@ -168,7 +179,7 @@ module Command
 
     def wait_for_replica(workload, location)
       wait_for("replica") do
-        cp.workload_get_replicas(workload, location: location)&.dig("items", 0)
+        cp.workload_get_replicas_safely(workload, location: location)&.dig("items", 0)
       end
     end
 

data/lib/command/deploy_image.rb

@@ -11,18 +11,28 @@ module Command
       - Deploys the latest image to app workloads
     DESC
 
-    def call
+    def call # rubocop:disable Metrics/MethodLength
+      deployed_endpoints = {}
+
       image = latest_image
 
       config[:app_workloads].each do |workload|
-        cp.fetch_workload!(workload).dig("spec", "containers").each do |container|
+        workload_data = cp.fetch_workload!(workload)
+        workload_data.dig("spec", "containers").each do |container|
           next unless container["image"].match?(%r{^/org/#{config.org}/image/#{config.app}:})
 
-          step("Deploying image '#{image}' for workload '#{container['name']}'") do
-            cp.workload_set_image_ref(workload, container: container["name"], image: image)
+          container_name = container["name"]
+          step("Deploying image '#{image}' for workload '#{container_name}'") do
+            cp.workload_set_image_ref(workload, container: container_name, image: image)
+            deployed_endpoints[container_name] = workload_data.dig("status", "endpoint")
           end
         end
       end
+
+      progress.puts("\nDeployed endpoints:")
+      deployed_endpoints.each do |workload, endpoint|
+        progress.puts("  - #{workload}: #{endpoint}")
+      end
     end
   end
 end

data/lib/command/run.rb

@@ -8,7 +8,9 @@ module Command
     DEFAULT_ARGS = ["bash"].freeze
     OPTIONS = [
       app_option(required: true),
-      image_option
+      image_option,
+      workload_option,
+      use_local_token_option
     ].freeze
     DESCRIPTION = "Runs one-off **_interactive_** replicas (analog of `heroku run`)"
     LONG_DESCRIPTION = <<~DESC
@@ -34,19 +36,25 @@ module Command
       # Uses a different image (which may not be promoted yet).
       cpl run rails db:migrate -a $APP_NAME --image appimage:123 # Exact image name
       cpl run rails db:migrate -a $APP_NAME --image latest       # Latest sequential image
+
+      # Uses a different workload
+      cpl run bash -a $APP_NAME -w other-workload
+
+      # Overrides remote CPLN_TOKEN env variable with local token.
+      # Useful when need superuser rights in remote container
+      cpl run bash -a $APP_NAME --use-local-token
       ```
     EX
 
-    attr_reader :location, :workload, :one_off
+    attr_reader :location, :workload, :one_off, :container
 
     def call
       @location = config[:default_location]
-      @workload = config[:one_off_workload]
+      @workload = config.options["workload"] || config[:one_off_workload]
       @one_off = "#{workload}-run-#{rand(1000..9999)}"
 
       clone_workload
       wait_for_workload(one_off)
-      sleep 2 # sometimes replica query lags workload creation, despite ok by prev query
       wait_for_replica(one_off, location)
       run_in_replica
     ensure
@@ -60,15 +68,16 @@ module Command
 
       # Create a base copy of workload props
       spec = cp.fetch_workload!(workload).fetch("spec")
-      container = spec["containers"].detect { _1["name"] == workload } || spec["containers"].first
+      container_spec = spec["containers"].detect { _1["name"] == workload } || spec["containers"].first
+      @container = container_spec["name"]
 
       # remove other containers if any
-      spec["containers"] = [container]
+      spec["containers"] = [container_spec]
 
       # Stub workload command with dummy server that just responds to port
       # Needed to avoid execution of ENTRYPOINT and CMD of Dockerfile
-      container["command"] = "ruby"
-      container["args"] = ["-e", Scripts.http_dummy_server_ruby]
+      container_spec["command"] = "ruby"
+      container_spec["args"] = ["-e", Scripts.http_dummy_server_ruby]
 
       # Ensure one-off workload will be running
       spec["defaultOptions"]["suspend"] = false
@@ -81,11 +90,15 @@ module Command
       # Override image if specified
       image = config.options[:image]
       image = "/org/#{config.org}/image/#{latest_image}" if image == "latest"
-      container["image"] = image if image
+      container_spec["image"] = image if image
 
       # Set runner
-      container["env"] ||= []
-      container["env"] << { "name" => "CONTROLPLANE_RUNNER", "value" => runner_script }
+      container_spec["env"] ||= []
+      container_spec["env"] << { "name" => "CONTROLPLANE_RUNNER", "value" => runner_script }
+
+      if config.options["use_local_token"]
+        container_spec["env"] << { "name" => "CONTROLPLANE_TOKEN", "value" => ControlplaneApiDirect.new.api_token }
+      end
 
       # Create workload clone
       cp.apply("kind" => "workload", "name" => one_off, "spec" => spec)
@@ -93,6 +106,14 @@ module Command
 
     def runner_script
       script = Scripts.helpers_cleanup
+
+      if config.options["use_local_token"]
+        script += <<~SHELL
+          CPLN_TOKEN=$CONTROLPLANE_TOKEN
+          unset CONTROLPLANE_TOKEN
+        SHELL
+      end
+
       script += args_join(config.args)
       script
     end
@@ -100,7 +121,7 @@ module Command
     def run_in_replica
       progress.puts "- Connecting"
       command = %(bash -c 'eval "$CONTROLPLANE_RUNNER"')
-      cp.workload_exec(one_off, location: location, container: workload, command: command)
+      cp.workload_exec(one_off, location: location, container: container, command: command)
     end
   end
 end

data/lib/command/run_detached.rb

@@ -7,7 +7,8 @@ module Command
     REQUIRES_ARGS = true
     OPTIONS = [
       app_option(required: true),
-      image_option
+      image_option,
+      workload_option
     ].freeze
     DESCRIPTION = "Runs one-off **_non-interactive_** replicas (close analog of `heroku run:detached`)"
     LONG_DESCRIPTION = <<~DESC
@@ -33,16 +34,19 @@ module Command
       # Uses a different image (which may not be promoted yet).
       cpl run:detached rails db:migrate -a $APP_NAME --image appimage:123 # Exact image name
       cpl run:detached rails db:migrate -a $APP_NAME --image latest       # Latest sequential image
+
+      # Uses a different workload
+      cpl run:detached rails db:migrate:status -a $APP_NAME -w other-workload
       ```
     EX
 
     WORKLOAD_SLEEP_CHECK = 2
 
-    attr_reader :location, :workload, :one_off
+    attr_reader :location, :workload, :one_off, :container
 
     def call
       @location = config[:default_location]
-      @workload = config[:one_off_workload]
+      @workload = config.options["workload"] || config[:one_off_workload]
       @one_off = "#{workload}-runner-#{rand(1000..9999)}"
 
       clone_workload
@@ -60,14 +64,15 @@ module Command
 
       # Get base specs of workload
       spec = cp.fetch_workload!(workload).fetch("spec")
-      container = spec["containers"].detect { _1["name"] == workload } || spec["containers"].first
+      container_spec = spec["containers"].detect { _1["name"] == workload } || spec["containers"].first
+      @container = container_spec["name"]
 
       # remove other containers if any
-      spec["containers"] = [container]
+      spec["containers"] = [container_spec]
 
       # Set runner
-      container["command"] = "bash"
-      container["args"] = ["-c", 'eval "$CONTROLPLANE_RUNNER"']
+      container_spec["command"] = "bash"
+      container_spec["args"] = ["-c", 'eval "$CONTROLPLANE_RUNNER"']
 
       # Ensure one-off workload will be running
       spec["defaultOptions"]["suspend"] = false
@@ -80,17 +85,17 @@ module Command
       # Override image if specified
       image = config.options[:image]
       image = "/org/#{config.org}/image/#{latest_image}" if image == "latest"
-      container["image"] = image if image
+      container_spec["image"] = image if image
 
       # Set cron job props
       spec["type"] = "cron"
       spec["job"] = { "schedule" => "* * * * *", "restartPolicy" => "Never" }
       spec["defaultOptions"]["autoscaling"] = {}
-      container.delete("ports")
+      container_spec.delete("ports")
 
-      container["env"] ||= []
-      container["env"] << { "name" => "CONTROLPLANE_TOKEN", "value" => ControlplaneApiDirect.new.api_token }
-      container["env"] << { "name" => "CONTROLPLANE_RUNNER", "value" => runner_script }
+      container_spec["env"] ||= []
+      container_spec["env"] << { "name" => "CONTROLPLANE_TOKEN", "value" => ControlplaneApiDirect.new.api_token }
+      container_spec["env"] << { "name" => "CONTROLPLANE_RUNNER", "value" => runner_script }
 
       # Create workload clone
       cp.apply("kind" => "workload", "name" => one_off, "spec" => spec)

data/lib/command/setup_app.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Command
+  class SetupApp < Base
+    NAME = "setup-app"
+    OPTIONS = [
+      app_option(required: true)
+    ].freeze
+    DESCRIPTION = "Creates an app and all its workloads"
+    LONG_DESCRIPTION = <<~DESC
+      - Creates an app and all its workloads
+      - Specify the templates for the app and workloads through `setup` in the `.controlplane/controlplane.yml` file
+      - This should should only be used for temporary apps like review apps, never for persistent apps like production (to update workloads for those, use 'cpl apply-template' instead)
+    DESC
+
+    def call
+      templates = config[:setup].join(" ")
+
+      app = cp.fetch_gvc
+      if app
+        raise "App '#{config.app}' already exists. If you want to update this app, " \
+              "either run 'cpl delete -a #{config.app}' and then re-run this command, " \
+              "or run 'cpl apply-template #{templates} -a #{config.app}'."
+      end
+
+      perform("cpl apply-template #{templates} -a #{config.app}")
+    end
+  end
+end

data/lib/core/controlplane.rb

@@ -130,6 +130,12 @@ class Controlplane # rubocop:disable Metrics/ClassLength
     perform_yaml(cmd)
   end
 
+  def workload_get_replicas_safely(workload, location:)
+    cmd = "cpln workload get-replicas #{workload} #{gvc_org} --location #{location} -o yaml 2> /dev/null"
+    result = `#{cmd}`
+    $CHILD_STATUS.success? ? YAML.safe_load(result) : nil
+  end
+
   def workload_set_image_ref(workload, container:, image:)
     cmd = "cpln workload update #{workload} #{gvc_org}"
     cmd += " --set spec.containers.#{container}.image=/org/#{config.org}/image/#{image}"

data/lib/cpl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cpl
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/cpl.rb

@@ -9,7 +9,12 @@ require "tempfile"
 require "thor"
 require "yaml"
 
-modules = Dir["#{__dir__}/**/*.rb"].reject { |file| file == __FILE__ || file.end_with?("main.rb") }
+# We need to require base before all commands, since the commands inherit from it
+require_relative "command/base"
+
+modules = Dir["#{__dir__}/**/*.rb"].reject do |file|
+  file == __FILE__ || file.end_with?("main.rb") || file.end_with?("base.rb")
+end
 modules.sort.each { require(_1) }
 
 # Fix for https://github.com/erikhuda/thor/issues/398

data/lib/deprecated_commands.json

@@ -1,6 +1,7 @@
 {
   "build": "build-image",
   "promote": "deploy-image",
-  "promote-image": "deploy-image",
-  "runner": "run:detached"
+  "promote_image": "deploy-image",
+  "runner": "run:detached",
+  "setup": "apply-template"
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpl
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Justin Gordon
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 2023-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -183,6 +183,7 @@ files:
 - examples/circleci.yml
 - examples/controlplane.yml
 - googlee2da545df05d92f9.html
+- lib/command/apply_template.rb
 - lib/command/base.rb
 - lib/command/build_image.rb
 - lib/command/cleanup_old_images.rb
@@ -205,7 +206,7 @@ files:
 - lib/command/ps_stop.rb
 - lib/command/run.rb
 - lib/command/run_detached.rb
-- lib/command/setup.rb
+- lib/command/setup_app.rb
 - lib/command/test.rb
 - lib/command/version.rb
 - lib/core/config.rb
@@ -250,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: Heroku to Control Plane