cpl 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d93c337f8796f7d559d3587333f8fee8e95785ccbe0879f5d47bbb41fcd3b54
-  data.tar.gz: 237d1440185416bca6d1552c25e04d0d225f91bde8fbb71cd6e5e15319d3eb97
+  metadata.gz: c162aaec9e6b476bb2ac9171d4cfbaf564a11f18821c1ee139c83120343ec127
+  data.tar.gz: 98a5f78b9fb4f17f4380e290d1ca01d2729570986b22b1fbf8171cedb5e9aca1
 SHA512:
-  metadata.gz: e0af450819139fa8ed5af99165bed18e2e5eb48516d916cedf10466da2e31334d8b0228b41a6c6eb5babdf2b064be91d52e59e950f08987d1d9c480c55e3dc3d
-  data.tar.gz: 1876895ad75a6c8329dda66e0aa151d6a5b83c29816ce3713249c977992d071ce9b898f44bd302ef3a4c120731ca359f02c23e08c5e4eb194a00a0f441c901f2
+  metadata.gz: 2f0cf811bd1e52e97039d66c24a282363798d1ae2e892d950360c6f99e1cfe84c0dd9da643c83b1a0de353d94fde1a6ded645ae167a804f2dc695f32439a84c4
+  data.tar.gz: 33d012cd711b38968d7eb8cff48cb313f3c7c0e71049a0c5c4af832ea9cd62c06a112b2975f40a9bbc78f36acb9eb2816a1f36be46b38112b4b1b45bf52ea180

data/Gemfile.lock

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

data/cpl.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email   = ["justin@shakacode.com", "sergey@shakacode.com"]
 
   spec.summary     = "Heroku to Control Plane"
-  spec.description = "Helper CLI for migrating from Heroku to Control Plane"
+  spec.description = "CLI for providing Heroku-like platform-as-a-service on Control Plane"
   spec.homepage    = "https://github.com/shakacode/heroku-to-control-plane"
   spec.license     = "MIT"
 

data/lib/command/base.rb

@@ -137,7 +137,7 @@ module Command
     end
 
     def wait_for_workload(workload)
-      wait_for("workload to start") { cp.workload_get(workload) }
+      wait_for("workload to start") { cp.fetch_workload(workload) }
     end
 
     def wait_for_replica(workload, location)
@@ -148,7 +148,7 @@ module Command
 
     def ensure_workload_deleted(workload)
       progress.puts "- Ensure workload is deleted"
-      cp.workload_delete(workload, no_raise: true)
+      cp.workload_delete(workload)
     end
 
     def latest_image_from(items, app_name: config.app, name_only: true)

data/lib/command/build_image.rb

@@ -15,11 +15,22 @@ module Command
     HEREDOC
 
     def call
+      ensure_docker_running!
+
       dockerfile = config.current[:dockerfile] || "Dockerfile"
       dockerfile = "#{config.app_cpln_dir}/#{dockerfile}"
       progress.puts "- Building dockerfile: #{dockerfile}"
 
       cp.image_build(latest_image_next, dockerfile: dockerfile)
     end
+
+    private
+
+    def ensure_docker_running!
+      `docker version > /dev/null 2>&1`
+      return if $?.success? # rubocop:disable Style/SpecialGlobalVars
+
+      Shell.abort("Can't run Docker. Please make sure that it's installed and started, then try again.")
+    end
   end
 end

data/lib/command/delete.rb

@@ -35,7 +35,7 @@ module Command
     def delete_gvc
       progress.puts "- Deleting gvc:"
 
-      return progress.puts "none" unless cp.gvc_get
+      return progress.puts "none" unless cp.fetch_gvc
 
       cp.gvc_delete
       progress.puts config.app

data/lib/command/deploy_image.rb

@@ -15,7 +15,7 @@ module Command
       image = latest_image
 
       config[:app_workloads].each do |workload|
