uffizzi-cli 1.0.5 → 2.0.27

data/lib/uffizzi/cli/login.rb

@@ -3,7 +3,11 @@
 require 'uffizzi'
 require 'uffizzi/response_helper'
 require 'uffizzi/helpers/project_helper'
+require 'uffizzi/helpers/login_helper'
+require 'uffizzi/helpers/config_helper'
 require 'uffizzi/clients/api/api_client'
+require 'launchy'
+require 'securerandom'
 require 'tty-prompt'
 
 module Uffizzi
@@ -12,104 +16,146 @@ module Uffizzi
 
     def initialize(options)
       @options = options
+      @server = Uffizzi::LoginHelper.set_server(@options)
     end
 
     def run
-      Uffizzi.ui.say('Login to Uffizzi server.')
-      server = set_server
+      AuthHelper.sign_out if AuthHelper.signed_in?
+      return perform_email_login if @options[:email]
+
+      perform_browser_login
+    end
 
-      username = set_username
-      password = set_password
-      params = prepare_request_params(username, password)
-      response = create_session(server, params)
+    private
+
+    def perform_email_login
+      Uffizzi.ui.say('Login to Uffizzi server.')
+      username =  Uffizzi::LoginHelper.set_username(@options)
+      password =  Uffizzi::LoginHelper.set_password
+      params = Uffizzi::LoginHelper.prepare_request_params(username, password)
+      response = create_session(@server, params)
 
       if ResponseHelper.created?(response)
-        handle_succeed_response(response, server, username)
+        handle_succeed_response(response, username)
       else
         ResponseHelper.handle_failed_response(response)
       end
     end
 
-    private
+    def perform_browser_login
+      session_id = SecureRandom.uuid
+      response = create_access_token(@server, session_id)
+      return handle_failed_response(response) unless ResponseHelper.created?(response)
 
-    def set_server
-      config_server = ConfigFile.exists? ? read_option_from_config(:server) : nil
-      server_address = (@options[:server] || config_server || Uffizzi.ui.ask('Server:')).sub(/\/+$/, '')
-      server_address.start_with?('http:', 'https:') ? server_address : "https://#{server_address}"
-    end
+      url = browser_sign_in_url(@server, session_id)
+      open_browser(url)
 
-    def set_username
-      config_username = ConfigFile.exists? ? read_option_from_config(:username) : nil
-      @options[:username] || config_username || Uffizzi.ui.ask('Username:')
-    end
+      loop do
+        response = get_access_token(@server, session_id)
 
-    def set_password
-      ENV['UFFIZZI_PASSWORD'] || Uffizzi.ui.ask('Password:', echo: false)
+        if ResponseHelper.ok?(response)
+          break handle_token_success(response)
+        elsif ResponseHelper.unprocessable_entity?(response)
+          break Uffizzi.ui.say('The session has expired. Please try again.')
+        else
+          sleep(3)
+        end
+      end
     end
 
-    def read_option_from_config(option)
-      ConfigFile.option_has_value?(option) ? ConfigFile.read_option(option) : nil
-    end
+    def handle_token_success(response)
+      ConfigFile.write_option(:server, @server)
+      token = response[:body][:access_token]
+      Uffizzi::Token.delete
+      Uffizzi::Token.write(token)
+      Uffizzi.ui.say('Login successfull')
 
-    def prepare_request_params(username, password)
-      {
-        user: {
-          email: username,
-          password: password,
-        },
-      }
+      set_current_account_and_project
     end
 
-    def handle_succeed_response(response, server, username)
-      # TODO Choose a personal account
-      account = response[:body][:user][:accounts].first
-      return Uffizzi.ui.say('No account related to this email') unless account_valid?(account)
+    def open_browser(url)
+      Launchy.open(url) do |_exception|
+        Uffizzi.ui.say('Login to Uffizzi server.')
+        Uffizzi.ui.say(url)
+      end
+    end
 
-      ConfigFile.write_option(:server, server)
+    def handle_succeed_response(response, username)
+      ConfigFile.write_option(:server, @server)
       ConfigFile.write_option(:username, username)
       ConfigFile.write_option(:cookie, response[:headers])
-      ConfigFile.write_option(:account_id, account[:id])
-
       Uffizzi.ui.say('Login successfull')
 
-      default_project = ConfigFile.read_option(:project)
-      return unless default_project
+      if ENV.fetch('CI_PIPELINE_RUN', false)
+        account = response[:body][:user][:default_account]
+        return ConfigFile.write_option(:account, Uffizzi::ConfigHelper.account_config(account[:id]))
+      end
 
