cpl 1.4.0 → 2.0.0.rc.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e67b960593def42983c0f333119e9edffe55434751769cb1ca25dd8333c1489
-  data.tar.gz: 3f201ff14fe51d451c5ab1fd8705e5e544d5e99c87b83e53c54464841a835a1d
+  metadata.gz: 84efbe4c7082edcef9193b7a4116af57177b54f52373e4e4bca7e6b277f1b846
+  data.tar.gz: 9e047c8b354e6e0a01b28b84e4b3c74c0f5dd675c8d1f5113119803f1f5bcabb
 SHA512:
-  metadata.gz: cb075c69a7fa151bdd800186594ef481999075c8377eabf7dcb886c0b30e246fcb5e3ccd6396ff0e8487ac5a8b50c24d01b3dade658cd7c2b4ebfa82cb6546c9
-  data.tar.gz: 2a7c0782f57fd543f79fdeb985221dc72bfdba830bbfda81dc966e432007ad314ccd28ba299d0084d446993201f05cabaec40a133c0a2edf7b16af70f3e38348
+  metadata.gz: 6efc92fbcb3ea76e6ec44561178e719afc80af717790771b9c2c8358f564eb94b9c76b8aef8367c401e6e98f2faf9c0a8e628371a3193e038843339d12f7058e
+  data.tar.gz: e43668ec1adc98bd399396a35cb092d8d940df1d6bfea3ecb09b99e1be48f8ff7f0c625d8c4936eb61d01ceec4e3c8fb6a2eb7018f6ee91c1b0751dc7847f93f

data/.github/workflows/command_docs.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "3.0"
+          ruby-version: "2.7"
           bundler-cache: true
       - name: Install dependencies
         run: bundle install

data/.github/workflows/rspec-shared.yml

@@ -0,0 +1,56 @@
+name: RSpec Shared
+
+on:
+  workflow_call:
+    inputs:
+      os-version:
+        required: true
+        type: string
+      ruby-version:
+        required: true
+        type: string
+      test-tag:
+        required: true
+        type: string
+
+jobs:
+  rspec:
+    runs-on: ${{ inputs.os-version }}
+    env:
+      RAILS_ENV: test
+      # We have to add "_CI" to the end, otherwise it messes with tests where we switch profiles,
+      # as Control Plane will try to use this token's profile instead.
+      CPLN_TOKEN_CI: ${{ secrets.CPLN_TOKEN }}
+      CPLN_ORG: ${{ vars.CPLN_ORG }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ inputs.ruby-version }}
+          bundler-cache: true
+      - name: Install dependencies
+        run: bundle install
+      - name: Install Control Plane tools
+        run: |
+          sudo npm install -g @controlplane/cli
+          cpln --version
+      - name: Setup Control Plane tools
+        run: |
+          cpln profile create default --token $CPLN_TOKEN_CI --org $CPLN_ORG
+          cpln image docker-login
+      - name: Run tests
+        run: bundle exec rspec --format documentation --tag ${{ inputs.test-tag }}
+      - name: Upload spec log
+        uses: actions/upload-artifact@master
+        if: always()
+        with:
+          name: spec-${{ inputs.test-tag }}-${{ github.run_id }}-${{ inputs.os-version }}-${{ inputs.ruby-version }}.log
+          path: spec.log
+      - name: Upload coverage results
+        uses: actions/upload-artifact@master
+        if: always()
+        with:
+          name: coverage-report-${{ inputs.test-tag }}-${{ github.run_id }}-${{ inputs.os-version }}-${{ inputs.ruby-version }}
+          path: coverage

data/.github/workflows/rspec.yml

@@ -5,36 +5,24 @@ on:
     branches:
       - main
   pull_request:
+  workflow_dispatch:
 
 jobs:
-  rspec:
-    strategy:
-      matrix:
-        os:
-          - ubuntu-latest
-          - macos-latest
-        ruby:
-          - "2.7"
-          - "3.0"
-    runs-on: ${{ matrix.os }}
-    name: RSpec
-    env:
-      RAILS_ENV: test
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-      - name: Install dependencies
-        run: bundle install
-      - name: Run tests
-        run: bundle exec rspec
-      - name: Upload coverage results
-        uses: actions/upload-artifact@master
-        if: always()
-        with:
-          name: coverage-report-${{ github.run_id }}-${{ matrix.os }}-${{ matrix.ruby }}
-          path: coverage
+  rspec-fast:
+    name: RSpec (Fast)
+    uses: ./.github/workflows/rspec-shared.yml
+    with:
+      os-version: ubuntu-latest
+      ruby-version: "2.7"
+      test-tag: ~slow
+    secrets: inherit
+
+  rspec-slow:
+    name: RSpec (Slow)
+    uses: ./.github/workflows/rspec-shared.yml
+    if: github.event_name == 'workflow_dispatch'
+    with:
+      os-version: ubuntu-latest
+      ruby-version: "2.7"
+      test-tag: slow
+    secrets: inherit

