uffizzi-cli 0.6.0 → 0.8.0

data/lib/uffizzi/cli/preview.rb

@@ -3,39 +3,43 @@
 require 'uffizzi'
 require 'uffizzi/auth_helper'
 require 'uffizzi/services/preview_service'
+require 'uffizzi/services/command_service'
 
 module Uffizzi
-  class CLI::Preview < Thor
+  class Cli::Preview < Thor
     include ApiClient
 
-    @spinner
-
-    desc 'service', 'service'
+    desc 'service', 'Show the preview services info'
     require_relative 'preview/service'
-    subcommand 'service', Uffizzi::CLI::Preview::Service
-
-    desc 'list', 'list'
+    subcommand 'service', Uffizzi::Cli::Preview::Service
+    desc 'list', 'List all previews'
     def list
       run('list')
     end
 
-    desc 'create [COMPOSE_FILE]', 'create'
+    desc 'create [COMPOSE_FILE]', 'Create a preview'
     method_option :output, required: false, type: :string, aliases: '-o', enum: ['json', 'github-action']
     def create(file_path = nil)
       run('create', file_path: file_path)
     end
 
-    desc 'delete [DEPLOYMENT_ID]', 'delete'
+    desc 'uffizzi preview update [DEPLOYMENT_ID] [COMPOSE_FILE]', 'Update a preview'
+    method_option :output, required: false, type: :string, aliases: '-o', enum: ['json', 'github-action']
+    def update(deployment_name, file_path)
+      run('update', deployment_name: deployment_name, file_path: file_path)
+    end
+
+    desc 'delete [DEPLOYMENT_ID]', 'Delete a preview'
     def delete(deployment_name)
       run('delete', deployment_name: deployment_name)
     end
 
-    desc 'describe [DEPLOYMENT_ID]', 'describe'
+    desc 'describe [DEPLOYMENT_ID]', 'Display details of a preview'
     def describe(deployment_name)
       run('describe', deployment_name: deployment_name)
     end
 
-    desc 'events [DEPLOYMENT_ID]', 'events'
+    desc 'events [DEPLOYMENT_ID]', 'Show the deployment event logs for a preview'
     def events(deployment_name)
       run('events', deployment_name: deployment_name)
     end
@@ -48,7 +52,7 @@ module Uffizzi
         Uffizzi.ui.disable_stdout
       end
       raise Uffizzi::Error.new('You are not logged in.') unless Uffizzi::AuthHelper.signed_in?
-      raise Uffizzi::Error.new('This command needs project to be set in config file') unless Uffizzi::AuthHelper.project_set?(options)
+      raise Uffizzi::Error.new('This command needs project to be set in config file') unless CommandService.project_set?(options)
 
       project_slug = options[:project].nil? ? ConfigFile.read_option(:project) : options[:project]
 
@@ -57,6 +61,8 @@ module Uffizzi
         handle_list_command(project_slug)
       when 'create'
         handle_create_command(file_path, project_slug)
+      when 'update'
+        handle_update_command(deployment_name, file_path, project_slug)
       when 'delete'
         handle_delete_command(deployment_name, project_slug)
       when 'describe'
@@ -80,133 +86,63 @@ module Uffizzi
       params = file_path.nil? ? {} : prepare_params(file_path)
       response = create_deployment(ConfigFile.read_option(:server), project_slug, params)
 
-      if ResponseHelper.created?(response)
-        handle_succeed_create_response(project_slug, response)
-      else
-        ResponseHelper.handle_failed_response(response)
-      end
-    end
-
-    def handle_events_command(deployment_name, project_slug)
-      deployment_id = PreviewService.read_deployment_id(deployment_name)
-
-      return Uffizzi.ui.say("Preview should be specified in 'deployment-PREVIEW_ID' format") if deployment_id.nil?
-
-      response = fetch_events(ConfigFile.read_option(:server), project_slug, deployment_id)
-
-      if ResponseHelper.ok?(response)
-        handle_succeed_events_response(response)
-      else
+      if !ResponseHelper.created?(response)
         ResponseHelper.handle_failed_response(response)
       end
