uffizzi-cli 0.3.7 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f4c103c385742d901959f98e01af795e472acae632cc162d74632be49b585fa
-  data.tar.gz: b80618d6497a312b3b32605ae3778fcfce39e3aab4fad248daf8f3c7e52ff8cf
+  metadata.gz: beaa38102ec282e48c643ba8f6a8c80a331d6ded1760681a004341e2b671b5cf
+  data.tar.gz: c6517ea90506e72c11cb244f02f00760d5bb2afa1171f48fc9a997a8489165f0
 SHA512:
-  metadata.gz: 00e878c19604b0a70668fc4eaacd46fdcc2c5bd63a8ff3c9ab0947bd7a3600e84968d09cc862d0e7257a1ab019c0eb8ec3ee5b5202a4f0ba6d9c03dbaa226c60
-  data.tar.gz: 1d3613c7c3f4a613cc1e719243747e79d7b78e3941fe2f2da5b1a5e0a6a1d9a3aa5d96ce70a20925f236e3f3dc541ef82c17bd80fb04ee3153892a75e68097b5
+  metadata.gz: 2736a387fb65e9efe83fda0311f9f79bf4916bc828e9b6113bbf7e4e407256438e607af8f1f46dc6df1fa43423ba4728f6432396b60e06c24e16270024382f7a
+  data.tar.gz: 53b0f5951c72ebfba472e147e4397d311380b051baf41d3ca2c7e20f894a3ea417406f4ac8fbc3063902a79c7e11f1e39d5246aee0505377b01583d733056914

data/README.md

@@ -176,6 +176,20 @@ $ uffizzi config delete OPTION
 
 Deletes specified option.
 
+### disconnect ###
+
+```
+$ uffizzi disconnect CREDENTIAL_TYPE
+```
+
+Deletes credential of specified type
+
+Supported credential types - `docker-hub`, `acr`, `ecr`, `gcr`
+
+## Generate manual
+
+In order to generate a manual, create a `.ronn` file having a name pattern like `uffizzi-{command-name}` (for example `uffizzi-project-compose`) in the `man` directory and run `bundle exec ronn man/{filename}.ronn` 
+
 ## Git workflow for the app:
 
 1. Clone the repository and checkout to `develop` branch

data/config/uffizzi.rb

@@ -18,6 +18,7 @@ module Uffizzi
       azure: 'UffizziCore::Credential::Azure',
       google: 'UffizziCore::Credential::Google',
       amazon: 'UffizziCore::Credential::Amazon',
+      github_container_registry: 'UffizziCore::Credential::GithubContainerRegistry',
     }
   end
 end

data/lib/uffizzi/cli/common.rb

@@ -5,8 +5,8 @@ require 'open3'
 module Cli
   class Common
     class << self
-      def show_manual(method_name)
-        manual_doc_path = "man/uffizzi-#{method_name}"
+      def show_manual(command_name)
+        manual_doc_path = "man/#{command_name}"
 
         Open3.pipeline("man #{manual_doc_path}")
       end

data/lib/uffizzi/cli/config.rb

@@ -12,17 +12,17 @@ module Uffizzi
       run('list')
     end
 
-    desc 'get', 'get'
+    desc 'get [PROPERTY]', 'get'
     def get(property)
       run('get', property)
     end
 
-    desc 'set', 'set'
+    desc 'set [PROPERTY] [VALUE]', 'set'
     def set(property, value)
       run('set', property, value)
     end
 
-    desc 'delete', 'delete'
+    desc 'delete [PROPERTY]', 'delete'
     def delete(property)
       run('delete', property)
     end

data/lib/uffizzi/cli/connect.rb

@@ -14,6 +14,8 @@ module Uffizzi
         handle_azure
       when 'ecr'
         handle_amazon
+      when 'ghcr'
+        handle_github_container_registry
       when 'gcr'
         handle_google(credential_file_path)
       else
@@ -111,6 +113,26 @@ module Uffizzi
       end
     end
 
