uffizzi-cli 0.6.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de1f8c92c08b2d323c6c379bd5521aa394db91d85ed02ebc73f8c8457bb083d9
-  data.tar.gz: 5c19dc240896c322b27d7dcf42499d6c5a67ce911ef3df625caf78fc71c259c5
+  metadata.gz: e9ab52c8638dc3d5a8f6245ba337da95fcf986e39040458add0c1128857014f8
+  data.tar.gz: b897ce235bc887bd161a7262fecddc28228b523b167338b599051ba370b704d3
 SHA512:
-  metadata.gz: b653f34930cd546941d9646f7b5e2fccb854a784ed375e7da0b51f2a0cd9d9642b2463598ed6092e2d86be2de6ba804c9ae4c474290e5bdcee12123ad04fcd96
-  data.tar.gz: 7f4c915af4bebe54b1ae2e96b2661d08374ce4d71a9fed04388b815bf3c6c6e02039bed214d8e6da678dc427d6753ac17869473a172df5c81bc5f2dca9c0c7c3
+  metadata.gz: a2976d6389a9a1d5c9d53ab66e34de98c391b250e2b4e5ebf636189b12f7e7a366e5140ef1c8583ce952d68fd8734600945402b6e38b10dea28700b71eb2bcf6
+  data.tar.gz: 78aa15c2dd0f21febc64c73c2a77e86de98ccda9a90278069ced243f3264f74240d5530aa67828515a4e03f858fb3e2d1d5d1713eca63127d027cbd4b3ea89ac

data/README.md

