uffizzi-cli 0.8.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17ac6475e11de6c24b044f64e19541587683aaad4bd3b72cafbc5160b92364a8
-  data.tar.gz: 228b5a14b359af42f9698eba6bd98c94155dfd05791b55378dfc99cf6ffe365d
+  metadata.gz: aad4e300e1250ee113d65b436b58045b368c707c5840bc26375918a33c894a5a
+  data.tar.gz: 711dc99c47c9d073405da14ce9409e2bfe99eaca6028143da0eccb7961ba8426
 SHA512:
-  metadata.gz: 4d9e8d2f99a297d2fac8452bc03e180c71f7b1e05d71ac333704b2e1649fffdfd2bb4f6b86ffb0d186e441629cb809b2d5c450984b2a36af49080b9b08fab700
-  data.tar.gz: ce3cdb192caa7ab39a7edec3b5d01788505cae7a4a2d5f440b99ef203f86f18d67c22ec5c07ef67603dc6ebb35871857f3f536ac71720b4634c46579f8e771d6
+  metadata.gz: aebda9657557027599278995e7a97bef373b118cdf4a8055d17706f418ffbd7b6a126703dfa5901833ab2c7198f91d91c5f07da5c836b0b602382a6fe860c235
+  data.tar.gz: 951c78b92cbee8f70a5b41231fa56cd9ea0cf3ec278c174b703a065567eb1d4ddfca18484396c5db208ea85d6fd1ad8f59c8c9a8a8c29ebbbc5fbe8b308e0ff8

data/config/uffizzi.rb

@@ -18,7 +18,7 @@ module Uffizzi
       azure: 'UffizziCore::Credential::Azure',
       google: 'UffizziCore::Credential::Google',
       amazon: 'UffizziCore::Credential::Amazon',
-      github_container_registry: 'UffizziCore::Credential::GithubContainerRegistry',
+      github_registry: 'UffizziCore::Credential::GithubContainerRegistry',
     }
     config.default_server = 'app.uffizzi.com'
   end

data/lib/uffizzi/auth_helper.rb

@@ -9,6 +9,11 @@ module Uffizzi
           ConfigFile.option_has_value?(:cookie) &&
           ConfigFile.option_has_value?(:server)
       end
+
+      def sign_out
+        Uffizzi::ConfigFile.unset_option(:cookie)
+        Uffizzi::ConfigFile.unset_option(:account_id)
+      end
     end
   end
 end

data/lib/uffizzi/cli/config.rb

@@ -58,7 +58,7 @@ module Uffizzi
                       \nUffizzi API service and manage previews.\n")
       server = Uffizzi.ui.ask('Server: ', default: Uffizzi.configuration.default_server.to_s)
       username = Uffizzi.ui.ask('Username: ')
-      project = Uffizzi.ui.ask('Project: ')
+      project = Uffizzi.ui.ask('Project: ', default: 'default')
       ConfigFile.delete
       ConfigFile.write_option(:server, server)
       ConfigFile.write_option(:username, username)

data/lib/uffizzi/cli/connect.rb

@@ -18,12 +18,14 @@ module Uffizzi
     end
 
     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'
     def docker_hub
       type = Uffizzi.configuration.credential_types[:dockerhub]
-      check_credential_existance(type, 'docker-hub')
+      check_credential_existence(type, 'docker-hub')
 
-      username = Uffizzi.ui.ask('Username: ')
-      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,
@@ -42,18 +44,20 @@ module Uffizzi
     end
 
     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'
     def acr
       type = Uffizzi.configuration.credential_types[:azure]
-      check_credential_existance(type, 'acr')
+      check_credential_existence(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)
+      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,
         password: password,
-        registry_url: registry_url,
+        registry_url: prepare_registry_url(registry_url),
         type: type,
       }
 
@@ -68,18 +72,20 @@ module Uffizzi
     end
 
     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'
     def ecr
       type = Uffizzi.configuration.credential_types[:amazon]
-      check_credential_existance(type, 'ecr')
+      check_credential_existence(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)
+      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: username,
-        password: password,
-        registry_url: registry_url,
+        username: access_key,
+        password: secret_access_key,
+        registry_url: prepare_registry_url(registry_url),
         type: type,
       }
 
