cpl 1.3.0 → 2.0.0.rc.0

data/lib/generator_templates/templates/postgres.yml

@@ -106,7 +106,7 @@ bindings:
 #      - use
 #      - view
     principalLinks:
-      - //gvc/APP_GVC/identity/postgres-poc-identity
+      - //gvc/{{APP_NAME}}/identity/postgres-poc-identity
 targetKind: secret
 targetLinks:
   - //secret/postgres-poc-credentials

data/lib/generator_templates/templates/rails.yml

@@ -14,7 +14,7 @@ spec:
           value: debug
       # Inherit other ENV values from GVC
       inheritEnv: true
-      image: '/org/APP_ORG/image/APP_IMAGE'
+      image: {{APP_IMAGE_LINK}}
       # 512 corresponds to a standard 1x dyno type
       memory: 512Mi
       ports:

data/script/check_cpln_links

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
-bad_links=("controlplane.com/shakacode")
-proper_links=("shakacode.controlplane.com")
+bad_links=("controlplane.com/shakacode" "https://docs.controlplane.com")
+proper_links=("shakacode.controlplane.com" "https://shakadocs.controlplane.com")
 
 bold=$(tput bold)
 normal=$(tput sgr0)
@@ -19,7 +19,7 @@ for ((idx = 0; idx < ${#bad_links[@]}; idx++)); do
         --heading \
         --color=always -- \
         "${bad_links[idx]}" \
-        ':!script/check_cpln_links')
+        ':!script/check_cpln_links' '*.md')
 
     # Line would become really unwieldly if everything was mushed into the
     # conditional, so let's ignore this check here.

data/templates/app.yml

@@ -0,0 +1,18 @@
+kind: gvc
+name: {{APP_NAME}}
+spec:
+  env:
+    - name: MEMCACHE_SERVERS
+      value: memcached.{{APP_NAME}}.cpln.local
+    - name: REDIS_URL
+      value: redis://redis.{{APP_NAME}}.cpln.local:6379
+    - name: DATABASE_URL
+      value: postgres://postgres:password123@postgres.{{APP_NAME}}.cpln.local:5432/{{APP_NAME}}
+  staticPlacement:
+    locationLinks:
+      - {{APP_LOCATION_LINK}}
+---
+# Identity is needed to access secrets
+kind: identity
+name: {{APP_IDENTITY}}
+

data/templates/daily-task.yml

@@ -18,7 +18,7 @@ spec:
         - rails
         - db:prepare
       inheritEnv: true
-      image: "/org/APP_ORG/image/APP_IMAGE"
+      image: {{APP_IMAGE_LINK}}
   defaultOptions:
     autoscaling:
       minScale: 1
@@ -28,4 +28,5 @@ spec:
     external:
       outboundAllowCIDR:
         - 0.0.0.0/0
-  identityLink: /org/APP_ORG/gvc/APP_GVC/identity/APP_GVC-identity
+  # Identity is used for binding workload to secrets
+  identityLink: {{APP_IDENTITY_LINK}}

data/templates/rails.yml

@@ -7,7 +7,7 @@ spec:
       cpu: 512m
       memory: 1Gi
       inheritEnv: true
-      image: "/org/APP_ORG/image/APP_IMAGE"
+      image: {{APP_IMAGE_LINK}}
       ports:
         - number: 3000
           protocol: http
@@ -23,4 +23,5 @@ spec:
         - 0.0.0.0/0
       outboundAllowCIDR:
         - 0.0.0.0/0
-  identityLink: /org/APP_ORG/gvc/APP_GVC/identity/APP_GVC-identity
+  # Identity is used for binding workload to secrets
+  identityLink: {{APP_IDENTITY_LINK}}

data/templates/secrets.yml

@@ -0,0 +1,11 @@
+kind: secret
+name: {{APP_SECRETS}}
+type: dictionary
+data: {}
+---
+# Policy is needed to allow identities to access secrets
+kind: policy
+name: {{APP_SECRETS_POLICY}}
+targetKind: secret
+targetLinks:
+  - //secret/{{APP_SECRETS}}

data/templates/sidekiq.yml

@@ -13,7 +13,7 @@ spec:
         - "-C"
         - config/sidekiq.yml
       inheritEnv: true
-      image: "/org/APP_ORG/image/APP_IMAGE"
+      image: {{APP_IMAGE_LINK}}
       ports:
         - number: 7433
           protocol: http
@@ -34,4 +34,5 @@ spec:
     external:
       outboundAllowCIDR:
         - 0.0.0.0/0
-  identityLink: /org/APP_ORG/gvc/APP_GVC/identity/APP_GVC-identity
+  # Identity is used for binding workload to secrets
+  identityLink: {{APP_IDENTITY_LINK}}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpl
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0.rc.0
 platform: ruby
 authors:
 - Justin Gordon
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-19 00:00:00.000000000 Z
+date: 2024-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -39,6 +39,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.8.1
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.1
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +109,20 @@ dependencies:
     - - "~>"
       - !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
@@ -165,20 +193,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.6
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -204,12 +218,13 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/check_cpln_links.yml"
 - ".github/workflows/command_docs.yml"
+- ".github/workflows/rspec-shared.yml"
 - ".github/workflows/rspec.yml"
 - ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".overcommit.yml"
-- ".rspec"
 - ".rubocop.yml"
+- ".simplecov_spawn.rb"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -262,18 +277,16 @@ files:
 - lib/command/ps_stop.rb
 - lib/command/ps_wait.rb
 - lib/command/run.rb
-- lib/command/run_cleanup.rb
-- lib/command/run_detached.rb
 - lib/command/setup_app.rb
 - lib/command/test.rb
 - lib/command/version.rb
+- lib/constants/exit_code.rb
 - lib/core/config.rb
 - lib/core/controlplane.rb
 - lib/core/controlplane_api.rb
 - lib/core/controlplane_api_cli.rb
 - lib/core/controlplane_api_direct.rb
 - lib/core/helpers.rb
-- lib/core/scripts.rb
 - lib/core/shell.rb
 - lib/cpl.rb
 - lib/cpl/version.rb
@@ -281,7 +294,7 @@ files:
 - lib/generator_templates/Dockerfile
 - lib/generator_templates/controlplane.yml
 - lib/generator_templates/entrypoint.sh
-- lib/generator_templates/templates/gvc.yml
+- lib/generator_templates/templates/app.yml
 - lib/generator_templates/templates/postgres.yml
 - lib/generator_templates/templates/rails.yml
 - rakelib/create_release.rake
@@ -290,14 +303,14 @@ files:
 - script/check_cpln_links
 - script/rename_command
 - script/update_command_docs
+- templates/app.yml
 - templates/daily-task.yml
-- templates/gvc.yml
-- templates/identity.yml
 - templates/maintenance.yml
 - templates/memcached.yml
 - templates/postgres.yml
 - templates/rails.yml
 - templates/redis.yml
+- templates/secrets.yml
 - templates/sidekiq.yml
 homepage: https://github.com/shakacode/heroku-to-control-plane
 licenses:
@@ -315,9 +328,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.21
 signing_key:

data/.rspec

@@ -1 +0,0 @@
---require spec_helper

data/lib/command/run_cleanup.rb

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-
-module Command
-  class RunCleanup < Base
-    NAME = "run:cleanup"
-    OPTIONS = [
-      app_option(required: true),
-      skip_confirm_option
-    ].freeze
-    DESCRIPTION = "Deletes stale run workloads for an app"
-    LONG_DESCRIPTION = <<~DESC
-      - 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
-
-    def call # rubocop:disable Metrics/MethodLength
-      return progress.puts("No stale run workloads found.") if stale_run_workloads.empty?
-
-      progress.puts("Stale run workloads:")
-      stale_run_workloads.each do |workload|
-        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
-
-      progress.puts
-      stale_run_workloads.each do |workload|
-        delete_workload(workload)
-      end
-    end
-
-    private
-
-    def app_matches?(app, app_name, app_options)
-      app == app_name.to_s || (app_options[:match_if_app_name_starts_with] && app.start_with?(app_name.to_s))
-    end
-
-    def find_app_options(app)
-      @app_options ||= {}
-      @app_options[app] ||= config.apps.find do |app_name, app_options|
-                              app_matches?(app, app_name, app_options)
-                            end&.last
-    end
-
-    def find_workloads(app)
-      app_options = find_app_options(app)
-      return [] if app_options.nil?
-
-      (app_options[:app_workloads] + app_options[:additional_workloads] + [app_options[:one_off_workload]]).uniq
-    end
-
-    def stale_run_workloads # rubocop:disable Metrics/MethodLength
-      @stale_run_workloads ||=
-        begin
-          defined_workloads = find_workloads(config.app)
-
-          run_workloads = []
-
-          now = DateTime.now
-          stale_run_workload_created_days = config[:stale_run_workload_created_days]
-
-          interactive_workloads = cp.query_workloads("-run-", partial_workload_match: true)["items"]
-          non_interactive_workloads = cp.query_workloads("-runner-", 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-|-runner-/)
-            next unless defined_workloads.include?(original_workload_name) && workload_number.match?(/^\d{4}$/)
-
-            created_date = DateTime.parse(workload["created"])
-            diff_in_days = (now - created_date).to_i
-            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
-                               })
-          end
-
-          run_workloads
-        end
-    end
-
-    def confirm_delete
-      return true if config.options[:yes]
-
-      Shell.confirm("\nAre you sure you want to delete these #{stale_run_workloads.length} run workloads?")
-    end
-
-    def delete_workload(workload)
-      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
-end

