uffizzi-cli 0.11.2 → 0.11.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c1515d3dbc2f3e8cdf08d18602248f6059aede5e63c702600f0cca97efa19d8
-  data.tar.gz: 7945ef89453d07a194f61102ab72484a24b5b4a44ebc834cb7bbfac06393e1bb
+  metadata.gz: a81fa2bb6f00491f6c59e4c10ea3ce067da1b75b26ff8543e1a08558893058c0
+  data.tar.gz: fec82e0d04c499515f0221740a1a40b51bd5593a35223c0a7723648f20b25a5e
 SHA512:
-  metadata.gz: 0deb98fdefb88dd09a65f1991c7980fe253eea34325f0cc044433823fe4ef2408d3dd2002078a141e94830ea8e3db4aa938dda9bfcf17b51f9526900ac04ba75
-  data.tar.gz: bc4b3deeae31d244aa8d2b76e3ab00ca671af015df70f328c9a843ffd27270275d098bdbe20fa5421db242e9311c93e2854be04063863086207180dae2a1fd4d
+  metadata.gz: 82610a6fe745521646e7d7e7c5e0f65a39263ea53987f1e431d0a0d0b69033d015a67bcd48b07e30c5d044f2167c752f307525438ca232044e90c5b60eb0f602
+  data.tar.gz: 67d5b6c3947e01e72c3ec678b6b14a1ccc6b78583d34f46274cdfa1f7692c9632b98728f43bf1ab5e0b3e984313db98e536c5231ddb9d2a07cc8156b8334ca2e

data/lib/uffizzi/cli/connect.rb

@@ -20,24 +20,26 @@ module Uffizzi
     desc 'docker-hub', 'Connect to Docker Hub (hub.docker.com)'
     method_option :skip_raise_existence_error, type: :boolean, default: false,
                                                desc: 'Skip raising an error within check the credential'
+    method_option :update_credential_if_exists, type: :boolean, default: false
     def docker_hub
       type = Uffizzi.configuration.credential_types[:dockerhub]
-      check_credential_existence(type, 'docker-hub')
+      credential_exists = credential_exists?(type)
+      handle_existing_credential_options('docker-hub') if credential_exists
 
-      username = ENV['DOCKERHUB_USERNAME'] || Uffizzi.ui.ask('Username: ')
-      password = ENV['DOCKERHUB_PASSWORD'] || Uffizzi.ui.ask('Password: ', echo: false)
+      username = ENV['DOCKERHUB_USERNAME'] || Uffizzi.ui.ask('Username:')
+      password = ENV['DOCKERHUB_PASSWORD'] || Uffizzi.ui.ask('Password:', echo: false)
 
       params = {
         username: username,
         password: password,
-        type: Uffizzi.configuration.credential_types[:dockerhub],
+        type: type,
       }
 
       server = ConfigFile.read_option(:server)
-      response = create_credential(server, params)
+      response = create_or_update_credential(server, params, create: !credential_exists)
 
-      if ResponseHelper.created?(response)
-        print_success_message('DockerHub')
+      if successful?(response)
+        print_success_message('Docker Hub')
       else
         ResponseHelper.handle_failed_response(response)
       end
@@ -46,13 +48,15 @@ module Uffizzi
     desc 'acr', 'Connect to Azure Container Registry (azurecr.io)'
     method_option :skip_raise_existence_error, type: :boolean, default: false,
                                                desc: 'Skip raising an error within check the credential'
+    method_option :update_credential_if_exists, type: :boolean, default: false
     def acr
       type = Uffizzi.configuration.credential_types[:azure]
-      check_credential_existence(type, 'acr')
+      credential_exists = credential_exists?(type)
+      handle_existing_credential_options('acr') if credential_exists
 
-      registry_url = ENV['ACR_REGISTRY_URL'] || Uffizzi.ui.ask('Registry Domain: ')
-      username = ENV['ACR_USERNAME'] || Uffizzi.ui.ask('Docker ID: ')
-      password = ENV['ACR_PASSWORD'] || Uffizzi.ui.ask('Password/Access Token: ', echo: false)
+      registry_url = ENV['ACR_REGISTRY_URL'] || Uffizzi.ui.ask('Registry Domain:')
+      username = ENV['ACR_USERNAME'] || Uffizzi.ui.ask('Docker ID:')
+      password = ENV['ACR_PASSWORD'] || Uffizzi.ui.ask('Password/Access Token:', echo: false)
 
       params = {
         username: username,
@@ -62,9 +66,9 @@ module Uffizzi
       }
 
       server = ConfigFile.read_option(:server)
-      response = create_credential(server, params)
+      response = create_or_update_credential(server, params, create: !credential_exists)
 
-      if ResponseHelper.created?(response)
+      if successful?(response)
         print_success_message('ACR')
       else
         ResponseHelper.handle_failed_response(response)
