cpl 1.1.2.rc.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd0eff627240313d5202ff74368af8fff67483bcf0769f52f9c923a0839bfd73
-  data.tar.gz: a31c430587ecfce5cc1e7ede82ce31a0c91aec07de401fa849d18f75035dc4f1
+  metadata.gz: 89a038d31fb497bfc6c0d34451ace68fe554d700f4686413a1919cf6d9bceb09
+  data.tar.gz: 3c733b43e703ad7b7798cf599b71f59ea1758ce2c71babd4486670c5ed5f12a3
 SHA512:
-  metadata.gz: 770a3ab110f7b5b7049103c50350044805ed74c1ffedf61249d9696c94877fba43cd2bef031f6d9fd2dd70f2e29e2f970cd2d32cecadd6d7a2eaa3048bd493eb
-  data.tar.gz: ec006511deb5b41610f9d4780e02c1265eddfde523f95e3c7c373ef787039c3f5cb9a99c0132da020cd649029ea6e355b37f51fb3d4035381b10724c2ac4a4d4
+  metadata.gz: 325eecc73176b362c4b898632e45040544ecfdda14ecfbbd655caf92d0912aa3e431fbd8ac90c2681d4a2bcff68db0a71f80813601c1cf3b3ca32d44c9ef033f
+  data.tar.gz: 0c0c04c6f1d4d57114d50d603fabfbd3470da4f373f48b091991e228306080f47bd3643e5c5c706fe9e3992e661b656b4634c881ee0861b79fbfa1f63a60d8e5

data/CHANGELOG.md

@@ -15,10 +15,21 @@ Changes since the last non-beta release.
 _Please add entries here for your pull requests that are not yet released._
 
 ## [1.1.2] - 2023-10-17