-    end
-
-    def handle_succeed_events_response(response)
-      Uffizzi.ui.pretty_say(response[:body][:events])
-    end
 
-    def handle_succeed_create_response(project_slug, response)
       deployment = response[:body][:deployment]
-      deployment_id = deployment[:id]
-      params = { id: deployment_id }
+      Uffizzi.ui.say("Preview created with name deployment-#{deployment[:id]}")
 
-      response = deploy_containers(ConfigFile.read_option(:server), project_slug, deployment_id, params)
+      success = PreviewService.run_containers_deploy(project_slug, deployment)
 
-      if ResponseHelper.no_content?(response)
-        Uffizzi.ui.say("Preview created with name deployment-#{deployment_id}")
-        print_deployment_progress(deployment, project_slug)
-      else
-        ResponseHelper.handle_failed_response(response)
-      end
+      display_deployment_data(deployment, success)
+    rescue SystemExit, Interrupt, SocketError
+      deployment_id = response[:body][:deployment][:id]
+      handle_preview_interruption(deployment_id, ConfigFile.read_option(:server), project_slug)
     end
 
-    def print_deployment_progress(deployment, project_slug)
-      deployment_id = deployment[:id]
-
-      @spinner = TTY::Spinner.new('[:spinner] Creating containers...', format: :dots)
-      @spinner.auto_spin
-
-      activity_items = []
+    def handle_update_command(deployment_name, file_path, project_slug)
+      deployment_id = PreviewService.read_deployment_id(deployment_name)
 
-      loop do
-        response = get_activity_items(ConfigFile.read_option(:server), project_slug, deployment_id)
-        handle_activity_items_response(response)
-        return unless @spinner.spinning?
+      raise Uffizzi::Error.new("Preview should be specified in 'deployment-PREVIEW_ID' format") if deployment_id.nil?
 
-        activity_items = response[:body][:activity_items]
-        break if !activity_items.empty? && activity_items.count == deployment[:containers].count
+      params = prepare_params(file_path)
+      response = update_deployment(ConfigFile.read_option(:server), project_slug, deployment_id, params)
 
-        sleep(5)
+      if !ResponseHelper.ok?(response)
+        ResponseHelper.handle_failed_response(response)
       end
 
-      @spinner.success
-
-      Uffizzi.ui.say('Done')
-
-      @spinner = TTY::Spinner::Multi.new('[:spinner] Deploying preview...', format: :dots, style: {
-                                           middle: '  ',
-                                           bottom: '  ',
-                                         })
-
-      containers_spinners = create_containers_spinners(activity_items)
+      deployment = response[:body][:deployment]
+      Uffizzi.ui.say("Preview with ID deployment-#{deployment_id} was successfully updated.")
 
-      wait_containers_deploying(project_slug, deployment_id, containers_spinners)
+      success = PreviewService.run_containers_deploy(project_slug, deployment)
 
-      if options[:output].nil?
-        Uffizzi.ui.say('Done')
-        preview_url = "https://#{deployment[:preview_url]}"
-        Uffizzi.ui.say(preview_url) if @spinner.success?
-      else
-        output_data = build_output_data(deployment)
-        Uffizzi.ui.output(output_data)
-      end
+      display_deployment_data(deployment, success)
     end
 
-    def wait_containers_deploying(project_slug, deployment_id, containers_spinners)
-      loop do
-        response = get_activity_items(ConfigFile.read_option(:server), project_slug, deployment_id)
-        handle_activity_items_response(response)
-        return if @spinner.done?
+    def handle_events_command(deployment_name, project_slug)
+      deployment_id = PreviewService.read_deployment_id(deployment_name)
 
-        activity_items = response[:body][:activity_items]
-        check_activity_items_state(activity_items, containers_spinners)
-        break if activity_items.all? { |activity_item| activity_item[:state] == 'deployed' || activity_item[:state] == 'failed' }
+      raise Uffizzi::Error.new("Preview should be specified in 'deployment-PREVIEW_ID' format") if deployment_id.nil?
 