+    def handle_github_container_registry
+      username = Uffizzi.ui.ask('Github Username: ')
+      password = Uffizzi.ui.ask('Access Token: ', echo: false)
+
+      params = {
+        username: username,
+        password: password,
+        type: Uffizzi.configuration.credential_types[:github_container_registry],
+      }
+
+      hostname = ConfigFile.read_option(:hostname)
+      response = create_credential(hostname, params)
+
+      if ResponseHelper.created?(response)
+        print_success_message('GitHub Container Registry')
+      else
+        ResponseHelper.handle_failed_response(response)
+      end
+    end
+
     def prepare_registry_url(registry_url)
       return registry_url if registry_url.match?(/^(?:http(s)?:\/\/)/)
 

data/lib/uffizzi/cli/disconnect.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'uffizzi'
+
+module Uffizzi
+  class CLI::Disconnect
+    include ApiClient
+
+    def run(credential_type)
+      connection_type = case credential_type
+                        when 'docker-hub'
+                          Uffizzi.configuration.credential_types[:dockerhub]
+                        when 'acr'
+                          Uffizzi.configuration.credential_types[:azure]
+                        when 'ecr'
+                          Uffizzi.configuration.credential_types[:amazon]
+                        when 'gcr'
+                          Uffizzi.configuration.credential_types[:google]
+                        when 'ghcr'
+                          Uffizzi.configuration.credential_types[:github_container_registry]
+                        else
+                          raise Uffizzi::Error.new('Unsupported credential type.')
+      end
+
+      response = delete_credential(ConfigFile.read_option(:hostname), connection_type)
+
+      if ResponseHelper.no_content?(response)
+        Uffizzi.ui.say("Successfully disconnected #{connection_name(credential_type)} connection")
+      else
+        ResponseHelper.handle_failed_response(response)
+      end
+    end
+
+    private
+
+    def connection_name(credential_type)
+      {
+        'docker-hub' => 'DockerHub',
+        'acr' => 'ACR',
+        'ecr' => 'ECR',
+        'gcr' => 'GCR',
+        'ghcr' => 'GHCR',
+      }[credential_type]
+    end
+  end
+end

data/lib/uffizzi/cli/logout.rb

@@ -7,6 +7,10 @@ module Uffizzi
   class CLI::Logout
     include ApiClient
 
+    def initialize(options)
+      @options = options
+    end
+
     def run
       return Uffizzi.ui.say('You are not logged in') unless Uffizzi::AuthHelper.signed_in?
 

data/lib/uffizzi/cli/preview/service.rb

@@ -9,7 +9,23 @@ module Uffizzi
   class CLI::Preview::Service < Thor
     include ApiClient
 
-    desc 'list', 'list'
+    desc 'logs [LOGS_TYPE] [DEPLOYMENT_ID] [CONTAINER_NAME]', 'logs'
+    def logs(logs_type, deployment_name, container_name = args)
+      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?
+
+      deployment_id = PreviewService.read_deployment_id(deployment_name)
+      response = service_logs_response(logs_type, deployment_id, container_name)
+      return Uffizzi.ui.say(response[:errors]) if response[:errors]
+
+      if ResponseHelper.ok?(response)
+        handle_succeed_logs_response(response, container_name)
+      else
+        ResponseHelper.handle_failed_response(response)
+      end
+    end
+
+    desc 'logs [DEPLOYMENT_ID]', 'list'
     def list(deployment_name)
       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?
@@ -20,7 +36,7 @@ module Uffizzi
       response = fetch_deployment_services(hostname, project_slug, deployment_id)
 
       if ResponseHelper.ok?(response)
-        handle_succeed_response(response, deployment_name)
+        handle_succeed_list_response(response, deployment_name)
       else
         ResponseHelper.handle_failed_response(response)
       end
@@ -28,7 +44,19 @@ module Uffizzi
 
     private
 
-    def handle_succeed_response(response, deployment_name)
+    def service_logs_response(logs_type, deployment_id, container_name)
+      project_slug = ConfigFile.read_option(:project)
+      hostname = ConfigFile.read_option(:hostname)
+
+      case logs_type
+      when 'container'
+        fetch_deployment_service_logs(hostname, project_slug, deployment_id, container_name)
+      else
+        raise Uffizzi::Error.new('Unknown log type')
+      end
+    end
+
+    def handle_succeed_list_response(response, deployment_name)
       services = response[:body][:containers] || []
       return Uffizzi.ui.say("There are no services associated with the preview #{deployment_name}") if services.empty?
 