data/lib/command/run_detached.rb

@@ -1,175 +0,0 @@
-# frozen_string_literal: true
-
-module Command
-  class RunDetached < Base # rubocop:disable Metrics/ClassLength
-    NAME = "run:detached"
-    USAGE = "run:detached COMMAND"
-    REQUIRES_ARGS = true
-    OPTIONS = [
-      app_option(required: true),
-      image_option,
-      workload_option,
-      location_option,
-      use_local_token_option,
-      clean_on_failure_option
-    ].freeze
-    DESCRIPTION = "Runs one-off **_non-interactive_** replicas (close analog of `heroku run:detached`)"
-    LONG_DESCRIPTION = <<~DESC
-      - Runs one-off **_non-interactive_** replicas (close analog of `heroku run:detached`)
-      - Uses `Cron` workload type with log async fetching
-      - Implemented with only async execution methods, more suitable for production tasks
-      - Has alternative log fetch implementation with only JSON-polling and no WebSockets
-      - Less responsive but more stable, useful for CI tasks
-      - Deletes the workload whenever finished with success
-      - Deletes the workload whenever finished with failure by default
-      - Use `--no-clean-on-failure` to disable cleanup to help with debugging failed runs
-    DESC
-    EXAMPLES = <<~EX
-      ```sh
-      cpl run:detached rails db:prepare -a $APP_NAME
-
-      # Need to quote COMMAND if setting ENV value or passing args.
-      cpl run:detached -a $APP_NAME -- 'LOG_LEVEL=warn rails db:migrate'
-
-      # Uses a different image (which may not be promoted yet).
-      cpl run:detached -a $APP_NAME --image appimage:123 -- rails db:migrate # Exact image name
-      cpl run:detached -a $APP_NAME --image latest -- rails db:migrate       # Latest sequential image
-
-      # Uses a different workload than `one_off_workload` from `.controlplane/controlplane.yml`.
-      cpl run:detached -a $APP_NAME -w other-workload -- rails db:migrate:status
-
-      # Overrides remote CPLN_TOKEN env variable with local token.
-      # Useful when superuser rights are needed in remote container.
-      cpl run:detached -a $APP_NAME --use-local-token -- rails db:migrate:status
-      ```
-    EX
-
-    WORKLOAD_SLEEP_CHECK = 2
-
-    attr_reader :location, :workload_to_clone, :workload_clone, :container
-
-    def call
-      @location = config.location
-      @workload_to_clone = config.options["workload"] || config[:one_off_workload]
-      @workload_clone = "#{workload_to_clone}-runner-#{random_four_digits}"
-
-      step("Cloning workload '#{workload_to_clone}' on app '#{config.options[:app]}' to '#{workload_clone}'") do
-        clone_workload
-      end
-
-      wait_for_workload(workload_clone)
-      show_logs_waiting
-    ensure
-      exit(1) if @crashed
-    end
-
-    private
-
-    def clone_workload # rubocop:disable Metrics/MethodLength
-      # Get base specs of workload
-      spec = cp.fetch_workload!(workload_to_clone).fetch("spec")
-      container_spec = spec["containers"].detect { _1["name"] == workload_to_clone } || spec["containers"].first
-      @container = container_spec["name"]
-
-      # remove other containers if any
-      spec["containers"] = [container_spec]
-
-      # Set runner
-      container_spec["command"] = "bash"
-      container_spec["args"] = ["-c", 'eval "$CONTROLPLANE_RUNNER"']
-
-      # Ensure one-off workload will be running
-      spec["defaultOptions"]["suspend"] = false
-
-      # Ensure no scaling
-      spec["defaultOptions"]["autoscaling"]["minScale"] = 1
-      spec["defaultOptions"]["autoscaling"]["maxScale"] = 1
-      spec["defaultOptions"]["capacityAI"] = false
-
-      # Override image if specified
-      image = config.options[:image]
-      image = latest_image if image == "latest"
-      container_spec["image"] = "/org/#{config.org}/image/#{image}" if image
-
-      # Set cron job props
-      spec["type"] = "cron"
-      spec["job"] = { "schedule" => "* * * * *", "restartPolicy" => "Never" }
-      spec["defaultOptions"]["autoscaling"] = {}
-      container_spec.delete("ports")
-
-      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_hash("kind" => "workload", "name" => workload_clone, "spec" => spec)
-    end
-
-    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
-        crashed=0
-        if ! eval "#{args_join(config.args)}"; then
-          crashed=1
-          echo "----- CRASHED -----"
-        fi
-        clean_on_failure=#{config.options[:clean_on_failure] ? 1 : 0}
-        if [ $crashed -eq 0 ] || [ $clean_on_failure -eq 1 ]; then
-          echo "-- FINISHED RUNNER SCRIPT, DELETING WORKLOAD --"
-          sleep 30 # grace time for logs propagation
-          curl ${CPLN_ENDPOINT}${CPLN_WORKLOAD} -H "Authorization: ${CONTROLPLANE_TOKEN}" -X DELETE -s -o /dev/null
-          while true; do sleep 1; done # wait for SIGTERM
-        else
-          echo "-- FINISHED RUNNER SCRIPT --"
-        fi
-      SHELL
-
-      script
-    end
-
-    def show_logs_waiting # rubocop:disable Metrics/MethodLength
-      progress.puts("Scheduled, fetching logs (it's a cron job, so it may take up to a minute to start)...\n\n")
-      begin
-        @finished = false
-        while cp.fetch_workload(workload_clone) && !@finished
-          sleep(WORKLOAD_SLEEP_CHECK)
-          print_uniq_logs
-        end
-      rescue RuntimeError => e
-        progress.puts(Shell.color("ERROR: #{e}", :red))
-        retry
-      end
-      progress.puts("\nFinished workload and logger.")
-    end
-
-    def print_uniq_logs
-      @printed_log_entries ||= []
-      ts = Time.now.to_i
-      entries = normalized_log_entries(from: ts - 60, to: ts)
-
-      (entries - @printed_log_entries).sort.each do |(_ts, val)|
-        @crashed = true if val.match?(/^----- CRASHED -----$/)
-        @finished = true if val.match?(/^-- FINISHED RUNNER SCRIPT(, DELETING WORKLOAD)? --$/)
-        puts val
-      end
-
-      @printed_log_entries = entries # as well truncate old entries if any
-    end
-
-    def normalized_log_entries(from:, to:)
-      log = cp.log_get(workload: workload_clone, from: from, to: to)
-
-      log["data"]["result"]
-        .each_with_object([]) { |obj, result| result.concat(obj["values"]) }
-        .select { |ts, _val| ts[..-10].to_i > from }
-    end
-  end
-end