-        sleep(5)
-      end
-    end
+      response = fetch_events(ConfigFile.read_option(:server), project_slug, deployment_id)
 
-    def create_containers_spinners(activity_items)
-      activity_items.map do |activity_item|
-        container_spinner = @spinner.register("[:spinner] #{activity_item[:name]}")
-        container_spinner.auto_spin
-        {
-          name: activity_item[:name],
-          spinner: container_spinner,
-        }
+      if ResponseHelper.ok?(response)
+        handle_succeed_events_response(response)
+      else
+        ResponseHelper.handle_failed_response(response)
       end
     end
 
-    def check_activity_items_state(activity_items, containers_spinners)
-      finished_activity_items = activity_items.filter do |activity_item|
-        activity_item[:state] == 'deployed' || activity_item[:state] == 'failed'
-      end
-      finished_activity_items.each do |activity_item|
-        container_spinner = containers_spinners.detect { |spinner| spinner[:name] == activity_item[:name] }
-        spinner = container_spinner[:spinner]
-        case activity_item[:state]
-        when 'deployed'
-          spinner.success
-        when 'failed'
-          spinner.error
-        end
-      end
+    def handle_succeed_events_response(response)
+      Uffizzi.ui.pretty_say(response[:body][:events])
     end
 
     def handle_delete_command(deployment_name, project_slug)
       deployment_id = PreviewService.read_deployment_id(deployment_name)
 
-      return Uffizzi.ui.say("Preview should be specified in 'deployment-PREVIEW_ID' format") if deployment_id.nil?
+      raise Uffizzi::Error.new("Preview should be specified in 'deployment-PREVIEW_ID' format") if deployment_id.nil?
 
       response = delete_deployment(ConfigFile.read_option(:server), project_slug, deployment_id)
 
@@ -220,7 +156,7 @@ module Uffizzi
     def handle_describe_command(deployment_name, project_slug)
       deployment_id = PreviewService.read_deployment_id(deployment_name)
 
-      return Uffizzi.ui.say("Preview should be specified in 'deployment-PREVIEW_ID' format") if deployment_id.nil?
+      raise Uffizzi::Error.new("Preview should be specified in 'deployment-PREVIEW_ID' format") if deployment_id.nil?
 
       response = describe_deployment(ConfigFile.read_option(:server), project_slug, deployment_id)
 
@@ -231,16 +167,9 @@ module Uffizzi
       end
     end
 
-    def handle_activity_items_response(response)
-      unless ResponseHelper.ok?(response)
-        @spinner.error
-        ResponseHelper.handle_failed_response(response)
-      end
-    end
-
     def handle_succeed_list_response(response)
       deployments = response[:body][:deployments] || []
-      return Uffizzi.ui.say('The project has no active deployments') if deployments.empty?
+      raise Uffizzi::Error.new('The project has no active deployments') if deployments.empty?
 
       deployments.each do |deployment|
         Uffizzi.ui.say("deployment-#{deployment[:id]}")
@@ -253,11 +182,26 @@ module Uffizzi
 
     def handle_succeed_describe_response(response)
       deployment = response[:body][:deployment]
+      deployment[:containers] = deployment[:containers].map do |container|
+        unless container[:secret_variables].nil?
+          container[:secret_variables] = hide_secrets(container[:secret_variables])
+        end
+
+        container
+      end
       deployment.each_key do |key|
         Uffizzi.ui.say("#{key}: #{deployment[key]}")
       end
     end
 
+    def hide_secrets(secret_variables)
+      secret_variables.map do |secret_variable|
+        secret_variable[:value] = '******'
+
+        secret_variable
+      end
+    end
+
     def prepare_params(file_path)
       begin
         compose_file_data = File.read(file_path)
@@ -280,10 +224,33 @@ module Uffizzi
       }
     end
 