-        cp.workload_get_and_ensure(workload).dig("spec", "containers").each do |container|
+        cp.fetch_workload!(workload).dig("spec", "containers").each do |container|
           next unless container["image"].match?(%r{^/org/#{config[:cpln_org]}/image/#{config.app}:})
 
           cp.workload_set_image_ref(workload, container: container["name"], image: image)

data/lib/command/env.rb

@@ -12,7 +12,7 @@ module Command
     HEREDOC
 
     def call
-      cp.gvc_get_and_ensure.dig("spec", "env").map do |prop|
+      cp.fetch_gvc!.dig("spec", "env").map do |prop|
         # NOTE: atm no special chars handling, consider adding if needed
         puts "#{prop['name']}=#{prop['value']}"
       end

data/lib/command/exists.rb

@@ -17,7 +17,7 @@ module Command
     HEREDOC
 
     def call
-      exit(!cp.gvc_get.nil?)
+      exit(!cp.fetch_gvc.nil?)
     end
   end
 end

data/lib/command/open.rb

@@ -23,7 +23,7 @@ module Command
 
     def call
       workload = config.options[:workload] || config[:one_off_workload]
-      data = cp.workload_get_and_ensure(workload)
+      data = cp.fetch_workload!(workload)
       url = data["status"]["endpoint"]
       opener = `which xdg-open open`.split("\n").grep_v("not found").first
 

data/lib/command/run.rb

@@ -59,7 +59,7 @@ module Command
       progress.puts "- Cloning workload '#{workload}' on '#{config.options[:app]}' to '#{one_off}'"
 
       # Create a base copy of workload props
-      spec = cp.workload_get_and_ensure(workload).fetch("spec")
+      spec = cp.fetch_workload!(workload).fetch("spec")
       container = spec["containers"].detect { _1["name"] == workload } || spec["containers"].first
 
       # remove other containers if any

data/lib/command/run_detached.rb

@@ -57,7 +57,7 @@ module Command
       progress.puts "- Cloning workload '#{workload}' on '#{config.options[:app]}' to '#{one_off}'"
 
       # Get base specs of workload
-      spec = cp.workload_get_and_ensure(workload).fetch("spec")
+      spec = cp.fetch_workload!(workload).fetch("spec")
       container = spec["containers"].detect { _1["name"] == workload } || spec["containers"].first
 
       # remove other containers if any
@@ -113,7 +113,7 @@ module Command
     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)"
       begin
-        while cp.workload_get(one_off)
+        while cp.fetch_workload(one_off)
           sleep(WORKLOAD_SLEEP_CHECK)
           print_uniq_logs
         end

data/lib/command/setup.rb

@@ -37,7 +37,7 @@ module Command
     def call
       config.args.each do |template|
         filename = "#{config.app_cpln_dir}/templates/#{template}.yml"
-        ensure_template(template, filename)
+        ensure_template!(template, filename)
         apply_template(filename)
         progress.puts(template)
       end
@@ -45,7 +45,7 @@ module Command
 
     private
 
-    def ensure_template(template, filename)
+    def ensure_template!(template, filename)
       Shell.abort("Can't find template '#{template}' at '#{filename}', please create it.") unless File.exist?(filename)
     end
 

data/lib/command/test.rb

@@ -18,7 +18,9 @@ module Command
       # You can use `debugger` to debug.
       # debugger
       # Or print values
+      # rubocop:disable Lint/Debugger
       pp latest_image_next
+      # rubocop:enable Lint/Debugger
     end
   end
 end

data/lib/core/config.rb

@@ -19,7 +19,7 @@ class Config
   end
 
   def [](key)
-    ensure_current_config
+    ensure_current_config!
 
     old_key = old_option_keys[key]
     if current.key?(key)
@@ -41,37 +41,37 @@ class Config
 
   private
 
-  def ensure_current_config
+  def ensure_current_config!
     Shell.abort("Can't find current config, please specify an app.") unless current
   end
 
-  def ensure_current_config_app(app)
+  def ensure_current_config_app!(app)
     Shell.abort("Can't find app '#{app}' in 'controlplane.yml'.") unless current
   end
 
-  def ensure_config
+  def ensure_config!
     Shell.abort("'controlplane.yml' is empty.") unless config
   end
 
-  def ensure_config_apps
+  def ensure_config_apps!
     Shell.abort("Can't find key 'apps' in 'controlplane.yml'.") unless config[:apps]
   end
 
-  def ensure_config_app(app, options)
+  def ensure_config_app!(app, options)
     Shell.abort("App '#{app}' is empty in 'controlplane.yml'.") unless options
   end
 
   def pick_current_config
-    ensure_config
-    ensure_config_apps
+    ensure_config!
+    ensure_config_apps!
     config[:apps].each do |c_app, c_data|
-      ensure_config_app(c_app, c_data)
+      ensure_config_app!(c_app, c_data)
       if c_app.to_s == app || (c_data[:match_if_app_name_starts_with] && app.start_with?(c_app.to_s))
         @current = c_data
         break
       end
     end
-    ensure_current_config_app(app)
+    ensure_current_config_app!(app)
   end
 
   def load_app_config

data/lib/core/controlplane.rb

@@ -15,7 +15,7 @@ class Controlplane # rubocop:disable Metrics/ClassLength
   def image_build(image, dockerfile:, push: true)
     cmd = "cpln image build --org #{org} --name #{image} --dir #{config.app_dir} --dockerfile #{dockerfile}"
     cmd += " --push" if push
-    perform(cmd)
+    perform!(cmd)
   end
 
   def image_query(app_name = config.app)
@@ -38,12 +38,12 @@ class Controlplane # rubocop:disable Metrics/ClassLength
     perform_yaml(cmd)
   end
 
-  def gvc_get(a_gvc = gvc)
+  def fetch_gvc(a_gvc = gvc)
     api.gvc_get(gvc: a_gvc, org: org)
   end
 
-  def gvc_get_and_ensure(a_gvc = gvc)
-    gvc_data = gvc_get(a_gvc)
+  def fetch_gvc!(a_gvc = gvc)
+    gvc_data = fetch_gvc(a_gvc)
     return gvc_data if gvc_data
 
     Shell.abort("Can't find GVC '#{gvc}', please create it with 'cpl setup gvc -a #{config.app}'.")
@@ -55,12 +55,12 @@ class Controlplane # rubocop:disable Metrics/ClassLength
 
   # workload
 
-  def workload_get(workload)
+  def fetch_workload(workload)
     api.workload_get(workload: workload, gvc: gvc, org: org)
   end
 
-  def workload_get_and_ensure(workload)
-    workload_data = workload_get(workload)
+  def fetch_workload!(workload)
+    workload_data = fetch_workload(workload)
     return workload_data if workload_data
 
     Shell.abort("Can't find workload '#{workload}', please create it with 'cpl setup #{workload} -a #{config.app}'.")
@@ -74,45 +74,50 @@ 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[:cpln_org]}/image/#{image}"
-    perform(cmd)
+    perform!(cmd)
   end
 
   def workload_set_suspend(workload, value)