data/.github/workflows/rubocop.yml

@@ -8,15 +8,7 @@ on:
 
 jobs:
   rubocop:
-    strategy:
-      matrix:
-        os:
-          - ubuntu-latest
-          - macos-latest
-        ruby:
-          - "2.7"
-          - "3.0"
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     name: Rubocop
     steps:
       - name: Checkout code
@@ -24,7 +16,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: ${{ matrix.ruby }}
+          ruby-version: "2.7"
           bundler-cache: true
       - name: Install dependencies
         run: bundle install

data/.gitignore

@@ -13,3 +13,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+spec.log

data/.simplecov_spawn.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "simplecov"
+
+SimpleCov.start do
+  command_name "spawn"
+  enable_coverage :branch
+
+  at_fork.call(Process.pid)
+end

data/CHANGELOG.md

@@ -14,6 +14,14 @@ Changes since the last non-beta release.
 
 _Please add entries here for your pull requests that are not yet released._
 
+### Added
+
+- Added option to set custom names for secrets and secrets policy, using `secrets_name` and `secrets_policy_name` in `controlplane.yml`. [PR 159](https://github.com/shakacode/heroku-to-control-plane/pull/159) by [Rafael Gomes](https://github.com/rafaelgomesxyz).
+
+### Changed
+
+- `deploy-image` command now raises an error if image does not exist. [PR 153](https://github.com/shakacode/heroku-to-control-plane/pull/153) by [Rafael Gomes](https://github.com/rafaelgomesxyz).
+
 ## [1.4.0] - 2024-03-20
 
 ### Added

data/CONTRIBUTING.md

@@ -12,13 +12,12 @@ git clone https://github.com/shakacode/heroku-to-control-plane
 alias cpl="~/projects/heroku-to-control-plane/bin/cpl"
 ```
 
-## Linting/Testing
+## Linting
 
 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:
 
@@ -28,6 +27,37 @@ gem install overcommit
 overcommit --install
 ```
 
+## Testing
+
+We use real apps for the tests. You'll need to have full access to a Control Plane org, and then set it as the env var `CPLN_ORG` when running the tests (or in the `.env` file):
+
+```sh
+CPLN_ORG=your-org-for-tests bundle exec rspec
+```
+
+Alternatively, you might have a `.envrc` file with:
+
+```sh
+export CPLN_ORG=shakacode-heroku-to-control-plane-ci
+export RSPEC_RETRY_RETRY_COUNT=1
+```
+
+Tests are separated between fast and slow. Slow tests can take a long time and usually involve building / deploying images and waiting for workloads to be ready / not ready, so they should only be run once in a while.
+
+If you add a slow test, tag it with `slow`. Tests without a `slow` tag are considered fast by default.
+
+To run fast tests:
+
+```sh
+CPLN_ORG=your-org-for-tests bundle exec rspec --tag ~slow
+```
+
+To run slow tests:
+
+```sh
+CPLN_ORG=your-org-for-tests bundle exec rspec --tag slow
+```
+
 ## Debugging
 
 1. Use the `--verbose` option to see more detailed logs.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cpl (1.4.0)
+    cpl (2.0.0.rc.0)
       debug (~> 1.7.1)
       dotenv (~> 2.8.1)
       jwt (~> 2.8.1)
@@ -11,60 +11,66 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.4)
+    addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     base64 (0.2.0)
+    bigdecimal (3.1.7)
     childprocess (4.1.0)
-    crack (0.4.5)
+    crack (1.0.0)
+      bigdecimal
       rexml
     debug (1.7.2)
       irb (>= 1.5.0)
       reline (>= 0.3.1)
-    diff-lcs (1.5.0)
+    diff-lcs (1.5.1)
     docile (1.4.0)
     dotenv (2.8.1)
-    hashdiff (1.0.1)
+    hashdiff (1.1.0)
     iniparse (1.5.0)
     io-console (0.7.2)
-    irb (1.12.0)
-      rdoc
+    irb (1.13.1)
+      rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.6.3)
+    json (2.7.2)
     jwt (2.8.1)
       base64
     overcommit (0.60.0)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)
       rexml (~> 3.2)
-    parallel (1.22.1)
-    parser (3.2.0.0)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
+      racc
     psych (5.1.2)
       stringio
-    public_suffix (5.0.1)
+    public_suffix (5.0.5)
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.6)
-    rdoc (6.6.2)
+    rake (13.2.1)
+    rdoc (6.6.3.1)
       psych (>= 4.0.0)
-    regexp_parser (2.6.2)
-    reline (0.4.3)
+    regexp_parser (2.9.0)
+    reline (0.5.6)
       io-console (~> 0.5)