-    def build_output_data(output_data)
+    def handle_preview_interruption(deployment_id, server, project_slug)
+      deletion_response = delete_deployment(server, project_slug, deployment_id)
+      deployment_name = "deployment-#{deployment_id}"
+      preview_deletion_message = if ResponseHelper.no_content?(deletion_response)
+        "The preview #{deployment_name} has been disabled."
+      else
+        "Couldn't disable the deployment #{deployment_name} - please disable maually."
+      end
+
+      raise Uffizzi::Error.new("The preview creation was interrupted. #{preview_deletion_message}")
+    end
+
+    def display_deployment_data(deployment, success)
+      if Uffizzi.ui.output_format.nil?
+        Uffizzi.ui.say('Done')
+        preview_url = "https://#{deployment[:preview_url]}"
+        Uffizzi.ui.say(preview_url) if success
+      else
+        deployment_data = build_deployment_data(deployment)
+        Uffizzi.ui.output(deployment_data)
+      end
+    end
+
+    def build_deployment_data(deployment)
       {
-        id: "deployment-#{output_data[:id]}",
-        url: "https://#{output_data[:preview_url]}",
+        id: "deployment-#{deployment[:id]}",
+        url: "https://#{deployment[:preview_url]}",
       }
     end
   end

data/lib/uffizzi/cli/project/compose.rb

@@ -5,22 +5,23 @@ require 'uffizzi/auth_helper'
 require 'uffizzi/response_helper'
 require 'uffizzi/services/compose_file_service'
 require 'uffizzi/services/env_variables_service'
+require 'uffizzi/services/command_service'
 
 module Uffizzi
-  class CLI::Project::Compose < Thor
+  class Cli::Project::Compose < Thor
     include ApiClient
 
-    desc 'set [OPTIONS]', 'set'
+    desc 'set [OPTIONS]', 'Set the configuration of a project with a compose file'
     def set
       run('set')
     end
 
-    desc 'unset', 'unset'
+    desc 'unset', 'Unset the compose file for a project'
     def unset
       run('unset')
     end
 
-    desc 'describe', 'describe'
+    desc 'describe', 'Display details of a compose file'
     def describe
       run('describe')
     end
@@ -29,26 +30,25 @@ module Uffizzi
 
     def run(command)
       return Uffizzi.ui.say('You are not logged in.') unless Uffizzi::AuthHelper.signed_in?
-      return Uffizzi.ui.say('This command needs project to be set in config file') unless Uffizzi::AuthHelper.project_set?(options)
+      return Uffizzi.ui.say('This command needs project to be set in config file') unless CommandService.project_set?(options)
 
-      @project_slug = options[:project].nil? ? ConfigFile.read_option(:project) : options[:project]
-      @server = ConfigFile.read_option(:server)
+      project_slug = options[:project].nil? ? ConfigFile.read_option(:project) : options[:project]
       file_path = options[:file]
       case command
       when 'set'
-        handle_set_command(file_path)
+        handle_set_command(project_slug, file_path)
       when 'unset'
-        handle_unset_command
+        handle_unset_command(project_slug)
       when 'describe'
-        handle_describe_command
+        handle_describe_command(project_slug)
       end
     end
 
-    def handle_set_command(file_path)
+    def handle_set_command(project_slug, file_path)
       return Uffizzi.ui.say('No file provided') if file_path.nil?
 
       params = prepare_params(file_path)
-      response = set_compose_file(@server, params, @project_slug)
+      response = set_compose_file(ConfigFile.read_option(:server), params, project_slug)
 
       if ResponseHelper.created?(response)
         Uffizzi.ui.say('compose file created')
@@ -57,9 +57,8 @@ module Uffizzi
       end
     end
 
-    def handle_unset_command
+    def handle_unset_command(project_slug)
       server = ConfigFile.read_option(:server)
-      project_slug = ConfigFile.read_option(:project)
       response = unset_compose_file(server, project_slug)
 
       if ResponseHelper.no_content?(response)
@@ -69,9 +68,8 @@ module Uffizzi
       end
     end
 
-    def handle_describe_command
+    def handle_describe_command(project_slug)
       server = ConfigFile.read_option(:server)