@@ -36,5 +64,14 @@ module Uffizzi
         Uffizzi.ui.say(service)
       end
     end
+
+    def handle_succeed_logs_response(response, container_name)
+      logs = response[:body][:logs] || []
+      return Uffizzi.ui.say("The service #{container_name} has no logs") if logs.empty?
+
+      logs.each do |log|
+        Uffizzi.ui.say(log)
+      end
+    end
   end
 end

data/lib/uffizzi/cli/preview.rb

@@ -10,56 +10,45 @@ module Uffizzi
 
     @spinner
 
-    class << self
-      def help(_shell, _subcommand)
-        Cli::Common.show_manual(:preview)
-      end
-    end
-
     desc 'service', 'service'
     require_relative 'preview/service'
     subcommand 'service', Uffizzi::CLI::Preview::Service
 
     desc 'list', 'list'
     def list
-      return Cli::Common.show_manual(:list) if options[:help]
-
-      run(options, 'list')
+      run('list')
     end
 
-    desc 'create', 'create'
+    desc 'create [COMPOSE_FILE]', 'create'
+    method_option :output, required: false, type: :string, aliases: '-o', enum: ['json', 'github-action']
     def create(file_path = nil)
-      return Cli::Common.show_manual(:create) if options[:help]
-
-      run(options, 'create', file_path: file_path)
+      run('create', file_path: file_path)
     end
 
-    desc 'delete', 'delete'
+    desc 'delete [DEPLOYMENT_ID]', 'delete'
     def delete(deployment_name)
-      return Cli::Common.show_manual(:delete) if options[:help]
-
-      run(options, 'delete', deployment_name: deployment_name)
+      run('delete', deployment_name: deployment_name)
     end
 
-    desc 'describe', 'describe'
+    desc 'describe [DEPLOYMENT_ID]', 'describe'
     def describe(deployment_name)
-      return Cli::Common.show_manual(:describe) if options[:help]
-
-      run(options, 'describe', deployment_name: deployment_name)
+      run('describe', deployment_name: deployment_name)
     end
 
-    desc 'events', 'events'
+    desc 'events [DEPLOYMENT_ID]', 'events'
     def events(deployment_name)
-      return Cli::Common.show_manual(:events) if options[:help]
-
-      run(options, 'events', deployment_name: deployment_name)
+      run('events', deployment_name: deployment_name)
     end
 
     private
 
-    def run(options, command, file_path: nil, deployment_name: nil)
-      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?
+    def run(command, file_path: nil, deployment_name: nil)
+      unless options[:output].nil?
+        Uffizzi.ui.output_format = options[:output]
+        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?
 
       project_slug = options[:project].nil? ? ConfigFile.read_option(:project) : options[:project]
 
@@ -161,6 +150,19 @@ module Uffizzi
 
       containers_spinners = create_containers_spinners(activity_items)
 
+      wait_containers_deploying(project_slug, deployment_id, containers_spinners)
+
+      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
+    end
+
+    def wait_containers_deploying(project_slug, deployment_id, containers_spinners)
       loop do
         response = get_activity_items(ConfigFile.read_option(:hostname), project_slug, deployment_id)
         handle_activity_items_response(response)
@@ -172,10 +174,6 @@ module Uffizzi
 
         sleep(5)
       end
-
-      Uffizzi.ui.say('Done')
-      preview_url = "http://#{deployment[:preview_url]}"
-      Uffizzi.ui.say(preview_url) if @spinner.success?
     end
 
     def create_containers_spinners(activity_items)
@@ -264,8 +262,7 @@ module Uffizzi
       begin
         compose_file_data = File.read(file_path)
       rescue Errno::ENOENT => e
-        Uffizzi.ui.say(e)
-        return
+        raise Uffizzi::Error.new(e.message)
       end
 
       compose_file_dir = File.dirname(file_path)
@@ -282,5 +279,12 @@ module Uffizzi
         dependencies: dependencies,
       }
     end