-      check_default_project(default_project, server)
+      set_current_account_and_project
     end
 
-    def account_valid?(account)
-      account[:state] == 'active'
+    def set_current_account_and_project
+      current_account_id = ConfigFile.read_option(:account, :id)
+      current_project_slug = ConfigFile.read_option(:project)
+
+      unless current_account_id
+        account_id = set_account
+        return set_project(account_id)
+      end
+
+      return if current_project_slug && project_exists?(current_account_id, current_project_slug)
+
+      set_project(account_id)
     end
 
-    def check_default_project(default_project, server)
-      check_project_response = fetch_projects(server)
+    def project_exists?(account_id, project_slug)
+      check_project_response = fetch_account_projects(@server, account_id)
       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:"
+      slugs.include?(project_slug)
+    end
+
+    def set_account
+      accounts_response = fetch_accounts(@server)
+      accounts = accounts_response[:body][:accounts]
+      if accounts.length == 1
+        current_account = accounts.first
+        ConfigFile.write_option(:account, Uffizzi::ConfigHelper.account_config(current_account[:id], current_account[:name]))
+        return current_account[:id]
+      end
+      question = 'Select an account:'
+      choices = accounts.map do |account|
+        { name: account[:name], value: account[:id] }
+      end
+      account_id = Uffizzi.prompt.select(question, choices)
+      account_name = accounts.detect { |account| account[:id] == account_id }[:name]
+
+      ConfigFile.write_option(:account, Uffizzi::ConfigHelper.account_config(account_id, account_name))
+
+      account_id
+    end
+
+    def set_project(account_id)
+      projects_response = fetch_account_projects(@server, account_id)
+      projects = projects_response[:body][:projects]
       choices = projects.map do |project|
         { name: project[:name], value: project[:slug] }
       end
       all_choices = choices + [{ name: 'Create a new project', value: nil }]
+      question = 'Select a project or create a new project:'
       answer = Uffizzi.prompt.select(question, all_choices)
-      return create_new_project(server) unless answer
+      return create_new_project unless answer
 
-      account_id = projects.detect { |project| project[:slug] == answer }[:account_id]
       ConfigFile.write_option(:project, answer)
-      ConfigFile.write_option(:account_id, account_id)
     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: ')
+    def create_new_project(prev_params = {})
+      project_name = Uffizzi.prompt.ask('Project name: ', required: true, default: prev_params.fetch(:name, nil))
+      project_slug = ask_project_slug(project_name, prev_params.fetch(:slug, nil))
+      project_description = Uffizzi.prompt.ask('Project desciption: ', default: prev_params.fetch(:description, nil))
 
       params = {
         project: {
@@ -119,31 +165,49 @@ module Uffizzi
         },
       }
 
-      account_id = ConfigFile.read_option(:account_id)
-      response = create_project(server, account_id, params)
+      account_id = ConfigFile.read_option(:account, :id)
+      response = create_project(@server, account_id, params)
 
       if ResponseHelper.created?(response)
         handle_create_project_succeess(response)
       else
-        handle_create_project_failed(response)
+        handle_create_project_failed(response, params[:project])
       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
+    def ask_project_slug(project_name, prev_slug = nil)
+      generated_slug = Uffizzi::ProjectHelper.generate_slug(project_name)
+      default_slug = prev_slug || generated_slug
+      project_slug = Uffizzi.prompt.ask('Project slug: ', default: default_slug)
+      return project_slug if project_slug.match?(/^[a-zA-Z0-9\-_]+\Z/i)
+
+      question = 'Slug must not content spaces or special characters. Do you want to a different project slug?'
+      answer = Uffizzi.prompt.yes?(question)
+      return ask_project_slug(project_name) if answer
+
+      raise Uffizzi::Error.new('Project creation aborted')
+    end
+
+    def handle_create_project_failed(response, project_params)
+      errors = [:name, :slug].map { |error_key| response.dig(:body, :errors, error_key).to_a.first }.compact
+
+      if errors.blank?
+        return ResponseHelper.handle_failed_response(response)
+      end
+
+      Uffizzi.ui.say(errors.join("\n"))
+      question = 'Do you want to try different project params?'
+      answer = Uffizzi.prompt.yes?(question)
+
+      return create_new_project(project_params) if answer
 
-      ResponseHelper.handle_failed_response(response)
+      raise Uffizzi::Error.new("Project creation aborted. You can run 'uffizzi config' to set project as a default")
     end
 
     def handle_create_project_succeess(response)
       project = response[:body][:project]
 
       ConfigFile.write_option(:project, project[:slug])
-      ConfigFile.write_option(:account_id, project[:account_id])
 
       Uffizzi.ui.say("Project #{project[:name]} was successfully created")
     end

data/lib/uffizzi/cli/login_by_identity_token.rb

@@ -3,6 +3,7 @@
 require 'uffizzi'
 require 'uffizzi/response_helper'
 require 'uffizzi/clients/api/api_client'
+require 'uffizzi/helpers/config_helper'
 
 module Uffizzi
   class Cli::LoginByIdentityToken
@@ -13,13 +14,14 @@ module Uffizzi
     end
 
     def run
-      token = @options[:token]
+      oidc_token = @options[:oidc_token]
+      github_access_token = @options[:access_token]
       server = @options[:server]
-      params = prepare_request_params(token)
+      params = prepare_request_params(oidc_token, github_access_token)
       response = create_ci_session(server, params)
 
       if ResponseHelper.created?(response)
-        handle_succeed_response(response, server)
+        handle_succeed_response(response, server, oidc_token)
       else
         ResponseHelper.handle_failed_response(response)
       end
@@ -27,19 +29,21 @@ module Uffizzi
 
     private
 
-    def prepare_request_params(token)
+    def prepare_request_params(oidc_token, github_access_token)
       {
         user: {
-          token: token,
+          token: oidc_token,
+          github_access_token: github_access_token,
         },
       }
     end
 
-    def handle_succeed_response(response, server)
+    def handle_succeed_response(response, server, oidc_token)
       ConfigFile.write_option(:server, server)
       ConfigFile.write_option(:cookie, response[:headers])
-      ConfigFile.write_option(:account_id, response[:body][:account_id])
+      ConfigFile.write_option(:account, Uffizzi::ConfigHelper.account_config(response[:body][:account_id]))
       ConfigFile.write_option(:project, response[:body][:project_slug])
+      ConfigFile.write_option(:oidc_token, oidc_token)
 
       Uffizzi.ui.say('Successful Login by Identity Token')
     end

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

@@ -26,7 +26,7 @@ module Uffizzi
       end
     end
 
-    desc 'list [DEPLOYMENT_ID]', 'List the container services of a given preview'
+    desc 'list [DEPLOYMENT_ID]', 'List the container services of a given compose environment (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 CommandService.project_set?(options)

data/lib/uffizzi/cli/preview.rb

@@ -4,47 +4,49 @@ require 'uffizzi'
 require 'uffizzi/auth_helper'
 require 'uffizzi/services/preview_service'
 require 'uffizzi/services/command_service'
+require 'uffizzi/services/github_service'
 
 module Uffizzi
   class Cli::Preview < Thor
     include ApiClient
 
-    desc 'service', 'Show the preview services info'
+    desc 'service', 'Show the compose environment (preview) services info'
     require_relative 'preview/service'
     subcommand 'service', Uffizzi::Cli::Preview::Service
 
-    desc 'list', 'List all previews'
+    desc 'list', 'List all compose environments (previews)'
     method_option :filter, required: false, type: :string, aliases: '-f'
     method_option :output, required: false, type: :string, aliases: '-o', enum: ['json', 'pretty-json']
     def list
       run('list')
     end
 
-    desc 'create [COMPOSE_FILE]', 'Create a preview'
+    desc 'create [COMPOSE_FILE]', 'Create a compose environment (preview)'
     method_option :output, required: false, type: :string, aliases: '-o', enum: ['json', 'github-action']
     method_option :"set-labels", required: false, type: :string, aliases: '-s'
+    method_option :"creation-source", required: false, type: :string
     def create(file_path = nil)
       run('create', file_path: file_path)
     end
 
-    desc 'uffizzi preview update [DEPLOYMENT_ID] [COMPOSE_FILE]', 'Update a preview'
+    desc 'update [DEPLOYMENT_ID] [COMPOSE_FILE]', 'Update a compose environment (preview)'
     method_option :output, required: false, type: :string, aliases: '-o', enum: ['json', 'github-action']
     method_option :"set-labels", required: false, type: :string, aliases: '-s'
     def update(deployment_name, file_path)
       run('update', deployment_name: deployment_name, file_path: file_path)
     end
 
-    desc 'delete [DEPLOYMENT_ID]', 'Delete a preview'
+    desc 'delete [DEPLOYMENT_ID]', 'Delete a compose environment (preview)'
     def delete(deployment_name)
       run('delete', deployment_name: deployment_name)
     end
 
-    desc 'describe [DEPLOYMENT_ID]', 'Display details of a preview'
+    desc 'describe [DEPLOYMENT_ID]', 'Display details of a compose environment (preview)'
     def describe(deployment_name)
       run('describe', deployment_name: deployment_name)
     end
 
-    desc 'events [DEPLOYMENT_ID]', 'Show the deployment event logs for a preview'
+    desc 'events [DEPLOYMENT_ID]', 'Show the deployment event logs for a compose environment (preview)'
     def events(deployment_name)
       run('events', deployment_name: deployment_name)
     end
@@ -62,7 +64,7 @@ module Uffizzi
       when 'list'
         handle_list_command(project_slug, options[:filter])
       when 'create'
-        handle_create_command(file_path, project_slug, options[:"set-labels"])
+        handle_create_command(file_path, project_slug, options[:"set-labels"], options[:"creation-source"])
       when 'update'
         handle_update_command(deployment_name, file_path, project_slug, options[:"set-labels"])
       when 'delete'
@@ -85,10 +87,9 @@ module Uffizzi
       end
     end
 
-    def handle_create_command(file_path, project_slug, labels)
-      Uffizzi.ui.disable_stdout unless options[:output].nil?
-
-      params = prepare_params(file_path, labels)
+    def handle_create_command(file_path, project_slug, labels, creation_source)
+      Uffizzi.ui.disable_stdout if Uffizzi.ui.output_format
+      params = prepare_params(file_path, labels, creation_source)
 
       response = create_deployment(ConfigFile.read_option(:server), project_slug, params)
 
@@ -98,17 +99,18 @@ module Uffizzi
 
       deployment = response[:body][:deployment]
       Uffizzi.ui.say("Preview with ID deployment-#{deployment[:id]} was created.")
+      deployment_data = build_deployment_data(deployment)
+      Uffizzi.ui.say("Deployment details url: #{deployment_data[:containers_uri]}")
 
-      success = PreviewService.run_containers_deploy(project_slug, deployment)
-
-      display_deployment_data(deployment, success)
+      PreviewService.run_containers_deploy(project_slug, deployment)
+      handle_result(deployment_data)
     rescue SystemExit, Interrupt, SocketError
       deployment_id = response[:body][:deployment][:id]
       handle_preview_interruption(deployment_id, ConfigFile.read_option(:server), project_slug)
     end
 
     def handle_update_command(deployment_name, file_path, project_slug, labels)
-      Uffizzi.ui.disable_stdout unless options[:output].nil?
+      Uffizzi.ui.disable_stdout if Uffizzi.ui.output_format
       deployment_id = PreviewService.read_deployment_id(deployment_name)
 
       raise Uffizzi::Error.new("Preview should be specified in 'deployment-PREVIEW_ID' format") if deployment_id.nil?
@@ -122,10 +124,11 @@ module Uffizzi
 
       deployment = response[:body][:deployment]
       Uffizzi.ui.say("Preview with ID deployment-#{deployment_id} was updated.")
+      deployment_data = build_deployment_data(deployment)
+      Uffizzi.ui.say("Deployment details url: #{deployment_data[:containers_uri]}")
 
-      success = PreviewService.run_containers_deploy(project_slug, deployment)
-
-      display_deployment_data(deployment, success)
+      PreviewService.run_containers_deploy(project_slug, deployment)
+      handle_result(deployment_data)
     rescue SystemExit, Interrupt, SocketError
       deployment_id = response[:body][:deployment][:id]
       handle_preview_interruption(deployment_id, ConfigFile.read_option(:server), project_slug)
@@ -215,10 +218,13 @@ module Uffizzi
       end
     end
 
-    def prepare_params(file_path, labels)
+    def prepare_params(file_path, labels, creation_source = nil)
       compose_file_params = file_path.nil? ? {} : build_compose_file_params(file_path)
       metadata_params = labels.nil? ? {} : build_metadata_params(labels)
-      compose_file_params.merge(metadata_params)
+      oidc_token = ConfigFile.read_option(:oidc_token)
+      extra_params = oidc_token.nil? ? {} : { token: oidc_token }
+      params = compose_file_params.merge(metadata_params)
+      params.merge(extra_params, { creation_source: creation_source })
     end
 
     def handle_preview_interruption(deployment_id, server, project_slug)
@@ -227,22 +233,16 @@ module Uffizzi
       preview_deletion_message = if ResponseHelper.no_content?(deletion_response)
         "The preview #{deployment_name} has been disabled."
       else