-      project_slug = ConfigFile.read_option(:project)
       response = describe_compose_file(server, project_slug)
       compose_file = response[:body][:compose_file]
 

data/lib/uffizzi/cli/project/secret.rb

@@ -3,23 +3,25 @@
 require 'uffizzi'
 require 'uffizzi/auth_helper'
 require 'uffizzi/response_helper'
+require 'uffizzi/date_helper'
 require 'uffizzi/shell'
+require 'time'
 
 module Uffizzi
-  class CLI::Project::Secret < Thor
+  class Cli::Project::Secret < Thor
     include ApiClient
 
-    desc 'list', 'List Secrets'
+    desc 'list', 'Show metadata for all secrets of a project'
     def list
       run('list')
     end
 
-    desc 'create [SECRET_ID]', 'Create secrets from $stdout'
+    desc 'create [SECRET_ID]', 'Create a secret for a project'
     def create(id)
       run('create', id)
     end
 
-    desc 'delete [SECRET_ID]', 'Delete a secret'
+    desc 'delete [SECRET_ID]', 'Delete a secret for a project'
     def delete(id)
       run('delete', id)
     end
@@ -30,7 +32,7 @@ module Uffizzi
       Cli::Common.show_manual(:project, :secret, command) if options[:help] || args.include?('help')
       return Uffizzi.ui.say('You are not logged in') unless AuthHelper.signed_in?
 
-      project_slug = ConfigFile.read_option(:project)
+      project_slug = options[:project].nil? ? ConfigFile.read_option(:project) : options[:project]
       return Uffizzi.ui.say('Please use the --project option to specify the project name') if project_slug.nil?
 
       case command
@@ -50,11 +52,20 @@ module Uffizzi
     def handle_list_command(project_slug)
       server = ConfigFile.read_option(:server)
       response = fetch_secrets(server, project_slug)
-      secrets = response[:body][:secrets].map { |secret| [secret[:name]] }
+      secrets = response[:body][:secrets]
+
       return Uffizzi.ui.say('There are no secrets for the project') if secrets.empty?
 
-      table_header = 'NAME'
-      table_data = [[table_header], *secrets]
+      current_date = Time.now.utc
+      prepared_secrets = secrets.map do |secret|
+        [
+          secret[:name],
+          DateHelper.count_distanse(current_date, Time.parse(secret[:created_at])),
+          DateHelper.count_distanse(current_date, Time.parse(secret[:updated_at])),
+        ]
+      end
+      table_header = ['NAME', 'CREATED', 'UPDATED']
+      table_data = [table_header, *prepared_secrets]
       return Uffizzi.ui.print_table(table_data) if ResponseHelper.ok?(response)
 
       ResponseHelper.handle_failed_response(response)

data/lib/uffizzi/cli/project.rb

@@ -5,31 +5,40 @@ require 'uffizzi/auth_helper'
 require 'uffizzi/response_helper'
 
 module Uffizzi
-  class CLI::Project < Thor
+  class Cli::Project < Thor
     include ApiClient
 
-    desc 'compose', 'compose'
+    desc 'compose', 'Manage the compose file for a project'
     method_option :file, required: false, aliases: '-f'
     require_relative 'project/compose'
-    subcommand 'compose', Uffizzi::CLI::Project::Compose
+    subcommand 'compose', Uffizzi::Cli::Project::Compose
 
-    desc 'secret', 'Secrets Actions'
+    desc 'secret', 'Manage secrets for a project'
     require_relative 'project/secret'
-    subcommand 'secret', Uffizzi::CLI::Project::Secret
+    subcommand 'secret', Uffizzi::Cli::Project::Secret
 
-    desc 'list', 'list'
+    desc 'list', 'List all projects in the account'
     def list
       run('list')
     end
 
+    desc 'set-default PROJECT_SLUG', 'set-default'
+    def set_default(project_slug)
+      run('set-default', project_slug: project_slug)
+    end
+
+    map('set-default' => :set_default)
+
     private
 