+
+    def build_output_data(output_data)
+      {
+        id: "deployment-#{output_data[:id]}",
+        url: "https://#{output_data[:preview_url]}",
+      }
+    end
   end
 end

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

@@ -10,7 +10,7 @@ module Uffizzi
   class CLI::Project::Compose < Thor
     include ApiClient
 
-    desc 'set', 'set'
+    desc 'set [OPTIONS]', 'set'
     def set
       run(options, 'set')
     end
@@ -96,7 +96,7 @@ module Uffizzi
       begin
         compose_file_data = EnvVariablesService.substitute_env_variables(File.read(file_path))
       rescue Errno::ENOENT => e
-        return Uffizzi.ui.say(e)
+        raise Uffizzi::Error.new(e.message)
       end
 
       compose_file_dir = File.dirname(file_path)

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

@@ -14,19 +14,20 @@ module Uffizzi
       run('list')
     end
 
-    desc 'create', 'Create secrets'
+    desc 'create [SECRET_ID]', 'Create secrets from $stdout'
     def create(id)
       run('create', id)
     end
 
-    desc 'delete', 'Delete a secret'
+    desc 'delete [SECRET_ID]', 'Delete a secret'
     def delete(id)
       run('delete', id)
     end
 
     private
 
-    def run(command, args = {})
+    def run(command, id = nil)
+      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)
@@ -36,13 +37,13 @@ module Uffizzi
       when 'list'
         handle_list_command(project_slug)
       when 'create'
-        handle_create_command(project_slug, args)
+        handle_create_command(project_slug, id)
       when 'delete'
-        handle_delete_command(project_slug, args)
+        handle_delete_command(project_slug, id)
       else
         error_message = "The subcommand #{command} does not exist, please run 'uffizzi project secret help' \
         to get the list of available subcommands"
-        Uffizzi.ui.say(error_message)
+        raise Thor::Error.new(error_message)
       end
     end
 

data/lib/uffizzi/cli.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'thor'
 require 'uffizzi'
 
 module Uffizzi
   class CLI < Thor
-    require_relative 'cli/common'
-    class_option :help, type: :boolean, aliases: ['-h', 'help']
+    def self.exit_on_failure?
+      true
+    end
 
     desc 'version', 'show version'
     def version
@@ -14,7 +14,7 @@ module Uffizzi
       Uffizzi.ui.say(Uffizzi::VERSION)
     end
 
-    desc 'login', 'Login into Uffizzi'
+    desc 'login [OPTIONS]', 'Login into Uffizzi'
     method_option :user, required: true, aliases: '-u'
     method_option :hostname, required: true
     def login
@@ -23,11 +23,9 @@ module Uffizzi
     end
 
     desc 'logout', 'Logout from Uffizzi'
-    def logout(help = nil)
-      return Cli::Common.show_manual(:logout) if help || options[:help]
-
+    def logout
       require_relative 'cli/logout'
-      Logout.new.run
+      Logout.new(options).run
     end
 
     desc 'projects', 'projects'
@@ -54,5 +52,36 @@ module Uffizzi
       require_relative 'cli/connect'
       Connect.new.run(credential_type, credential_file_path)
     end
+
+    desc 'disconect CREDENTIAL_TYPE', 'Disonnect credentials from Uffizzi'
+    def disconnect(credential_type)
+      require_relative 'cli/disconnect'
+      Disconnect.new.run(credential_type)
+    end
+
+    class << self
+      protected
+
+      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)
+
+        super
+      end
+
+      private
+
+      def filename(args)
+        args_without_help = args.reject { |arg| arg == 'help' }
+        return 'uffizzi' if args_without_help.empty?
+
+        "uffizzi-#{args_without_help.join('-')}"
+      end
+
+      def show_help?(args, opts)
+        help_options = ['--help', '-h', '--help=true']
+        args.empty? || args.include?('help') || opts.any? { |opt| help_options.include?(opt) }
+      end
+    end
   end
 end

data/lib/uffizzi/clients/api/api_client.rb

@@ -41,6 +41,20 @@ module ApiClient
     build_response(response)
   end
 