-    data = workload_get_and_ensure(workload)
+    data = fetch_workload!(workload)
     data["spec"]["defaultOptions"]["suspend"] = value
     apply(data)
   end
 
   def workload_force_redeployment(workload)
     cmd = "cpln workload force-redeployment #{workload} #{gvc_org}"
+    perform!(cmd)
+  end
+
+  def workload_delete(workload)
+    cmd = "cpln workload delete #{workload} #{gvc_org}"
+    cmd += " 2> /dev/null"
     perform(cmd)
   end
 
-  def workload_delete(workload, no_raise: false)
+  def workload_delete!(workload)
     cmd = "cpln workload delete #{workload} #{gvc_org}"
-    cmd += " 2> /dev/null" if no_raise
-    no_raise ? perform_no_raise(cmd) : perform(cmd)
+    perform!(cmd)
   end
 
   def workload_connect(workload, location:, container: nil, shell: nil)
     cmd = "cpln workload connect #{workload} #{gvc_org} --location #{location}"
     cmd += " --container #{container}" if container
     cmd += " --shell #{shell}" if shell
-    perform(cmd)
+    perform!(cmd)
   end
 
   def workload_exec(workload, location:, container: nil, command: nil)
     cmd = "cpln workload exec #{workload} #{gvc_org} --location #{location}"
     cmd += " --container #{container}" if container
     cmd += " -- #{command}"
-    perform(cmd)
+    perform!(cmd)
   end
 
   # logs
 
   def logs(workload:)
     cmd = "cpln logs '{workload=\"#{workload}\"}' --org #{org} -t -o raw --limit 200"
-    perform(cmd)
+    perform!(cmd)
   end
 
   def log_get(workload:, from:, to:)
@@ -126,18 +131,18 @@ class Controlplane # rubocop:disable Metrics/ClassLength
       f.write(data.to_yaml)
       f.rewind
       cmd = "cpln apply #{gvc_org} --file #{f.path} > /dev/null"
-      perform(cmd)
+      perform!(cmd)
     end
   end
 
   private
 
   def perform(cmd)
-    system(cmd) || exit(false)
+    system(cmd)
   end
 
-  def perform_no_raise(cmd)
-    system(cmd)
+  def perform!(cmd)
+    system(cmd) || exit(false)
   end
 
   def perform_yaml(cmd)

data/lib/cpl/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpl
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Justin Gordon
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2023-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -137,7 +137,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.22.0
-description: Helper CLI for migrating from Heroku to Control Plane
+description: CLI for providing Heroku-like platform-as-a-service on Control Plane
 email:
 - justin@shakacode.com
 - sergey@shakacode.com