-        "Couldn't disable the deployment #{deployment_name} - please disable maually."
+        "Couldn't disable the deployment #{deployment_name} - please disable manually."
       end
 
       raise Uffizzi::Error.new("The preview creation was interrupted. #{preview_deletion_message}")
     end
 
-    def display_deployment_data(deployment, success)
-      if Uffizzi.ui.output_format.nil?
-        Uffizzi.ui.say('Done')
-        preview_url = "https://#{deployment[:preview_url]}"
-        Uffizzi.ui.say(preview_url) if success
-      else
-        deployment_data = build_deployment_data(deployment)
-        Uffizzi.ui.enable_stdout
-        Uffizzi.ui.say(deployment_data)
-      end
+    def handle_result(deployment_data)
+      Uffizzi.ui.enable_stdout
+      Uffizzi.ui.say(deployment_data) if Uffizzi.ui.output_format
+      GithubService.write_to_github_env(deployment_data) if GithubService.github_actions_exists?
     end
 
     def build_deployment_data(deployment)
@@ -251,6 +251,7 @@ module Uffizzi
       {
         id: "deployment-#{deployment[:id]}",
         url: "https://#{deployment[:preview_url]}",
+        proxy_url: "https://#{deployment[:proxy_preview_url]}",
         containers_uri: "#{url_server}/projects/#{deployment[:project_id]}/deployments/#{deployment[:id]}/containers",
       }
     end

data/lib/uffizzi/cli/project.rb

@@ -4,6 +4,7 @@ require 'uffizzi'
 require 'uffizzi/auth_helper'
 require 'uffizzi/response_helper'
 require 'uffizzi/helpers/project_helper'
+require 'uffizzi/helpers/config_helper'
 require 'uffizzi/services/project_service'
 
 module Uffizzi
@@ -36,6 +37,7 @@ module Uffizzi
     end
 
     map('set-default' => :set_default)
+    map('set' => :set_default)
 
     method_option :name, required: true
     method_option :slug, default: ''
@@ -70,7 +72,7 @@ module Uffizzi
     end
 
     def handle_describe_command(project_slug)
-      response = describe_project(ConfigFile.read_option(:server), project_slug)
+      response = fetch_project(ConfigFile.read_option(:server), project_slug)
 
       if ResponseHelper.ok?(response)
         handle_succeed_describe_response(response)
@@ -87,7 +89,8 @@ module Uffizzi
 
     def handle_list_command
       server = ConfigFile.read_option(:server)
-      response = fetch_projects(server)
+      account_id = ConfigFile.read_option(:account, :id)
+      response = fetch_account_projects(server, account_id)
 
       if ResponseHelper.ok?(response)
         handle_list_success_response(response)
@@ -102,7 +105,8 @@ module Uffizzi
       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)
-      account_id = ConfigFile.read_option(:account_id)
+      account_id = ConfigFile.read_option(:account, :id)
+
       params = {
         name: name,
         description: options[:description],
@@ -130,14 +134,14 @@ module Uffizzi
 
     def handle_list_success_response(response)
       projects = response[:body][:projects]
-      return Uffizzi.ui.say('No projects related to this email') if projects.empty?
+      return Uffizzi.ui.say('No projects found') if projects.empty?
 
       set_default_project(projects.first) if projects.size == 1
       print_projects(projects)
     end
 
     def handle_set_default_command(project_slug)
-      response = describe_project(ConfigFile.read_option(:server), project_slug)
+      response = fetch_project(ConfigFile.read_option(:server), project_slug)
 
       if ResponseHelper.ok?(response)
         handle_succeed_set_default_response(response)
@@ -152,9 +156,9 @@ module Uffizzi
     end
 
     def handle_create_success_response(response)
-      project_name = response[:body][:project][:name]
-
-      Uffizzi.ui.say("Project #{project_name} was successfully created")
+      project = response[:body][:project]
+      ConfigFile.write_option(:project, project[:slug])
+      Uffizzi.ui.say("Project '#{project[:name]}' with slug '#{project[:slug]}' was successfully created")
     end
 
     def print_projects(projects)
@@ -166,7 +170,11 @@ module Uffizzi
 
     def set_default_project(project)
       ConfigFile.write_option(:project, project[:slug])
-      ConfigFile.write_option(:account_id, project[:account_id])
+      account = project[:account]
+      return ConfigFile.write_option(:account, Uffizzi::ConfigHelper.account_config(account[:id], account[:name])) if account
+
+      # For core versions < core_v2.2.3
+      ConfigFile.write_option(:account, Uffizzi::ConfigHelper.account_config(project[:account_id]))
     end
   end
 end