cpl 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 976c390927b51f67afe7a161b7185242261afb4c24db893026457b205fe61b12
-  data.tar.gz: b55bec82c485eb413c9a8787d34172e2c7e89212c15e319f3f626c652c3ac6e7
+  metadata.gz: 410e8bfdc923cabc36b900bb6cc3bb98e586cc2789579ec01cc33fe9c9c39fe1
+  data.tar.gz: a7428c35cff0dabcd1c68469561b82e2c3f24282b92dba9b1eeeb94c51d9d654
 SHA512:
-  metadata.gz: 678825b452c56d5c481639de70904ab087f29e362c4b8ced34d3c2131f15a176f78c0c928b02449ebc96a0e69bd1e5c2cd1982577e06a0b62000aa0993bd4f91
-  data.tar.gz: a40e2ea6bfb43122c919d9126d6fffdb6a9722396bed1c4b22b5874d06f9b2126ee4f14e6df37047bb417bcb0788b3b19869d03b34801030b6e8e373f47950c2
+  metadata.gz: 9c09fb9477e7dd638220e4ad711161a176daab7e82ed7224d584b6617989e3dd789ae5f66eb75e0086bdcd9690d680e2de668b5698ce322184ecdd23522835a3
+  data.tar.gz: 82f3a8aaf6b465850f9b577c5f7aed1b8b4313bf0224d52f058fc94e17f334a9cb9f51bb2638600c150184714fb254c2edeea1bb1f77b40a976fe20d0db11b54

data/.github/workflows/command_docs.yml

@@ -0,0 +1,24 @@
+name: Command Docs
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    name: Command Docs
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.0"
+          bundler-cache: true
+      - name: Install dependencies
+        run: bundle install
+      - name: Check if command docs are up to date
+        run: bundle exec rake check_command_docs

data/.github/workflows/rspec.yml

@@ -8,15 +8,18 @@ on:
 
 jobs:
   rspec:
-    runs-on: ubuntu-latest
-    name: RSpec
-    env:
-      RAILS_ENV: test
     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
@@ -28,7 +31,7 @@ jobs:
       - name: Install dependencies
         run: bundle install
       - name: Run tests
-        run: bundle exec rspec spec
+        run: bundle exec rspec
       - name: Upload coverage results
         uses: actions/upload-artifact@master
         if: always()

data/.github/workflows/rubocop.yml

@@ -8,13 +8,16 @@ on:
 
 jobs:
   rubocop:
-    runs-on: ubuntu-latest
-    name: Rubocop
     strategy:
       matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
         ruby:
           - "2.7"
           - "3.0"
+    runs-on: ${{ matrix.os }}
+    name: Rubocop
     steps:
       - name: Checkout code
         uses: actions/checkout@v3

data/.overcommit.yml

@@ -1,4 +1,7 @@
 PreCommit:
+  CommandDocs:
+    enabled: true
+    command: ["bundle", "exec", "rake", "check_command_docs"]
   RuboCop:
     enabled: true
     on_warn: fail

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cpl (0.7.0)
+    cpl (1.0.0)
       debug (~> 1.7.1)
       dotenv (~> 2.8.1)
       psych (~> 5.1.0)
@@ -41,7 +41,7 @@ GEM
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.6.2)
-    reline (0.3.3)
+    reline (0.3.4)
       io-console (~> 0.5)
     rexml (3.2.5)
     rspec (3.12.0)

data/Rakefile

@@ -10,7 +10,12 @@ RuboCop::RakeTask.new
 
 task default: %i[rspec rubocop]
 
+desc "Checks if commands.md file is up to date"
+task :check_command_docs do
+  sh "./script/check_command_docs"
+end
+
 desc "Updates commands.md file"
-task :command_docs do
-  sh "./script/generate_commands_docs"
+task :update_command_docs do
+  sh "./script/update_command_docs"
 end

data/lib/command/base.rb

@@ -187,28 +187,22 @@ module Command
       end
     end
 
-    def wait_for(title)
-      progress.print "- Waiting for #{title}"
-      until yield
-        progress.print(".")
-        sleep(1)
-      end
-      progress.puts
-    end
-
     def wait_for_workload(workload)
-      wait_for("workload to start") { cp.fetch_workload(workload) }
+      step("Waiting for workload", retry_on_failure: true) do
+        cp.fetch_workload(workload)
+      end
     end
 
     def wait_for_replica(workload, location)
-      wait_for("replica") do
+      step("Waiting for replica", retry_on_failure: true) do
         cp.workload_get_replicas_safely(workload, location: location)&.dig("items", 0)
       end
     end
 
     def ensure_workload_deleted(workload)
-      progress.puts "- Ensure workload is deleted"
-      cp.delete_workload(workload)
+      step("Deleting workload") do
+        cp.delete_workload(workload)
+      end
     end
 
     def latest_image_from(items, app_name: config.app, name_only: true)

data/lib/command/run.rb

@@ -56,24 +56,26 @@ module Command
 
     attr_reader :location, :workload, :one_off, :container
 
