uffizzi-cli 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f517c288807e4cb2a7480303b9c04b2856fe76885c79abc3bfb39f77dee24abc
-  data.tar.gz: be93d597d0a6892854974706d2bd629c5b323cffc6ee682f2623884d61d013ba
+  metadata.gz: beaa38102ec282e48c643ba8f6a8c80a331d6ded1760681a004341e2b671b5cf
+  data.tar.gz: c6517ea90506e72c11cb244f02f00760d5bb2afa1171f48fc9a997a8489165f0
 SHA512:
-  metadata.gz: 54df68a43dddc1827a83dfa0f172c57d68b12f6ac52064990b02cd69ccb6a27bced898db4420f146fdd55dcefc017317142b7c587213114af2135dd0a4cc2444
-  data.tar.gz: ff40d04955d46452f0823788c1e62b6de2267fc4623cf4cdd0448e107d78610a1d021051346cd7db55f1b5c1ff18b27da9c81328490fb98c3bb19bf4e0a406aa
+  metadata.gz: 2736a387fb65e9efe83fda0311f9f79bf4916bc828e9b6113bbf7e4e407256438e607af8f1f46dc6df1fa43423ba4728f6432396b60e06c24e16270024382f7a
+  data.tar.gz: 53b0f5951c72ebfba472e147e4397d311380b051baf41d3ca2c7e20f894a3ea417406f4ac8fbc3063902a79c7e11f1e39d5246aee0505377b01583d733056914

data/README.md

@@ -186,6 +186,10 @@ 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

@@ -16,6 +16,8 @@ module Uffizzi
                           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
@@ -37,6 +39,7 @@ module Uffizzi
         'acr' => 'ACR',
         'ecr' => 'ECR',
         'gcr' => 'GCR',
+        'ghcr' => 'GHCR',
       }[credential_type]
     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,7 @@ module Uffizzi
   class CLI::Preview::Service < Thor
     include ApiClient
 
-    desc 'uffizzi preview service logs [LOGS_TYPE] [DEPLOYMENT_ID] [CONTAINER_NAME]', 'logs'
+    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?
@@ -25,7 +25,7 @@ module Uffizzi
       end
     end
 
-    desc 'uffizzi preview service logs [DEPLOYMENT_ID]', 'list'
+    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?

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,13 +1,9 @@
 # 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
@@ -18,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
@@ -27,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'
@@ -64,5 +58,30 @@ module Uffizzi
       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/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.4.0'
+  VERSION = '0.5.0'
 end

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
+

data/man/uffizzi-login

@@ -0,0 +1,32 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-LOGIN" "" "April 2022" ""
+.SH "NAME"
+\fBuffizzi\-login\fR \- login to Uffizzi
+.SH "SYNOPSIS"
+.nf
+uffizzi login [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+The uffizzi login command lets you authenticate with Uffizzi\.
+
+For more information on authentication and credential types, see:
+https://docs\.uffizzi\.com/references/cli
+.fi
+.SH "UFFIZZI WIDE FLAGS"
+.nf
+These flags are available to all commands: \-\-project\. Run $ uffizzi
+help for details\.
+.fi
+.SH "EXAMPLES"
+.nf
+To login to the default host with the default user account, run:
+
+    $ uffizzi login
+
+To login to an alternate host, run:
+
+    $ uffizzi login \-\-hostname=uffizzi\.example\.com
+.fi
+

data/man/uffizzi-login.html

@@ -0,0 +1,113 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' content='text/html;charset=utf8'>
+  <meta name='generator' content='Ronn-NG/v0.9.1 (http://github.com/apjanke/ronn-ng/tree/0.9.1)'>
+  <title>uffizzi-login</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</a>
+    <a href="#EXAMPLES">EXAMPLES</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>uffizzi-login</li>
+    <li class='tc'></li>
+    <li class='tr'>uffizzi-login</li>
+  </ol>
+
+  
+<h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>uffizzi-login</code>
+</p>
+<h2 id="NAME">NAME</h2>
+<pre><code>uffizzi login - login to Uffizzi
+</code></pre>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+<pre><code>uffizzi login [UFFIZZI_WIDE_FLAG ...]
+</code></pre>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+<pre><code>The uffizzi login command lets you authenticate with Uffizzi. 
+
+For more information on authentication and credential types, see:
+https://docs.uffizzi.com/references/cli
+</code></pre>
+
+<h2 id="UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</h2>
+<pre><code>These flags are available to all commands: --project. Run $ uffizzi 
+help for details.
+</code></pre>
+
+<h2 id="EXAMPLES">EXAMPLES</h2>
+<pre><code>To login to the default host with the default user account, run:
+
+    $ uffizzi login
+
+To login to an alternate host, run:
+
+    $ uffizzi login --hostname=uffizzi.example.com
+</code></pre>
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>March 2022</li>
+    <li class='tr'>uffizzi-login</li>
+  </ol>
+
+  </div>
+</body>
+</html>

data/man/uffizzi-login.ronn

@@ -0,0 +1,24 @@
+  uffizzi-login - login to Uffizzi
+================================================================
+
+## SYNOPSIS
+    uffizzi login [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    The uffizzi login command lets you authenticate with Uffizzi. 
+
+    For more information on authentication and credential types, see:
+    https://docs.uffizzi.com/references/cli
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## EXAMPLES
+    To login to the default host with the default user account, run:
+
+        $ uffizzi login
+
+    To login to an alternate host, run:
+
+        $ uffizzi login --hostname=uffizzi.example.com