uffizzi-cli 0.1.4.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22ba7aad922d83a3168cba4c93f476c334359ca83663f6fd9e10a9bbface0ae9
-  data.tar.gz: e32af9850d0dca8b4ba93675cd5f19d4c4fcdf8b86df5e4231125aa56ef63341
+  metadata.gz: d4cfb476e78f4f753db221ae22db4f6a697c9570b53f5ed9c607cf53b8bae22f
+  data.tar.gz: 9c81c733aaef45544d9a012ea70bef7e52e11838643243519d3d3c655e6ac6ca
 SHA512:
-  metadata.gz: 013051664b8bdf93ed677b3ceff71053f283800dc4493f98c1326de0a85db99ba2e58217d8c6a16ec3502c7cf4898a3612208f2343ec177d7f44eae32ddb8d63
-  data.tar.gz: a1054b99e188dbbb6e13c5d19dec8134996386a42730dd5f2d9af857fc1b05b02cca00543e0c9158942a61d1b5e51a1d483f60c16ff74a4adca3f924d6819ed9
+  metadata.gz: c912e51e896f064d74e8c42c0903eac6ccc31311dae189cd27261b31b8f218b8db596957fd98cdcf8ba19d340bdac3b5dc7104ab9eecbf75e7c45daa9d031d29
+  data.tar.gz: a4c2e7f02463a12552d3205d5aa525baef3426796bd935c1bcbd087a452f11e467a55839e2a07b511e53e3df843db9f2af28068fa719946c7cc880c0d27e2616

data/.rubocop.yml

@@ -23,6 +23,9 @@ Style/AsciiComments:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#english-comments'
   Enabled: false
 
+Style/OptionalBooleanParameter:
+  Enabled: false
+
 Naming/AsciiIdentifiers:
   Description: 'Use only ascii symbols in identifiers.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#english-identifiers'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    uffizzi-cli (0.1.4.3)
+    uffizzi-cli (0.2.0)
       thor
 
 GEM
@@ -78,6 +78,9 @@ GEM
       rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
     thor (1.2.1)
+    tty-cursor (0.7.1)
+    tty-spinner (0.9.3)
+      tty-cursor (~> 0.7)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode (0.4.4.4)
@@ -106,6 +109,7 @@ DEPENDENCIES
   rubocop
   rubocop-minitest
   rubocop-rake
+  tty-spinner
   uffizzi-cli!
   webmock
 

data/README.md

@@ -1,31 +1,31 @@
-# Uffizzi CLI  
+# Uffizzi CLI
 