-    def call
+    def call # rubocop:disable Metrics/MethodLength
       @location = config[:default_location]
       @workload = config.options["workload"] || config[:one_off_workload]
       @one_off = "#{workload}-run-#{rand(1000..9999)}"
 
-      clone_workload
+      step("Cloning workload '#{workload}' on app '#{config.options[:app]}' to '#{one_off}'") do
+        clone_workload
+      end
+
       wait_for_workload(one_off)
       wait_for_replica(one_off, location)
       run_in_replica
     ensure
+      progress.puts
       ensure_workload_deleted(one_off)
     end
 
     private
 
     def clone_workload # rubocop:disable Metrics/MethodLength
-      progress.puts "- Cloning workload '#{workload}' on '#{config.options[:app]}' to '#{one_off}'"
-
       # Create a base copy of workload props
       spec = cp.fetch_workload!(workload).fetch("spec")
       container_spec = spec["containers"].detect { _1["name"] == workload } || spec["containers"].first
@@ -127,7 +129,7 @@ module Command
         if config.options[:terminal_size]
           rows, cols = config.options[:terminal_size].split(",")
         else
-          rows, cols = `stty -a`.match(/(\d+)\s*rows;\s*(\d+)\s*columns/).captures
+          rows, cols = `stty size`.split(/\s+/)
         end
         script += "stty rows #{rows}\nstty cols #{cols}\n" if rows && cols
       end
@@ -137,7 +139,7 @@ module Command
     end
 
     def run_in_replica
-      progress.puts "- Connecting"
+      progress.puts("Connecting...\n\n")
       command = %(bash -c 'eval "$CONTROLPLANE_RUNNER"')
       cp.workload_exec(one_off, location: location, container: container, command: command)
     end

data/lib/command/run_detached.rb

@@ -47,24 +47,28 @@ module Command
 
     attr_reader :location, :workload, :one_off, :container
 
-    def call
+    def call # rubocop:disable Metrics/MethodLength
       @location = config[:default_location]
       @workload = config.options["workload"] || config[:one_off_workload]
       @one_off = "#{workload}-runner-#{rand(1000..9999)}"
 
-      clone_workload
+      step("Cloning workload '#{workload}' on app '#{config.options[:app]}' to '#{one_off}'") do
+        clone_workload
+      end
+
       wait_for_workload(one_off)
       show_logs_waiting
     ensure
-      ensure_workload_deleted(one_off)
+      if cp.fetch_workload(one_off)
+        progress.puts
+        ensure_workload_deleted(one_off)
+      end
       exit(1) if @crashed
     end
 
     private
 
     def clone_workload # rubocop:disable Metrics/MethodLength
-      progress.puts "- Cloning workload '#{workload}' on '#{config.options[:app]}' to '#{one_off}'"
-
       # Get base specs of workload
       spec = cp.fetch_workload!(workload).fetch("spec")
       container_spec = spec["containers"].detect { _1["name"] == workload } || spec["containers"].first
@@ -121,17 +125,17 @@ module Command
     end
 
     def show_logs_waiting # rubocop:disable Metrics/MethodLength
-      progress.puts "- Scheduled, fetching logs (it is cron job, so it may take up to a minute to start)"
+      progress.puts("Scheduled, fetching logs (it's a cron job, so it may take up to a minute to start)...\n\n")
       begin
         while cp.fetch_workload(one_off)
           sleep(WORKLOAD_SLEEP_CHECK)
           print_uniq_logs
         end
       rescue RuntimeError => e
-        progress.puts "ERROR: #{e}"
+        progress.puts(Shell.color("ERROR: #{e}", :red))
         retry
       end
-      progress.puts "- Finished workload and logger"
+      progress.puts("\nFinished workload and logger.")
     end
 
     def print_uniq_logs

data/lib/core/scripts.rb

@@ -10,7 +10,7 @@ module Scripts
         -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: $REPLICAS_QTY"
+        echo "-- MULTIPLE REPLICAS ATTEMPT: $REPLICAS_QTY --"
         exit -1
       fi
     SHELL
@@ -24,7 +24,7 @@ module Scripts
 
   # 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"]);' \
+    '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
 

data/lib/cpl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cpl
-  VERSION = "0.7.0"
+  VERSION = "1.0.0"
 end

data/script/check_command_docs

@@ -0,0 +1,3 @@
+#!/bin/sh
+bundle exec rake update_command_docs
+git diff --exit-code || exit 1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpl
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Justin Gordon
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-19 00:00:00.000000000 Z
+date: 2023-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -202,6 +202,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/command_docs.yml"
 - ".github/workflows/rspec.yml"
 - ".github/workflows/rubocop.yml"
 - ".gitignore"
@@ -269,8 +270,9 @@ files:
 - lib/main.rb
 - rakelib/create_release.rake
 - script/add_command
-- script/generate_commands_docs
+- script/check_command_docs
 - script/rename_command
+- script/update_command_docs
 - templates/daily-task.yml
 - templates/gvc.yml
 - templates/identity.yml