@@ -74,13 +78,15 @@ module Uffizzi
     desc 'ecr', 'Connect to Amazon Elastic Container Registry'
     method_option :skip_raise_existence_error, type: :boolean, default: false,
                                                desc: 'Skip raising an error within check the credential'
+    method_option :update_credential_if_exists, type: :boolean, default: false
     def ecr
       type = Uffizzi.configuration.credential_types[:amazon]
-      check_credential_existence(type, 'ecr')
+      credential_exists = credential_exists?(type)
+      handle_existing_credential_options('ecr') if credential_exists
 
-      registry_url = ENV['AWS_REGISTRY_URL'] || Uffizzi.ui.ask('Registry Domain: ')
-      access_key = ENV['AWS_ACCESS_KEY_ID'] || Uffizzi.ui.ask('Access key ID: ')
-      secret_access_key = ENV['AWS_SECRET_ACCESS_KEY'] || Uffizzi.ui.ask('Secret access key: ', echo: false)
+      registry_url = ENV['AWS_REGISTRY_URL'] || Uffizzi.ui.ask('Registry Domain:')
+      access_key = ENV['AWS_ACCESS_KEY_ID'] || Uffizzi.ui.ask('Access key ID:')
+      secret_access_key = ENV['AWS_SECRET_ACCESS_KEY'] || Uffizzi.ui.ask('Secret access key:', echo: false)
 
       params = {
         username: access_key,
@@ -90,9 +96,9 @@ module Uffizzi
       }
 
       server = ConfigFile.read_option(:server)
-      response = create_credential(server, params)
+      response = create_or_update_credential(server, params, create: !credential_exists)
 
-      if ResponseHelper.created?(response)
+      if successful?(response)
         print_success_message('ECR')
       else
         ResponseHelper.handle_failed_response(response)
@@ -102,9 +108,11 @@ module Uffizzi
     desc 'gcr', 'Connect to Google Container Registry (gcr.io)'
     method_option :skip_raise_existence_error, type: :boolean, default: false,
                                                desc: 'Skip raising an error within check the credential'
+    method_option :update_credential_if_exists, type: :boolean, default: false
     def gcr(credential_file_path = nil)
       type = Uffizzi.configuration.credential_types[:google]
-      check_credential_existence(type, 'gcr')
+      credential_exists = credential_exists?(type)
+      handle_existing_credential_options('gcr') if credential_exists
 
       credential_content = google_service_account_content(credential_file_path)
 
@@ -114,9 +122,9 @@ module Uffizzi
       }
 
       server = ConfigFile.read_option(:server)
-      response = create_credential(server, params)
+      response = create_or_update_credential(server, params, create: !credential_exists)
 
-      if ResponseHelper.created?(response)
+      if successful?(response)
         print_success_message('GCR')
       else
         ResponseHelper.handle_failed_response(response)
@@ -126,12 +134,16 @@ module Uffizzi
     desc 'ghcr', 'Connect to GitHub Container Registry (ghcr.io)'
     method_option :skip_raise_existence_error, type: :boolean, default: false,
                                                desc: 'Skip raising an error within check the credential'
+    method_option :update_credential_if_exists, type: :boolean, default: false
+    method_option :username, type: :string, aliases: :u
+    method_option :token, type: :string, aliases: :t
     def ghcr
       type = Uffizzi.configuration.credential_types[:github_registry]
-      check_credential_existence(type, 'ghcr')
+      credential_exists = credential_exists?(type)
+      handle_existing_credential_options('ghcr') if credential_exists
 
-      username = ENV['GITHUB_USERNAME'] || Uffizzi.ui.ask('Github Username: ')
-      password = ENV['GITHUB_ACCESS_TOKEN'] || Uffizzi.ui.ask('Access Token: ', echo: false)
+      username = options[:username] || ENV['GITHUB_USERNAME'] || Uffizzi.ui.ask('Github Username:')
+      password = options[:token] || ENV['GITHUB_ACCESS_TOKEN'] || Uffizzi.ui.ask('Access Token:', echo: false)
 
       params = {
         username: username,
@@ -140,9 +152,9 @@ module Uffizzi
       }
 
       server = ConfigFile.read_option(:server)
-      response = create_credential(server, params)
+      response = create_or_update_credential(server, params, create: !credential_exists)
 
-      if ResponseHelper.created?(response)
+      if successful?(response)
         print_success_message('GHCR')
       else
         ResponseHelper.handle_failed_response(response)
@@ -154,31 +166,46 @@ module Uffizzi
 
     private
 
+    def successful?(response)
+      ResponseHelper.created?(response) || ResponseHelper.ok?(response)
+    end
+
     def prepare_registry_url(registry_url)
       return registry_url if registry_url.match?(/^(?:http(s)?:\/\/)/)
 
       "https://#{registry_url}"
     end
 