-    rexml (3.2.5)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
+    rspec-core (3.12.3)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.3)
+    rspec-mocks (3.12.7)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.45.0)
+    rspec-retry (0.6.2)
+      rspec-core (> 3.3)
+    rspec-support (3.12.2)
+    rubocop (1.45.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
@@ -74,16 +80,16 @@ GEM
       rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.24.1)
-      parser (>= 3.1.1.0)
-    rubocop-capybara (2.17.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-capybara (2.20.0)
       rubocop (~> 1.41)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
     rubocop-rspec (2.18.1)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
-    ruby-progressbar (1.11.0)
+    ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -92,9 +98,8 @@ GEM
     simplecov_json_formatter (0.1.4)
     stringio (3.1.0)
     thor (1.2.2)
-    timecop (0.9.6)
-    unicode-display_width (2.4.2)
-    vcr (6.1.0)
+    timecop (0.9.8)
+    unicode-display_width (2.5.0)
     webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
@@ -109,12 +114,12 @@ DEPENDENCIES
   overcommit (~> 0.60.0)
   rake (~> 13.0)
   rspec (~> 3.12.0)
+  rspec-retry (~> 0.6.2)
   rubocop (~> 1.45.0)
   rubocop-rake (~> 0.6.0)
   rubocop-rspec (~> 2.18.1)
   simplecov (~> 0.22.0)
   timecop (~> 0.9.6)
-  vcr (~> 6.1.0)
   webmock (~> 3.18.1)
 
 BUNDLED WITH

data/README.md

@@ -110,7 +110,7 @@ For the typical Rails app, this means:
 
 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)).