+
 ### Fixed
 
 - Fixed failed build on MacOS by adding platform flag and fixed multiple files in yaml document for template. [PR 81](https://github.com/shakacode/heroku-to-control-plane/pull/81) by [justin808](https://github.com/justin808).
 
+### Added
+
+- Added `open-console` command to open the app console on Control Plane. [PR 83](https://github.com/shakacode/heroku-to-control-plane/pull/83) by [Rafael Gomes](https://github.com/rafaelgomesxyz).
+- Added option to set the org with a `CPLN_ORG` env var. [PR 83](https://github.com/shakacode/heroku-to-control-plane/pull/83) by [Rafael Gomes](https://github.com/rafaelgomesxyz).
+- Added `--verbose` option to all commands for more detailed logs. [PR 83](https://github.com/shakacode/heroku-to-control-plane/pull/83) by [Rafael Gomes](https://github.com/rafaelgomesxyz).
+
+### Changed
+
+- Calling `cpl` with no command now shows the help menu. [PR 83](https://github.com/shakacode/heroku-to-control-plane/pull/83) by [Rafael Gomes](https://github.com/rafaelgomesxyz).
+
 ## [1.1.1] - 2023-09-23
 
 ### Fixed
@@ -84,7 +95,9 @@ _Please add entries here for your pull requests that are not yet released._
 
 - Initial release
 
-[Unreleased]: https://github.com/shakacode/heroku-to-control-plane/compare/v1.1.0...HEAD
+[Unreleased]: https://github.com/shakacode/heroku-to-control-plane/compare/v1.1.2...HEAD
+[1.1.2]: https://github.com/shakacode/heroku-to-control-plane/compare/v1.1.1...v1.1.2
+[1.1.1]: https://github.com/shakacode/heroku-to-control-plane/compare/v1.1.0...v1.1.1
 [1.1.0]: https://github.com/shakacode/heroku-to-control-plane/compare/v1.0.4...v1.1.0
 [1.0.4]: https://github.com/shakacode/heroku-to-control-plane/compare/v1.0.3...v1.0.4
 [1.0.3]: https://github.com/shakacode/heroku-to-control-plane/compare/v1.0.2...v1.0.3

data/Gemfile.lock

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

data/README.md

@@ -29,17 +29,18 @@ a **helper CLI** based on templates to save lots of day-to-day typing (and human
 2. [Concept Mapping](#concept-mapping)
 3. [Installation](#installation)
 4. [Steps to Migrate](#steps-to-migrate)
-5. [Config](#config)
-6. [Environment](#environment)
-7. [Database](#database)
-8. [In-memory Databases](#in-memory-databases)
-9. [Scheduled Jobs](#scheduled-jobs)
-10. [CLI Commands Reference](#cli-commands-reference)
-11. [Mapping of Heroku Commands to `cpl` and `cpln`](#mapping-of-heroku-commands-to-cpl-and-cpln)
-12. [Examples](#examples)
-13. [Migrating Postgres Database from Heroku Infrastructure](/docs/postgres.md)
-14. [Migrating Redis Database from Heroku Infrastructure](/docs/redis.md)
-15. [Tips](/docs/tips.md)
+5. [Configuration Files](#configuration-files)
+6. [Workflow](#workflow)
+7. [Environment](#environment)
+8. [Database](#database)
+9. [In-memory Databases](#in-memory-databases)
+10. [Scheduled Jobs](#scheduled-jobs)
+11. [CLI Commands Reference](#cli-commands-reference)
+12. [Mapping of Heroku Commands to `cpl` and `cpln`](#mapping-of-heroku-commands-to-cpl-and-cpln)
+13. [Examples](#examples)
+14. [Migrating Postgres Database from Heroku Infrastructure](/docs/postgres.md)
+15. [Migrating Redis Database from Heroku Infrastructure](/docs/redis.md)
+16. [Tips](/docs/tips.md)
 
 ## Key Features
 
@@ -89,23 +90,31 @@ For the typical Rails app, this means:
 
 ## Installation
 
-1. Ensure your [Control Plane](https://controlplane.com) account is set up. Set up an `organization` <your-org> for testing in that account and modify value for `aliases.common.cpln_org` in `.controlplane/controlplane.yml`. If you need an organization, please [contact Shakcode](mailto:controlplane@shkacode.com).
-1. Install [Node.js](https://nodejs.org/en) (required for Control Plane CLI).
+1. Ensure your [Control Plane](https://controlplane.com) account is set up. Set up an `organization` <your-org> for testing in that account and modify the value for `aliases.common.cpln_org` in `.controlplane/controlplane.yml`, or you can also set it with the `CPLN_ORG` environment variable. If you need an organization, please [contact Shakacode](mailto:controlplane@shakacode.com).
 
-1. Install [Ruby](https://www.ruby-lang.org/en/) (required for these helpers).
+2. Install [Node.js](https://nodejs.org/en) (required for Control Plane CLI).
+
+3. Install [Ruby](https://www.ruby-lang.org/en/) (required for these helpers).
+
+4. Install Control Plane CLI, and configure access ([docs here](https://docs.controlplane.com/quickstart/quick-start-3-cli#getting-started-with-the-cli)).
 
-1. Install Control Plane CLI (and configure access) [docs here](https://docs.controlplane.com/quickstart/quick-start-3-cli#getting-started-with-the-cli), `npm install -g @controlplane/cli`. You can update the `cpln` command line with `npm update -g @controlplane/cli`. Then run `cpln login` to ensure access.
 ```sh
+# Install CLI
 npm install -g @controlplane/cli
+
+# Configure access
 cpln login
+
+# Update CLI
+npm update -g @controlplane/cli
 ```
 
-1. Run `cpln image docker-login --org <your-org>` to ensure that you have access to the Control Plane Docker registry.
+5. Run `cpln image docker-login --org <your-org>` to ensure that you have access to the Control Plane Docker registry.
 
-1. Install Heroku to Control Plane `cpl` CLI, either as a [Ruby gem](https://rubygems.org/gems/cpl) or a local clone.
+6. Install Heroku to Control Plane `cpl` CLI, either as a [Ruby gem](https://rubygems.org/gems/cpl) or a local clone.
    For information on the latter, see [CONTRIBUTING.md](CONTRIBUTING.md). You may also install `cpl` in your project's Gemfile.
 
-1. This project has a `Dockerfile` for Control Plane in this directory. You can use it as an example for your project. Ensure that you have Docker running.
+7. You can use [this Dockerfile](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/.controlplane/Dockerfile) as an example for your project. Ensure that you have Docker running.
 
 **Note:** Do not confuse the `cpl` CLI with the `cpln` CLI. The `cpl` CLI is the Heroku to Control Plane playbook CLI.
 The `cpln` CLI is the Control Plane CLI.
@@ -116,7 +125,7 @@ Click [here](/docs/migrating.md) to see the steps to migrate.
 
 ## Configuration Files
 
-The `cpl` gem is based on several configuration files within a `/.controlplane` top-level directory in your Rails project.
+The `cpl` gem is based on several configuration files within a `/.controlplane` top-level directory in your project.
 
 ```
 .controlplane/
@@ -129,17 +138,18 @@ The `cpl` gem is based on several configuration files within a `/.controlplane`
 ├─ entrypoint.sh
 ```
 
-1. `controlplane.yml` describes the overall application. Be sure to have <your-org> as the value for `aliases.common.cpln_org`.
+1. `controlplane.yml` describes the overall application. Be sure to have <your-org> as the value for `aliases.common.cpln_org`, or set it with the `CPLN_ORG` environment variable.
 2. `Dockerfile` builds the production application. `entrypoint.sh` is an _example_ entrypoint script for the production application, referenced in your Dockerfile.
 3. `templates` directory contains the templates for the various workloads, such as `rails.yml` and `postgres.yml`.
-4. `templates/gvc.yml` defines your project's GVC (like a Heroku app). Most importantly, it contains ENV values for app.
-5. `templates/rails.yml` defines your Rails workload. It may inherit ENV values from the parent GVC, which is populated from the `templates/gvc.yml`. This file also configures scaling, sizing, firewalls, and other workload specific values.
-6. For other workloads (like lines in a Heroku Procfile), you create additional template files. For example, you can base a `templates/sidekiq.yml` on the `templates/rails.yml` file.
-7. You can have other files in the `templates` directory, such as `redis.yml` and `postgres.yml` which could setup Redis and Postgres for a testing application.
+4. `templates/gvc.yml` defines your project's GVC (like a Heroku app). More importantly, it contains ENV values for the app.
+5. `templates/rails.yml` defines your Rails workload. It may inherit ENV values from the parent GVC, which is populated from the `templates/gvc.yml`. This file also configures scaling, sizing, firewalls, and other workload-specific values.
+6. For other workloads (like lines in a Heroku `Procfile`), you create additional template files. For example, you can base a `templates/sidekiq.yml` on the `templates/rails.yml` file.
+7. You can have other files in the `templates` directory, such as `redis.yml` and `postgres.yml`, which could setup Redis and Postgres for a testing application.
 
 Here's a complete example of all supported config keys explained for the `controlplane.yml` file:
-                                                       
+
 ### `controlplane.yml`
+
 ```yaml
 # Keys beginning with "cpln_" correspond to your settings in Control Plane.
 
@@ -234,58 +244,64 @@ apps:
 
 ## Workflow
 
-For a live example, see the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/.controlplane/readme.md).
+For a live example, see the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/.controlplane/readme.md) repository.
+
 This example should closely match the below example.
 
 Suppose your app is called `tutorial-app`. You can run the following commands.
 
 ### Setup Commands
+
 ```sh
 # Provision all infrastructure on Control Plane.
-# app tutorial-app will be created per definition in .controlplane/controlplane.yml
+# `tutorial-app` will be created per definition in .controlplane/controlplane.yml.
 cpl apply-template gvc postgres redis rails -a tutorial-app
 
-# Build and push docker image to Control Plane repository
-# Note, may take many minutes. Be patient. Check for error messages, such as forgetting to run `cpln image docker-login --org <your-org>`
+# Build and push the Docker image to the Control Plane repository.
+# Note, it may take many minutes. Be patient.
+# Check for error messages, such as forgetting to run `cpln image docker-login --org <your-org>`.
 cpl build-image -a tutorial-app
 
-# Promote image to app after running `cpl build-image command`
-# Note, the UX of images may not show the image for up to 5 minutes. However, it's ready.
+# Promote the image to the app after running the `cpl build-image` command.
+# Note, the UX of the images may not show the image for up to 5 minutes. However, it's ready.
 cpl deploy-image -a tutorial-app
 
-# See how app is starting up
+# See how the app is starting up.
 cpl logs -a tutorial-app
 
-# Open app in browser (once it has started up)
+# Open the app in browser (once it has started up).
 cpl open -a tutorial-app
 ```
 
-### Promoting code updates
+### Promoting Code Updates
 
 After committing code, you will update your deployment of `tutorial-app` with the following commands:
 
 ```sh
-# Build and push new image with sequential image tagging, e.g. 'tutorial-app:1', then 'tutorial-app:2', etc.
+# Build and push a new image with sequential image tagging, e.g. 'tutorial-app:1', then 'tutorial-app:2', etc.
 cpl build-image -a tutorial-app
 
-# Run database migrations (or other release tasks) with latest image,
-# while app is still running on previous image.
+# Run database migrations (or other release tasks) with the latest image,
+# while the app is still running on the previous image.
 # This is analogous to the release phase.
-cpl runner rails db:migrate -a tutorial-app --image latest
+cpl run:detached rails db:migrate -a tutorial-app --image latest
 
-# Pomote latest image to app
+# Pomote the latest image to the app.
 cpl deploy-image -a tutorial-app
 ```
 
 If you needed to push a new image with a specific commit SHA, you can run the following command:
 
 ```sh
-# Build and push with sequential image tagging and commit SHA, e.g. 'tutorial-app:123_ABCD'
+# Build and push with sequential image tagging and commit SHA, e.g. 'tutorial-app:123_ABCD', etc.
 cpl build-image -a tutorial-app --commit ABCD
 ```
 
 ### Real World
-Most companies will configure their CI system to handle the above steps. Please [contact Shakcode](mailto:controlplane@shkacode.com) for examples of how to do this, jump on [**React+Rails Slack channel**] (https://reactrails.slack.com/join/shared_invite/enQtNjY3NTczMjczNzYxLTlmYjdiZmY3MTVlMzU2YWE0OWM0MzNiZDI0MzdkZGFiZTFkYTFkOGVjODBmOWEyYWQ3MzA2NGE1YWJjNmVlMGE).
+
+Most companies will configure their CI system to handle the above steps. Please [contact Shakacode](mailto:controlplane@shakacode.com) for examples of how to do this.
+
+You can also join our [**Slack channel**](https://reactrails.slack.com/join/shared_invite/enQtNjY3NTczMjczNzYxLTlmYjdiZmY3MTVlMzU2YWE0OWM0MzNiZDI0MzdkZGFiZTFkYTFkOGVjODBmOWEyYWQ3MzA2NGE1YWJjNmVlMGE) for ShakaCode open source projects.
 
 ## Environment
 
@@ -307,25 +323,27 @@ It is also possible to set up a Secret store (of type `Dictionary`), which we ca
 Policy to access the secret.
 
 In `templates/gvc.yml`:
+
 ```yaml
 spec:
   env:
     - name: MY_GLOBAL_VAR
-      value: 'value'
+      value: "value"
     - name: MY_SECRET_GLOBAL_VAR
-      value: 'cpln://secret/MY_SECRET_STORE_NAME/MY_SECRET_GLOBAL_VAR'
+      value: "cpln://secret/MY_SECRET_STORE_NAME/MY_SECRET_GLOBAL_VAR"
 ```
 
 In `templates/rails.yml`:
+
 ```yaml
 spec:
   containers:
     - name: rails
       env:
         - name: MY_LOCAL_VAR
-          value: 'value'
+          value: "value"
         - name: MY_SECRET_LOCAL_VAR
-          value: 'cpln://secret/MY_SECRET_STORE_NAME/MY_SECRET_LOCAL_VAR'
+          value: "cpln://secret/MY_SECRET_STORE_NAME/MY_SECRET_LOCAL_VAR"
       inheritEnv: true # To enable global env inheritance.
 ```
 

data/docs/commands.md

@@ -227,6 +227,15 @@ cpl open -a $APP_NAME
 cpl open -a $APP_NAME -w $WORKLOAD_NAME
 ```
 
+### `open-console`
+
+- Opens the app console on Control Plane in the default browser
+- Can also go directly to a workload page if `--workload` is provided
+
+```sh
+cpl open-console -a $APP_NAME
+```
+
 ### `promote-app-from-upstream`
 
 - Copies the latest image from upstream, runs a release script (optional), and deploys the image

data/lib/command/apply_template.rb

@@ -35,13 +35,12 @@ module Command
       ```
     EX
 
-    def call # rubocop:disable Metrics/MethodLength
+    def call # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity
       ensure_templates!
 
-      @app_status = :existing
-      @created_workloads = []
-      @failed_workloads = []
-      @skipped_workloads = []
+      @created_items = []
+      @failed_templates = []
+      @skipped_templates = []
 
       @asked_for_confirmation = false
 
@@ -57,9 +56,11 @@ module Command
 
       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)
+          items = apply_template(filename)
+          if items
+            items.each do |item|
+              report_success(item)
+            end
           else
             report_failure(template)
           end
@@ -68,10 +69,9 @@ module Command
         end
       end
 
-      print_app_status
-      print_created_workloads
-      print_failed_workloads
-      print_skipped_workloads
+      print_created_items
+      print_failed_templates
+      print_skipped_templates
     end
 
     private
@@ -134,62 +134,37 @@ module Command
       cp.apply_template(data)
     end
 
-    def report_success(template)
-      if template == "gvc"
-        @app_status = :success
-      else
-        @created_workloads.push(template)
-      end
+    def report_success(item)
+      @created_items.push(item)
     end
 
     def report_failure(template)
-      if template == "gvc"
-        @app_status = :failure
-      else
-        @failed_workloads.push(template)
-      end
+      @failed_templates.push(template)
     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
-
-      case @app_status
-      when :success
-        progress.puts("\n#{Shell.color("Created app '#{config.app}'.", :green)}")
-      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
+      @skipped_templates.push(template)
     end
 
-    def print_created_workloads
-      return unless @created_workloads.any?
+    def print_created_items
+      return unless @created_items.any?
 
-      workloads = @created_workloads.map { |template| "  - #{template}" }.join("\n")
-      progress.puts("\n#{Shell.color('Created workloads:', :green)}\n#{workloads}")
+      created = @created_items.map { |item| "  - [#{item[:kind]}] #{item[:name]}" }.join("\n")
+      progress.puts("\n#{Shell.color('Created items:', :green)}\n#{created}")
     end
 
-    def print_failed_workloads
-      return unless @failed_workloads.any?
+    def print_failed_templates
+      return unless @failed_templates.any?
 
-      workloads = @failed_workloads.map { |template| "  - #{template}" }.join("\n")
-      progress.puts("\n#{Shell.color('Failed to create workloads:', :red)}\n#{workloads}")
+      failed = @failed_templates.map { |template| "  - #{template}" }.join("\n")
+      progress.puts("\n#{Shell.color('Failed to apply templates:', :red)}\n#{failed}")
     end
 
-    def print_skipped_workloads
-      return unless @skipped_workloads.any?
+    def print_skipped_templates
+      return unless @skipped_templates.any?
 
-      workloads = @skipped_workloads.map { |template| "  - #{template}" }.join("\n")
-      progress.puts("\n#{Shell.color('Skipped workloads (already exist):', :blue)}\n#{workloads}")
+      skipped = @skipped_templates.map { |template| "  - #{template}" }.join("\n")
+      progress.puts("\n#{Shell.color('Skipped templates (already exist):', :blue)}\n#{skipped}")
     end
   end
 end

data/lib/command/base.rb

@@ -176,6 +176,18 @@ module Command
       }
     end
 
+    def self.verbose_option(required: false)
+      {
+        name: :verbose,
+        params: {
+          aliases: ["-d"],
+          desc: "Shows detailed logs",
+          type: :boolean,
+          required: required
+        }
+      }
+    end
+
     def self.all_options
       methods.grep(/_option$/).map { |method| send(method.to_s) }
     end

data/lib/command/config.rb

@@ -21,6 +21,11 @@ module Command
     EX
 
     def call # rubocop:disable Metrics/MethodLength
+      if config.org_comes_from_env
+        puts Shell.color("Org comes from CPLN_ORG env var", :yellow)
+        puts
+      end
+
       if config.app
         puts "#{Shell.color("Current config (app '#{config.app}')", :blue)}:"
         puts pretty_print(config.current)

data/lib/command/copy_image_from_upstream.rb

@@ -29,7 +29,7 @@ module Command
       ensure_docker_running!
 
       @upstream = config[:upstream]
-      @upstream_org = config.apps[@upstream.to_sym][:cpln_org]
+      @upstream_org = config.apps[@upstream.to_sym][:cpln_org] || ENV.fetch("CPLN_ORG_UPSTREAM", nil)
       ensure_upstream_org!
 
       create_upstream_profile
@@ -51,7 +51,10 @@ module Command
     end
 
     def ensure_upstream_org!
-      raise "Can't find option 'cpln_org' for app '#{@upstream}' in 'controlplane.yml'." unless @upstream_org
+      return if @upstream_org
+
+      raise "Can't find option 'cpln_org' for app '#{@upstream}' in 'controlplane.yml', " \
+            "and CPLN_ORG_UPSTREAM env var is not set."
     end
 
     def create_upstream_profile

data/lib/command/info.rb

@@ -81,17 +81,20 @@ module Command
       end
     end
 
-    def orgs # rubocop:disable Metrics/MethodLength
+    def orgs # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
       result = []
 
       if config.options[:org]
         result.push(config.options[:org])
       else
+        org_from_env = ENV.fetch("CPLN_ORG", nil)
+        result.push(org_from_env) if org_from_env
+
         config.apps.each do |app_name, app_options|
           next if config.app && !app_matches?(config.app, app_name, app_options)
 
           org = app_options[:cpln_org]
-          result.push(org) unless result.include?(org)
+          result.push(org) if org && !result.include?(org)
         end
       end
 

data/lib/command/no_command.rb

@@ -11,9 +11,11 @@ module Command
     HIDE = true
 
     def call
-      return unless config.options[:version]
-
-      Cpl::Cli.start(["version"])
+      if config.options[:version]
+        Cpl::Cli.start(["version"])
+      else
+        Cpl::Cli.start(["help"])
+      end
     end
   end
 end

data/lib/command/open_console.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Command
+  class OpenConsole < Base
+    NAME = "open-console"
+    OPTIONS = [
+      app_option(required: true),
+      workload_option
+    ].freeze
+    DESCRIPTION = "Opens the app console on Control Plane in the default browser"
+    LONG_DESCRIPTION = <<~DESC
+      - Opens the app console on Control Plane in the default browser
+      - Can also go directly to a workload page if `--workload` is provided
+    DESC
+
+    def call
+      workload = config.options[:workload]
+      url = "https://console.cpln.io/console/org/#{config.org}/gvc/#{config.app}"
+      url += "/workload/#{workload}" if workload
+      url += "/-info"
+      opener = `which xdg-open open`.split("\n").grep_v("not found").first
+
+      exec %(#{opener} "#{url}")
+    end
+  end
+end

data/lib/core/config.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-class Config
+class Config # rubocop:disable Metrics/ClassLength
   attr_reader :config, :current,
-              :org, :app, :apps, :app_dir,
+              :org, :org_comes_from_env, :app, :apps, :app_dir,
               # command line options
               :args, :options
 
@@ -12,10 +12,13 @@ class Config
     @args = args
     @options = options
     @org = options[:org]
+    @org_comes_from_env = false
     @app = options[:app]
 
     load_app_config
     load_apps
+
+    Shell.verbose_mode(options[:verbose])
   end
 
   def [](key)
@@ -48,6 +51,13 @@ class Config
     raise "Can't find app '#{app_name}' in 'controlplane.yml'." unless current
   end
 
+  def ensure_current_config_org!(app_name)
+    return if @org
+
+    raise "Can't find option 'cpln_org' for app '#{app_name}' in 'controlplane.yml', " \
+          "and CPLN_ORG env var is not set."
+  end
+
   def ensure_config!
     raise "'controlplane.yml' is empty." unless config
   end
@@ -66,8 +76,15 @@ class Config
 
   def pick_current_config(app_name, app_options)
     @current = app_options
-    @org = self[:cpln_org]
     ensure_current_config_app!(app_name)
+
+    if current.key?(:cpln_org)
+      @org = current.fetch(:cpln_org)
+    else
+      @org = ENV.fetch("CPLN_ORG", nil)
+      @org_comes_from_env = true
+    end
+    ensure_current_config_org!(app_name)
   end
 
   def load_apps # rubocop:disable Metrics/MethodLength

data/lib/core/controlplane.rb

@@ -24,13 +24,13 @@ class Controlplane # rubocop:disable Metrics/ClassLength
 
   def profile_create(profile, token)
     cmd = "cpln profile create #{profile} --token #{token}"
-    cmd += " > /dev/null" if Shell.tmp_stderr
+    cmd += " > /dev/null" if Shell.should_hide_output?
     perform!(cmd)
   end
 
   def profile_delete(profile)
     cmd = "cpln profile delete #{profile}"
-    cmd += " > /dev/null" if Shell.tmp_stderr
+    cmd += " > /dev/null" if Shell.should_hide_output?
     perform!(cmd)
   end
 
@@ -61,25 +61,25 @@ class Controlplane # rubocop:disable Metrics/ClassLength
 
   def image_login(org_name = config.org)
     cmd = "cpln image docker-login --org #{org_name}"
-    cmd += " > /dev/null 2>&1" if Shell.tmp_stderr
+    cmd += " > /dev/null 2>&1" if Shell.should_hide_output?
     perform!(cmd)
   end
 
   def image_pull(image)
     cmd = "docker pull #{image}"
-    cmd += " > /dev/null" if Shell.tmp_stderr
+    cmd += " > /dev/null" if Shell.should_hide_output?
     perform!(cmd)
   end
 
   def image_tag(old_tag, new_tag)
     cmd = "docker tag #{old_tag} #{new_tag}"
-    cmd += " > /dev/null" if Shell.tmp_stderr
+    cmd += " > /dev/null" if Shell.should_hide_output?
     perform!(cmd)
   end
 
   def image_push(image)
     cmd = "docker push #{image}"
-    cmd += " > /dev/null" if Shell.tmp_stderr
+    cmd += " > /dev/null" if Shell.should_hide_output?
     perform!(cmd)
   end
 
@@ -148,7 +148,11 @@ class Controlplane # rubocop:disable Metrics/ClassLength
   end
 
   def workload_get_replicas_safely(workload, location:)
-    cmd = "cpln workload get-replicas #{workload} #{gvc_org} --location #{location} -o yaml 2> /dev/null"
+    cmd = "cpln workload get-replicas #{workload} #{gvc_org} --location #{location} -o yaml"
+    cmd += " 2> /dev/null" if Shell.should_hide_output?
+
+    Shell.debug("CMD", cmd)
+
     result = `#{cmd}`
     $CHILD_STATUS.success? ? YAML.safe_load(result) : nil
   end
@@ -180,7 +184,7 @@ class Controlplane # rubocop:disable Metrics/ClassLength
   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}"
-    cmd += " > /dev/null" if Shell.tmp_stderr
+    cmd += " > /dev/null" if Shell.should_hide_output?
     perform!(cmd)
   end
 
@@ -208,7 +212,7 @@ class Controlplane # rubocop:disable Metrics/ClassLength
 
   def workload_force_redeployment(workload)
     cmd = "cpln workload force-redeployment #{workload} #{gvc_org}"
-    cmd += " > /dev/null" if Shell.tmp_stderr
+    cmd += " > /dev/null" if Shell.should_hide_output?
     perform!(cmd)
   end
 
@@ -280,41 +284,77 @@ class Controlplane # rubocop:disable Metrics/ClassLength
     Tempfile.create do |f|
       f.write(data)
       f.rewind
-      cmd = "cpln apply #{gvc_org} --file #{f.path} > /dev/null"
+      cmd = "cpln apply #{gvc_org} --file #{f.path}"
       if Shell.tmp_stderr
-        cmd += " 2> #{Shell.tmp_stderr.path}"
-        perform(cmd)
+        cmd += " 2> #{Shell.tmp_stderr.path}" if Shell.should_hide_output?
+
+        Shell.debug("CMD", cmd)
+
+        result = `#{cmd}`
+        $CHILD_STATUS.success? ? parse_apply_result(result) : false
       else
-        perform!(cmd)
+        Shell.debug("CMD", cmd)
+
+        result = `#{cmd}`
+        $CHILD_STATUS.success? ? parse_apply_result(result) : exit(false)
       end
     end
   end
 
-  def apply_hash(data) # rubocop:disable Metrics/MethodLength
-    Tempfile.create do |f|
-      f.write(data.to_yaml)
-      f.rewind
-      cmd = "cpln apply #{gvc_org} --file #{f.path} > /dev/null"
-      if Shell.tmp_stderr
-        cmd += " 2> #{Shell.tmp_stderr.path}"
-        perform(cmd)
+  def apply_hash(data)
+    apply_template(data.to_yaml)
+  end
+
+  def parse_apply_result(result) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    items = []
+
+    lines = result.split("\n")
+    lines.each do |line|
+      # The line can be in one of these formats:
+      # - "Created /org/shakacode-open-source-examples/gvc/my-app-staging"
+      # - "Created /org/shakacode-open-source-examples/gvc/my-app-staging/workload/redis"
+      # - "Updated gvc 'tutorial-app-test-1'"
+      # - "Updated workload 'redis'"
+      if line.start_with?("Created")
+        matches = line.match(%r{Created\s/org/[^/]+/gvc/([^/]+)($|(/([^/]+)/([^/]+)$))})&.captures
+        next unless matches
+
+        app, _, __, kind, name = matches
+        if kind
+          items.push({ kind: kind, name: name })
+        else
+          items.push({ kind: "app", name: app })
+        end
       else
-        perform!(cmd)
+        matches = line.match(/Updated\s([^\s]+)\s'([^\s]+)'$/)&.captures
+        next unless matches
+
+        kind, name = matches
+        kind = "app" if kind == "gvc"
+        items.push({ kind: kind, name: name })
       end
     end
+
+    items
   end
 
   private
 
   def perform(cmd)
+    Shell.debug("CMD", cmd)
+
     system(cmd)
   end
 
   def perform!(cmd)
+    Shell.debug("CMD", cmd)
+
     system(cmd) || exit(false)
   end
 
   def perform_yaml(cmd)
+    Shell.debug("CMD", cmd)
+
     result = `#{cmd}`
     $CHILD_STATUS.success? ? YAML.safe_load(result) : exit(false)
   end

data/lib/core/controlplane_api_direct.rb

@@ -24,6 +24,8 @@ class ControlplaneApiDirect
     request["Authorization"] = api_token
     request.body = body.to_json if body
 
+    Shell.debug(method.upcase, "#{uri} #{body&.to_json}")
+
     response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(request) }
 
     case response

data/lib/core/shell.rb

@@ -2,7 +2,7 @@
 
 class Shell
   class << self
-    attr_reader :tmp_stderr
+    attr_reader :tmp_stderr, :verbose
   end
 
   def self.shell
@@ -50,4 +50,16 @@ class Shell
   def self.abort(message)
     Kernel.abort(color("ERROR: #{message}", :red))
   end
+
+  def self.verbose_mode(verbose)
+    @verbose = verbose
+  end
+
+  def self.debug(prefix, message)
+    stderr.puts("\n[#{color(prefix, :red)}] #{message}") if verbose
+  end
+
+  def self.should_hide_output?
+    tmp_stderr && !verbose
+  end
 end

data/lib/cpl/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Cpl
-  VERSION = "1.1.2.rc.0"
+  VERSION = "1.1.2"
   MIN_CPLN_VERSION = "0.0.71"
 end

data/lib/cpl.rb

@@ -141,7 +141,7 @@ module Cpl
       usage = command_class::USAGE.empty? ? name : command_class::USAGE
       requires_args = command_class::REQUIRES_ARGS
       default_args = command_class::DEFAULT_ARGS
-      command_options = command_class::OPTIONS
+      command_options = command_class::OPTIONS + [::Command::Base.verbose_option]
       description = command_class::DESCRIPTION
       long_description = command_class::LONG_DESCRIPTION
       examples = command_class::EXAMPLES

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpl
 version: !ruby/object:Gem::Version
-  version: 1.1.2.rc.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Justin Gordon
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-18 00:00:00.000000000 Z
+date: 2023-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -251,6 +251,7 @@ files:
 - lib/command/maintenance_set_page.rb
 - lib/command/no_command.rb
 - lib/command/open.rb
+- lib/command/open_console.rb
 - lib/command/promote_app_from_upstream.rb
 - lib/command/ps.rb
 - lib/command/ps_restart.rb
@@ -303,9 +304,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: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.12
 signing_key: