Class: Command::PsWait

Inherits:
Base
  • Object
show all
Defined in:
lib/command/ps_wait.rb

Constant Summary collapse

NAME =
"ps:wait"
OPTIONS =
[
  app_option(required: true),
  workload_option,
  location_option
].freeze
DESCRIPTION =
"Waits for workloads in app to be ready after re-deployment"
LONG_DESCRIPTION =
<<~DESC
  - Waits for workloads in app to be ready after re-deployment
DESC
EXAMPLES =
<<~EX
  ```sh
  # Waits for all workloads in app.
  cpflow ps:wait -a $APP_NAME

  # Waits for a specific workload in app.
  cpflow ps:swait -a $APP_NAME -w $WORKLOAD_NAME
  ```
EX

Constants inherited from Base

Base::ACCEPTS_EXTRA_OPTIONS, Base::ALL_VALIDATIONS, Base::DEFAULT_ARGS, Base::HIDE, Base::REQUIRES_ARGS, Base::USAGE, Base::VALIDATIONS, Base::VALIDATIONS_WITHOUT_ADDITIONAL_OPTIONS, Base::VALIDATIONS_WITH_ADDITIONAL_OPTIONS, Base::WITH_INFO_HEADER

Instance Attribute Summary

Attributes inherited from Base

#config

Instance Method Summary collapse

Methods inherited from Base

add_app_identity_option, all_commands, all_options, all_options_by_key_name, app_option, #args_join, commit_option, common_options, #cp, cpu_option, detached_option, docker_context_option, domain_option, #ensure_docker_running!, entrypoint_option, image_option, #initialize, interactive_option, location_option, log_method_option, logs_limit_option, logs_since_option, memory_option, org_option, #progress, replica_option, #run_command_in_latest_image, #run_cpflow_command, run_release_phase_option, skip_confirm_option, skip_post_creation_hook_option, skip_pre_deletion_hook_option, skip_secret_access_binding_option, skip_secrets_setup_option, #step, #step_finish, terminal_size_option, trace_option, upstream_token_option, use_local_token_option, validations_option, verbose_option, version_option, wait_option, #with_retry, workload_option

Methods included from Helpers

normalize_command_name, normalize_option_name, random_four_digits, strip_str_and_validate

Constructor Details

This class inherits a constructor from Command::Base

Instance Method Details

#callObject

rubocop:disable Metrics/MethodLength



25
26
27
28
29
30
31
32
33
34
35
36
37
38
# File 'lib/command/ps_wait.rb', line 25

def call # rubocop:disable Metrics/MethodLength
  @workloads = [config.options[:workload]] if config.options[:workload]
  @workloads ||= config[:app_workloads] + config[:additional_workloads]

  @workloads.reverse_each do |workload|
    if cp.workload_suspended?(workload)
      progress.puts("Workload '#{workload}' is suspended. Skipping...")
    else
      step("Waiting for workload '#{workload}' to be ready", retry_on_failure: true) do
        cp.workload_deployments_ready?(workload, location: config.location, expected_status: true)
      end
    end
  end
end