cpl 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97534e7ffeb4c0b6c7db70851d6cbac5f86ca0329a76af9975dc4a164eeb08b3
-  data.tar.gz: 3e8a4e9a60af5859bf157464a164f3b7b430a335a33815d65d9bbc54415d43b5
+  metadata.gz: 9d187c354ac6a9a75c0aea498f8fbc060f741809d075439ee22663fdf06f265d
+  data.tar.gz: ffde2f0f3be4663ba85baadf599c6a12882c2ba11734f9220d26366bacc5368d
 SHA512:
-  metadata.gz: 41f11336b2c8a741693e5acc415225bf64d19b4fd0f2240da6ee3de884a517abdb23a37b1ebe166b5b8fd0ccf4d0ae0b95cb7fb3cce0c8f770bfd7c7bc5c6e3e
-  data.tar.gz: e3367bea0aeca04add5823d7129f0ffa3f276709e967d5fe6e533241c8fbace80dd1811b54cb2ee7fd71ce500d54535e4bbe4aea76a1c58114ecf324a3fee763
+  metadata.gz: 70941d48b8ccc5bb3fb46b6c96c91fd0d3c2f13f2a702822ee6541231d90957df5a3b3c9d60d2091afad9f6e76be8870953f69085a97315c2a865d534d0c1ce7
+  data.tar.gz: 3a109996c812ec2b2e9dc76c189bd5d3518835e5b221ff8f12416982f3542f1753dcba441dbb3ec32224e807d0c83db54fe78e21cad43da0d829b8d65593a6d5

data/CONTRIBUTING.md

@@ -1,13 +1,15 @@
 # Contributing
 
 ## Installation
-Rather than installing `cpl` as a Ruby gem, install this repo locally and alias `cpl` command globally for easier access, e.g.:
+
+Rather than installing `cpl` as a Ruby gem, install this repo locally and alias the `cpl` command globally for easier
+access, e.g.:
 
 ```sh
 git clone https://github.com/shakacode/heroku-to-control-plane
 
 # Create an alias in some local shell startup script, e.g., `.profile`, `.bashrc`, etc.
-alias cpl="~/projects/heroku-to-control-plane/cpl"
+alias cpl="~/projects/heroku-to-control-plane/bin/cpl"
 ```
 
 Or set the path of the Ruby gem in your Gemfile.
@@ -16,13 +18,30 @@ Or set the path of the Ruby gem in your Gemfile.
 gem 'cpl', path: '~/projects/heroku-to-control-plane'
 ```
 
-## Linting
-Be sure to run `rubocop -a` before committing code.
+## Linting/Testing
+
+Before committing or pushing code, be sure to:
+
+- Run `bundle exec rake update_command_docs` to sync any doc changes made in the source code to the docs
+- Run `bundle exec rubocop -a` to fix any linting errors
+- Run `bundle exec rspec` to run the test suite
+
+You can also install [overcommit](https://github.com/sds/overcommit) and let it automatically check for you:
+
+```sh
+gem install overcommit
+
+overcommit --install
+```
 
 ## Debugging
 
-1. Install gem: `gem install debug`
-2. Require: Add a `require "debug"` statement to the file you want to debug.
-3. Add breakpoint: Add a `debugger` statement to the line you want to debug.
-4. Modify the `lib/command/test.rb` file to triggger the code that you want to run.
-5. Run the test in your test app with a `.controlplane` directory. `cpl test -a my-app-name`
+1. Add a breakpoint (`debugger`) to any line of code you want to debug.
+2. Modify the `lib/command/test.rb` file to trigger the code you want to test. To simulate a command, you can use
+   `Cpl::Cli.start` (e.g., `Cpl::Cli.start(["deploy-image", "-a", "my-app-name"])` would be the same as running
+   `cpl deploy-image -a my-app-name`).
+3. Run the `test` command in your test app with a `.controlplane` directory.
+
+```sh
+cpl test
+```

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cpl (1.0.2)
+    cpl (1.0.3)
       debug (~> 1.7.1)
       dotenv (~> 2.8.1)
       psych (~> 5.1.0)

data/bin/cpl

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "cpl"
+require_relative "../lib/cpl"
 
 Cpl::Cli.start

data/cpl

@@ -1,15 +1,6 @@
-#!/bin/sh
+#!/usr/bin/env ruby
+# frozen_string_literal: true
 
-SCRIPT_DIR=$(dirname $(realpath $0))
+require_relative "lib/cpl"
 
-# exports .env to vars
-#
-# Example .env:
-# CPLN_TOKEN=xxx
-#
-if [ -f "$SCRIPT_DIR/.env" ]; then
-  export $(grep -v '^#' $SCRIPT_DIR/.env | xargs -0)
-fi
-
-# exec $SCRIPT_DIR/old_commands/main.sh "$@"
-exec ruby $SCRIPT_DIR/lib/main.rb "$@"
+Cpl::Cli.start

data/docs/commands.md

@@ -341,6 +341,7 @@ cpl run bash -a $APP_NAME --use-local-token
 - Deletes stale run workloads for an app
 - Workloads are considered stale based on how many days since created
 - `stale_run_workload_created_days` in the `.controlplane/controlplane.yml` file specifies the number of days after created that the workload is considered stale
+- Works for both interactive workloads (created with `cpl run`) and non-interactive workloads (created with `cpl run:detached`)
 - Will ask for explicit user confirmation of deletion
 
 ```sh