+  def delete_credential(hostname, credential_type)
+    uri = delete_credential_uri(hostname, credential_type)
+    response = Uffizzi::HttpClient.make_delete_request(uri)
+
+    build_response(response)
+  end
+
+  def fetch_deployment_service_logs(hostname, project_slug, deployment_id, container_name)
+    uri = preview_service_logs_uri(hostname, project_slug, deployment_id, container_name)
+    response = Uffizzi::HttpClient.make_get_request(uri)
+
+    build_response(response)
+  end
+
   def set_compose_file(hostname, params, project_slug)
     uri = compose_file_uri(hostname, project_slug)
     response = Uffizzi::HttpClient.make_post_request(uri, params)

data/lib/uffizzi/clients/api/api_routes.rb

@@ -55,4 +55,12 @@ module ApiRoutes
   def preview_services_uri(hostname, project_slug, deployment_id)
     "#{hostname}/api/cli/v1/projects/#{project_slug}/deployments/#{deployment_id}/containers"
   end
+
+  def delete_credential_uri(hostname, credential_type)
+    "#{hostname}/api/cli/v1/account/credentials/#{credential_type}"
+  end
+
+  def preview_service_logs_uri(hostname, project_slug, deployment_id, container_name)
+    "#{hostname}/api/cli/v1/projects/#{project_slug}/deployments/#{deployment_id}/containers/#{container_name}/logs"
+  end
 end

data/lib/uffizzi/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Uffizzi
+  class Error < Thor::Error; end
+end

data/lib/uffizzi/shell.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'thor'
-
 module Uffizzi
   module UI
     class Shell
+      attr_accessor :output_format
+
       def initialize
         @shell = Thor::Shell::Basic.new
       end
@@ -28,6 +28,31 @@ module Uffizzi
       def last_message
         @shell.send(:stdout).string.strip
       end
+
+      def disable_stdout
+        $stdout = StringIO.new
+      end
+
+      def output(data)
+        $stdout = IO.new(1, 'w')
+        json_format? ? output_in_json(data) : output_in_github_format(data)
+      end
+
+      private
+
+      def json_format?
+        output_format == 'json'
+      end
+
+      def output_in_json(data)
+        say(data.to_json)
+      end
+
+      def output_in_github_format(data)
+        data.each_key do |key|
+          say("::set-output name=#{key}::#{data[key]}")
+        end
+      end
     end
   end
 end

data/lib/uffizzi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Uffizzi
-  VERSION = '0.3.7'
+  VERSION = '0.5.0'
 end

data/lib/uffizzi.rb

@@ -3,6 +3,8 @@
 require 'io/console'
 require 'tty-spinner'
 
+require 'thor'
+require 'uffizzi/error'
 require 'uffizzi/shell'
 require 'uffizzi/version'
 require 'uffizzi/clients/api/api_client'
@@ -11,8 +13,6 @@ require 'uffizzi/config_file'
 require_relative '../config/uffizzi'
 
 module Uffizzi
-  class Error < StandardError; end
-
   class << self
     def ui
       @ui ||= Uffizzi::UI::Shell.new

data/man/uffizzi

@@ -0,0 +1,51 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI" "" "April 2022" ""
+.SH "NAME"
+\fBuffizzi\fR \- manage Uffizzi resources
+.SH "SYNOPSIS"
+.nf
+uffizzi GROUP | COMMAND
+.fi
+.SH "DESCRIPTION"
+.nf
+The uffizzi CLI manages authentication, configuration, and
+interaction with Uffizzi APIs\.
+
+For more information on the uffizzi CLI, see:
+https://docs\.uffizzi\.com/cli
+.fi
+.SH "GROUP"
+.nf
+GROUP is one of the following:
+
+ config
+     Configure the uffizzi CLI
+
+ connect
+     Grant a Uffizzi user account access to external services
+
+ preview
+     Manage Uffizzi previews and view logs
+
+ project
+     Manage Uffizzi project resources including compose files for
+     specifying preview configurations and secrets
+.fi
+.SH "COMMAND"
+.nf
+COMMAND is one of the following:
+
+ help
+     Show uffizzi documentation
+
+ login
+     Log in to a Uffizzi user account
+
+ logout
+     Log out of a Uffizzi user account
+
+ version
+     Print version information for uffizzi CLI
+.fi
+