data/lib/core/scripts.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Scripts
-  module_function
-
-  def assert_replicas(gvc:, workload:, location:)
-    <<~SHELL
-      REPLICAS_QTY=$( \
-        curl ${CPLN_ENDPOINT}/org/shakacode-staging/gvc/#{gvc}/workload/#{workload}/deployment/#{location} \
-        -H "Authorization: ${CONTROLPLANE_TOKEN}" -s | grep -o '"replicas":[0-9]*' | grep -o '[0-9]*')
-
-      if [ "$REPLICAS_QTY" -gt 0 ]; then
-        echo "-- MULTIPLE REPLICAS ATTEMPT: $REPLICAS_QTY --"
-        exit -1
-      fi
-    SHELL
-  end
-
-  def helpers_cleanup
-    <<~SHELL
-      unset CONTROLPLANE_RUNNER
-    SHELL
-  end
-
-  # NOTE: please escape all '/' as '//' (as it is ruby interpolation here as well)
-  def http_dummy_server_ruby
-    'require "socket";s=TCPServer.new(ENV["PORT"] || 80);' \
-      'loop do c=s.accept;c.puts("HTTP/1.1 200 OK\\nContent-Length: 2\\n\\nOk");c.close end'
-  end
-
-  def http_ping_ruby
-    'require "net/http";uri=URI(ENV["CPLN_GLOBAL_ENDPOINT"]);loop do puts(Net::HTTP.get(uri));sleep(5);end'
-  end
-end

data/templates/gvc.yml

@@ -1,13 +0,0 @@
-kind: gvc
-name: APP_GVC
-spec:
-  env:
-    - name: MEMCACHE_SERVERS
-      value: memcached.APP_GVC.cpln.local
-    - name: REDIS_URL
-      value: redis://redis.APP_GVC.cpln.local:6379
-    - name: DATABASE_URL
-      value: postgres://postgres:password123@postgres.APP_GVC.cpln.local:5432/APP_GVC
-  staticPlacement:
-    locationLinks:
-      - /org/APP_ORG/location/APP_LOCATION

data/templates/identity.yml

@@ -1,2 +0,0 @@
-kind: identity
-name: APP_GVC-identity