@@ -364,18 +365,16 @@ cpl run:detached 'LOG_LEVEL=warn rails db:migrate' -a $APP_NAME
 # COMMAND may also be passed at the end (in this case, no need to quote).
 cpl run:detached -a $APP_NAME -- rails db:migrate
 
-# Uses some other image.
-cpl run:detached rails db:migrate -a $APP_NAME --image /some/full/image/path
-
-# Uses latest app image (which may not be promoted yet).
-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
 
 # Uses a different workload than `one_off_workload` from `.controlplane/controlplane.yml`.
 cpl run:detached rails db:migrate:status -a $APP_NAME -w other-workload
+
+# Overrides remote CPLN_TOKEN env variable with local token.
+# Useful when superuser rights are needed in remote container.
+cpl run:detached rails db:migrate:status -a $APP_NAME --use-local-token
 ```
 
 ### `setup-app`

data/examples/circleci.yml

@@ -59,8 +59,7 @@ build-review-app:
           cpln profile create default --token ${CPLN_TOKEN} --org ${CPLN_ORG} --gvc ${APP_NAME}
           cpln image docker-login
 
-          git clone https://github.com/shakacode/heroku-to-control-plane ~/heroku-to-control-plane
-          sudo ln -s ~/heroku-to-control-plane/cpl /usr/local/bin/cpl
+          gem install cpl
     - run:
         name: Provision review app if needed
         command: |

data/lib/command/cleanup_old_images.rb

@@ -31,6 +31,18 @@ module Command
 
     private
 
+    def app_prefix
+      config.should_app_start_with?(config.app) ? "#{config.app}-" : "#{config.app}:"
+    end
+
+    def remove_deployed_image(app, app_images)
+      return app_images unless cp.fetch_gvc(app)
+
+      # If app exists, remove latest image, because we don't want to delete the image that is currently deployed
+      latest_image_name = latest_image_from(app_images, app_name: app)
+      app_images.filter { |item| item["name"] != latest_image_name }
+    end
+
     def old_images # rubocop:disable Metrics/MethodLength
       @old_images ||=
         begin
@@ -39,21 +51,20 @@ module Command
           now = DateTime.now
           old_image_retention_days = config[:old_image_retention_days]
 
-          images = cp.image_query["items"].filter { |item| item["name"].start_with?("#{config.app}:")	}
-
-          # Remove latest image, because we don't want to delete the image that is currently deployed
-          latest_image_name = latest_image_from(images)
-          images = images.filter { |item| item["name"] != latest_image_name }
-
-          images.each do |image|
-            created_date = DateTime.parse(image["created"])
-            diff_in_days = (now - created_date).to_i
-            next unless diff_in_days >= old_image_retention_days
-
-            result_images.push({
-                                 name: image["name"],
-                                 date: created_date
-                               })
+          images = cp.image_query["items"].filter { |item| item["name"].start_with?(app_prefix)	}
+          images_by_app = images.group_by { |item| item["repository"] }
+          images_by_app.each do |app, app_images|
+            app_images = remove_deployed_image(app, app_images)
+            app_images.each do |image|
+              created_date = DateTime.parse(image["created"])
+              diff_in_days = (now - created_date).to_i
+              next unless diff_in_days >= old_image_retention_days
+
+              result_images.push({
+                                   name: image["name"],
+                                   date: created_date
+                                 })
+            end
           end
 
           result_images

data/lib/command/info.rb

@@ -112,10 +112,6 @@ module Command
       result.uniq.sort
     end
 
-    def should_app_start_with?(app)
-      config.apps[app.to_sym]&.dig(:match_if_app_name_starts_with)
-    end
-
     def any_app_starts_with?(app)
       @app_workloads.keys.find { |app_name| app_matches?(app_name, app, config.apps[app.to_sym]) }
     end
@@ -132,7 +128,7 @@ module Command
     end
 
     def add_to_missing_workloads(app, workload)
-      if should_app_start_with?(app)
+      if config.should_app_start_with?(app)
         @missing_apps_starting_with[app] ||= []
         @missing_apps_starting_with[app].push(workload)
       else
@@ -142,7 +138,7 @@ module Command
     end
 
     def print_app(app, org)
-      if should_app_start_with?(app)
+      if config.should_app_start_with?(app)
         check_any_app_starts_with(app)
       elsif cp.fetch_gvc(app, org).nil?
         @missing_apps_workloads[app] = ["gvc"]

data/lib/command/run.rb

@@ -99,8 +99,8 @@ module Command
 
       # Override image if specified
       image = config.options[:image]
-      image = "/org/#{config.org}/image/#{latest_image}" if image == "latest"
-      container_spec["image"] = image if image
+      image = latest_image if image == "latest"
+      container_spec["image"] = "/org/#{config.org}/image/#{image}"
 
       # Set runner
       container_spec["env"] ||= []

data/lib/command/run_cleanup.rb

@@ -12,6 +12,7 @@ module Command
       - Deletes stale run workloads for an app
       - Workloads are considered stale based on how many days since created
       - `stale_run_workload_created_days` in the `.controlplane/controlplane.yml` file specifies the number of days after created that the workload is considered stale
+      - Works for both interactive workloads (created with `cpl run`) and non-interactive workloads (created with `cpl run:detached`)
       - Will ask for explicit user confirmation of deletion
     DESC
 
@@ -20,8 +21,14 @@ module Command
 
       progress.puts("Stale run workloads:")
       stale_run_workloads.each do |workload|
-        progress.puts("  #{workload[:name]} " \
-                      "(#{Shell.color("#{workload[:date]} - #{workload[:days]} days ago", :red)})")
+        output = ""
+        output += if config.should_app_start_with?(config.app)
+                    "  #{workload[:app]} - #{workload[:name]}"
+                  else
+                    "  #{workload[:name]}"
+                  end
+        output += " (#{Shell.color("#{workload[:date]} - #{workload[:days]} days ago", :red)})"
+        progress.puts(output)
       end
 
       return unless confirm_delete
@@ -62,11 +69,19 @@ module Command
           now = DateTime.now
           stale_run_workload_created_days = config[:stale_run_workload_created_days]
 
-          workloads = cp.query_workloads("-run-", partial_match: true)["items"]
+          interactive_workloads = cp.query_workloads(
+            "-run-", partial_gvc_match: config.should_app_start_with?(config.app), partial_workload_match: true
+          )["items"]
+          non_interactive_workloads = cp.query_workloads(
+            "-runner-", partial_gvc_match: config.should_app_start_with?(config.app), partial_workload_match: true
+          )["items"]
+          workloads = interactive_workloads + non_interactive_workloads
+
           workloads.each do |workload|
+            app_name = workload["links"].find { |link| link["rel"] == "gvc" }["href"].split("/").last
             workload_name = workload["name"]
 
-            original_workload_name, workload_number = workload_name.split("-run-")
+            original_workload_name, workload_number = workload_name.split(/-run-|-runner-/)
             next unless defined_workloads.include?(original_workload_name) && workload_number.match?(/^\d{4}$/)
 
             created_date = DateTime.parse(workload["created"])
@@ -74,6 +89,7 @@ module Command
             next unless diff_in_days >= stale_run_workload_created_days
 
             run_workloads.push({
+                                 app: app_name,
                                  name: workload_name,
                                  date: created_date,
                                  days: diff_in_days
@@ -91,8 +107,13 @@ module Command
     end
 
     def delete_workload(workload)
-      step("Deleting run workload '#{workload[:name]}'") do
-        cp.delete_workload(workload[:name])
+      message = if config.should_app_start_with?(config.app)
+                  "Deleting run workload '#{workload[:app]} - #{workload[:name]}'"
+                else
+                  "Deleting run workload '#{workload[:name]}'"
+                end
+      step(message) do
+        cp.delete_workload(workload[:name], workload[:app])
       end
     end
   end

data/lib/command/run_detached.rb

@@ -8,7 +8,8 @@ module Command
     OPTIONS = [
       app_option(required: true),
       image_option,
-      workload_option
+      workload_option,
+      use_local_token_option
     ].freeze
     DESCRIPTION = "Runs one-off **_non-interactive_** replicas (close analog of `heroku run:detached`)"
     LONG_DESCRIPTION = <<~DESC
@@ -28,18 +29,16 @@ module Command
       # COMMAND may also be passed at the end (in this case, no need to quote).
       cpl run:detached -a $APP_NAME -- rails db:migrate
 
-      # Uses some other image.
-      cpl run:detached rails db:migrate -a $APP_NAME --image /some/full/image/path
-
-      # Uses latest app image (which may not be promoted yet).
-      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
 
       # Uses a different workload than `one_off_workload` from `.controlplane/controlplane.yml`.
       cpl run:detached rails db:migrate:status -a $APP_NAME -w other-workload
+
+      # Overrides remote CPLN_TOKEN env variable with local token.
+      # Useful when superuser rights are needed in remote container.
+      cpl run:detached rails db:migrate:status -a $APP_NAME --use-local-token
       ```
     EX
 