-    def print_success_message(connection_name)
-      Uffizzi.ui.say("Successfully connected to #{connection_name}")
+    def print_success_message(credential_type_slug)
+      Uffizzi.ui.say("Successfully connected to #{credential_type_slug}.")
     end
 
-    def check_credential_existence(type, connection_name)
+    def credential_exists?(type)
       server = ConfigFile.read_option(:server)
       response = check_credential(server, type)
-      return if ResponseHelper.ok?(response)
+      !ResponseHelper.ok?(response)
+    end
+
+    def handle_existing_credential_options(credential_type_slug)
+      if options.update_credential_if_exists?
+        Uffizzi.ui.say('Updating existing credential.')
+        return
+      end
 
       if options.skip_raise_existence_error?
-        Uffizzi.ui.say("Credentials of type #{connection_name} already exist for this account.")
+        Uffizzi.ui.say("Credential of type #{credential_type_slug} already exists for this account.")
         exit(true)
       else
-        message = "Credentials of type #{connection_name} already exist for this account. " \
-        "To remove them, run $ uffizzi disconnect #{connection_name}."
+        message = "Credential of type #{credential_type_slug} already exists for this account.\n" \
+        "To remove them, run uffizzi disconnect #{credential_type_slug}."
         raise Uffizzi::Error.new(message)
       end
     end
 
+    def create_or_update_credential(server, params, create: true)
+      create ? create_credential(server, params) : update_credential(server, params, params[:type])
+    end
+
     def handle_list_credentials_success(response)
       credentials = response[:body][:credentials]
       credentials.each do |credential|
@@ -202,7 +229,7 @@ module Uffizzi
     def google_service_account_content(credential_file_path = nil)
       return ENV['GCLOUD_SERVICE_KEY'] if ENV['GCLOUD_SERVICE_KEY']
 
-      return Uffizzi.ui.say('Path to google service account key file wasn\'t specified.') if credential_file_path.nil?
+      raise Uffizzi::Error.new("Path to a google service account key file wasn't specified.") if credential_file_path.nil?
 
       begin
         credential_content = File.read(credential_file_path)

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

@@ -70,6 +70,13 @@ module ApiClient
     build_response(response)
   end
 
+  def update_credential(server, params, type)
+    uri = credential_uri(server, type)
+    response = http_client.make_put_request(uri, params)
+
+    build_response(response)
+  end
+
   def fetch_deployment_services(server, project_slug, deployment_id)
     uri = preview_services_uri(server, project_slug, deployment_id)
     response = http_client.make_get_request(uri)
@@ -78,7 +85,7 @@ module ApiClient
   end
 
   def delete_credential(server, credential_type)
-    uri = delete_credential_uri(server, credential_type)
+    uri = credential_uri(server, credential_type)
     response = http_client.make_delete_request(uri)
 
     build_response(response)

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

@@ -64,7 +64,7 @@ module ApiRoutes
     "#{server}/api/cli/v1/projects/#{project_slug}/deployments/#{deployment_id}/containers"
   end
 
-  def delete_credential_uri(server, credential_type)
+  def credential_uri(server, credential_type)
     "#{server}/api/cli/v1/account/credentials/#{credential_type}"
   end
 

data/lib/uffizzi/services/compose_file_service.rb

@@ -92,7 +92,7 @@ class ComposeFileService
 
     def parse_compose_content_to_object(compose_content)
       begin
-        compose_data = Psych.safe_load(compose_content)
+        compose_data = Psych.safe_load(compose_content, aliases: true)
       rescue Psych::SyntaxError
         Uffizzi.ui.say('Invalid compose file')
       end

data/lib/uffizzi/version.rb

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

data/man/uffizzi-connect

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CONNECT" "" "May 2022" ""
+.TH "UFFIZZI\-CONNECT" "" "July 2022" ""
 .SH "NAME"
 \fBuffizzi\-connect\fR \- grant a Uffizzi user account access to external services
 .SH "SYNOPSIS"
@@ -30,8 +30,14 @@ ecr
 gcr
     Connect to Google Container Registry (gcr\.io)\.
 
-gchr
+ghcr
     Connect to GitHub Container Registry (ghcr\.io)\.
 .fi
+.SH "FLAGS"
+.nf
+\-\-skip\-raise\-existence\-error        If credential exist, do not raise an exception, just print a message
+
+\-\-update\-credential\-if\-exists       Update credential if it exists
+.fi
 .P
 Run \'uffizzi connect COMMAND \-\-help\' for more information on a command\.

data/man/uffizzi-connect-ghcr

@@ -1,16 +1,20 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CONNECT\-ECR" "" "May 2022" ""
+.TH "UFFIZZI\-CONNECT\-GHCR" "" "July 2022" ""
 .SH "NAME"