+4. Install Control Plane CLI, and configure access ([docs here](https://shakadocs.controlplane.com/quickstart/quick-start-3-cli#getting-started-with-the-cli)).
 
 ```sh
 # Install CLI
@@ -125,7 +125,7 @@ npm update -g @controlplane/cli
 
 5. Run `cpln image docker-login --org <your-org>` to ensure that you have access to the Control Plane Docker registry.
 
-6. Install Heroku to Control Plane `cpl` CLI as a [Ruby gem](https://rubygems.org/gems/cpl): `gem install cpl`. If you want to hack on the source code, see [CONTRIBUTING.md](CONTRIBUTING.md).
+6. Install Heroku to Control Plane `cpl` CLI as a [Ruby gem](https://rubygems.org/gems/cpl): `gem install cpl`. If you want to use `cpl` from Rake tasks in a Rails project, use `Bundler.with_unbundled_env { `cpl help` } or else you'll get an error that `cpl` cannot be found. While you can add `cpl` to your Gemfile, it's not recommended because it might trigger conflicts with other gems.
 
 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.
 
@@ -143,7 +143,7 @@ The `cpl` gem is based on several configuration files within a `/.controlplane`
 ```
 .controlplane/
 ├─ templates/
-│  ├─ gvc.yml
+│  ├─ app.yml
 │  ├─ postgres.yml
 │  ├─ rails.yml
 ├─ controlplane.yml
@@ -154,8 +154,8 @@ The `cpl` gem is based on several configuration files within a `/.controlplane`
 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). 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.
+4. `templates/app.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/app.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.
 
@@ -183,39 +183,52 @@ aliases:
 
     # Control Plane offers the ability to use multiple locations.
     # default_location is used for commands that require a location
-    # including `ps`, `run`, `run:detached`, `apply-template`.
+    # including `ps`, `run`, `apply-template`.
     # This can be overridden with option --location=<location> and
     # CPLN_LOCATION environment variable.
     default_location: aws-us-east-2
 
     # Allows running the command `cpl setup-app`
-    # instead of `cpl apply-template gvc redis postgres memcached rails sidekiq`.
+    # instead of `cpl apply-template app redis postgres memcached rails sidekiq`.
     #
     # Note:
     # 1. These names correspond to files in the `./controlplane/templates` directory.
     # 2. Each file can contain many objects, such as in the case of templates that create a resource, like `postgres`.
     # 3. While the naming often corresponds to a workload or other object name, the naming is arbitrary. 
     #    Naming does not need to match anything other than the file name without the `.yml` extension.
+    #
+    # If you're going to use secrets, you need to apply the `secrets.yml` template separately (one-time setup):
+    # `cpl apply-template secrets -a my-app`
     setup_app_templates:
-      - gvc
-
-      # These templates are only required if using secrets.
-      - identity
-      - secrets
-      - secrets-policy
-
+      - app
       - redis
       - postgres
       - memcached
       - rails
       - sidekiq
 
+    # Only needed if using a custom secrets name.
+    # The default is '{APP_PREFIX}-secrets'. For example:
+    # - for an app 'my-app-staging' with `match_if_app_name_starts_with` set to `false`,
+    #   it would be 'my-app-staging-secrets'
+    # - for an app 'my-app-review-1234' with `match_if_app_name_starts_with` set to `true`,
+    #   it would be 'my-app-review-secrets'
+    secrets_name: my-secrets
+
+    # Only needed if using a custom secrets policy name.
+    # The default is '{APP_SECRETS}-policy'. For example:
+    # - for an app 'my-app-staging' with `match_if_app_name_starts_with` set to `false`,
+    #   it would be 'my-app-staging-secrets-policy'
+    # - for an app 'my-app-review-1234' with `match_if_app_name_starts_with` set to `true`,
+    #   it would be 'my-app-review-secrets-policy'
+    secrets_policy_name: my-secrets-policy
+
     # Configure the workload name used as a template for one-off scripts, like a Heroku one-off dyno.
     one_off_workload: rails
 
     # Workloads that are for the application itself and are using application Docker images.
     # These are updated with the new image when running the `deploy-image` command,
-    # and are also used by the `info`, `ps:`, and `run:cleanup` commands in order to get all of the defined workloads.
+    # and are also used by the `info` and `ps:` commands in order to get all of the defined workloads.
     # On the other hand, if you have a workload for Redis, that would NOT use the application Docker image
     # and not be listed here.
     app_workloads:
@@ -223,7 +236,7 @@ aliases:
       - sidekiq
 
     # Additional "service type" workloads, using non-application Docker images.
-    # These are only used by the `info`, `ps:` and `run:cleanup` commands in order to get all of the defined workloads.
+    # These are only used by the `info` and `ps:` commands in order to get all of the defined workloads.
     additional_workloads:
       - redis
       - postgres
@@ -233,7 +246,7 @@ aliases:
     maintenance_workload: maintenance
 
     # Fixes the remote terminal size to match the local terminal size
-    # when running the commands `cpl run` or `cpl run:detached`.
+    # when running `cpl run`.
     fix_terminal_size: true
 
     # Apps with a deployed image created before this amount of days will be listed for deletion
@@ -248,10 +261,6 @@ aliases:
     # when running the command `cpl cleanup-images` (`image_retention_max_qty` takes precedence).
     image_retention_days: 5
 
-    # Run workloads created before this amount of days will be listed for deletion
-    # when running the command `cpl run:cleanup`.
-    stale_run_workload_created_days: 2
-
 apps:
   my-app-staging:
     # Use the values from the common section above.
@@ -307,7 +316,7 @@ Suppose your app is called `tutorial-app`. You can run the following commands.
 ```sh
 # Provision all infrastructure on Control Plane.
 # `tutorial-app` will be created per definition in .controlplane/controlplane.yml.
-cpl apply-template gvc postgres redis rails daily-task -a tutorial-app
+cpl apply-template app postgres redis rails daily-task -a tutorial-app
 
 # Build and push the Docker image to the Control Plane repository.
 # Note, it may take many minutes. Be patient.
@@ -336,7 +345,7 @@ cpl build-image -a tutorial-app
 # 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 run:detached rails db:migrate -a tutorial-app --image latest
+cpl run -a tutorial-app --image latest -- rails db:migrate
 
 # Pomote the latest image to the app.
 cpl deploy-image -a tutorial-app
@@ -374,7 +383,7 @@ It is also possible to set up a Secret store (of type `Dictionary`), which we ca
 `cpln://secret/MY_SECRET_STORE_NAME/MY_SECRET_VAR_NAME`. In such a case, we must set up an app Identity and proper
 Policy to access the secret.
 
-In `templates/gvc.yml`:
+In `templates/app.yml`:
 
 ```yaml
 spec:
@@ -446,7 +455,7 @@ development purposes.
 
 ## Scheduled Jobs
 
-Control Plane supports scheduled jobs via [cron workloads](https://docs.controlplane.com/reference/workload#cron).
+Control Plane supports scheduled jobs via [cron workloads](https://shakadocs.controlplane.com/reference/workload#cron).
 
 Here's a partial example of a template for a cron workload, using the app image:
 

data/cpl.gemspec

@@ -23,12 +23,12 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "overcommit",    "~> 0.60.0"
   spec.add_development_dependency "rspec",         "~> 3.12.0"
+  spec.add_development_dependency "rspec-retry",   "~> 0.6.2"
   spec.add_development_dependency "rubocop",       "~> 1.45.0"
   spec.add_development_dependency "rubocop-rake",  "~> 0.6.0"
   spec.add_development_dependency "rubocop-rspec", "~> 2.18.1"
   spec.add_development_dependency "simplecov",     "~> 0.22.0"
   spec.add_development_dependency "timecop",       "~> 0.9.6"
-  spec.add_development_dependency "vcr",           "~> 6.1.0"
   spec.add_development_dependency "webmock",       "~> 3.18.1"
 
   spec.files = `git ls-files -z`.split("\x0").reject do |file|