-    def run(command)
+    def run(command, project_slug: nil)
       return Uffizzi.ui.say('You are not logged in.') unless Uffizzi::AuthHelper.signed_in?
 
       case command
       when 'list'
         handle_list_command
+      when 'set-default'
+        handle_set_default_command(project_slug)
       end
     end
 
@@ -52,6 +61,21 @@ module Uffizzi
       print_projects(projects)
     end
 
+    def handle_set_default_command(project_slug)
+      response = describe_project(ConfigFile.read_option(:server), project_slug)
+
+      if ResponseHelper.ok?(response)
+        handle_succeed_set_default_response(response)
+      else
+        ResponseHelper.handle_failed_response(response)
+      end
+    end
+
+    def handle_succeed_set_default_response(response)
+      set_default_project(response[:body][:project])
+      Uffizzi.ui.say('Default project has been updated.')
+    end
+
     def print_projects(projects)
       projects_list = projects.reduce('') do |acc, project|
         "#{acc}#{project[:slug]}\n"

data/lib/uffizzi/cli.rb

@@ -3,23 +3,20 @@
 require 'uffizzi'
 
 module Uffizzi
-  class CLI < Thor
-    require_relative 'cli/common'
-
-    class_option :help, type: :boolean, aliases: HELP_MAPPINGS
+  class Cli < Thor
     class_option :project, type: :string
 
     def self.exit_on_failure?
       true
     end
 
-    desc 'version', 'Show Version'
+    desc 'version', 'Print version information for uffizzi CLI'
     def version
       require_relative 'version'
       Uffizzi.ui.say(Uffizzi::VERSION)
     end
 
-    desc 'login [OPTIONS]', 'Login into Uffizzi'
+    desc 'login [OPTIONS]', 'Login to Uffizzi to view and manage your previews'
     method_option :server, required: false, aliases: '-s'
     method_option :username, required: false, aliases: '-u'
     def login
@@ -27,38 +24,30 @@ module Uffizzi
       Login.new(options).run
     end
 
-    desc 'logout', 'Logout from Uffizzi'
+    desc 'logout', 'Log out of a Uffizzi user account'
     def logout
       require_relative 'cli/logout'
       Logout.new(options).run
     end
 
-    desc 'projects', 'projects'
-    def projects
-      require_relative 'cli/projects'
-      Projects.new.run
-    end
-
     desc 'project', 'project'
     require_relative 'cli/project'
-    subcommand 'project', CLI::Project
+    subcommand 'project', Cli::Project
 
     desc 'config', 'config'
     require_relative 'cli/config'
-    subcommand 'config', CLI::Config
+    subcommand 'config', Cli::Config
 
     desc 'preview', 'preview'
     method_option :project, required: false
     require_relative 'cli/preview'
-    subcommand 'preview', CLI::Preview
+    subcommand 'preview', Cli::Preview
 
-    desc 'connect CREDENTIAL_TYPE', 'Connect credentials into Uffizzi'
-    def connect(credential_type, credential_file_path = nil)
-      require_relative 'cli/connect'
-      Connect.new.run(credential_type, credential_file_path)
-    end
+    desc 'connect', 'connect'
+    require_relative 'cli/connect'
+    subcommand 'connect', Cli::Connect
 
-    desc 'disconect CREDENTIAL_TYPE', 'Disonnect credentials from Uffizzi'
+    desc 'disconect CREDENTIAL_TYPE', 'Revoke a Uffizzi user account access to external services'
     def disconnect(credential_type)
       require_relative 'cli/disconnect'
       Disconnect.new.run(credential_type)
@@ -67,11 +56,14 @@ module Uffizzi
     class << self
       protected
 
+      require_relative 'cli/common'
       def dispatch(meth, given_args, given_opts, config)
         args, opts = Thor::Options.split(given_args)
-        return Cli::Common.show_manual(filename(args)) if show_help?(args, opts)
+        return Common.show_manual(filename(args)) if show_help?(args, opts)
 
         super
+      rescue SystemExit, Interrupt, SocketError
+        raise Uffizzi::Error.new('The command was interrupted')
       end
 
       private