@@ -91,8 +90,8 @@ module Command
 
       # Override image if specified
       image = config.options[:image]
-      image = "/org/#{config.org}/image/#{latest_image}" if image == "latest"
-      container_spec["image"] = image if image
+      image = latest_image if image == "latest"
+      container_spec["image"] = "/org/#{config.org}/image/#{image}"
 
       # Set cron job props
       spec["type"] = "cron"
@@ -108,10 +107,16 @@ module Command
       cp.apply("kind" => "workload", "name" => one_off, "spec" => spec)
     end
 
-    def runner_script
+    def runner_script # rubocop:disable Metrics/MethodLength
       script = "echo '-- STARTED RUNNER SCRIPT --'\n"
       script += Scripts.helpers_cleanup
 
+      if config.options["use_local_token"]
+        script += <<~SHELL
+          CPLN_TOKEN=$CONTROLPLANE_TOKEN
+        SHELL
+      end
+
       script += <<~SHELL
         if ! eval "#{args_join(config.args)}"; then echo "----- CRASHED -----"; fi
 

data/lib/command/test.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# Be sure to have run: gem install debug
 require "debug"
 
 module Command
@@ -14,13 +13,10 @@ module Command
     HIDE = true
 
     def call
-      # Change code here to test.
+      # Modify this method to trigger the code you want to test.
       # You can use `debugger` to debug.