@@ -94,17 +100,13 @@ module Uffizzi
     end
 
     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'
     def gcr(credential_file_path = nil)
       type = Uffizzi.configuration.credential_types[:google]
-      check_credential_existance(type, 'gcr')
+      check_credential_existence(type, 'gcr')
 
-      return Uffizzi.ui.say('Path to google service account key file wasn\'t specified.') if credential_file_path.nil?
-
-      begin
-        credential_content = File.read(credential_file_path)
-      rescue Errno::ENOENT => e
-        return Uffizzi.ui.say(e)
-      end
+      credential_content = google_service_account_content(credential_file_path)
 
       params = {
         password: credential_content,
@@ -122,12 +124,14 @@ module Uffizzi
     end
 
     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'
     def ghcr
-      type = Uffizzi.configuration.credential_types[:github_container_registry]
-      check_credential_existance(type, 'gchr')
+      type = Uffizzi.configuration.credential_types[:github_registry]
+      check_credential_existence(type, 'ghcr')
 
-      username = Uffizzi.ui.ask('Github Username: ')
-      password = Uffizzi.ui.ask('Access Token: ', echo: false)
+      username = ENV['GITHUB_USERNAME'] || Uffizzi.ui.ask('Github Username: ')
+      password = ENV['GITHUB_ACCESS_TOKEN'] || Uffizzi.ui.ask('Access Token: ', echo: false)
 
       params = {
         username: username,
@@ -160,14 +164,19 @@ module Uffizzi
       Uffizzi.ui.say("Successfully connected to #{connection_name}")
     end
 
-    def check_credential_existance(type, connection_name)
+    def check_credential_existence(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)
+      if options.skip_raise_existence_error?
+        Uffizzi.ui.say("Credentials of type #{connection_name} already exist 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}."
+        raise Uffizzi::Error.new(message)
+      end
     end
 
     def handle_list_credentials_success(response)
@@ -189,5 +198,19 @@ module Uffizzi
 
       map[credential]
     end
+
+    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?
+
+      begin
+        credential_content = File.read(credential_file_path)
+      rescue Errno::ENOENT => e
+        raise Uffizzi::Error.new(e.message)
+      end
+
+      credential_content
+    end
   end
 end

data/lib/uffizzi/cli/disconnect.rb

@@ -17,7 +17,7 @@ module Uffizzi
                         when 'gcr'
                           Uffizzi.configuration.credential_types[:google]
                         when 'ghcr'
-                          Uffizzi.configuration.credential_types[:github_container_registry]
+                          Uffizzi.configuration.credential_types[:github_registry]
                         else
                           raise Uffizzi::Error.new('Unsupported credential type.')
       end

data/lib/uffizzi/cli/login.rb

@@ -2,7 +2,9 @@
 
 require 'uffizzi'
 require 'uffizzi/response_helper'
+require 'uffizzi/helpers/project_helper'
 require 'uffizzi/clients/api/api_client'
+require 'tty-prompt'
 
 module Uffizzi
   class Cli::Login
@@ -15,6 +17,7 @@ module Uffizzi
     def run
       Uffizzi.ui.say('Login to Uffizzi to view and manage your previews.')
       server = set_server
+
       username = set_username
       password = set_password
       params = prepare_request_params(username, password)
@@ -30,12 +33,12 @@ module Uffizzi
     private
 
     def set_server
-      config_server = ConfigFile.exists? && ConfigFile.option_has_value?(:server) ? ConfigFile.read_option(:server) : nil
+      config_server = ConfigFile.exists? ? read_option_from_config(:server) : nil
       @options[:server] || config_server || Uffizzi.ui.ask('Server: ')
     end
 
     def set_username
-      config_username = ConfigFile.exists? && ConfigFile.option_has_value?(:username) ? ConfigFile.read_option(:username) : nil
+      config_username = ConfigFile.exists? ? read_option_from_config(:username) : nil
       @options[:username] || config_username || Uffizzi.ui.ask('Username: ')
     end
 
@@ -43,6 +46,10 @@ module Uffizzi
       ENV['UFFIZZI_PASSWORD'] || Uffizzi.ui.ask('Password: ', echo: false)
     end
 
+    def read_option_from_config(option)
+      ConfigFile.option_has_value?(option) ? ConfigFile.read_option(option) : nil
+    end
+
     def prepare_request_params(username, password)
       {
         user: {
@@ -60,10 +67,77 @@ module Uffizzi
       ConfigFile.write_option(:username, username)
       ConfigFile.write_option(:cookie, response[:headers])
       ConfigFile.write_option(:account_id, account[:id])
+
+      default_project = ConfigFile.read_option(:project)
+      return unless default_project
+
+      check_default_project(default_project, server)
     end
 
     def account_valid?(account)
       account[:state] == 'active'
     end
+
+    def check_default_project(default_project, server)
+      check_project_response = fetch_projects(server)
+      return ResponseHelper.handle_failed_response(check_project_response) unless ResponseHelper.ok?(check_project_response)
+
+      projects = check_project_response[:body][:projects]
+      slugs = projects.map { |project| project[:slug] }
+      return if slugs.include?(default_project)
+
+      question = "Project '#{default_project}' does not exist. Select one of the following projects or create a new project:"
+      choices = projects.map do |project|
+        { name: project[:name], value: project[:slug] }
+      end
+      all_choices = choices + [{ name: 'Create a new project', value: nil }]
+      answer = Uffizzi.prompt.select(question, all_choices)
+      return ConfigFile.write_option(:project, answer) if answer
+
+      create_new_project(server)
+    end
+
+    def create_new_project(server)
+      project_name = Uffizzi.prompt.ask('Project name: ', required: true)
+      generated_slug = Uffizzi::ProjectHelper.generate_slug(project_name)
+      project_slug = Uffizzi.prompt.ask('Project slug: ', default: generated_slug)
+      raise Uffizzi::Error.new('Slug must not content spaces or special characters') unless project_slug.match?(/^[a-zA-Z0-9\-_]+\Z/i)
+
+      project_description = Uffizzi.prompt.ask('Project desciption: ')
+
+      params = {
+        project: {
+          name: project_name.strip,
+          slug: project_slug,
+          description: project_description,
+        },
+      }
+
+      response = create_project(server, params)
+
+      if ResponseHelper.created?(response)
+        handle_create_project_succeess(response)
+      else
+        handle_create_project_failed(response)
+      end
+    end
+
+    def handle_create_project_failed(response)
+      name_error = response[:body][:errors][:name].first
+      name_already_exists = name_error && name_error.first == 'Name already exists'
+      message = "Project with name #{project_name} already exists. " \
+      'Please run $ uffizzi config to set it as a default project'
+      raise Uffizzi::Error.new(message) if name_already_exists
+
+      ResponseHelper.handle_failed_response(response)
+    end
+
+    def handle_create_project_succeess(response)
+      project = response[:body][:project]
+
+      ConfigFile.write_option(:project, project[:slug])
+
+      Uffizzi.ui.say("Project #{project[:name]} was successfully created")
+    end
   end
 end

data/lib/uffizzi/cli/logout.rb

@@ -17,7 +17,7 @@ module Uffizzi
       server = ConfigFile.read_option(:server)
       destroy_session(server)
 
-      ConfigFile.delete
+      AuthHelper.sign_out
       Uffizzi.ui.say('You have been successfully logged out')
     end
   end

data/lib/uffizzi/cli/preview.rb

@@ -119,6 +119,9 @@ module Uffizzi
       success = PreviewService.run_containers_deploy(project_slug, deployment)
 
       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 handle_events_command(deployment_name, project_slug)
@@ -204,7 +207,7 @@ module Uffizzi
 
     def prepare_params(file_path)
       begin
-        compose_file_data = File.read(file_path)
+        compose_file_data = EnvVariablesService.substitute_env_variables(File.read(file_path))
       rescue Errno::ENOENT => e
         raise Uffizzi::Error.new(e.message)
       end

data/lib/uffizzi/cli/project.rb

@@ -3,6 +3,8 @@
 require 'uffizzi'
 require 'uffizzi/auth_helper'
 require 'uffizzi/response_helper'
+require 'uffizzi/helpers/project_helper'
+require 'uffizzi/services/project_service'
 
 module Uffizzi
   class Cli::Project < Thor
@@ -27,8 +29,27 @@ module Uffizzi
       run('set-default', project_slug: project_slug)
     end
 
+    desc 'describe [PROJECT_SLUG]', 'describe'
+    method_option :output, type: :string, aliases: '-o', enum: ['json', 'pretty'], default: 'json'
+    def describe(project_slug)
+      run('describe', project_slug: project_slug)
+    end
+
     map('set-default' => :set_default)
 
+    method_option :name, required: true
+    method_option :slug, default: ''
+    method_option :description, required: false
+    desc 'create', 'Create a project'
+    def create
+      run('create')
+    end
+
+    desc 'delete [PROJECT_SLUG]', 'Delete a project'
+    def delete(project_slug)
+      run('delete', project_slug: project_slug)
+    end
+
     private
 
     def run(command, project_slug: nil)
@@ -39,21 +60,74 @@ module Uffizzi
         handle_list_command
       when 'set-default'
         handle_set_default_command(project_slug)
+      when 'create'
+        handle_create_command
+      when 'delete'
+        handle_delete_command(project_slug)
+      when 'describe'
+        handle_describe_command(project_slug)
       end
     end
 
+    def handle_describe_command(project_slug)
+      response = describe_project(ConfigFile.read_option(:server), project_slug)
+
+      if ResponseHelper.ok?(response)
+        handle_succeed_describe_response(response)
+      else
+        ResponseHelper.handle_failed_response(response)
+      end
+    end
+
+    def handle_succeed_describe_response(response)
+      project = response[:body][:project]
+      project[:deployments] = ProjectService.select_active_deployments(project)
+      ProjectService.describe_project(project, options[:output])
+    end
+
     def handle_list_command
       server = ConfigFile.read_option(:server)
       response = fetch_projects(server)
 
       if ResponseHelper.ok?(response)
-        handle_succeed_response(response)
+        handle_list_success_response(response)
       else
         ResponseHelper.handle_failed_response(response)
       end
     end
 
-    def handle_succeed_response(response)
+    def handle_create_command
+      name = options[:name]
+      slug = options[:slug].empty? ? Uffizzi::ProjectHelper.generate_slug(name) : options[:slug]
+      raise Uffizzi::Error.new('Slug must not content spaces or special characters') unless slug.match?(/^[a-zA-Z0-9\-_]+\Z/i)
+
+      server = ConfigFile.read_option(:server)
+      params = {
+        name: name,
+        description: options[:description],
+        slug: slug,
+      }
+      response = create_project(server, params)
+
+      if ResponseHelper.created?(response)
+        handle_create_success_response(response)
+      else
+        ResponseHelper.handle_failed_response(response)
+      end
+    end
+
+    def handle_delete_command(project_slug)
+      server = ConfigFile.read_option(:server)
+      response = delete_project(server, project_slug)
+
+      if ResponseHelper.no_content?(response)
+        Uffizzi.ui.say("Project with slug #{project_slug} was deleted successfully")
+      else
+        ResponseHelper.handle_failed_response(response)
+      end
+    end
+
+    def handle_list_success_response(response)
       projects = response[:body][:projects]
       return Uffizzi.ui.say('No projects related to this email') if projects.empty?
 
@@ -76,6 +150,12 @@ module Uffizzi
       Uffizzi.ui.say('Default project has been updated.')
     end
 
+    def handle_create_success_response(response)
+      project_name = response[:body][:project][:name]
+
+      Uffizzi.ui.say("Project #{project_name} was successfully created")
+    end
+
     def print_projects(projects)
       projects_list = projects.reduce('') do |acc, project|
         "#{acc}#{project[:slug]}\n"

data/lib/uffizzi/cli.rb

@@ -62,8 +62,10 @@ module Uffizzi
         return Common.show_manual(filename(args)) if show_help?(args, opts)
 
         super
-      rescue SystemExit, Interrupt, SocketError
+      rescue Interrupt
         raise Uffizzi::Error.new('The command was interrupted')
+      rescue SocketError
+        raise Uffizzi::Error.new('A request was not sent to Uffizzi app')
       end
 
       private

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

@@ -49,6 +49,20 @@ module ApiClient
     build_response(response)
   end
 
+  def create_project(server, params)
+    uri = projects_uri(server)
+    response = http_client.make_post_request(uri, params)
+
+    build_response(response)
+  end
+
+  def delete_project(server, project_slug)
+    uri = project_uri(server, project_slug)
+    response = http_client.make_delete_request(uri)
+
+    build_response(response)
+  end
+
   def create_credential(server, params)
     uri = credentials_uri(server)
     response = http_client.make_post_request(uri, params)
@@ -221,7 +235,7 @@ module ApiClient
 
     cookie_content = cookies.first
     cookie = cookie_content.split(';').first
-    Uffizzi::ConfigFile.rewrite_cookie(cookie) if Uffizzi::ConfigFile.exists?
+    Uffizzi::ConfigFile.rewrite_cookie(cookie) if Uffizzi::ConfigFile.exists? && Uffizzi::ConfigFile.option_has_value?(:cookie)
     http_client.auth_cookie = cookie
 
     cookie

data/lib/uffizzi/config_file.rb

@@ -5,20 +5,15 @@ require 'fileutils'
 
 module Uffizzi
   class ConfigFile
-    CONFIG_PATH = "#{Dir.home}/.config/uffizzi/config_default.json"
+    CONFIG_PATH = "#{Dir.home}/.config/uffizzi/config_default"
 
     class << self
       def config_path
         CONFIG_PATH
       end
 
-      def create(account_id, cookie, server)
-        data = prepare_config_data(account_id, cookie, server)
-        data.each_pair { |key, value| write_option(key, value) }
-      end
-
       def delete
-        File.delete(config_path) if exists?
+        File.truncate(config_path, 0) if exists?
       end
 
       def exists?
@@ -73,8 +68,6 @@ module Uffizzi
         data
       end
 
-      private
-
       def option_exists?(option)
         data = read
         return false unless data.is_a?(Hash)
@@ -82,6 +75,8 @@ module Uffizzi
         data.key?(option)
       end
 
+      private
+
       def read
         data = File.read(config_path)
         options = data.split("\n")
@@ -90,7 +85,10 @@ module Uffizzi
           acc.merge({ key.strip.to_sym => value.strip })
         end
       rescue Errno::ENOENT => e
-        Uffizzi.ui.say(e)
+        file_path = e.message.split(' ').last
+        message = "Configuration file not found: #{file_path}\n" \
+        'To configure the uffizzi CLI interactively, run $ uffizzi config'
+        raise Uffizzi::Error.new(message)
       end
 
       def write(data)
@@ -107,14 +105,6 @@ module Uffizzi
         end
       end
 
-      def prepare_config_data(account_id, cookie, server)
-        {
-          account_id: account_id,
-          server: server,
-          cookie: cookie,
-        }
-      end
-
       def create_file
         dir = File.dirname(config_path)
 

data/lib/uffizzi/helpers/project_helper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Uffizzi
+  module ProjectHelper
+    SLUG_ENDING_LENGTH = 6
+    class << self
+      def generate_slug(name)
+        formatted_name = name.downcase.gsub(/ /, '-').gsub(/[^\w-]+/, '')
+        slug_ending = generate_random_string(SLUG_ENDING_LENGTH)
+
+        "#{formatted_name}-#{slug_ending}"
+      end
+
+      private
+
+      def generate_random_string(length)
+        hexatridecimal_base = 36
+        rand(hexatridecimal_base**length).to_s(hexatridecimal_base)
+      end
+    end
+  end
+end

data/lib/uffizzi/promt.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'tty-prompt'
+
+module Uffizzi
+  module UI
+    class Prompt
+      def initialize
+        @prompt = TTY::Prompt.new
+      end
+
+      def select(question, choices)
+        @prompt.select(question, choices)
+      end
+
+      def ask(message, **args)
+        @prompt.ask(message, **args)
+      end
+    end
+  end
+end