cpl 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa61e0b16e85c21a6a16d6fee067a5d68182644051b287ead7d62e9030436848
-  data.tar.gz: 6b4fd76fcb7255930257315dd297024d3527ea4e686badb79d3f1ff4a8c66613
+  metadata.gz: 0be2530a33ac1f8a6b71d6d90eca0026b1048faf76b3e2f88cf13572f7e50a92
+  data.tar.gz: c15e191f5d8e984aece73bf5954ba977ee1c3013851447592ef4f2e96c1e2732
 SHA512:
-  metadata.gz: 5d3a5bd08d10284b4ff9825764a8198f9bda5eedc9164dcb6eb16423b14ca9f09c6124410d252496b5807824666adfd4d1d88a22ea5d6adbc7bbb527fa8914e6
-  data.tar.gz: fa98e16499b0fa92e5c16761d6e7aa2584498a5aebed35dfdb2eefff66bb1840224f55680d9a863c779ea8fb965a3aa10df380c1cbdbca24f90c21c3a0fbaad6
+  metadata.gz: 9fe01da2ec88fdb25ba56b9ca78267f8cca42b73f219576decc4af5c0aa695168d08b32692bcdcabc7274ab1f5e9f587d3d7b09d18817c262f011fc328ee7409
+  data.tar.gz: a88847f98eaa1426eeabe23919cd1dbbf31275491e61ba825eebb44ae991b8eba087ffa1c61986e9f576026dbac59f4f118f00abcbfdfb273997ba95c1b27cdc

data/.overcommit.yml

@@ -0,0 +1,10 @@
+PreCommit:
+  RuboCop:
+    enabled: true
+    on_warn: fail
+    command: ["bundle", "exec", "rubocop"]
+
+PrePush:
+  RSpec:
+    enabled: true
+    command: ["bundle", "exec", "rspec"]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cpl (0.4.1)
+    cpl (0.5.0)
       debug (~> 1.7.1)
       dotenv (~> 2.8.1)
       psych (~> 5.1.0)
@@ -11,16 +11,22 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    debug (1.7.1)
+    childprocess (4.1.0)
+    debug (1.7.2)
       irb (>= 1.5.0)
       reline (>= 0.3.1)
     diff-lcs (1.5.0)
     docile (1.4.0)
     dotenv (2.8.1)
+    iniparse (1.5.0)
     io-console (0.6.0)
     irb (1.6.3)
       reline (>= 0.3.0)
     json (2.6.3)
+    overcommit (0.60.0)
+      childprocess (>= 0.6.3, < 5)
+      iniparse (~> 1.4)
+      rexml (~> 3.2)
     parallel (1.22.1)
     parser (3.2.0.0)
       ast (~> 2.4.1)
@@ -29,7 +35,7 @@ GEM
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.6.2)
-    reline (0.3.2)
+    reline (0.3.3)
       io-console (~> 0.5)
     rexml (3.2.5)
     rspec (3.12.0)
@@ -81,6 +87,7 @@ PLATFORMS
 
 DEPENDENCIES
   cpl!
+  overcommit (~> 0.60.0)
   rake (~> 13.0)
   rspec (~> 3.12.0)
   rubocop (~> 1.45.0)

data/README.md

@@ -1,5 +1,11 @@
 # Heroku to Control Plane `cpl` CLI
 