-      # debugger
-      # Or print values
-      # rubocop:disable Lint/Debugger
-      pp latest_image_next
-      # rubocop:enable Lint/Debugger
+      # You can use `Cpl::Cli.start` to simulate a command
+      # (e.g., `Cpl::Cli.start(["deploy-image", "-a", "my-app-name"])`).
     end
   end
 end

data/lib/core/config.rb

@@ -34,6 +34,10 @@ class Config
     "#{app_dir}/.controlplane"
   end
 
+  def should_app_start_with?(app)
+    apps[app.to_sym]&.dig(:match_if_app_name_starts_with) || false
+  end
+
   private
 
   def ensure_current_config!

data/lib/core/controlplane.rb

@@ -45,7 +45,11 @@ class Controlplane # rubocop:disable Metrics/ClassLength
   end
 
   def image_query(app_name = config.app, org_name = config.org)
-    cmd = "cpln image query --org #{org_name} -o yaml --max -1 --prop repository=#{app_name}"
+    # When `match_if_app_name_starts_with` is `true`, we query for images from any gvc containing the name,
+    # otherwise we query for images from a gvc with the exact name.
+    op = config.should_app_start_with?(app_name) ? "~" : "="
+
+    cmd = "cpln image query --org #{org_name} -o yaml --max -1 --prop repository#{op}#{app_name}"
     perform_yaml(cmd)
   end
 