@@ -4,14 +4,14 @@ A command-line interace (CLI) for [Uffizzi App](https://github.com/UffizziCloud/
 
 ## Uffizzi Overview
 
-Uffizzi is an open-source engine for creating lightweight, ephemeral test environments for APIs and full-stack applications. Uffizzi enables teams to preview new features before merging and to mitigate the risk of introducing regressions into a codebase. Each preview gets a shareable URL that's updated when you push new commits or image tags, so teams can provide continual feedback during the development/QA process. Previews can be configured to expire or be destroyed when a pull request is closed, so environments exist only as long as they are needed. Uffizzi also helps deconflict shared development environments since previews are deployed as isolated namespaces—there is no risk of clobbering another developer's preview. 
+Uffizzi is an open-source engine for creating lightweight, ephemeral test environments for APIs and full-stack applications. Uffizzi enables teams to preview new features before merging and to mitigate the risk of introducing regressions into a codebase. Each preview gets a shareable URL that's updated when you push new commits or image tags, so teams can provide continual feedback during the development/QA process. Previews can be configured to expire or be destroyed when a pull request is closed, so environments exist only as long as they are needed. Uffizzi also helps deconflict shared development environments since previews are deployed as isolated namespaces—there is no risk of clobbering another developer's preview.
 
 While Uffizzi depends on Kubernetes, it does not require end-users to interface with Kubernetes directly. Instead, Uffizzi leverages Docker Compose as its configuration file format, so developers do not need modify Kubernetes manifests or even know about Kubernetes.
 
 Uffizzi is designed to integrate with any CI/CD system.
 
 ## Uffizzi Architecture
-<img src="https://github.com/UffizziCloud/uffizzi_app/blob/main/docs/images/uffizzi-architecture.png" description="Uffizzi Architecture" width="320"/>  
+<img src="https://github.com/UffizziCloud/uffizzi_app/blob/main/docs/images/uffizzi-architecture.png" description="Uffizzi Architecture" width="320"/>
 
 Uffizzi consists of the following components:
 
@@ -31,7 +31,7 @@ The Uffizzi CLI can be used interactively or as part of an automated workflow (e
 
 ### Interactive mode
 
-Run the CLI as a Docker container in interactive mode:  
+Run the CLI as a Docker container in interactive mode:
 ```
 docker run --interactive --rm --tty --entrypoint=sh uffizzi/cli
 ```
@@ -44,9 +44,9 @@ entrypoint script can log you into Uffizzi before executing your command.
 - `UFFIZZI_PASSWORD`
 - `UFFIZZI_PROJECT` (optional)
 
-### Automated mode  
+### Automated mode
 
-If you want to use Uffizzi as part of an automated workflow, you can pass the Uffizzi commands to the Docker run command. For example:    
+If you want to use Uffizzi as part of an automated workflow, you can pass the Uffizzi commands to the Docker run command. For example:
 
 ```
 docker run -it --rm uffizzi/cli project list
@@ -141,7 +141,14 @@ uffizzi project list
 
 Shows all your projects' slugs
 
-If you have only one project it will be added to your config file automatically, if there's more than one project you need to set up your project manually with the command `uffizzi config set YOUR_PROJECT_SLUG`
+If you have only one project it will be added to your config file automatically, if there's more than one project you need to set up your project manually with the commands `uffizzi config set YOUR_PROJECT_SLUG` or `uffizzi project set-default YOUR_PROJECT_SLUG`
+
+```
+$ uffizzi project set-default PROJECT_SLUG
+```
+Create a preview from a compose file.
+
+Sets the default project given with the given project slug. When set, all commands use this project as the default context unless overridden by the --project flag.
 
 ### preview
 
@@ -169,4 +176,4 @@ Supported credential types - `docker-hub`, `acr`, `ecr`, `gcr`
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/UffizziCloud/uffizzi_cli.
+Bug reports and pull requests are welcome on GitHub at https://github.com/UffizziCloud/uffizzi_cli. See `CONTRIBUTING.md` in this repository.

data/exe/uffizzi

@@ -2,4 +2,4 @@
 # frozen_string_literal: true
 
 require 'uffizzi/cli'
-Uffizzi::CLI.start
+Uffizzi::Cli.start

data/lib/uffizzi/auth_helper.rb

@@ -9,10 +9,6 @@ module Uffizzi
           ConfigFile.option_has_value?(:cookie) &&
           ConfigFile.option_has_value?(:server)
       end
-
-      def project_set?(options)
-        !options[:project].nil? || (ConfigFile.exists? && ConfigFile.option_has_value?(:project))
-      end
     end
   end
 end

data/lib/uffizzi/cli/common.rb

@@ -2,8 +2,8 @@
 
 require 'open3'
 
-module Cli
-  class Common
+module Uffizzi
+  class Cli::Common
     class << self
       def show_manual(command_name)
         manual_doc_path = File.join(Uffizzi.root, "man/#{command_name}")

data/lib/uffizzi/cli/config.rb

@@ -4,31 +4,25 @@ require 'uffizzi'
 require 'uffizzi/clients/api/api_client'
 
 module Uffizzi
-  class CLI::Config < Thor
+  class Cli::Config < Thor
     include ApiClient
 
-    class << self
-      def help(_shell, _subcommand)
-        Cli::Common.show_manual(:config)
-      end
-    end
-
-    desc 'list', 'list'
+    desc 'list', 'Lists all options and their values from the config file'
     def list
       run('list')
     end
 
-    desc 'get [PROPERTY]', 'get'
+    desc 'get [PROPERTY]', 'Displays the value of the specified option'
     def get_value(property)
       run('get', property)
     end
 
-    desc 'set [PROPERTY] [VALUE]', 'set'
+    desc 'set [PROPERTY] [VALUE]', 'Sets the value of the specified option'
     def set(property, value)
       run('set', property, value)
     end
 
-    desc 'unset [PROPERTY]', 'unset'
+    desc 'unset [PROPERTY]', 'Deletes the value of the specified option'
     def unset(property)
       run('unset', property)
     end

data/lib/uffizzi/cli/connect.rb

@@ -3,29 +3,25 @@
 require 'uffizzi'
 
 module Uffizzi
-  class CLI::Connect
+  class Cli::Connect < Thor
     include ApiClient
 
-    def run(credential_type, credential_file_path)
-      case credential_type
-      when 'docker-hub'
-        handle_docker_hub
-      when 'acr'
-        handle_azure
-      when 'ecr'
-        handle_amazon
-      when 'ghcr'
-        handle_github_container_registry
-      when 'gcr'
-        handle_google(credential_file_path)
+    desc 'list-credentials', 'List existing credentials for an account'
+    def list_credentials
+      server = ConfigFile.read_option(:server)
+      response = fetch_credentials(server)
+      if ResponseHelper.ok?(response)
+        handle_list_credentials_success(response)
       else
-        Uffizzi.ui.say('Unsupported credential type.')
+        ResponseHelper.handle_failed_response(response)
       end
     end
 
-    private
+    desc 'docker-hub', 'Connect to Docker Hub (hub.docker.com)'
+    def docker_hub
+      type = Uffizzi.configuration.credential_types[:dockerhub]
+      check_credential_existance(type, 'docker-hub')
 
-    def handle_docker_hub
       username = Uffizzi.ui.ask('Username: ')
       password = Uffizzi.ui.ask('Password: ', echo: false)
 
@@ -45,7 +41,11 @@ module Uffizzi
       end
     end
 
-    def handle_azure
+    desc 'acr', 'Connect to Azure Container Registry (azurecr.io)'
+    def acr
+      type = Uffizzi.configuration.credential_types[:azure]
+      check_credential_existance(type, 'acr')
+
       registry_url = prepare_registry_url(Uffizzi.ui.ask('Registry Domain: '))
       username = Uffizzi.ui.ask('Docker ID: ')
       password = Uffizzi.ui.ask('Password/Access Token: ', echo: false)
@@ -54,7 +54,7 @@ module Uffizzi
         username: username,
         password: password,
         registry_url: registry_url,
-        type: Uffizzi.configuration.credential_types[:azure],
+        type: type,
       }
 
       server = ConfigFile.read_option(:server)
@@ -67,7 +67,11 @@ module Uffizzi
       end
     end
 
-    def handle_amazon
+    desc 'ecr', 'Connect to Amazon Elastic Container Registry'
+    def ecr
+      type = Uffizzi.configuration.credential_types[:amazon]
+      check_credential_existance(type, 'ecr')
+
       registry_url = prepare_registry_url(Uffizzi.ui.ask('Registry Domain: '))
       username = Uffizzi.ui.ask('Access key ID: ')
       password = Uffizzi.ui.ask('Secret access key: ', echo: false)
@@ -76,7 +80,7 @@ module Uffizzi
         username: username,
         password: password,
         registry_url: registry_url,
-        type: Uffizzi.configuration.credential_types[:amazon],
+        type: type,
       }
 
       server = ConfigFile.read_option(:server)
@@ -89,7 +93,11 @@ module Uffizzi
       end
     end
 
-    def handle_google(credential_file_path)
+    desc 'gcr', 'Connect to Google Container Registry (gcr.io)'
+    def gcr(credential_file_path = nil)
+      type = Uffizzi.configuration.credential_types[:google]
+      check_credential_existance(type, 'gcr')
+
       return Uffizzi.ui.say('Path to google service account key file wasn\'t specified.') if credential_file_path.nil?
 
       begin
@@ -100,7 +108,7 @@ module Uffizzi
 
       params = {
         password: credential_content,
-        type: Uffizzi.configuration.credential_types[:google],
+        type: type,
       }
 
       server = ConfigFile.read_option(:server)
@@ -113,26 +121,35 @@ module Uffizzi
       end
     end
 
-    def handle_github_container_registry
+    desc 'ghcr', 'Connect to GitHub Container Registry (ghcr.io)'
+    def ghcr
+      type = Uffizzi.configuration.credential_types[:github_container_registry]
+      check_credential_existance(type, 'gchr')
+
       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],
+        type: type,
       }
 
-      hostname = ConfigFile.read_option(:hostname)
-      response = create_credential(hostname, params)
+      server = ConfigFile.read_option(:server)
+      response = create_credential(server, params)
 
       if ResponseHelper.created?(response)
-        print_success_message('GitHub Container Registry')
+        print_success_message('GHCR')
       else
         ResponseHelper.handle_failed_response(response)
       end
     end
 
+    map 'list-credentials' => 'list_credentials'
+    map 'docker-hub' => 'docker_hub'
+
+    private
+
     def prepare_registry_url(registry_url)
       return registry_url if registry_url.match?(/^(?:http(s)?:\/\/)/)
 
@@ -142,5 +159,35 @@ module Uffizzi
     def print_success_message(connection_name)
       Uffizzi.ui.say("Successfully connected to #{connection_name}")
     end
+
+    def check_credential_existance(type, connection_name)
+      server = ConfigFile.read_option(:server)
+      response = check_credential(server, type)
+      return if ResponseHelper.ok?(response)
+
+      message = "Credentials of type #{connection_name} already exist for this account. " \
+      "To remove them, run $ uffizzi disconnect #{connection_name}."
+      raise Uffizzi::Error.new(message)
+    end
+
+    def handle_list_credentials_success(response)
+      credentials = response[:body][:credentials]
+      credentials.each do |credential|
+        Uffizzi.ui.say(credential_readable_name(credential))
+      end
+    end
+
+    def credential_readable_name(credential)
+      map = {
+        'UffizziCore::Credential::DockerHub' => 'docker-hub',
+        'UffizziCore::Credential::Github' => 'github',
+        'UffizziCore::Credential::Azure' => 'acr',
+        'UffizziCore::Credential::Amazon' => 'ecr',
+        'UffizziCore::Credential::GithubContainerRegistry' => 'ghcr',
+        'UffizziCore::Credential::Google' => 'gcr',
+      }
+
+      map[credential]
+    end
   end
 end

data/lib/uffizzi/cli/disconnect.rb

@@ -3,7 +3,7 @@
 require 'uffizzi'
 
 module Uffizzi
-  class CLI::Disconnect
+  class Cli::Disconnect
     include ApiClient
 
     def run(credential_type)

data/lib/uffizzi/cli/login.rb

@@ -5,7 +5,7 @@ require 'uffizzi/response_helper'
 require 'uffizzi/clients/api/api_client'
 
 module Uffizzi
-  class CLI::Login
+  class Cli::Login
     include ApiClient
 
     def initialize(options)
@@ -13,7 +13,7 @@ module Uffizzi
     end
 
     def run
-      Uffizzi.ui.say('Login to Uffizzi to your previews.')
+      Uffizzi.ui.say('Login to Uffizzi to view and manage your previews.')
       server = set_server
       username = set_username
       password = set_password

data/lib/uffizzi/cli/logout.rb

@@ -4,7 +4,7 @@ require 'uffizzi'
 require 'uffizzi/auth_helper'
 
 module Uffizzi
-  class CLI::Logout
+  class Cli::Logout
     include ApiClient
 
     def initialize(options)

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

@@ -4,15 +4,16 @@ require 'uffizzi'
 require 'uffizzi/auth_helper'
 require 'uffizzi/response_helper'
 require 'uffizzi/services/preview_service'
+require 'uffizzi/services/command_service'
 
 module Uffizzi
-  class CLI::Preview::Service < Thor
+  class Cli::Preview::Service < Thor
     include ApiClient
 
-    desc 'logs [LOGS_TYPE] [DEPLOYMENT_ID] [CONTAINER_NAME]', 'logs'
+    desc 'logs [LOGS_TYPE] [DEPLOYMENT_ID] [CONTAINER_NAME]', 'Show the logs for a container service of a preview'
     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?(options)
+      return Uffizzi.ui.say('This command needs project to be set in config file') unless CommandService.project_set?(options)
 
       deployment_id = PreviewService.read_deployment_id(deployment_name)
       response = service_logs_response(logs_type, deployment_id, container_name)
@@ -25,12 +26,12 @@ module Uffizzi
       end
     end
 
-    desc 'logs [DEPLOYMENT_ID]', 'list'
+    desc 'list [DEPLOYMENT_ID]', 'List the container services of a given preview'
     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?(options)
+      return Uffizzi.ui.say('This command needs project to be set in config file') unless CommandService.project_set?(options)
 
-      project_slug = ConfigFile.read_option(:project)
+      project_slug = options[:project].nil? ? ConfigFile.read_option(:project) : options[:project]
       server = ConfigFile.read_option(:server)
       deployment_id = PreviewService.read_deployment_id(deployment_name)
       response = fetch_deployment_services(server, project_slug, deployment_id)
@@ -45,7 +46,7 @@ module Uffizzi
     private
 
     def service_logs_response(logs_type, deployment_id, container_name)
-      project_slug = ConfigFile.read_option(:project)
+      project_slug = options[:project].nil? ? ConfigFile.read_option(:project) : options[:project]
       server = ConfigFile.read_option(:server)
 
       case logs_type