+<meta name="author" content="Justin Gordon and Sergey Tarasov">
+<meta name="description" content="Instructions on how to migrate from Heroku to Control Plane and a CLI called cpl to make it easier.">
+<meta name="copyright" content="ShakaCode, 2023">
+<meta name="keywords" content="Control Plane, Heroku, Kubernetes, K8, Infrastructure">
+<meta name="google-site-verification" content="dIV4nMplcYl6YOKOaZMqgvdKXhLJ4cdYY6pS6e_YrPU" />
+
 _A playbook for migrating from [Heroku](https://heroku.com) to [Control Plane](https://controlplane.com)_
 
 [![RSpec](https://github.com/shakacode/heroku-to-control-plane/actions/workflows/rspec.yml/badge.svg)](https://github.com/shakacode/heroku-to-control-plane/actions/workflows/rspec.yml)

data/cpl.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "psych",    "~> 5.1.0"
   spec.add_dependency "thor",     "~> 1.2.1"
 
+  spec.add_development_dependency "overcommit",    "~> 0.60.0"
   spec.add_development_dependency "rspec",         "~> 3.12.0"
   spec.add_development_dependency "rubocop",       "~> 1.45.0"
   spec.add_development_dependency "rubocop-rake",  "~> 0.6.0"

data/docs/commands.md

@@ -46,16 +46,31 @@ cpl cleanup-stale-apps -a $APP_NAME
 
 ### `config`
 
-- Displays current configs (global and app-specific)
+- Displays config for each app or a specific app
 
 ```sh
-# Shows the global config.
+# Shows the config for each app.
 cpl config
 
-# Shows both global and app-specific configs.
+# Shows the config for a specific app.
 cpl config -a $APP_NAME
 ```
 
+### `copy-image-from-upstream`
+
+- Copies an image (by default the latest) from a source org to the current org
+- The source org must be specified through `upstream` in the `.controlplane/controlplane.yml` file
+- Additionally, the token for the source org must be provided through `--upstream-token` or `-t`
+- A `cpln` profile will be temporarily created to pull the image from the source org
+
+```sh
+# Copies the latest image from the source org to the current org.
+cpl copy-image-from-upstream -a $APP_NAME --upstream-token $UPSTREAM_TOKEN
+
+# Copies a specific image from the source org to the current org.
+cpl copy-image-from-upstream -a $APP_NAME --upstream-token $UPSTREAM_TOKEN --image appimage:123
+```
+
 ### `delete`
 
 - Deletes the whole app (GVC with all workloads and all images)
@@ -89,6 +104,25 @@ cpl env -a $APP_NAME
 if [ cpl exists -a $APP_NAME ]; ...
 ```
 
+### `info`
+
+- Displays the diff between defined/available apps/workloads (apps equal GVCs)
+- Apps that are defined but not available are displayed in red
+- Apps that are available but not defined are displayed in green
+- Apps that are both defined and available are displayed in white
+- The diff is based on what's defined in the `.controlplane/controlplane.yml` file
+
+```sh
+# Shows diff for all apps in all orgs.
+cpl info
+
+# Shows diff for all apps in a specific org.
+cpl info -o $ORG_NAME
+
+# Shows diff for a specific app.
+cpl info -a $APP_NAME
+```
+
 ### `latest-image`
 
 - Displays the latest image name
@@ -121,6 +155,18 @@ cpl open -a $APP_NAME
 cpl open -a $APP_NAME -w $WORKLOAD_NAME
 ```
 
+### `promote-app-from-upstream`
+
+- Copies the latest image from upstream, runs a release script (optional), and deploys the image
+- It performs the following steps:
+  - Runs `cpl copy-image-from-upstream` to copy the latest image from upstream
+  - Runs a release script if specified through `release_script` in the `.controlplane/controlplane.yml` file
+  - Runs `cpl deploy-image` to deploy the image
+
+```sh
+cpl promote-app-from-upstream -a $APP_NAME -t $UPSTREAM_TOKEN
+```
+
 ### `ps`
 
 - Shows running replicas in app
@@ -204,6 +250,8 @@ cpl run rails db:migrate -a $APP_NAME --image latest       # Latest sequential i
 
 ```sh
 cpl run:detached rails db:prepare -a $APP_NAME
+
+# Need to quote COMMAND if setting ENV value or passing args to command to run
 cpl run:detached 'LOG_LEVEL=warn rails db:migrate' -a $APP_NAME
 
 # Uses some other image.

data/googlee2da545df05d92f9.html

@@ -0,0 +1 @@
+google-site-verification: googlee2da545df05d92f9.html

data/lib/command/base.rb

@@ -38,6 +38,19 @@ module Command
       end
     end
 
+    def self.org_option(required: false)
+      {
+        name: :org,
+        params: {
+          aliases: ["-o"],
+          banner: "ORG_NAME",
+          desc: "Organization name",
+          type: :string,
+          required: required
+        }
+      }
+    end
+
     def self.app_option(required: false)
       {
         name: :app,
@@ -90,6 +103,19 @@ module Command
       }
     end
 
+    def self.upstream_token_option(required: false)
+      {
+        name: :upstream_token,
+        params: {
+          aliases: ["-t"],
+          banner: "UPSTREAM_TOKEN",
+          desc: "Upstream token",
+          type: :string,
+          required: required
+        }
+      }
+    end
+
     def self.skip_confirm_option(required: false)
       {
         name: :yes,
@@ -163,17 +189,19 @@ module Command
       end
     end
 
-    def latest_image
-      @latest_image ||=
+    def latest_image(app = config.app, org = config.org)
+      @latest_image ||= {}
+      @latest_image[app] ||=
         begin
-          items = cp.image_query["items"]
-          latest_image_from(items)
+          items = cp.image_query(app, org)["items"]
+          latest_image_from(items, app_name: app)
         end
     end
 
-    def latest_image_next
-      @latest_image_next ||= begin
-        image = latest_image.split(":").first
+    def latest_image_next(app = config.app, org = config.org)
+      @latest_image_next ||= {}
+      @latest_image_next[app] ||= begin
+        image = latest_image(app, org).split(":").first
         image += ":#{extract_image_number(latest_image) + 1}"
         image += "_#{config.options[:commit]}" if config.options[:commit]
         image
@@ -190,10 +218,40 @@ module Command
       $stderr
     end
 
+    def step(message, abort_on_error: true) # rubocop:disable Metrics/MethodLength
+      progress.print("#{message}...")
+
+      Shell.use_tmp_stderr do
+        success = false
+
+        begin
+          success = yield
+        rescue RuntimeError => e
+          message = e.message
+          if abort_on_error
+            progress.puts(" #{Shell.color('failed!', :red)}\n\n")
+            Shell.abort(message)
+          else
+            Shell.write_to_tmp_stderr(message)
+          end
+        end
+
+        if success
+          progress.puts(" #{Shell.color('done!', :green)}")
+        else
+          progress.puts(" #{Shell.color('failed!', :red)}\n\n#{Shell.read_from_tmp_stderr}\n\n")
+        end
+      end
+    end
+
     def cp
       @cp ||= Controlplane.new(config)
     end
 
+    def perform(cmd)
+      system(cmd) || exit(false)
+    end
+
     private
 
     # returns 0 if no prior image

data/lib/command/build_image.rb

@@ -8,18 +8,19 @@ module Command
       commit_option
     ].freeze
     DESCRIPTION = "Builds and pushes the image to Control Plane"
-    LONG_DESCRIPTION = <<~HEREDOC
+    LONG_DESCRIPTION = <<~DESC
       - Builds and pushes the image to Control Plane
       - Automatically assigns image numbers, e.g., `app:1`, `app:2`, etc.
       - Uses `.controlplane/Dockerfile`
-    HEREDOC
+    DESC
 
     def call
       ensure_docker_running!
 
       dockerfile = config.current[:dockerfile] || "Dockerfile"
       dockerfile = "#{config.app_cpln_dir}/#{dockerfile}"
-      progress.puts "- Building dockerfile: #{dockerfile}"
+
+      progress.puts("Building image from Dockerfile '#{dockerfile}'...\n\n")
 
       cp.image_build(latest_image_next, dockerfile: dockerfile)
     end
@@ -28,9 +29,9 @@ module Command
 
     def ensure_docker_running!
       `docker version > /dev/null 2>&1`
-      return if $?.success? # rubocop:disable Style/SpecialGlobalVars
+      return if $CHILD_STATUS.success?
 
-      Shell.abort("Can't run Docker. Please make sure that it's installed and started, then try again.")
+      raise "Can't run Docker. Please make sure that it's installed and started, then try again."
     end
   end
 end

data/lib/command/cleanup_old_images.rb

@@ -8,19 +8,19 @@ module Command
       skip_confirm_option
     ].freeze
     DESCRIPTION = "Deletes all images for an app that are older than the specified amount of days"
-    LONG_DESCRIPTION = <<~HEREDOC
+    LONG_DESCRIPTION = <<~DESC
       - Deletes all images for an app that are older than the specified amount of days
       - Specify the amount of days through `old_image_retention_days` in the `.controlplane/controlplane.yml` file
       - Will ask for explicit user confirmation
       - Does not affect the latest image, regardless of how old it is
-    HEREDOC
+    DESC
 
     def call
-      return progress.puts "No old images found" if old_images.empty?
+      return progress.puts("No old images found.") if old_images.empty?
 
-      progress.puts "Old images:"
+      progress.puts("Old images:")
       old_images.each do |image|
-        progress.puts "  #{image[:name]} (#{Shell.color((image[:date]).to_s, :red)})"
+        progress.puts("  - #{image[:name]} (#{Shell.color((image[:date]).to_s, :red)})")
       end
 
       return unless confirm_delete
@@ -68,8 +68,9 @@ module Command
 
     def delete_images
       old_images.each do |image|
-        cp.image_delete(image[:name])
-        progress.puts "#{image[:name]} deleted"
+        step("Deleting image '#{image[:name]}'") do
+          cp.image_delete(image[:name])
+        end
       end
     end
   end

data/lib/command/cleanup_stale_apps.rb

@@ -10,20 +10,20 @@ module Command
       skip_confirm_option
     ].freeze
     DESCRIPTION = "Deletes the whole app (GVC with all workloads and all images) for all stale apps"
-    LONG_DESCRIPTION = <<~HEREDOC
+    LONG_DESCRIPTION = <<~DESC
       - Deletes the whole app (GVC with all workloads and all images) for all stale apps
       - Stale apps are identified based on the creation date of the latest image
       - Specify the amount of days after an app should be considered stale through `stale_app_image_deployed_days` in the `.controlplane/controlplane.yml` file
       - If `match_if_app_name_starts_with` is `true` in the `.controlplane/controlplane.yml` file, it will delete all stale apps that start with the name
       - Will ask for explicit user confirmation
-    HEREDOC
+    DESC
 
     def call # rubocop:disable Metrics/MethodLength
-      return progress.puts "No stale apps found" if stale_apps.empty?
+      return progress.puts("No stale apps found.") if stale_apps.empty?
 
-      progress.puts "Stale apps:"
+      progress.puts("Stale apps:")
       stale_apps.each do |app|
-        progress.puts "  #{app[:name]} (#{Shell.color((app[:date]).to_s, :red)})"
+        progress.puts("  #{app[:name]} (#{Shell.color((app[:date]).to_s, :red)})")
       end
 
       return unless confirm_delete
@@ -74,14 +74,16 @@ module Command
     end
 
     def delete_gvc(app)
-      cp.gvc_delete(app[:name])
-      progress.puts "#{app[:name]} deleted"
+      step("Deleting app '#{app[:name]}'") do
+        cp.gvc_delete(app[:name])
+      end
     end
 
     def delete_images(app)
       app[:images].each do |image|
-        cp.image_delete(image)
-        progress.puts "#{image} deleted"
+        step("Deleting image '#{image}'") do
+          cp.image_delete(image)
+        end
       end
     end
   end

data/lib/command/config.rb

@@ -6,28 +6,43 @@ module Command
     OPTIONS = [
       app_option
     ].freeze
-    DESCRIPTION = "Displays current configs (global and app-specific)"
-    LONG_DESCRIPTION = <<~HEREDOC
-      - Displays current configs (global and app-specific)
-    HEREDOC
-    EXAMPLES = <<~HEREDOC
+    DESCRIPTION = "Displays config for each app or a specific app"
+    LONG_DESCRIPTION = <<~DESC
+      - Displays config for each app or a specific app
+    DESC
+    EXAMPLES = <<~EX
       ```sh
-      # Shows the global config.
+      # Shows the config for each app.
       cpl config
 
-      # Shows both global and app-specific configs.
+      # Shows the config for a specific app.
       cpl config -a $APP_NAME
       ```
-    HEREDOC
+    EX
 
-    def call
-      puts "-- Options"
-      puts config.options.to_hash.to_yaml[4..]
-      puts
+    def call # rubocop:disable Metrics/MethodLength
+      if config.app
+        puts "#{Shell.color("Current config (app '#{config.app}')", :blue)}:"
+        puts pretty_print(config.current)
+        puts
+      else
+        config.apps.each do |app_name, app_options|
+          puts "#{Shell.color("Config for app '#{app_name}'", :blue)}:"
+          puts pretty_print(app_options)
+          puts
+        end
+      end
+    end
+
+    private
 
-      puts "-- Current config (app: #{config.app})"
-      puts config.app ? config.current.to_yaml[4..] : "Please specify app to get app config"
-      puts
+    def pretty_print(hash)
+      hash.transform_keys(&:to_s)
+          .to_yaml(indentation: 2)[4..]
+          # Adds an indentation of 2 to the beginning of each line
+          .gsub(/^(\s*)/, "  \\1")
+          # Adds an indentation of 2 before the '-' in array items
+          .gsub(/^(\s*)-\s/, "\\1  - ")
     end
   end
 end

data/lib/command/copy_image_from_upstream.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Command
+  class CopyImageFromUpstream < Base
+    NAME = "copy-image-from-upstream"
+    OPTIONS = [
+      app_option(required: true),
+      upstream_token_option(required: true),
+      image_option
+    ].freeze
+    DESCRIPTION = "Copies an image (by default the latest) from a source org to the current org"
+    LONG_DESCRIPTION = <<~DESC
+      - Copies an image (by default the latest) from a source org to the current org
+      - The source org must be specified through `upstream` in the `.controlplane/controlplane.yml` file
+      - Additionally, the token for the source org must be provided through `--upstream-token` or `-t`
+      - A `cpln` profile will be temporarily created to pull the image from the source org
+    DESC
+    EXAMPLES = <<~EX
+      ```sh
+      # Copies the latest image from the source org to the current org.
+      cpl copy-image-from-upstream -a $APP_NAME --upstream-token $UPSTREAM_TOKEN
+
+      # Copies a specific image from the source org to the current org.
+      cpl copy-image-from-upstream -a $APP_NAME --upstream-token $UPSTREAM_TOKEN --image appimage:123
+      ```
+    EX
+
+    def call # rubocop:disable Metrics/MethodLength
+      ensure_docker_running!
+
+      @upstream = config[:upstream]
+      @upstream_org = config.apps[@upstream.to_sym][:cpln_org] || config.apps[@upstream.to_sym][:org]
+      ensure_upstream_org!
+
+      create_upstream_profile
+      fetch_upstream_image_url
+      fetch_app_image_url
+      pull_image_from_upstream
+      push_image_to_app
+    ensure
+      delete_upstream_profile
+    end
+
+    private
+
+    def ensure_docker_running!
+      `docker version > /dev/null 2>&1`
+      return if $CHILD_STATUS.success?
+
+      raise "Can't run Docker. Please make sure that it's installed and started, then try again."
+    end
+
+    def ensure_upstream_org!
+      raise "Can't find option 'cpln_org' for app '#{@upstream}' in 'controlplane.yml'." unless @upstream_org
+    end
+
+    def create_upstream_profile
+      step("Creating upstream profile") do
+        loop do
+          @upstream_profile = "upstream-#{rand(1000..9999)}"
+          break unless cp.profile_exists?(@upstream_profile)
+        end
+
+        cp.profile_create(@upstream_profile, config.options[:upstream_token])
+      end
+    end
+
+    def fetch_upstream_image_url
+      step("Fetching upstream image URL") do
+        cp.profile_switch(@upstream_profile)
+        upstream_image = config.options[:image]
+        upstream_image = latest_image(@upstream, @upstream_org) if !upstream_image || upstream_image == "latest"
+        @upstream_image_url = "#{@upstream_org}.registry.cpln.io/#{upstream_image}"
+      end
+    end
+
+    def fetch_app_image_url
+      step("Fetching app image URL") do
+        cp.profile_switch("default")
+        app_image = latest_image_next(config.app, config.org)
+        @app_image_url = "#{config.org}.registry.cpln.io/#{app_image}"
+      end
+    end
+
+    def pull_image_from_upstream
+      step("Pulling image from '#{@upstream_image_url}'") do
+        cp.profile_switch(@upstream_profile)
+        cp.image_login(@upstream_org)
+        cp.image_pull(@upstream_image_url)
+      end
+    end
+
+    def push_image_to_app
+      step("Pushing image to '#{@app_image_url}'") do
+        cp.profile_switch("default")
+        cp.image_login(config.org)
+        cp.image_tag(@upstream_image_url, @app_image_url)
+        cp.image_push(@app_image_url)
+      end
+    end
+
+    def delete_upstream_profile
+      return unless @upstream_profile
+
+      step("Deleting upstream profile") do
+        cp.profile_delete(@upstream_profile)
+      end
+    end
+  end
+end

data/lib/command/delete.rb

@@ -8,10 +8,10 @@ module Command
       skip_confirm_option
     ].freeze
     DESCRIPTION = "Deletes the whole app (GVC with all workloads and all images)"
-    LONG_DESCRIPTION = <<~HEREDOC
+    LONG_DESCRIPTION = <<~DESC
       - Deletes the whole app (GVC with all workloads and all images)
       - Will ask for explicit user confirmation
-    HEREDOC
+    DESC
 
     def call
       return unless confirm_delete
@@ -33,25 +33,23 @@ module Command
     end
 
     def delete_gvc
-      progress.puts "- Deleting gvc:"
+      return progress.puts("App '#{config.app}' does not exist.") if cp.fetch_gvc.nil?
 
-      return progress.puts "none" unless cp.fetch_gvc
-
-      cp.gvc_delete
-      progress.puts config.app
+      step("Deleting app '#{config.app}'") do
+        cp.gvc_delete
+      end
     end
 
     def delete_images
-      progress.puts "- Deleting image(s):"
-
       images = cp.image_query["items"]
                  .filter_map { |item| item["name"] if item["name"].start_with?("#{config.app}:") }
 
-      return progress.puts "none" unless images
+      return progress.puts("No images to delete.") unless images.any?
 
       images.each do |image|
-        cp.image_delete(image)
-        progress.puts image
+        step("Deleting image '#{image}'") do
+          cp.image_delete(image)
+        end
       end
     end
   end

data/lib/command/deploy_image.rb

@@ -7,19 +7,20 @@ module Command
       app_option(required: true)
     ].freeze
     DESCRIPTION = "Deploys the latest image to app workloads"
-    LONG_DESCRIPTION = <<~HEREDOC
+    LONG_DESCRIPTION = <<~DESC
       - Deploys the latest image to app workloads
-    HEREDOC
+    DESC
 
     def call
       image = latest_image
 
       config[:app_workloads].each do |workload|
         cp.fetch_workload!(workload).dig("spec", "containers").each do |container|
-          next unless container["image"].match?(%r{^/org/#{config[:cpln_org]}/image/#{config.app}:})
+          next unless container["image"].match?(%r{^/org/#{config.org}/image/#{config.app}:})
 
-          cp.workload_set_image_ref(workload, container: container["name"], image: image)
-          progress.puts "updated #{container['name']}"
+          step("Deploying image '#{image}' for workload '#{container['name']}'") do
+            cp.workload_set_image_ref(workload, container: container["name"], image: image)
+          end
         end
       end
     end

data/lib/command/env.rb

@@ -7,9 +7,9 @@ module Command
       app_option(required: true)
     ].freeze
     DESCRIPTION = "Displays app-specific environment variables"
-    LONG_DESCRIPTION = <<~HEREDOC
+    LONG_DESCRIPTION = <<~DESC
       - Displays app-specific environment variables
-    HEREDOC
+    DESC
 
     def call
       cp.fetch_gvc!.dig("spec", "env").map do |prop|