-\fBuffizzi\-connect\-ecr\fR \- grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
+\fBuffizzi\-connect\-ghcr\fR \- grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
 .SH "SYNOPSIS"
 .nf
-uffizzi connect ecr
+uffizzi connect ghcr [OPTION]\|\.\|\.\|\.
 .fi
 .SH "DESCRIPTION"
 .nf
 Given valid credentials, grants a Uffizzi user account access
-to a private GitHub Container Registry
+to a private GitHub Container Registry\.
+
+Credentials can be provided interactively or non\-interactively
+via command options or environment variables:
+GITHUB_USERNAME, GITHUB_ACCESS_TOKEN
 
 This command can fail for the following reasons:
     \- The active user does not have permission to connect
@@ -24,12 +28,17 @@ For detailed instructions on configuring webhooks to send push
 notifications to Uffizzi, see
 https://docs\.uffizzi\.com/guides/container\-registry\-integrations
 .fi
+.SH "OPTIONS"
+.nf
+\-u, \-\-username        GitHub username
+\-t, \-\-token           Personal access token from GitHub
+.fi
 .SH "EXAMPLES"
 .nf
 The following command will prompt the user to enter GHCR
 credentials, including GitHub account name and
-personal access key (PAT):
+personal access token (PAT):
 
-    $ uffizzi connect ecr
+uffizzi connect ghcr
 .fi
 

data/man/uffizzi-connect-ghcr.ronn

@@ -1,15 +1,19 @@
-uffizzi-connect-ecr - grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
+uffizzi-connect-ghcr - grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
 ================================================================
 
 ## SYNOPSIS
-    uffizzi connect ecr
+    uffizzi connect ghcr [OPTION]...
 
 ## DESCRIPTION
-    Given valid credentials, grants a Uffizzi user account access 
-    to a private GitHub Container Registry
+    Given valid credentials, grants a Uffizzi user account access
+    to a private GitHub Container Registry.
+
+    Credentials can be provided interactively or non-interactively
+    via command options or environment variables:
+    GITHUB_USERNAME, GITHUB_ACCESS_TOKEN
 
     This command can fail for the following reasons:
-        - The active user does not have permission to connect 
+        - The active user does not have permission to connect
           external services.
         - The given credentials are invalid.
 
@@ -17,12 +21,16 @@ uffizzi-connect-ecr - grant a Uffizzi user account access to a private GitHub Co
     https://github.com/UffizziCloud/uffizzi_cli
 
     For detailed instructions on configuring webhooks to send push
-    notifications to Uffizzi, see 
+    notifications to Uffizzi, see
     https://docs.uffizzi.com/guides/container-registry-integrations
 
+## OPTIONS
+    -u, --username        GitHub username
+    -t, --token           Personal access token from GitHub
+
 ## EXAMPLES
-    The following command will prompt the user to enter GHCR 
-    credentials, including GitHub account name and 
-    personal access key (PAT):
-          
-        $ uffizzi connect ecr
+    The following command will prompt the user to enter GHCR
+    credentials, including GitHub account name and
+    personal access token (PAT):
+
+    uffizzi connect ghcr

data/man/uffizzi-connect.ronn

@@ -24,8 +24,14 @@ uffizzi-connect - grant a Uffizzi user account access to external services
 
     gcr
         Connect to Google Container Registry (gcr.io).
-    
-    gchr
+
+    ghcr
         Connect to GitHub Container Registry (ghcr.io).
 
+
+## FLAGS
+    --skip-raise-existence-error        If credential exist, do not raise an exception, just print a message
+
+    --update-credential-if-exists       Update credential if it exists
+
 Run 'uffizzi connect COMMAND --help' for more information on a command.

data/man/uffizzi-disconnect

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-DISCONNECT" "" "May 2022" ""
+.TH "UFFIZZI\-DISCONNECT" "" "July 2022" ""
 .SH "NAME"
 \fBuffizzi\-disconnect\fR \- revoke a Uffizzi user account access to external services
 .SH "SYNOPSIS"
@@ -30,7 +30,7 @@ ecr
 gcr
     Disonnect from Google Container Registry (gcr\.io)\.
 
-gchr
+ghcr
     Disonnect from GitHub Container Registry (ghcr\.io)\.
 .fi
 .P

data/man/uffizzi-disconnect.ronn

@@ -24,8 +24,8 @@ uffizzi-disconnect - revoke a Uffizzi user account access to external services
 
     gcr
         Disonnect from Google Container Registry (gcr.io).
-    
-    gchr
+
+    ghcr
         Disonnect from GitHub Container Registry (ghcr.io).
 
 Run 'uffizzi disconnect COMMAND --help' for more information on a command.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uffizzi-cli
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.11.5
 platform: ruby
 authors:
 - Josh Thurman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-12 00:00:00.000000000 Z
+date: 2022-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print