-A command-line interace (CLI) for [Uffizzi App](https://github.com/UffizziCloud/uffizzi_app) 
+A command-line interace (CLI) for [Uffizzi App](https://github.com/UffizziCloud/uffizzi_app)
 
 ## Uffizzi Overview
 
-Uffizzi is the Full-stack Previews Engine that makes it easy for your team to preview code changes before merging—whether frontend, backend or microserivce. Define your full-stack apps with a familiar syntax based on Docker Compose, and Uffizzi will create on-demand test environments when you open pull requests or build new images. Preview URLs are updated when there’s a new commit, so your team can catch issues early, iterate quickly, and accelerate your release cycles.  
+Uffizzi is the Full-stack Previews Engine that makes it easy for your team to preview code changes before merging—whether frontend, backend or microserivce. Define your full-stack apps with a familiar syntax based on Docker Compose, and Uffizzi will create on-demand test environments when you open pull requests or build new images. Preview URLs are updated when there’s a new commit, so your team can catch issues early, iterate quickly, and accelerate your release cycles.
 
-## Getting started with Uffizzi  
+## Getting started with Uffizzi
 
-The fastest and easiest way to get started with Uffizzi is via the fully hosted version available at https://uffizzi.com, which includes free plans for small teams and qualifying open-source projects.   
+The fastest and easiest way to get started with Uffizzi is via the fully hosted version available at https://uffizzi.com, which includes free plans for small teams and qualifying open-source projects.
 
 Alternatively, you can self-host Uffizzi via the open-source repositories available here on GitHub. The remainder of this README is intended for users interested in self-hosting Uffizzi or for those who are just curious about how Uffizzi works.
 
-## Uffizzi Architecture  
+## Uffizzi Architecture
 
-Uffizzi consists of the following components:  
+Uffizzi consists of the following components:
 
-* [Uffizzi App](https://github.com/UffizziCloud/uffizzi_app) - The primary REST API for creating and managing Previews  
-* [Uffizzi Controller](https://github.com/UffizziCloud/uffizzi_controller) - A smart proxy service that handles requests from Uffizzi App to the Kubernetes API  
-* Uffizzi CLI (this repository) - A command-line interface for Uffizzi App    
-* [Uffizzi Dashboard](https://app.uffizzi.com) - A graphical user interface for Uffizzi App, available as a paid service at https://uffizzi.com  
+- [Uffizzi App](https://github.com/UffizziCloud/uffizzi_app) - The primary REST API for creating and managing Previews
+- [Uffizzi Controller](https://github.com/UffizziCloud/uffizzi_controller) - A smart proxy service that handles requests from Uffizzi App to the Kubernetes API
+- Uffizzi CLI (this repository) - A command-line interface for Uffizzi App
+- [Uffizzi Dashboard](https://app.uffizzi.com) - A graphical user interface for Uffizzi App, available as a paid service at https://uffizzi.com
 
-To host Uffizzi yourself, you will also need the following external dependencies:  
+To host Uffizzi yourself, you will also need the following external dependencies:
 
- * Kubernetes (k8s) cluster  
- * Postgres database  
- * Redis cache 
+- Kubernetes (k8s) cluster
+- Postgres database
+- Redis cache
 
 ## Installation
 
@@ -54,40 +54,81 @@ Run rubocop:
 
 ## Commands
 
-### login ###
+### login
 
 ```
-$ uffizzi login -u your@email.com -h localhost:8080
+$ uffizzi login -u your@email.com --hostname localhost:8080
 ```
-Logging you into the app which you set in the hostname option.
 
+Logging you into the app which you set in the hostname option.
 
-### login options ###
+### login options
 
-Option      | Aliase          | Description
--------     | -------         | -----------
-`--user`    | `-u`            | Your email for logging in
-`--hostname`| `-h`            | Adress of your app
+| Option       | Aliase | Description               |
+| ------------ | ------ | ------------------------- |
+| `--user`     | `-u`   | Your email for logging in |
+| `--hostname` |        | Adress of your app        |
 
 If hostname uses basic authentication you can specify options for it by setting `basic_auth_user` and `basic_auth_password` via `config set` command.
 
-### projects ###
+### project
 
 ```
-$ uffizzi projects
+$ uffizzi project
+```
+
+Use this command to configure your projects. This command has 2 subcommands `list` and `compose`.
+
+```
+$ 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`
 
-### config ###
+### compose
+
+```
+$ uffizzi project compose
+```
+
+That's the subcommand for project command. Use it to configure your compose file. This command has 3 subcommands `set`, `describe` and `unset`.
+
+```
+$ uffizzi project compose set -f path_to_your_compose_file.yml
+```
+
+Creates a new or updates existed compose file in uffizzi app for project specified in config file
+
+```
+$ uffizzi project compose describe
+```
+
+Shows the content of compose file related to project specified in config file if it's valid or validation errors if it's not
+
+```
+$ uffizzi project compose unset
+```
+
+Removes compose file related to project specified in config file
+
+You need to set project before use any of these commands via `uffizzi config set project YOUR_PROJECT_SLUG` command
+
+### compose options
+
+| Option   | Aliase | Description               |
+| -------- | ------ | ------------------------- |
+| `--file` | `-f`   | Path to your compose file |
+
+### config
 
 Use this command to configure your cli app. This command has 4 subcommands `list`, `get`, `set`, and `delete`.
 
 ```
 $ uffizzi config list
 ```
+
 Shows all options and their values from the config file.
 
 ```

data/config/config.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+module Uffizzi
+  def self.configuration
+    @configuration ||= OpenStruct.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  configure do |config|
+    config.hostname = 'http://web:7000'
+  end
+end

data/lib/uffizzi/auth_helper.rb

@@ -9,6 +9,11 @@ module Uffizzi
           ConfigFile.option_exists?(:cookie) &&
           ConfigFile.option_exists?(:hostname)
       end
+
+      def project_set?
+        ConfigFile.exists? &&
+          ConfigFile.option_exists?(:project)
+      end
     end
   end
 end

data/lib/uffizzi/cli/config.rb

@@ -2,12 +2,35 @@
 
 require 'io/console'
 require 'uffizzi'
+require 'uffizzi/clients/api/api_client'
 
 module Uffizzi
-  class Config
+  class CLI::Config < Thor
     include ApiClient
 
-    def run(command, property, value)
+    desc 'list', 'list'
+    def list
+      run('list')
+    end
+
+    desc 'get', 'get'
+    def get(property)
+      run('get', property)
+    end
+
+    desc 'set', 'set'
+    def set(property, value)
+      run('set', property, value)
+    end
+
+    desc 'delete', 'delete'
+    def delete(property)
+      run('delete', property)
+    end
+
+    private
+
+    def run(command, property = nil, value = nil)
       case command
       when 'list'
         handle_list_command
@@ -17,40 +40,25 @@ module Uffizzi
         handle_set_command(property, value)
       when 'delete'
         handle_delete_command(property)
-      else
-        puts "#{command} is not a uffizzi config command"
       end
     end
 
-    private
-
     def handle_list_command
       ConfigFile.list
     end
 
     def handle_get_command(property)
-      if property.nil?
-        puts 'No property provided'
-        return
-      end
       option = ConfigFile.read_option(property.to_sym)
-      puts option unless option.nil?
+      message = option.nil? ? "The option #{property} doesn't exist in config file" : option
+
+      Uffizzi.ui.say(message)
     end
 
     def handle_set_command(property, value)
-      if property.nil? || value.nil?
-        puts 'No property provided' if property.nil?
-        puts 'No value provided' if value.nil?
-        return
-      end
       ConfigFile.write_option(property.to_sym, value)
     end
 
     def handle_delete_command(property)
-      if property.nil?
-        puts 'No property provided'
-        return
-      end
       ConfigFile.delete_option(property.to_sym)
     end
   end

data/lib/uffizzi/cli/login.rb

@@ -3,6 +3,7 @@
 require 'io/console'
 require 'uffizzi'
 require 'uffizzi/response_helper'
+require 'uffizzi/clients/api/api_client'
 
 module Uffizzi
   class CLI::Login
@@ -17,10 +18,10 @@ module Uffizzi
       params = prepare_request_params(password)
       response = create_session(@options[:hostname], params)
 
-      if Uffizzi::ResponseHelper.created?(response)
+      if ResponseHelper.created?(response)
         handle_succeed_response(response)
       else
-        handle_failed_response(response)
+        ResponseHelper.handle_failed_response(response)
       end
     end
 
@@ -35,10 +36,6 @@ module Uffizzi
       }
     end
 
-    def handle_failed_response(response)
-      print_errors(response[:body][:errors])
-    end
-
     def handle_succeed_response(response)
       account = response[:body][:user][:accounts].first
       return Uffizzi.ui.say('No account related to this email') unless account_valid?(account)

data/lib/uffizzi/cli/preview.rb

@@ -0,0 +1,267 @@
+# frozen_string_literal: true
+
+require 'uffizzi'
+require 'tty-spinner'
+require 'uffizzi/auth_helper'
+
+module Uffizzi
+  class CLI::Preview < Thor
+    include ApiClient
+
+    @spinner
+
+    class << self
+      def help(_shell, _subcommand)
+        Cli::Common.show_manual(:preview)
+      end
+    end
+
+    desc 'list', 'list'
+    def list
+      return Cli::Common.show_manual(:list) if options[:help]
+
+      run(options, 'list', nil, nil)
+    end
+
+    desc 'create', 'create'
+    def create(file_path = nil)
+      return Cli::Common.show_manual(:create) if options[:help]
+
+      run(options, 'create', file_path, nil)
+    end
+
+    desc 'delete', 'delete'
+    def delete(deployment)
+      return Cli::Common.show_manual(:delete) if options[:help]
+
+      run(options, 'delete', nil, deployment)
+    end
+
+    desc 'describe', 'describe'
+    def describe(deployment)
+      return Cli::Common.show_manual(:describe) if options[:help]
+
+      run(options, 'describe', nil, deployment)
+    end
+
+    private
+
+    def run(options, command, file_path, deployment)
+      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?
+
+      project_slug = options[:project].nil? ? ConfigFile.read_option(:project) : options[:project]
+
+      case command
+      when 'list'
+        handle_list_command(project_slug)
+      when 'create'
+        handle_create_command(file_path, project_slug)
+      when 'delete'
+        handle_delete_command(deployment, project_slug)
+      when 'describe'
+        handle_describe_command(deployment, project_slug)
+      end
+    end
+
+    def handle_list_command(project_slug)
+      hostname = ConfigFile.read_option(:hostname)
+      response = fetch_deployments(hostname, project_slug)
+
+      if ResponseHelper.ok?(response)
+        handle_succeed_list_response(response)
+      else
+        ResponseHelper.handle_failed_response(response)
+      end
+    end
+
+    def handle_create_command(file_path, project_slug)
+      hostname = ConfigFile.read_option(:hostname)
+      params = file_path.nil? ? {} : prepare_params(file_path)
+      response = create_deployment(hostname, project_slug, params)
+
+      if ResponseHelper.created?(response)
+        handle_succeed_create_response(hostname, project_slug, response)
+      else
+        ResponseHelper.handle_failed_response(response)
+      end
+    end
+
+    def handle_succeed_create_response(hostname, project_slug, response)
+      deployment = response[:body][:deployment]
+      deployment_id = deployment[:id]
+      params = { id: deployment_id }
+
+      response = deploy_containers(hostname, project_slug, deployment_id, params)
+
+      if ResponseHelper.no_content?(response)
+        Uffizzi.ui.say("Preview created with name deployment-#{deployment_id}")
+        print_deployment_progress(hostname, deployment, project_slug)
+      else
+        ResponseHelper.handle_failed_response(response)
+      end
+    end
+
+    def print_deployment_progress(hostname, deployment, project_slug)
+      deployment_id = deployment[:id]
+
+      @spinner = TTY::Spinner.new('[:spinner] Creating containers...', format: :dots)
+      @spinner.auto_spin
+
+      activity_items = []
+
+      loop do
+        response = get_activity_items(hostname, project_slug, deployment_id)
+        handle_activity_items_response(response)
+        return unless @spinner.spinning?
+
+        activity_items = response[:body][:activity_items]
+        break unless activity_items.empty?
+
+        sleep(5)
+      end
+
+      @spinner.success
+
+      Uffizzi.ui.say('Done')
+
+      @spinner = TTY::Spinner::Multi.new('[:spinner] Deploying preview...', format: :dots, style: {
+                                           middle: '  ',
+                                           bottom: '  ',
+                                         })
+
+      containers_spinners = create_containers_spinners(activity_items)
+
+      loop do
+        response = get_activity_items(hostname, project_slug, deployment_id)
+        handle_activity_items_response(response)
+        return if @spinner.done?
+
+        activity_items = response[:body][:activity_items]
+        check_activity_items_state(activity_items, containers_spinners)
+        break if activity_items.all? { |activity_item| activity_item[:state] == 'deployed' || activity_item[:state] == 'failed' }
+
+        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)
+      activity_items.map do |activity_item|
+        container_spinner = @spinner.register("[:spinner] #{activity_item[:name]}")
+        container_spinner.auto_spin
+        {
+          name: activity_item[:name],
+          spinner: container_spinner,
+        }
+      end
+    end
+
+    def check_activity_items_state(activity_items, containers_spinners)
+      finished_activity_items = activity_items.filter do |activity_item|
+        activity_item[:state] == 'deployed' || activity_item[:state] == 'failed'
+      end
+      finished_activity_items.each do |activity_item|
+        container_spinner = containers_spinners.detect { |spinner| spinner[:name] == activity_item[:name] }
+        spinner = container_spinner[:spinner]
+        case activity_item[:state]
+        when 'deployed'
+          spinner.success
+        when 'failed'
+          spinner.error
+        end
+      end
+    end
+
+    def handle_delete_command(deployment, project_slug)
+      return Uffizzi.ui.say("Preview should be specified in 'deployment-PREVIEW_ID' format") unless deployment_name_valid?(deployment)
+
+      hostname = ConfigFile.read_option(:hostname)
+      deployment_id = deployment.split('-').last
+
+      response = delete_deployment(hostname, project_slug, deployment_id)
+
+      if ResponseHelper.no_content?(response)
+        handle_succeed_delete_response(deployment_id)
+      else
+        ResponseHelper.handle_failed_response(response)
+      end
+    end
+
+    def handle_describe_command(deployment, project_slug)
+      return Uffizzi.ui.say("Preview should be specified in 'deployment-PREVIEW_ID' format") unless deployment_name_valid?(deployment)
+
+      hostname = ConfigFile.read_option(:hostname)
+      deployment_id = deployment.split('-').last
+
+      response = describe_deployment(hostname, project_slug, deployment_id)
+
+      if ResponseHelper.ok?(response)
+        handle_succeed_describe_response(response)
+      else
+        ResponseHelper.handle_failed_response(response)
+      end
+    end
+
+    def handle_activity_items_response(response)
+      unless ResponseHelper.ok?(response)
+        @spinner.error
+        ResponseHelper.handle_failed_response(response)
+      end
+    end
+
+    def handle_succeed_list_response(response)
+      deployments = response[:body][:deployments] || []
+      return Uffizzi.ui.say('The project has no active deployments') if deployments.empty?
+
+      deployments.each do |deployment|
+        Uffizzi.ui.say("deployment-#{deployment[:id]}")
+      end
+    end
+
+    def handle_succeed_delete_response(deployment_id)
+      Uffizzi.ui.say("Preview deployment-#{deployment_id} deleted")
+    end
+
+    def handle_succeed_describe_response(response)
+      deployment = response[:body][:deployment]
+      deployment.each_key do |key|
+        Uffizzi.ui.say("#{key}: #{deployment[key]}")
+      end
+    end
+
+    def prepare_params(file_path)
+      begin
+        compose_file_data = File.read(file_path)
+      rescue Errno::ENOENT => e
+        Uffizzi.ui.say(e)
+        return
+      end
+
+      compose_file_dir = File.dirname(file_path)
+      dependencies = ComposeFileService.parse(compose_file_data, compose_file_dir)
+      absolute_path = File.absolute_path(file_path)
+      compose_file_params = {
+        path: absolute_path,
+        content: Base64.encode64(compose_file_data),
+        source: absolute_path,
+      }
+
+      {
+        compose_file: compose_file_params,
+        dependencies: dependencies,
+      }
+    end
+
+    def deployment_name_valid?(deployment)
+      return false unless deployment.start_with?('deployment-')
+      return false unless deployment.split('-').size == 2
+
+      deployment_id = deployment.split('-').last
+      deployment_id.to_i.to_s == deployment_id
+    end
+  end
+end