@@ -86,7 +90,7 @@ class Controlplane # rubocop:disable Metrics/ClassLength
   def gvc_query(app_name = config.app)
     # When `match_if_app_name_starts_with` is `true`, we query for any gvc containing the name,
     # otherwise we query for a gvc with the exact name.
-    op = config.current[:match_if_app_name_starts_with] ? "~" : "="
+    op = config.should_app_start_with?(app_name) ? "~" : "="
 
     cmd = "cpln gvc query --org #{org} -o yaml --prop name#{op}#{app_name}"
     perform_yaml(cmd)
@@ -128,10 +132,11 @@ class Controlplane # rubocop:disable Metrics/ClassLength
     raise "Can't find workload '#{workload}', please create it with 'cpl apply-template #{workload} -a #{config.app}'."
   end
 
-  def query_workloads(workload, partial_match: false)
-    op = partial_match ? "~" : "="
+  def query_workloads(workload, partial_gvc_match: false, partial_workload_match: false)
+    gvc_op = partial_gvc_match ? "~" : "="
+    workload_op = partial_workload_match ? "~" : "="
 
-    api.query_workloads(org: org, gvc: gvc, workload: workload, op_type: op)
+    api.query_workloads(org: org, gvc: gvc, workload: workload, gvc_op_type: gvc_op, workload_op_type: workload_op)
   end
 
   def workload_get_replicas(workload, location:)
@@ -204,8 +209,8 @@ class Controlplane # rubocop:disable Metrics/ClassLength
     perform!(cmd)
   end
 
-  def delete_workload(workload)
-    api.delete_workload(org: org, gvc: gvc, workload: workload)
+  def delete_workload(workload, a_gvc = gvc)
+    api.delete_workload(org: org, gvc: a_gvc, workload: workload)
   end
 
   def workload_connect(workload, location:, container: nil, shell: nil)

data/lib/core/controlplane_api.rb

@@ -33,7 +33,7 @@ class ControlplaneApi
     api_json_direct("/logs/org/#{org}/loki/api/v1/query_range?#{params}", method: :get, host: :logs)
   end
 
-  def query_workloads(org:, gvc:, workload:, op_type:) # rubocop:disable Metrics/MethodLength
+  def query_workloads(org:, gvc:, workload:, gvc_op_type:, workload_op_type:) # rubocop:disable Metrics/MethodLength
     body = {
       kind: "string",
       spec: {
@@ -41,12 +41,12 @@ class ControlplaneApi
         terms: [
           {
             rel: "gvc",
-            op: "=",
+            op: gvc_op_type,
             value: gvc
           },
           {
             property: "name",
-            op: op_type,
+            op: workload_op_type,
             value: workload
           }
         ]

data/lib/cpl/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Cpl
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
   MIN_CPLN_VERSION = "0.0.71"
 end

data/lib/cpl.rb

@@ -13,7 +13,7 @@ require "yaml"
 require_relative "command/base"
 
 modules = Dir["#{__dir__}/**/*.rb"].reject do |file|
-  file == __FILE__ || file.end_with?("main.rb") || file.end_with?("base.rb")
+  file == __FILE__ || file.end_with?("base.rb")
 end
 modules.sort.each { require(_1) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpl
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Justin Gordon
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-02 00:00:00.000000000 Z
+date: 2023-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -273,7 +273,6 @@ files:
 - lib/cpl.rb
 - lib/cpl/version.rb
 - lib/deprecated_commands.json
-- lib/main.rb
 - rakelib/create_release.rake
 - script/add_command
 - script/check_command_docs

data/lib/main.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "cpl"
-
-Cpl::Cli.start